class DynamicEntityReferenceFieldItemList in Dynamic Entity Reference 8.2
Same name and namespace in other branches
- 8 src/Plugin/Field/FieldType/DynamicEntityReferenceFieldItemList.php \Drupal\dynamic_entity_reference\Plugin\Field\FieldType\DynamicEntityReferenceFieldItemList
Defines a item list class for dynamic entity reference fields.
@property DynamicEntityReferenceItem[] list
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\dynamic_entity_reference\Plugin\Field\FieldType\DynamicEntityReferenceFieldItemList
- class \Drupal\Core\Field\EntityReferenceFieldItemList implements EntityReferenceFieldItemListInterface
- class \Drupal\Core\Field\FieldItemList implements FieldItemListInterface
- class \Drupal\Core\TypedData\Plugin\DataType\ItemList implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ListInterface
Expanded class hierarchy of DynamicEntityReferenceFieldItemList
File
- src/
Plugin/ Field/ FieldType/ DynamicEntityReferenceFieldItemList.php, line 16
Namespace
Drupal\dynamic_entity_reference\Plugin\Field\FieldTypeView source
class DynamicEntityReferenceFieldItemList extends EntityReferenceFieldItemList {
/**
* {@inheritdoc}
*/
public function getConstraints() {
$constraints = parent::getConstraints();
// Remove the 'ValidReferenceConstraint' validation constraint because
// dynamic entity reference fields already use the 'ValidDynamicReference'
// constraint.
foreach ($constraints as $key => $constraint) {
if ($constraint instanceof ValidReferenceConstraint) {
unset($constraints[$key]);
}
}
$constraints = array_values($constraints);
$constraint_manager = $this
->getTypedDataManager()
->getValidationConstraintManager();
$constraints[] = $constraint_manager
->create('ValidDynamicReference', []);
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 && $item->target_type !== NULL) {
$ids[$item->target_type][$delta] = $item->target_id;
}
elseif ($item
->hasNewEntity()) {
$target_entities[$delta] = $item->entity;
}
}
// Load and add the existing entities.
if ($ids) {
foreach ($ids as $target_type => $entity_type_ids) {
$entities = \Drupal::entityTypeManager()
->getStorage($target_type)
->loadMultiple($entity_type_ids);
foreach ($entity_type_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) {
$manager = \Drupal::entityTypeManager();
// We want to bypass the EntityReferenceItem::processDefaultValue() so
// we duplicate FieldItemList::processDefaultValue() here which just returns
// $default_values.
if ($default_value) {
// Convert UUIDs to numeric IDs.
$all_uuids = [];
foreach ($default_value as $delta => $properties) {
if (isset($properties['target_uuid'])) {
$target_type = $properties['target_type'];
$all_uuids[$target_type][$delta] = $properties['target_uuid'];
}
}
$entity_uuids = [];
foreach ($all_uuids as $target_type => $uuids) {
if ($uuids) {
$entities = $manager
->getStorage($target_type)
->loadByProperties([
'uuid' => $uuids,
]);
$entity_uuids[$target_type] = [];
foreach ($entities as $id => $entity) {
$entity_uuids[$target_type][$entity
->uuid()] = $id;
}
foreach ($uuids as $delta => $uuid) {
if (isset($entity_uuids[$target_type]) && isset($entity_uuids[$target_type][$uuid])) {
$default_value[$delta]['target_id'] = $entity_uuids[$target_type][$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) {
$manager = \Drupal::entityTypeManager();
$default_value = [];
// We want to bypass the EntityReferenceItem::defaultValuesFormSubmit() so
// we duplicate FieldItemList::defaultValuesFormSubmit() here.
// Extract the submitted value, and store it as an array.
if ($widget = $this
->defaultValueWidget($form_state)) {
$widget
->extractFormValues($this, $element, $form_state);
$default_value = $this
->getValue();
}
// Convert numeric IDs to UUIDs to ensure config deployability.
$all_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();
$default_value[$delta]['target_type'] = $properties['entity']
->getEntityTypeId();
unset($default_value[$delta]['entity']);
}
$all_ids[$default_value[$delta]['target_type']][] = $default_value[$delta]['target_id'];
}
$entities = [];
foreach ($all_ids as $target_type => $ids) {
$entities[$target_type] = $manager
->getStorage($target_type)
->loadMultiple($ids);
}
foreach ($default_value as $delta => $properties) {
unset($default_value[$delta]['target_id']);
$default_value[$delta]['target_uuid'] = $entities[$properties['target_type']][$properties['target_id']]
->uuid();
}
return $default_value;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
DynamicEntityReferenceFieldItemList:: |
public | function |
Processes the submitted default value. Overrides EntityReferenceFieldItemList:: |
|
DynamicEntityReferenceFieldItemList:: |
public | function |
Gets a list of validation constraints. Overrides EntityReferenceFieldItemList:: |
|
DynamicEntityReferenceFieldItemList:: |
public static | function |
Processes the default value before being applied. Overrides EntityReferenceFieldItemList:: |
|
DynamicEntityReferenceFieldItemList:: |
public | function |
Gets the entities referenced by this field, preserving field item deltas. Overrides EntityReferenceFieldItemList:: |
|
FieldItemList:: |
protected | property | The langcode of the field values held in the object. | |
FieldItemList:: |
protected | property |
Numerically indexed array of field items. Overrides ItemList:: |
1 |
FieldItemList:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
FieldItemList:: |
public | function |
Applies the default value. Overrides TypedData:: |
|
FieldItemList:: |
protected | function |
Helper for creating a list item object. Overrides ItemList:: |
|
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:: |
1 |
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:: |
|
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 ItemList:: |
|
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:: |
|
ItemList:: |
public | function |
Appends a new item to the list. Overrides ListInterface:: |
|
ItemList:: |
public | function | ||
ItemList:: |
public | function |
Filters the items in the list using a custom callback. Overrides ListInterface:: |
|
ItemList:: |
public | function |
Returns the first item in this list. Overrides ListInterface:: |
|
ItemList:: |
public | function |
Returns the item at the specified position in this list. Overrides ListInterface:: |
2 |
ItemList:: |
public | function |
Gets the definition of a contained item. Overrides ListInterface:: |
|
ItemList:: |
public | function | ||
ItemList:: |
public | function |
Returns a string representation of the data. Overrides TypedData:: |
|
ItemList:: |
public | function |
Gets the data value. Overrides TypedData:: |
|
ItemList:: |
public | function |
Determines whether the list contains any non-empty items. Overrides ListInterface:: |
|
ItemList:: |
public | function | 1 | |
ItemList:: |
public | function | ||
ItemList:: |
public | function | ||
ItemList:: |
public | function | ||
ItemList:: |
public | function |
React to changes to a child property or item. Overrides TraversableTypedDataInterface:: |
1 |
ItemList:: |
protected | function | Renumbers the items in the list. | |
ItemList:: |
public | function |
Removes the item at the specified position. Overrides ListInterface:: |
|
ItemList:: |
public | function |
Sets the value of the item at a given position in the list. Overrides ListInterface:: |
|
ItemList:: |
public | function | Magic method: Implements a deep clone. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TypedData:: |
protected | property | The data definition. | 1 |
TypedData:: |
protected | property | The property name. | |
TypedData:: |
protected | property | The parent typed data object. | |
TypedData:: |
public static | function |
Constructs a TypedData object given its definition and context. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Gets the data definition. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the name of a property or item. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
TypedData:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
TypedData:: |
public | function |
Returns the property path of the data. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the root of the typed data tree. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Validates the currently set data value. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function | Constructs a TypedData object given its definition and context. | 3 |
TypedDataTrait:: |
protected | property | The typed data manager used for creating the data types. | |
TypedDataTrait:: |
public | function | Gets the typed data manager. | 2 |
TypedDataTrait:: |
public | function | Sets the typed data manager. | 2 |