class EntityReferenceRevisionsFieldItemList in Entity Reference Revisions 8
Defines a item list class for entity reference fields.
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\entity_reference_revisions\EntityReferenceRevisionsFieldItemList implements EntityReferenceFieldItemListInterface
- 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 EntityReferenceRevisionsFieldItemList
File
- src/
EntityReferenceRevisionsFieldItemList.php, line 16
Namespace
Drupal\entity_reference_revisionsView source
class EntityReferenceRevisionsFieldItemList extends EntityReferenceFieldItemList implements EntityReferenceFieldItemListInterface {
/**
* {@inheritdoc}
*/
public function referencedEntities() {
if (empty($this->list)) {
return array();
}
// Collect the IDs of existing entities to load, and directly grab the
// "autocreate" entities that are already populated in $item->entity.
$target_entities = $ids = array();
foreach ($this->list as $delta => $item) {
if ($item
->hasNewEntity()) {
$target_entities[$delta] = $item->entity;
}
elseif ($item->target_revision_id !== NULL) {
$ids[$delta] = $item->target_revision_id;
}
}
// Load and add the existing entities.
if ($ids) {
$target_type = $this
->getFieldDefinition()
->getSetting('target_type');
foreach ($ids as $delta => $target_id) {
$entity = \Drupal::entityTypeManager()
->getStorage($target_type)
->loadRevision($target_id);
if ($entity) {
$target_entities[$delta] = $entity;
}
}
// 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 = array();
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)
->condition('uuid', $uuids, 'IN')
->execute();
$entities = \Drupal::entityTypeManager()
->getStorage($target_type)
->loadMultiple($entity_ids);
$entity_uuids = array();
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 = array();
foreach ($default_value as $delta => $properties) {
$ids[] = $properties['target_revision_id'];
}
$entities = array();
foreach ($ids as $id) {
$entities[$id] = \Drupal::entityTypeManager()
->getStorage($this
->getSetting('target_type'))
->loadRevision($id);
}
foreach ($default_value as $delta => $properties) {
$default_value[$delta] = array(
'target_uuid' => $entities[$properties['target_revision_id']]
->uuid(),
'target_revision_id' => $properties['target_revision_id'],
);
}
return $default_value;
}
/**
* {@inheritdoc}
*/
public function hasAffectingChanges(FieldItemListInterface $original_items, $langcode) {
// If there are fewer items, then it is a change.
if (count($this) < count($original_items)) {
return TRUE;
}
foreach ($this as $delta => $item) {
// If this is a different entity, then it is an affecting change.
if (!$original_items
->offsetExists($delta) || $item->target_id != $original_items[$delta]->target_id) {
return TRUE;
}
// If it is the same entity, only consider it as having affecting changes
// if the target entity itself has changes.
if ($item->entity && $item->entity
->hasTranslation($langcode) && $item->entity
->getTranslation($langcode)
->hasTranslationChanges()) {
return TRUE;
}
}
return FALSE;
}
}
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 | |
EntityReferenceFieldItemList:: |
public | function |
Gets a list of validation constraints. Overrides FieldItemList:: |
|
EntityReferenceRevisionsFieldItemList:: |
public | function |
Processes the submitted default value. Overrides EntityReferenceFieldItemList:: |
|
EntityReferenceRevisionsFieldItemList:: |
public | function |
Determines whether the field has relevant changes. Overrides FieldItemList:: |
|
EntityReferenceRevisionsFieldItemList:: |
public static | function |
Processes the default value before being applied. Overrides EntityReferenceFieldItemList:: |
|
EntityReferenceRevisionsFieldItemList:: |
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 |
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 |