class DateRecurItem in Recurring Dates Field 3.0.x

Same name and namespace in other branches

8.2 src/Plugin/Field/FieldType/DateRecurItem.php \Drupal\date_recur\Plugin\Field\FieldType\DateRecurItem
8 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.1.x src/Plugin/Field/FieldType/DateRecurItem.php \Drupal\date_recur\Plugin\Field\FieldType\DateRecurItem

Plugin implementation of the 'date_recur' field type.

@FieldType( id = "date_recur", label = @Translation("Recurring dates field"), description = @Translation("Field for storing recurring dates."), default_widget = "date_recur_basic_widget", default_formatter = "date_recur_basic_formatter", list_class = "\Drupal\date_recur\Plugin\Field\FieldType\DateRecurFieldItemList", constraints = { "DateRecurRrule" = {}, "DateRecurRuleParts" = {}, } )

@property \Drupal\Core\Datetime\DrupalDateTime|null $start_date @property \Drupal\Core\Datetime\DrupalDateTime|null $end_date @property string|null $timezone @property string|null $rrule

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

20 files declare their use of DateRecurItem

DateRecurBasicFormatter.php in src/Plugin/Field/FieldFormatter/DateRecurBasicFormatter.php
DateRecurBasicWidget.php in src/Plugin/Field/FieldWidget/DateRecurBasicWidget.php
DateRecurBasicWidgetTest.php in tests/src/Functional/DateRecurBasicWidgetTest.php
DateRecurCachedHooks.php in src/DateRecurCachedHooks.php
DateRecurFieldItemListTest.php in tests/src/Kernel/DateRecurFieldItemListTest.php

... See full list

File

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

Namespace

Drupal\date_recur\Plugin\Field\FieldType

View source

class DateRecurItem extends DateRangeItem {

  /**
   * Part used represent when all parts in a frequency are supported.
   */
  public const PART_SUPPORTS_ALL = '*';

  /**
   * Value for frequency setting: 'Disabled'.
   *
   * @internal will be made protected.
   */
  public const FREQUENCY_SETTINGS_DISABLED = 'disabled';

  /**
   * Value for frequency setting: 'All parts'.
   *
   * @internal will be made protected.
   */
  public const FREQUENCY_SETTINGS_PARTS_ALL = 'all-parts';

  /**
   * Value for frequency setting: 'Specify parts'.
   *
   * @internal will be made protected.
   */
  public const FREQUENCY_SETTINGS_PARTS_PARTIAL = 'some-parts';

  /**
   * The date recur helper.
   *
   * @var \Drupal\date_recur\DateRecurHelperInterface|null
   */
  protected $helper;

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

    /** @var \Drupal\Core\TypedData\DataDefinition $startDateProperty */
    $startDateProperty = $properties['start_date'];
    $startDateProperty
      ->setClass(DateRecurDateTimeComputed::class);

