IntervalItem.php in Interval Field 8

Namespace

Drupal\interval\Plugin\Field\FieldType

File

src/Plugin/Field/FieldType/IntervalItem.php

<?php

namespace Drupal\interval\Plugin\Field\FieldType;

use Drupal\Core\Field\FieldItemBase;
use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\Core\TypedData\DataDefinition;
use Drupal\interval\IntervalItemInterface;
use Drupal\interval\InvalidIntervalException;

/**
 * Provides a data type plugin for an interval item.
 *
 * @FieldType(
 *   id = "interval",
 *   label = @Translation("Interval"),
 *   description = @Translation("Provides an interval field allowing you to enter a number and select a period."),
 *   default_widget = "interval_default",
 *   default_formatter = "interval_default"
 * )
 */
class IntervalItem extends FieldItemBase implements IntervalItemInterface {

  /**
   * The interval plugin configuration for the selected period.
   *
   * @var array
   */
  protected $intervalPlugin = [];

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties['interval'] = DataDefinition::create('integer')
      ->setLabel(t('Interval'));
    $properties['period'] = DataDefinition::create('string')
      ->setLabel(t('Period'));
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    $columns = [
      'interval' => [
        'description' => 'The number of multiples of the period',
        'type' => 'int',
        'size' => 'medium',
        'not null' => TRUE,
        'default' => 0,
      ],
      'period' => [
        'description' => 'The period machine name',
        'type' => 'varchar',
        'size' => 'normal',
        'length' => 20,
        'not null' => TRUE,
        'default' => 'day',
      ],
    ];
    $indexes = [
      'period' => [
        'period',
      ],
      'interval' => [
        'interval',
      ],
    ];
    return [
      'columns' => $columns,
      'indexes' => $indexes,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getInterval() {
    return (int) $this
      ->get('interval')
      ->getValue();
  }

  /**
   * {@inheritdoc}
   */
  public function getPeriod() {
    return $this
      ->get('period')
      ->getString();
  }

  /**
   * {@inheritdoc}
   */
  public function isEmpty() {
    return empty($this
      ->getValue()['interval']);
  }

  /**
   * {@inheritdoc}
   */
  public function getIntervalPlugin() {
    if (!$this->intervalPlugin) {
      $this->intervalPlugin = \Drupal::service('plugin.manager.interval.intervals')
        ->getDefinition($this
        ->getPeriod());
    }
    return $this->intervalPlugin;
  }

  /**
   * {@inheritdoc}
   */
  public function setValue($values, $notify = TRUE) {
    unset($this->intervalPlugin);
    parent::setValue($values, $notify);
  }

  /**
   * {@inheritdoc}
   */
  public function applyInterval(\DateTime $date, $limit = FALSE) {
    try {
      $old_date = clone $date;
      $datetime = $this
        ->buildPHPString();
      $date
        ->modify($datetime);
      $configuration = $this
        ->getIntervalPlugin();
      if ($limit && $configuration['php'] == 'months') {
        $date_interval = $date
          ->diff($old_date);
        if ($date_interval->d != 0) {
          $date
            ->modify("last day of last month");
        }
      }
    } catch (\Exception $e) {
      throw new InvalidIntervalException($e
        ->getMessage(), 0, $e, $date, $this);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildPHPString() {
    $interval = $this
      ->getIntervalPlugin();
    $value = $this
      ->getInterval() * $interval['multiplier'];
    return $value . ' ' . $interval['php'];
  }

  /**
   * {@inheritdoc}
   */
  public static function mainPropertyName() {
    return NULL;
  }

}

Classes

Name	Description
IntervalItem	Provides a data type plugin for an interval item.