class DateRecurItem in Recurring Dates Field 8

Same name and namespace in other branches

8.2 src/Plugin/Field/FieldType/DateRecurItem.php \Drupal\date_recur\Plugin\Field\FieldType\DateRecurItem
3.x src/Plugin/Field/FieldType/DateRecurItem.php \Drupal\date_recur\Plugin\Field\FieldType\DateRecurItem
3.0.x src/Plugin/Field/FieldType/DateRecurItem.php \Drupal\date_recur\Plugin\Field\FieldType\DateRecurItem
3.1.x src/Plugin/Field/FieldType/DateRecurItem.php \Drupal\date_recur\Plugin\Field\FieldType\DateRecurItem

Plugin implementation of the 'date_recur' field type.

Plugin annotation


@FieldType(
  id = "date_recur",
  label = @Translation("Date Recur"),
  description = @Translation("Recurring dates field"),
  default_widget = "date_recur_default_widget",
  default_formatter = "date_recur_default_formatter",
  list_class = "\Drupal\date_recur\Plugin\Field\FieldType\DateRecurFieldItemList"
)

Hierarchy

class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ComplexDataInterface
  - class \Drupal\Core\Field\FieldItemBase implements FieldItemInterface
    class \Drupal\datetime\Plugin\Field\FieldType\DateTimeItem implements DateTimeItemInterface
    class \Drupal\datetime_range\Plugin\Field\FieldType\DateRangeItem
    class \Drupal\date_recur\Plugin\Field\FieldType\DateRecurItem

Expanded class hierarchy of DateRecurItem

7 files declare their use of DateRecurItem

DateRecurDefaultFormatter.php in src/Plugin/Field/FieldFormatter/DateRecurDefaultFormatter.php
DateRecurFieldSimpleRender.php in src/Plugin/views/field/DateRecurFieldSimpleRender.php
DateRecurOccurrenceHandlerInterface.php in src/Plugin/DateRecurOccurrenceHandlerInterface.php
DateRecurOccurrencesComputed.php in src/DateRecurOccurrencesComputed.php
DateRecurOccurrenceTableTest.php in tests/src/Kernel/DateRecurOccurrenceTableTest.php

... See full list

File

src/Plugin/Field/FieldType/DateRecurItem.php, line 26

Namespace

Drupal\date_recur\Plugin\Field\FieldType

View source

class DateRecurItem extends DateRangeItem {

  /**
   * @var DateRecurOccurrenceHandlerInterface;
   */
  protected $occurrenceHandler;

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties = parent::propertyDefinitions($field_definition);