    /** @var \Drupal\Core\TypedData\DataDefinition $endDateProperty */
    $endDateProperty = $properties['end_date'];
    $endDateProperty
      ->setClass(DateRecurDateTimeComputed::class);
    $properties['rrule'] = DataDefinition::create('string')
      ->setLabel((string) new TranslatableMarkup('RRule'))
      ->setRequired(FALSE);
    $rruleMaxLength = $field_definition
      ->getSetting('rrule_max_length');
    assert(empty($rruleMaxLength) || is_numeric($rruleMaxLength) && $rruleMaxLength > 0);
    if (!empty($rruleMaxLength)) {
      $properties['rrule']
        ->addConstraint('Length', [
        'max' => $rruleMaxLength,
      ]);
    }
    $properties['timezone'] = DataDefinition::create('string')
      ->setLabel((string) new TranslatableMarkup('Timezone'))
      ->setRequired(TRUE)
      ->addConstraint('DateRecurTimeZone');
    $properties['infinite'] = DataDefinition::create('boolean')
      ->setLabel((string) new TranslatableMarkup('Whether the RRule is an infinite rule. Derived value from RRULE.'))
      ->setRequired(FALSE);
    $properties['occurrences'] = ListDataDefinition::create('any')
      ->setLabel((string) new TranslatableMarkup('Occurrences'))
      ->setComputed(TRUE)
      ->setClass(DateRecurOccurrencesComputed::class);
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) : array {
    $schema = parent::schema($field_definition);
    $schema['columns']['rrule'] = [
      'description' => 'The repeat rule.',
      'type' => 'text',
    ];
    $schema['columns']['timezone'] = [
      'description' => 'The timezone.',
      'type' => 'varchar',
      'length' => 255,
    ];
    $schema['columns']['infinite'] = [
      'description' => 'Whether the RRule is an infinite rule. Derived value from RRULE.',
      'type' => 'int',
      'size' => 'tiny',
    ];
    return $schema;
  }

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

  /**
   * {@inheritdoc}
   */
  public static function defaultFieldSettings() : array {
    return [
      // @todo needs settings tests.
      'precreate' => 'P2Y',
      'parts' => [
        'all' => TRUE,
        'frequencies' => [],
      ],
    ] + parent::defaultFieldSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) : array {
    assert(is_bool($has_data));
    $element = parent::storageSettingsForm($form, $form_state, $has_data);
    $element['rrule_max_length'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Maximum character length of RRULE'),
      '#description' => $this
        ->t('Define the maximum characters a RRULE can contain.'),
      '#default_value' => $this
        ->getSetting('rrule_max_length'),
      '#min' => 0,
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function fieldSettingsForm(array $form, FormStateInterface $form_state) : array {

    // Its not possible to locate the parent from FieldConfigEditForm.
    $elementParts = [
      'settings',
    ];
    $element = parent::fieldSettingsForm($form, $form_state);

    // @todo Needs UI tests.
    $options = [];
    foreach (range(1, 5) as $i) {
      $options['P' . $i . 'Y'] = $this
        ->formatPlural($i, '@year year', '@year years', [
        '@year' => $i,
      ]);
    }

    // @todo allow custom values.
    $element['precreate'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Precreate occurrences'),
      '#description' => $this
        ->t('For infinitely repeating dates, precreate occurrences for this amount of time in the views cache table.'),
      '#options' => $options,
      '#default_value' => $this
        ->getSetting('precreate'),
    ];
    $element['parts'] = [
      '#type' => 'container',
    ];
    $element['parts']['#after_build'][] = [
      get_class($this),
      'partsAfterBuild',
    ];
    $allPartsSettings = $this
      ->getSetting('parts');
    $element['parts']['all'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow all frequency and parts'),
      '#default_value' => $allPartsSettings['all'] ?? TRUE,
    ];
    $parents = array_merge($elementParts, [
      'parts',
      'all',
    ]);

    // The form 'name' attribute of the 'all' parts checkbox above.
    $allPartsCheckboxName = $parents[0] . '[' . implode('][', array_slice($parents, 1)) . ']';
    $frequencyLabels = DateRecurRruleMap::frequencyLabels();
    $partLabels = DateRecurRruleMap::partLabels();
    $partsCheckboxes = [];
    foreach (DateRecurRruleMap::PARTS as $part) {
      $partsCheckboxes[$part] = [
        '#type' => 'checkbox',
        '#title' => $partLabels[$part],
      ];
    }
    $settingsOptions = [
      static::FREQUENCY_SETTINGS_DISABLED => $this
        ->t('Disabled'),
      static::FREQUENCY_SETTINGS_PARTS_ALL => $this
        ->t('All parts'),
      static::FREQUENCY_SETTINGS_PARTS_PARTIAL => $this
        ->t('Specify parts'),
    ];

    // Table is a container so visibility states can be added.
    $element['parts']['table'] = [
      '#theme' => 'date_recur_settings_frequency_table',
      '#type' => 'container',
      '#states' => [
        'visible' => [
          ':input[name="' . $allPartsCheckboxName . '"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    foreach (DateRecurRruleMap::FREQUENCIES as $frequency) {
      $row = [];
      $row['frequency']['#markup'] = $frequencyLabels[$frequency];
      $parents = array_merge($elementParts, [
        'parts',
        'table',
        $frequency,
        'setting',
      ]);

      // Constructs a name that looks like
      // settings[parts][table][MINUTELY][setting].
      $settingsCheckboxName = $parents[0] . '[' . implode('][', array_slice($parents, 1)) . ']';
      $enabledParts = $allPartsSettings['frequencies'][$frequency] ?? [];
      $defaultSetting = NULL;
      if (count($enabledParts) === 0) {
        $defaultSetting = static::FREQUENCY_SETTINGS_DISABLED;
      }
      elseif (in_array(static::PART_SUPPORTS_ALL, $enabledParts)) {
        $defaultSetting = static::FREQUENCY_SETTINGS_PARTS_ALL;
      }
      elseif (count($enabledParts) > 0) {
        $defaultSetting = static::FREQUENCY_SETTINGS_PARTS_PARTIAL;
      }
      $row['setting'] = [
        '#type' => 'radios',
        '#options' => $settingsOptions,
        '#required' => TRUE,
        '#default_value' => $defaultSetting,
      ];
      $row['parts'] = $partsCheckboxes;
      foreach ($row['parts'] as $part => &$partsCheckbox) {
        $partsCheckbox['#states']['visible'][] = [
          ':input[name="' . $settingsCheckboxName . '"]' => [
            'value' => static::FREQUENCY_SETTINGS_PARTS_PARTIAL,
          ],
        ];
        $partsCheckbox['#default_value'] = in_array($part, $enabledParts, TRUE);
      }
      $element['parts']['table'][$frequency] = $row;
    }
    $list = [];
    $partLabels = DateRecurRruleMap::partLabels();
    foreach (DateRecurRruleMap::partDescriptions() as $part => $partDescription) {
      $list[] = $this
        ->t('<strong>@label:</strong> @description', [
        '@label' => $partLabels[$part],
        '@description' => $partDescription,
      ]);
    }
    $element['parts']['help']['#markup'] = '<ul><li>' . implode('</li><li>', $list) . '</li></ul></ul>';
    return $element;
  }

  /**
   * After build used to format of submitted values.
   *
   * FormBuilder has finished processing the input of children, now re-arrange
   * the values.
   *
   * @param array $element
   *   An associative array containing the structure of the element.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array
   *   The new structure of the element.
   */
  public static function partsAfterBuild(array $element, FormStateInterface $form_state) : array {

    // Original parts container.
    $values = NestedArray::getValue($form_state
      ->getValues(), $element['#parents']);

    // Remove the original parts values so they dont get saved in same structure
    // as the form.
    NestedArray::unsetValue($form_state
      ->getValues(), $element['#parents']);
    $parts = [];
    $parts['all'] = !empty($values['all']);
    $parts['frequencies'] = [];
    foreach ($values['table'] as $frequency => $row) {
      $enabledParts = array_keys(array_filter($row['parts']));
      if ($row['setting'] === static::FREQUENCY_SETTINGS_PARTS_ALL) {
        $enabledParts[] = static::PART_SUPPORTS_ALL;
      }
      elseif ($row['setting'] === static::FREQUENCY_SETTINGS_DISABLED) {
        $enabledParts = [];
      }

      // Sort in order so config always looks consistent.
      sort($enabledParts);
      $parts['frequencies'][$frequency] = $enabledParts;
    }

    // Set the new value.
    $form_state
      ->setValue($element['#parents'], $parts);
    return $element;
  }

  /**
   * Get the date storage format of this field.
   *
   * @return string
   *   A date format string.
   */
  public function getDateStorageFormat() : string {

    // @todo tests
    return $this
      ->getSetting('datetime_type') == static::DATETIME_TYPE_DATE ? static::DATE_STORAGE_FORMAT : static::DATETIME_STORAGE_FORMAT;
  }

  /**
   * {@inheritdoc}
   */
  public function preSave() : void {
    parent::preSave();
    try {
      $isInfinite = $this
        ->getHelper()
        ->isInfinite();
    } catch (DateRecurHelperArgumentException $e) {
      $isInfinite = FALSE;
    }
    $this
      ->get('infinite')
      ->setValue($isInfinite);
  }

  /**
   * {@inheritdoc}
   */
  public function setValue($values, $notify = TRUE) : void {

    // Cast infinite to boolean on load.
    $values['infinite'] = !empty($values['infinite']);

    // All values are going to be overwritten atomically.
    $this
      ->resetHelper();
    parent::setValue($values, $notify);
  }

  /**
   * {@inheritdoc}
   */
  public function onChange($property_name, $notify = TRUE) {
    if (in_array($property_name, [
      'value',
      'end_value',
      'rrule',
      'timezone',
    ])) {

      // Reset cached helper instance if values changed.
      $this
        ->resetHelper();
    }
    parent::onChange($property_name, $notify);
  }

  /**
   * Determine whether the field value is recurring/repeating.
   *
   * @return bool
   *   Whether the field value is recurring.
   */
  public function isRecurring() : bool {
    return !empty($this->rrule);
  }

  /**
   * Get the helper for this field item.
   *
   * Will always return a helper even if field value is non-recurring.
   *
   * @return \Drupal\date_recur\DateRecurHelperInterface
   *   The helper.
   *
   * @throws \Drupal\date_recur\Exception\DateRecurHelperArgumentException
   *   If a helper could not be created due to faulty field value.
   */
  public function getHelper() : DateRecurHelperInterface {
    if (isset($this->helper)) {
      return $this->helper;
    }
    try {
      $timeZoneString = $this->timezone;

      // If its not a string then cast it so a TypeError is not thrown. An empty
      // string will cause the exception to be thrown.
      $timeZone = new \DateTimeZone(is_string($timeZoneString) ? $timeZoneString : '');
    } catch (\Exception $exception) {
      throw new DateRecurHelperArgumentException('Invalid time zone');
    }
    $startDate = NULL;
    $startDateEnd = NULL;
    if ($this->start_date instanceof DrupalDateTime) {
      $startDate = $this->start_date
        ->getPhpDateTime();
      $startDate
        ->setTimezone($timeZone);
    }
    else {
      throw new DateRecurHelperArgumentException('Start date is required.');
    }
    if ($this->end_date instanceof DrupalDateTime) {
      $startDateEnd = $this->end_date
        ->getPhpDateTime();
      $startDateEnd
        ->setTimezone($timeZone);
    }
    $this->helper = $this
      ->isRecurring() ? DateRecurHelper::create((string) $this->rrule, $startDate, $startDateEnd) : DateRecurNonRecurringHelper::createInstance('', $startDate, $startDateEnd);
    return $this->helper;
  }

  /**
   * {@inheritdoc}
   */
  public function isEmpty() : bool {
    $start_value = $this
      ->get('value')
      ->getValue();
    $end_value = $this
      ->get('end_value')
      ->getValue();
    return $start_value === NULL || $start_value === '' || ($end_value === NULL || $end_value === '') || empty($this
      ->get('timezone')
      ->getValue());
  }

  /**
   * {@inheritdoc}
   */
  public static function generateSampleValue(FieldDefinitionInterface $field_definition) : array {
    $values = parent::generateSampleValue($field_definition);
    $timeZoneList = timezone_identifiers_list();
    $values['timezone'] = $timeZoneList[array_rand($timeZoneList)];
    $values['rrule'] = 'FREQ=DAILY;COUNT=' . rand(2, 10);
    $values['infinite'] = FALSE;
    return $values;
  }

  /**
   * Resets helper value since source values changed.
   */
  public function resetHelper() : void {
    $this->helper = NULL;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DateRangeItem::DATETIME_TYPE_ALLDAY		constant	Value for the 'datetime_type' setting: store a date and time.
DateRecurItem::$helper	protected	property	The date recur helper.
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::FREQUENCY_SETTINGS_DISABLED	public	constant	Value for frequency setting: 'Disabled'.
DateRecurItem::FREQUENCY_SETTINGS_PARTS_ALL	public	constant	Value for frequency setting: 'All parts'.
DateRecurItem::FREQUENCY_SETTINGS_PARTS_PARTIAL	public	constant	Value for frequency setting: 'Specify parts'.
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::getHelper	public	function	Get the helper for this field item.
DateRecurItem::isEmpty	public	function	Determines whether the data structure is empty. Overrides DateRangeItem::isEmpty
DateRecurItem::isRecurring	public	function	Determine whether the field value is recurring/repeating.
DateRecurItem::onChange	public	function	React to changes to a child property or item. Overrides DateRangeItem::onChange
DateRecurItem::partsAfterBuild	public static	function	After build used to format of submitted values.
DateRecurItem::PART_SUPPORTS_ALL	public	constant	Part used represent when all parts in a frequency are supported.
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	1
DateRecurItem::resetHelper	public	function	Resets helper value since source values changed.
DateRecurItem::schema	public static	function	Returns the schema for the field. Overrides DateRangeItem::schema	1
DateRecurItem::setValue	public	function	Sets the data value. Overrides FieldItemBase::setValue
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
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
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::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.	4
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 3.0.x

Hierarchy

File

Namespace

Members

API Navigation