class EntityReferenceFieldInheritanceFactory in Field Inheritance 8

The EntityReferenceFieldInheritanceFactory class.

Note: This class exists separately to the FieldInheritanceFactor because when inheriting data from an entity_reference field we end up with type hints failing during calls to EntityReferenceFormatterBase::getEntitiesToView().

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\Core\Field\FieldItemList implements FieldItemListInterface
      • class \Drupal\Core\Field\EntityReferenceFieldItemList implements EntityReferenceFieldItemListInterface
        • class \Drupal\field_inheritance\EntityReferenceFieldInheritanceFactory uses ComputedItemListTrait

File

src/EntityReferenceFieldInheritanceFactory.php, line 17

Namespace

Drupal\field_inheritance

class EntityReferenceFieldInheritanceFactory extends EntityReferenceFieldItemList {
  use ComputedItemListTrait;

  /**
   * Constructs a TypedData object given its definition and context.
   *
   * @param \Drupal\Core\Field\BaseFieldDefinition $definition
   *   The data definition.
   * @param string $name
   *   (optional) The name of the created property, or NULL if it is the root
   *   of a typed data tree. Defaults to NULL.
   * @param \Drupal\Core\TypedData\TypedDataInterface $parent
   *   (optional) The parent object of the data property, or NULL if it is the
   *   root of a typed data tree. Defaults to NULL.
   *
   * @see \Drupal\Core\TypedData\TypedDataManager::create()
   */
  public function __construct(BaseFieldDefinition $definition, $name = NULL, TypedDataInterface $parent = NULL) {
    parent::__construct($definition, $name, $parent);
    if ($this
      ->getSetting('plugin') === NULL) {
      throw new \InvalidArgumentException("The definition's 'plugin' key has to specify the plugin to use to inherit data.");
    }
    if ($this
      ->getSetting('method') === NULL) {
      throw new \InvalidArgumentException("The definition's 'method' key has to specify the method to use to inherit data. Valid options are inherit, prepend, replace, and append.");
    }
    if ($this
      ->getSetting('source entity type') === NULL) {
      throw new \InvalidArgumentException("The definition's 'source entity type' key has to specify the entity type from which to inherit data.");
    }
    if ($this
      ->getSetting('source entity bundle') === NULL) {
      throw new \InvalidArgumentException("The definition's 'source entity bundle' key has to specify the entity bundle from which to inherit data.");
    }
    if ($this
      ->getSetting('source field') === NULL) {
      throw new \InvalidArgumentException("The definition's 'source field' key has to specify the field from which to inherit data.");
    }
  }

  /**
   * Compute the field property from state.
   */
  protected function computeValue() {
    $entity = $this
      ->getEntity();
    $manager = $this
      ->getManager();
    $configuration = $this
      ->getSettings() + [
      'entity' => $entity,
    ];
    $plugin = $manager
      ->createInstance($this
      ->getSetting('plugin'), $configuration);
    $values = $plugin
      ->computeValue();
    if (!empty($values)) {
      foreach ($values as $key => $value) {
        $this->list[$key] = $this
          ->createItem($key, $value);
      }
    }
    else {
      $this
        ->applyDefaultValue();
    }
  }

