class DateRecurOccurrencesComputed in Recurring Dates Field 3.1.x

Provides values for the computed 'occurrences' property on date recur fields.

Usage:

$entity->field_myfield->occurrences;

@method FieldType\DateRecurItem getParent()

Hierarchy

• class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
  • class \Drupal\Core\TypedData\Plugin\DataType\ItemList implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ListInterface
    • class \Drupal\date_recur\Plugin\Field\DateRecurOccurrencesComputed

1 file declares its use of DateRecurOccurrencesComputed

DateRecurItem.php in src/Plugin/Field/FieldType/DateRecurItem.php

File

src/Plugin/Field/DateRecurOccurrencesComputed.php, line 19

Namespace

Drupal\date_recur\Plugin\Field

class DateRecurOccurrencesComputed extends ItemList {

  /**
   * {@inheritdoc}
   *
   * @yield \Generator
   *   An occurrence generator.
   */
  public function getValue($langcode = NULL) : \Generator {
    yield from $this
      ->getParent()
      ->getHelper()
      ->generateOccurrences();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DateRecurOccurrencesComputed::getValue	public	function	@yield \Generator An occurrence generator. Overrides ItemList::getValue
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
ItemList::$list	protected	property	Numerically indexed array of items.	1
ItemList::appendItem	public	function	Appends a new item to the list. Overrides ListInterface::appendItem
ItemList::count	public	function
ItemList::createItem	protected	function	Helper for creating a list item object.	1
ItemList::filter	public	function	Filters the items in the list using a custom callback. Overrides ListInterface::filter
ItemList::first	public	function	Returns the first item in this list. Overrides ListInterface::first
ItemList::get	public	function	Returns the item at the specified position in this list. Overrides ListInterface::get	2
ItemList::getItemDefinition	public	function	Gets the definition of a contained item. Overrides ListInterface::getItemDefinition
ItemList::getIterator	public	function
ItemList::getString	public	function	Returns a string representation of the data. Overrides TypedData::getString
ItemList::isEmpty	public	function	Determines whether the list contains any non-empty items. Overrides ListInterface::isEmpty
ItemList::offsetExists	public	function		1
ItemList::offsetGet	public	function
ItemList::offsetSet	public	function
ItemList::offsetUnset	public	function
ItemList::onChange	public	function	React to changes to a child property or item. Overrides TraversableTypedDataInterface::onChange	1
ItemList::rekey	protected	function	Renumbers the items in the list.
ItemList::removeItem	public	function	Removes the item at the specified position. Overrides ListInterface::removeItem
ItemList::set	public	function	Sets the value of the item at a given position in the list. Overrides ListInterface::set
ItemList::setValue	public	function	Overrides \Drupal\Core\TypedData\TypedData::setValue(). Overrides TypedData::setValue	1
ItemList::__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::$definition	protected	property	The data definition.	1
TypedData::$name	protected	property	The property name.
TypedData::$parent	protected	property	The parent typed data object.
TypedData::applyDefaultValue	public	function	Applies the default value. Overrides TypedDataInterface::applyDefaultValue	3
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
TypedData::__construct	public	function	Constructs a TypedData object given its definition and context.	3
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