Same name and namespace in other branches
- 8.9.x core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php \Drupal\file\Plugin\Field\FieldType\FileFieldItemList
- 9 core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php \Drupal\file\Plugin\Field\FieldType\FileFieldItemList
Represents a configurable entity file field.
Hierarchy
- class \Drupal\Core\Field\FieldItemList extends \Drupal\Core\TypedData\Plugin\DataType\ItemList implements FieldItemListInterface
- class \Drupal\Core\Field\EntityReferenceFieldItemList implements EntityReferenceFieldItemListInterface
- class \Drupal\file\Plugin\Field\FieldType\FileFieldItemList
- class \Drupal\Core\Field\EntityReferenceFieldItemList implements EntityReferenceFieldItemListInterface
Expanded class hierarchy of FileFieldItemList
1 file declares its use of FileFieldItemList
- FileUploadForm.php in core/
modules/ media_library/ src/ Form/ FileUploadForm.php
File
- core/
modules/ file/ src/ Plugin/ Field/ FieldType/ FileFieldItemList.php, line 11
Namespace
Drupal\file\Plugin\Field\FieldTypeView source
class FileFieldItemList extends EntityReferenceFieldItemList {
/**
* {@inheritdoc}
*/
public function defaultValuesForm(array &$form, FormStateInterface $form_state) {
}
/**
* {@inheritdoc}
*/
public function postSave($update) {
$entity = $this
->getEntity();
if (!$update) {
// Add a new usage for newly uploaded files.
foreach ($this
->referencedEntities() as $file) {
\Drupal::service('file.usage')
->add($file, 'file', $entity
->getEntityTypeId(), $entity
->id());
}
}
else {
// Get current target file entities and file IDs.
$files = $this
->referencedEntities();
$ids = [];
/** @var \Drupal\file\FileInterface $file */
foreach ($files as $file) {
$ids[] = $file
->id();
}
// On new revisions, all files are considered to be a new usage and no
// deletion of previous file usages are necessary.
if (!empty($entity->original) && $entity
->getRevisionId() != $entity->original
->getRevisionId()) {
foreach ($files as $file) {
\Drupal::service('file.usage')
->add($file, 'file', $entity
->getEntityTypeId(), $entity
->id());
}
return;
}
// Get the file IDs attached to the field before this update.
$field_name = $this
->getFieldDefinition()
->getName();
$original_ids = [];
$langcode = $this
->getLangcode();
$original = $entity->original;
if ($original
->hasTranslation($langcode)) {
$original_items = $original
->getTranslation($langcode)->{$field_name};
foreach ($original_items as $item) {
$original_ids[] = $item->target_id;
}
}
// Decrement file usage by 1 for files that were removed from the field.
$removed_ids = array_filter(array_diff($original_ids, $ids));
$removed_files = \Drupal::entityTypeManager()
->getStorage('file')
->loadMultiple($removed_ids);
foreach ($removed_files as $file) {
\Drupal::service('file.usage')
->delete($file, 'file', $entity
->getEntityTypeId(), $entity
->id());
}
// Add new usage entries for newly added files.
foreach ($files as $file) {
if (!in_array($file
->id(), $original_ids)) {
\Drupal::service('file.usage')
->add($file, 'file', $entity
->getEntityTypeId(), $entity
->id());
}
}
}
}
/**
* {@inheritdoc}
*/
public function delete() {
parent::delete();
$entity = $this
->getEntity();
// If a translation is deleted only decrement the file usage by one. If the
// default translation is deleted remove all file usages within this entity.
$count = $entity
->isDefaultTranslation() ? 0 : 1;
foreach ($this
->referencedEntities() as $file) {
\Drupal::service('file.usage')
->delete($file, 'file', $entity
->getEntityTypeId(), $entity
->id(), $count);
}
}
/**
* {@inheritdoc}
*/
public function deleteRevision() {
parent::deleteRevision();
$entity = $this
->getEntity();
// Decrement the file usage by 1.
foreach ($this
->referencedEntities() as $file) {
\Drupal::service('file.usage')
->delete($file, 'file', $entity
->getEntityTypeId(), $entity
->id());
}
}
}
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 |
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 |
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 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:: |
|
FileFieldItemList:: |
public | function |
Returns a form for the default value input. Overrides FieldItemList:: |
|
FileFieldItemList:: |
public | function |
Defines custom delete behavior for field values. Overrides FieldItemList:: |
|
FileFieldItemList:: |
public | function |
Defines custom revision delete behavior for field values. Overrides FieldItemList:: |
|
FileFieldItemList:: |
public | function |
Defines custom post-save behavior for field values. Overrides FieldItemList:: |
|
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 |