  /**
   * Returns the FieldInheritancePluginManager plugin manager.
   *
   * @return \Drupal\recurring_events\FieldInheritancePluginManager
   *   The FieldInheritancePluginManager plugin manager.
   */
  protected function getManager() {
    return \Drupal::service('plugin.manager.field_inheritance');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ComputedItemListTrait::$valueComputed	protected	property	Whether the values have already been computed or not.
ComputedItemListTrait::appendItem	public	function
ComputedItemListTrait::applyDefaultValue	public	function
ComputedItemListTrait::count	public	function
ComputedItemListTrait::ensureComputedValue	protected	function	Ensures that values are only computed once.
ComputedItemListTrait::get	public	function
ComputedItemListTrait::getIterator	public	function
ComputedItemListTrait::getString	public	function
ComputedItemListTrait::getValue	public	function
ComputedItemListTrait::isEmpty	public	function
ComputedItemListTrait::offsetExists	public	function
ComputedItemListTrait::removeItem	public	function
ComputedItemListTrait::set	public	function
ComputedItemListTrait::setValue	public	function		1
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
EntityReferenceFieldInheritanceFactory::computeValue	protected	function	Compute the field property from state. Overrides ComputedItemListTrait::computeValue
EntityReferenceFieldInheritanceFactory::getManager	protected	function	Returns the FieldInheritancePluginManager plugin manager.
EntityReferenceFieldInheritanceFactory::__construct	public	function	Constructs a TypedData object given its definition and context. Overrides TypedData::__construct
EntityReferenceFieldItemList::defaultValuesFormSubmit	public	function	Processes the submitted default value. Overrides FieldItemList::defaultValuesFormSubmit
EntityReferenceFieldItemList::getConstraints	public	function	Gets a list of validation constraints. Overrides FieldItemList::getConstraints
EntityReferenceFieldItemList::processDefaultValue	public static	function	Processes the default value before being applied. Overrides FieldItemList::processDefaultValue
EntityReferenceFieldItemList::referencedEntities	public	function	Gets the entities referenced by this field, preserving field item deltas. Overrides EntityReferenceFieldItemListInterface::referencedEntities
FieldItemList::$langcode	protected	property	The langcode of the field values held in the object.
FieldItemList::$list	protected	property	Numerically indexed array of field items. Overrides ItemList::$list	1
FieldItemList::access	public	function	Checks data value access. Overrides AccessibleInterface::access	1
FieldItemList::createItem	protected	function	Helper for creating a list item object. Overrides ItemList::createItem
FieldItemList::defaultAccess	public	function	Contains the default access logic of this field. Overrides FieldItemListInterface::defaultAccess	3
FieldItemList::defaultValuesForm	public	function	Returns a form for the default value input. Overrides FieldItemListInterface::defaultValuesForm	2
FieldItemList::defaultValuesFormValidate	public	function	Validates the submitted default value. Overrides FieldItemListInterface::defaultValuesFormValidate	1
FieldItemList::defaultValueWidget	protected	function	Returns the widget object used in default value form.
FieldItemList::delegateMethod	protected	function	Calls a method on each FieldItem.
FieldItemList::delete	public	function	Defines custom delete behavior for field values. Overrides FieldItemListInterface::delete	2
FieldItemList::deleteRevision	public	function	Defines custom revision delete behavior for field values. Overrides FieldItemListInterface::deleteRevision	1
FieldItemList::equals	public	function	Determines equality to another object implementing FieldItemListInterface. Overrides FieldItemListInterface::equals	2
FieldItemList::filterEmptyItems	public	function	Filters out empty field items and re-numbers the item deltas. Overrides FieldItemListInterface::filterEmptyItems
FieldItemList::generateSampleItems	public	function	Populates a specified number of field items with valid sample data. Overrides FieldItemListInterface::generateSampleItems
FieldItemList::getEntity	public	function	Gets the entity that field belongs to. Overrides FieldItemListInterface::getEntity	1
FieldItemList::getFieldDefinition	public	function	Gets the field definition. Overrides FieldItemListInterface::getFieldDefinition
FieldItemList::getLangcode	public	function	Gets the langcode of the field values held in the object. Overrides FieldItemListInterface::getLangcode
FieldItemList::getSetting	public	function	Returns the value of a given field setting. Overrides FieldItemListInterface::getSetting
FieldItemList::getSettings	public	function	Returns the array of field settings. Overrides FieldItemListInterface::getSettings
FieldItemList::hasAffectingChanges	public	function	Determines whether the field has relevant changes. Overrides FieldItemListInterface::hasAffectingChanges	1
FieldItemList::postSave	public	function	Defines custom post-save behavior for field values. Overrides FieldItemListInterface::postSave	1
FieldItemList::preSave	public	function	Defines custom presave behavior for field values. Overrides FieldItemListInterface::preSave	1
FieldItemList::setLangcode	public	function	Sets the langcode of the field values held in the object. Overrides FieldItemListInterface::setLangcode
FieldItemList::view	public	function	Returns a renderable array for the field items. Overrides FieldItemListInterface::view
FieldItemList::__get	public	function	Magic method: Gets a property value of to the first field item. Overrides FieldItemListInterface::__get
FieldItemList::__isset	public	function	Magic method: Determines whether a property of the first field item is set. Overrides FieldItemListInterface::__isset
FieldItemList::__set	public	function	Magic method: Sets a property value of the first field item. Overrides FieldItemListInterface::__set
FieldItemList::__unset	public	function	Magic method: Unsets a property of the first field item. Overrides FieldItemListInterface::__unset
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::getItemDefinition	public	function	Gets the definition of a contained item. Overrides ListInterface::getItemDefinition
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::__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::$definition	protected	property	The data definition.	1
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::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