    // Prevent early t() calls by using the TranslatableMarkup.
    $properties['timezone'] = DataDefinition::create('string')
      ->setLabel(new TranslatableMarkup('Timezone'))
      ->setRequired(FALSE);
    $properties['rrule'] = DataDefinition::create('string')
      ->setLabel(new TranslatableMarkup('RRule'))
      ->setRequired(FALSE);
    $properties['infinite'] = DataDefinition::create('boolean')
      ->setLabel(new TranslatableMarkup('Is the RRule an infinite rule?'))
      ->setRequired(FALSE);
    $handler = date_recur_create_occurrence_handler($field_definition);
    $properties['occurrences'] = $handler
      ->occurrencePropertyDefinition($field_definition);
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    $schema = parent::schema($field_definition);
    $schema['columns']['rrule'] = [
      'description' => 'The repeat rule.',
      'type' => 'varchar',
      'length' => 255,
    ];
    $schema['columns']['infinite'] = [
      'description' => 'Infinity of the repeat rule.',
      'type' => 'int',
      'size' => 'tiny',
    ];
    $schema['columns']['timezone'] = [
      'description' => 'The timezone',
      'type' => 'varchar',
      'length' => 255,
    ];
    return $schema;
  }

  /**
   * {@inheritdoc}
   */
  public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
    $values = parent::generateSampleValue($field_definition);
    return $values;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultStorageSettings() {
    return [
      'occurrence_handler_plugin' => 'date_recur_occurrence_handler',
    ] + parent::defaultStorageSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
    $elements = parent::storageSettingsForm($form, $form_state, $has_data);
    $handler_options = [];

    /** @var DateRecurOccurrenceHandlerManager $manager */
    $manager = \Drupal::getContainer()
      ->get('plugin.manager.date_recur_occurrence_handler');
    foreach ($manager
      ->getDefinitions() as $id => $definition) {
      $handler_options[$id] = $definition['label'];
    }
    $elements['occurrence_handler_plugin'] = [
      '#type' => 'select',
      '#title' => t('Occurrence handler'),
      '#description' => t('Select an occurrence handler for calculating, saving and retrieving occurrences.'),
      '#options' => $handler_options,
      '#default_value' => $this
        ->getSetting('occurrence_handler_plugin'),
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultFieldSettings() {
    return [
      'precreate' => 'P2Y',
    ] + parent::defaultFieldSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::fieldSettingsForm($form, $form_state);
    $options = [];
    for ($i = 1; $i < 6; $i++) {
      $options['P' . $i . 'Y'] = $this
        ->formatPlural($i, '@count year', '@count years', [
        '@count' => $i,
      ]);
    }
    $element['precreate'] = [
      '#type' => 'select',
      '#title' => t('Precreate occurrences'),
      '#description' => t('For infinitely repeating dates, precreate occurrences for this amount of time in the views cache table.'),
      '#options' => $options,
      '#default_value' => $this
        ->getSetting('precreate'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function isEmpty() {
    return parent::isEmpty();
  }

  /**
   * Get the date storage format of this field.
   *
   * @return string
   */
  public function getDateStorageFormat() {
    switch ($this
      ->getSetting('daterange_type')) {
      case DateRangeItem::DATETIME_TYPE_DATE:
        return DATETIME_DATE_STORAGE_FORMAT;
        break;
      default:
        return DATETIME_DATETIME_STORAGE_FORMAT;
        break;
    }
  }

  /**
   * Get the occurrence handler and initialize it.
   *
   * @return DateRecurOccurrenceHandlerInterface|bool
   */
  public function getOccurrenceHandler() {
    if (empty($this->occurrenceHandler)) {
      $pluginName = $this
        ->getSetting('occurrence_handler_plugin');

      /** @var DateRecurOccurrenceHandlerManager $manager */
      $manager = \Drupal::getContainer()
        ->get('plugin.manager.date_recur_occurrence_handler');

      /** @var DateRecurOccurrenceHandlerInterface $occurrenceHandler */
      $this->occurrenceHandler = $manager
        ->createInstance($pluginName);
      $this->occurrenceHandler
        ->init($this);
    }
    return $this->occurrenceHandler;
  }

  /**
   * {@inheritdoc}
   */
  public function onChange($property_name, $notify = TRUE) {

    // Enforce that the occurrence handler is re-initialized.
    $this->occurrenceHandler = NULL;
    parent::onChange($property_name, $notify);
  }

  /**
   * {@inheritdoc}
   */
  public function preSave() {
    parent::preSave();
    $this->infinite = $this
      ->getOccurrenceHandler()
      ->isInfinite();
  }

  /**
   * Get the item's delta.
   *
   * Field items have their name property set to the delta.
   *
   * @return int
   */
  public function getDelta() {
    return (int) $this->name;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DateRangeItem::DATETIME_TYPE_ALLDAY		constant	Value for the 'datetime_type' setting: store a date and time.
DateRecurItem::$occurrenceHandler	protected	property
DateRecurItem::defaultFieldSettings	public static	function	Defines the field-level settings for this plugin. Overrides FieldItemBase::defaultFieldSettings
DateRecurItem::defaultStorageSettings	public static	function	Defines the storage-level settings for this plugin. Overrides DateTimeItem::defaultStorageSettings
DateRecurItem::fieldSettingsForm	public	function	Returns a form for the field-level settings. Overrides FieldItemBase::fieldSettingsForm
DateRecurItem::generateSampleValue	public static	function	Generates placeholder field values. Overrides DateRangeItem::generateSampleValue
DateRecurItem::getDateStorageFormat	public	function	Get the date storage format of this field.
DateRecurItem::getDelta	public	function	Get the item's delta.
DateRecurItem::getOccurrenceHandler	public	function	Get the occurrence handler and initialize it.
DateRecurItem::isEmpty	public	function	Determines whether the data structure is empty. Overrides DateRangeItem::isEmpty
DateRecurItem::onChange	public	function	React to changes to a child property or item. Overrides DateRangeItem::onChange
DateRecurItem::preSave	public	function	Defines custom presave behavior for field values. Overrides FieldItemBase::preSave
DateRecurItem::propertyDefinitions	public static	function	Defines field item properties. Overrides DateRangeItem::propertyDefinitions
DateRecurItem::schema	public static	function	Returns the schema for the field. Overrides DateRangeItem::schema
DateRecurItem::storageSettingsForm	public	function	Returns a form for the storage-level settings. Overrides DateRangeItem::storageSettingsForm
DateTimeItem::DATETIME_TYPE_DATE		constant	Value for the 'datetime_type' setting: store only a date.
DateTimeItem::DATETIME_TYPE_DATETIME		constant	Value for the 'datetime_type' setting: store a date and time.
DateTimeItemInterface::DATETIME_STORAGE_FORMAT		constant	Defines the format that date and time should be stored in.
DateTimeItemInterface::DATE_STORAGE_FORMAT		constant	Defines the format that dates should be stored in.
DateTimeItemInterface::STORAGE_TIMEZONE		constant	Defines the timezone that dates should be stored in.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FieldItemBase::calculateDependencies	public static	function	Calculates dependencies for field items. Overrides FieldItemInterface::calculateDependencies	2
FieldItemBase::calculateStorageDependencies	public static	function	Calculates dependencies for field items on the storage level. Overrides FieldItemInterface::calculateStorageDependencies	1
FieldItemBase::delete	public	function	Defines custom delete behavior for field values. Overrides FieldItemInterface::delete	2
FieldItemBase::deleteRevision	public	function	Defines custom revision delete behavior for field values. Overrides FieldItemInterface::deleteRevision
FieldItemBase::fieldSettingsFromConfigData	public static	function	Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::fieldSettingsFromConfigData	1
FieldItemBase::fieldSettingsToConfigData	public static	function	Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::fieldSettingsToConfigData	1
FieldItemBase::getEntity	public	function	Gets the entity that field belongs to. Overrides FieldItemInterface::getEntity
FieldItemBase::getFieldDefinition	public	function	Gets the field definition. Overrides FieldItemInterface::getFieldDefinition
FieldItemBase::getLangcode	public	function	Gets the langcode of the field values held in the object. Overrides FieldItemInterface::getLangcode
FieldItemBase::getSetting	protected	function	Returns the value of a field setting.
FieldItemBase::getSettings	protected	function	Returns the array of field settings.
FieldItemBase::mainPropertyName	public static	function	Returns the name of the main property, if any. Overrides FieldItemInterface::mainPropertyName	8
FieldItemBase::onDependencyRemoval	public static	function	Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface::onDependencyRemoval	1
FieldItemBase::postSave	public	function	Defines custom post-save behavior for field values. Overrides FieldItemInterface::postSave	2
FieldItemBase::setValue	public	function	Sets the data value. Overrides Map::setValue	4
FieldItemBase::storageSettingsFromConfigData	public static	function	Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::storageSettingsFromConfigData	2
FieldItemBase::storageSettingsToConfigData	public static	function	Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::storageSettingsToConfigData	2
FieldItemBase::view	public	function	Returns a renderable array for a single field item. Overrides FieldItemInterface::view
FieldItemBase::writePropertyValue	protected	function	Different to the parent Map class, we avoid creating property objects as far as possible in order to optimize performance. Thus we just update $this->values if no property object has been created yet. Overrides Map::writePropertyValue
FieldItemBase::__construct	public	function	Constructs a TypedData object given its definition and context. Overrides TypedData::__construct	1
FieldItemBase::__get	public	function	Magic method: Gets a property value. Overrides FieldItemInterface::__get	2
FieldItemBase::__isset	public	function	Magic method: Determines whether a property is set. Overrides FieldItemInterface::__isset
FieldItemBase::__set	public	function	Magic method: Sets a property value. Overrides FieldItemInterface::__set	1
FieldItemBase::__unset	public	function	Magic method: Unsets a property. Overrides FieldItemInterface::__unset
Map::$definition	protected	property	The data definition. Overrides TypedData::$definition
Map::$properties	protected	property	The array of properties.
Map::$values	protected	property	An array of values for the contained properties.
Map::applyDefaultValue	public	function	Applies the default value. Overrides TypedData::applyDefaultValue	4
Map::get	public	function	Gets a property object. Overrides ComplexDataInterface::get
Map::getIterator	public	function
Map::getProperties	public	function	Gets an array of property objects. Overrides ComplexDataInterface::getProperties
Map::getString	public	function	Returns a string representation of the data. Overrides TypedData::getString
Map::getValue	public	function	Gets the data value. Overrides TypedData::getValue	1
Map::set	public	function	Sets a property value. Overrides ComplexDataInterface::set
Map::toArray	public	function	Returns an array of all property values. Overrides ComplexDataInterface::toArray	1
Map::__clone	public	function	Magic method: Implements a deep clone.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TypedData::$name	protected	property	The property name.
TypedData::$parent	protected	property	The parent typed data object.
TypedData::createInstance	public static	function	Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getConstraints	public	function	Gets a list of validation constraints. Overrides TypedDataInterface::getConstraints	9
TypedData::getDataDefinition	public	function	Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName	public	function	Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent	public	function	Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath	public	function	Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot	public	function	Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::setContext	public	function	Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate	public	function	Validates the currently set data value. Overrides TypedDataInterface::validate
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class DateRecurItem in Recurring Dates Field 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation