interface EntityReferenceFieldItemListInterface in Drupal 9

Interface for entity reference lists of field items.

Hierarchy

• interface \Drupal\Core\TypedData\ListInterface extends \Drupal\Core\TypedData\ArrayAccess \Drupal\Core\TypedData\Countable; interface \Drupal\Core\Access\AccessibleInterface
  • interface \Drupal\Core\Field\FieldItemListInterface
    • interface \Drupal\Core\Field\EntityReferenceFieldItemListInterface

8 files declare their use of EntityReferenceFieldItemListInterface

EntityReferenceFieldNormalizer.php in core/modules/jsonapi/src/Normalizer/EntityReferenceFieldNormalizer.php

EntityReferenceFormatterBase.php in core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/EntityReferenceFormatterBase.php

FileMediaFormatterBase.php in core/modules/file/src/Plugin/Field/FieldFormatter/FileMediaFormatterBase.php

HalEntityNormalizationTrait.php in core/modules/hal/tests/src/Functional/EntityResource/HalEntityNormalizationTrait.php

ImageFormatterBase.php in core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatterBase.php

... See full list

File

core/lib/Drupal/Core/Field/EntityReferenceFieldItemListInterface.php, line 8

Namespace

Drupal\Core\Field

interface EntityReferenceFieldItemListInterface extends FieldItemListInterface {

  /**
   * Gets the entities referenced by this field, preserving field item deltas.
   *
   * @return \Drupal\Core\Entity\EntityInterface[]
   *   An array of entity objects keyed by field item deltas.
   */
  public function referencedEntities();

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	9
EntityReferenceFieldItemListInterface::referencedEntities	public	function	Gets the entities referenced by this field, preserving field item deltas.	1
FieldItemListInterface::defaultAccess	public	function	Contains the default access logic of this field.	1
FieldItemListInterface::defaultValuesForm	public	function	Returns a form for the default value input.	1
FieldItemListInterface::defaultValuesFormSubmit	public	function	Processes the submitted default value.	1
FieldItemListInterface::defaultValuesFormValidate	public	function	Validates the submitted default value.	1
FieldItemListInterface::delete	public	function	Defines custom delete behavior for field values.	1
FieldItemListInterface::deleteRevision	public	function	Defines custom revision delete behavior for field values.	1
FieldItemListInterface::equals	public	function	Determines equality to another object implementing FieldItemListInterface.	1
FieldItemListInterface::filterEmptyItems	public	function	Filters out empty field items and re-numbers the item deltas.	1
FieldItemListInterface::generateSampleItems	public	function	Populates a specified number of field items with valid sample data.	1
FieldItemListInterface::getEntity	public	function	Gets the entity that field belongs to.	1
FieldItemListInterface::getFieldDefinition	public	function	Gets the field definition.	1
FieldItemListInterface::getLangcode	public	function	Gets the langcode of the field values held in the object.	1
FieldItemListInterface::getSetting	public	function	Returns the value of a given field setting.	1
FieldItemListInterface::getSettings	public	function	Returns the array of field settings.	1
FieldItemListInterface::hasAffectingChanges	public	function	Determines whether the field has relevant changes.	1
FieldItemListInterface::postSave	public	function	Defines custom post-save behavior for field values.	1
FieldItemListInterface::preSave	public	function	Defines custom presave behavior for field values.	1
FieldItemListInterface::processDefaultValue	public static	function	Processes the default value before being applied.	1
FieldItemListInterface::setLangcode	public	function	Sets the langcode of the field values held in the object.	1
FieldItemListInterface::view	public	function	Returns a renderable array for the field items.	1
FieldItemListInterface::__get	public	function	Magic method: Gets a property value of to the first field item.	1
FieldItemListInterface::__isset	public	function	Magic method: Determines whether a property of the first field item is set.	1
FieldItemListInterface::__set	public	function	Magic method: Sets a property value of the first field item.	1
FieldItemListInterface::__unset	public	function	Magic method: Unsets a property of the first field item.	1
ListInterface::appendItem	public	function	Appends a new item to the list.	1
ListInterface::filter	public	function	Filters the items in the list using a custom callback.	1
ListInterface::first	public	function	Returns the first item in this list.	1
ListInterface::get	public	function	Returns the item at the specified position in this list.	1
ListInterface::getDataDefinition	public	function	Gets the data definition. Overrides TypedDataInterface::getDataDefinition
ListInterface::getItemDefinition	public	function	Gets the definition of a contained item.	1
ListInterface::isEmpty	public	function	Determines whether the list contains any non-empty items.	1
ListInterface::removeItem	public	function	Removes the item at the specified position.	1
ListInterface::set	public	function	Sets the value of the item at a given position in the list.	1
TraversableTypedDataInterface::onChange	public	function	React to changes to a child property or item.	4
TypedDataInterface::applyDefaultValue	public	function	Applies the default value.	1
TypedDataInterface::createInstance	public static	function	Constructs a TypedData object given its definition and context.	1
TypedDataInterface::getConstraints	public	function	Gets a list of validation constraints.	1
TypedDataInterface::getName	public	function	Returns the name of a property or item.	1
TypedDataInterface::getParent	public	function	Returns the parent data structure; i.e. either complex data or a list.	1
TypedDataInterface::getPropertyPath	public	function	Returns the property path of the data.	1
TypedDataInterface::getRoot	public	function	Returns the root of the typed data tree.	1
TypedDataInterface::getString	public	function	Returns a string representation of the data.	1
TypedDataInterface::getValue	public	function	Gets the data value.	1
TypedDataInterface::setContext	public	function	Sets the context of a property or item via a context aware parent.	1
TypedDataInterface::setValue	public	function	Sets the data value.	1
TypedDataInterface::validate	public	function	Validates the currently set data value.	1