Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php \Drupal\Core\Field\EntityReferenceFieldItemList
- 9 core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php \Drupal\Core\Field\EntityReferenceFieldItemList
Defines an item list class for entity reference fields.
Hierarchy
- class \Drupal\Core\Field\FieldItemList extends \Drupal\Core\TypedData\Plugin\DataType\ItemList implements FieldItemListInterface
- class \Drupal\Core\Field\EntityReferenceFieldItemList implements EntityReferenceFieldItemListInterface
Expanded class hierarchy of EntityReferenceFieldItemList
3 files declare their use of EntityReferenceFieldItemList
- ComputedReferenceTestFieldItemList.php in core/
modules/ system/ tests/ modules/ entity_test/ src/ Plugin/ Field/ ComputedReferenceTestFieldItemList.php - FileFieldItemList.php in core/
modules/ file/ src/ Plugin/ Field/ FieldType/ FileFieldItemList.php - MediaLibraryFieldWidgetOpener.php in core/
modules/ media_library/ src/ MediaLibraryFieldWidgetOpener.php
File
- core/
lib/ Drupal/ Core/ Field/ EntityReferenceFieldItemList.php, line 11
Namespace
Drupal\Core\FieldView source
class EntityReferenceFieldItemList extends FieldItemList implements EntityReferenceFieldItemListInterface {
/**
* {@inheritdoc}
*/
public function getConstraints() {
$constraints = parent::getConstraints();
$constraint_manager = $this
->getTypedDataManager()
->getValidationConstraintManager();
$constraints[] = $constraint_manager
->create('ValidReference', []);
return $constraints;
}
/**
* {@inheritdoc}
*/
public function referencedEntities() {
if ($this
->isEmpty()) {
return [];
}
// Collect the IDs of existing entities to load, and directly grab the
// "autocreate" entities that are already populated in $item->entity.
$target_entities = $ids = [];
foreach ($this->list as $delta => $item) {
if ($item->target_id !== NULL) {
$ids[$delta] = $item->target_id;
}
elseif ($item
->hasNewEntity()) {
$target_entities[$delta] = $item->entity;
}
}
// Load and add the existing entities.
if ($ids) {
$target_type = $this
->getFieldDefinition()
->getSetting('target_type');
$entities = \Drupal::entityTypeManager()
->getStorage($target_type)
->loadMultiple($ids);
foreach ($ids as $delta => $target_id) {
if (isset($entities[$target_id])) {
$target_entities[$delta] = $entities[$target_id];
}
}
// Ensure the returned array is ordered by deltas.
ksort($target_entities);
}
return $target_entities;
}
/**
* {@inheritdoc}
*/
public static function processDefaultValue($default_value, FieldableEntityInterface $entity, FieldDefinitionInterface $definition) {
$default_value = parent::processDefaultValue($default_value, $entity, $definition);
if ($default_value) {
// Convert UUIDs to numeric IDs.
$uuids = [];
foreach ($default_value as $delta => $properties) {
if (isset($properties['target_uuid'])) {
$uuids[$delta] = $properties['target_uuid'];
}
}
if ($uuids) {
$target_type = $definition
->getSetting('target_type');
$entity_ids = \Drupal::entityQuery($target_type)
->accessCheck(TRUE)
->condition('uuid', $uuids, 'IN')
->execute();
$entities = \Drupal::entityTypeManager()
->getStorage($target_type)
->loadMultiple($entity_ids);
$entity_uuids = [];
foreach ($entities as $id => $entity) {
$entity_uuids[$entity
->uuid()] = $id;
}
foreach ($uuids as $delta => $uuid) {
if (isset($entity_uuids[$uuid])) {
$default_value[$delta]['target_id'] = $entity_uuids[$uuid];
unset($default_value[$delta]['target_uuid']);
}
else {
unset($default_value[$delta]);
}
}
}
// Ensure we return consecutive deltas, in case we removed unknown UUIDs.
$default_value = array_values($default_value);
}
return $default_value;
}
/**
* {@inheritdoc}
*/
public function defaultValuesFormSubmit(array $element, array &$form, FormStateInterface $form_state) {
$default_value = parent::defaultValuesFormSubmit($element, $form, $form_state);
// Convert numeric IDs to UUIDs to ensure config deployability.
$ids = [];
foreach ($default_value as $delta => $properties) {
if (isset($properties['entity']) && $properties['entity']
->isNew()) {
// This may be a newly created term.
$properties['entity']
->save();
$default_value[$delta]['target_id'] = $properties['entity']
->id();
unset($default_value[$delta]['entity']);
}
$ids[] = $default_value[$delta]['target_id'];
}
$entities = \Drupal::entityTypeManager()
->getStorage($this
->getSetting('target_type'))
->loadMultiple($ids);
foreach ($default_value as $delta => $properties) {
unset($default_value[$delta]['target_id']);
$default_value[$delta]['target_uuid'] = $entities[$properties['target_id']]
->uuid();
}
return $default_value;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
EntityReferenceFieldItemList:: |
public | function |
Processes the submitted default value. Overrides FieldItemList:: |
|
EntityReferenceFieldItemList:: |
public | function |
Gets a list of validation constraints. Overrides FieldItemList:: |
|
EntityReferenceFieldItemList:: |
public static | function |
Processes the default value before being applied. Overrides FieldItemList:: |
|
EntityReferenceFieldItemList:: |
public | function |
Gets the entities referenced by this field, preserving field item deltas. Overrides EntityReferenceFieldItemListInterface:: |
|
FieldItemList:: |
protected | property | The langcode of the field values held in the object. | |
FieldItemList:: |
protected | property | Numerically indexed array of field items. | 1 |
FieldItemList:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
FieldItemList:: |
public | function |
Applies the default value. Overrides TypedDataInterface:: |
|
FieldItemList:: |
protected | function | ||
FieldItemList:: |
public | function |
Contains the default access logic of this field. Overrides FieldItemListInterface:: |
3 |
FieldItemList:: |
public | function |
Returns a form for the default value input. Overrides FieldItemListInterface:: |
2 |
FieldItemList:: |
public | function |
Validates the submitted default value. Overrides FieldItemListInterface:: |
2 |
FieldItemList:: |
protected | function | Returns the widget object used in default value form. | |
FieldItemList:: |
protected | function | Calls a method on each FieldItem. | |
FieldItemList:: |
public | function |
Defines custom delete behavior for field values. Overrides FieldItemListInterface:: |
2 |
FieldItemList:: |
public | function |
Defines custom revision delete behavior for field values. Overrides FieldItemListInterface:: |
1 |
FieldItemList:: |
public | function |
Determines equality to another object implementing FieldItemListInterface. Overrides FieldItemListInterface:: |
2 |
FieldItemList:: |
public | function |
Filters out empty field items and re-numbers the item deltas. Overrides FieldItemListInterface:: |
|
FieldItemList:: |
public | function |
Populates a specified number of field items with valid sample data. Overrides FieldItemListInterface:: |
1 |
FieldItemList:: |
public | function |
Gets the entity that field belongs to. Overrides FieldItemListInterface:: |
1 |
FieldItemList:: |
public | function |
Gets the field definition. Overrides FieldItemListInterface:: |
|
FieldItemList:: |
public | function |
Gets the langcode of the field values held in the object. Overrides FieldItemListInterface:: |
|
FieldItemList:: |
public | function |
Returns the value of a given field setting. Overrides FieldItemListInterface:: |
|
FieldItemList:: |
public | function |
Returns the array of field settings. Overrides FieldItemListInterface:: |
|
FieldItemList:: |
public | function |
Determines whether the field has relevant changes. Overrides FieldItemListInterface:: |
1 |
FieldItemList:: |
public | function |
Defines custom post-save behavior for field values. Overrides FieldItemListInterface:: |
1 |
FieldItemList:: |
public | function |
Defines custom presave behavior for field values. Overrides FieldItemListInterface:: |
1 |
FieldItemList:: |
public | function |
Sets the langcode of the field values held in the object. Overrides FieldItemListInterface:: |
|
FieldItemList:: |
public | function |
Sets the data value. Overrides TypedDataInterface:: |
|
FieldItemList:: |
public | function |
Returns a renderable array for the field items. Overrides FieldItemListInterface:: |
|
FieldItemList:: |
public | function |
Magic method: Gets a property value of to the first field item. Overrides FieldItemListInterface:: |
|
FieldItemList:: |
public | function |
Magic method: Determines whether a property of the first field item is set. Overrides FieldItemListInterface:: |
|
FieldItemList:: |
public | function |
Magic method: Sets a property value of the first field item. Overrides FieldItemListInterface:: |
|
FieldItemList:: |
public | function |
Magic method: Unsets a property of the first field item. Overrides FieldItemListInterface:: |
|
ListInterface:: |
public | function | Appends a new item to the list. | |
ListInterface:: |
public | function | Filters the items in the list using a custom callback. | |
ListInterface:: |
public | function | Returns the first item in this list. | |
ListInterface:: |
public | function | Returns the item at the specified position in this list. | 2 |
ListInterface:: |
public | function |
Gets the data definition. Overrides TypedDataInterface:: |
|
ListInterface:: |
public | function | Gets the definition of a contained item. | |
ListInterface:: |
public | function | Determines whether the list contains any non-empty items. | |
ListInterface:: |
public | function | Removes the item at the specified position. | |
ListInterface:: |
public | function | Sets the value of the item at a given position in the list. | |
TraversableTypedDataInterface:: |
public | function | React to changes to a child property or item. | 5 |
TypedDataInterface:: |
public static | function | Constructs a TypedData object given its definition and context. | 1 |
TypedDataInterface:: |
public | function | Returns the name of a property or item. | 1 |
TypedDataInterface:: |
public | function | Returns the parent data structure; i.e. either complex data or a list. | 1 |
TypedDataInterface:: |
public | function | Returns the property path of the data. | 1 |
TypedDataInterface:: |
public | function | Returns the root of the typed data tree. | 1 |
TypedDataInterface:: |
public | function | Returns a string representation of the data. | 1 |
TypedDataInterface:: |
public | function | Gets the data value. | 1 |
TypedDataInterface:: |
public | function | Sets the context of a property or item via a context aware parent. | 1 |
TypedDataInterface:: |
public | function | Validates the currently set data value. | 1 |