Represents an entity field; that is, a list of field item objects.
An entity field is a list of field items, each containing a set of properties. Note that even single-valued entity fields are represented as list of field items, however for easy access to the contained item the entity field delegates __get() and __set() calls directly to the first item.
Hierarchy
- class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\TypedData\Plugin\DataType\ItemList implements \IteratorAggregate, ListInterface
- class \Drupal\Core\Field\FieldItemList implements FieldItemListInterface
- class \Drupal\Core\TypedData\Plugin\DataType\ItemList implements \IteratorAggregate, ListInterface
File
- core/lib/Drupal/Core/Field/FieldItemList.php, line 20
Namespace
Drupal\Core\Field
Members
| Name | Modifiers | Type | Description |
|---|---|---|---|
| FieldItemList::$langcode | protected | property | The langcode of the field values held in the object. |
| FieldItemList::$list | protected | property | Numerically indexed array of field items. Overrides ItemList::$list |
| FieldItemList::access | public | function | Checks data value access. Overrides AccessibleInterface::access |
| FieldItemList::applyDefaultValue | public | function | Applies the default value. Overrides TypedData::applyDefaultValue |
| FieldItemList::createItem | protected | function | Helper for creating a list item object. Overrides ItemList::createItem |
| FieldItemList::defaultAccess | public | function | Contains the default access logic of this field. Overrides FieldItemListInterface::defaultAccess |
| FieldItemList::defaultValuesForm | public | function | Returns a form for the default value input. Overrides FieldItemListInterface::defaultValuesForm |
| FieldItemList::defaultValuesFormSubmit | public | function | Processes the submitted default value. Overrides FieldItemListInterface::defaultValuesFormSubmit |
| FieldItemList::defaultValuesFormValidate | public | function | Validates the submitted default value. Overrides FieldItemListInterface::defaultValuesFormValidate |
| FieldItemList::defaultValueWidget | protected | function | Returns the widget object used in default value form. |
| FieldItemList::delegateMethod | protected | function | Calls a method on each FieldItem. |
| FieldItemList::delete | public | function | Defines custom delete behavior for field values. Overrides FieldItemListInterface::delete |
| FieldItemList::deleteRevision | public | function | Defines custom revision delete behavior for field values. Overrides FieldItemListInterface::deleteRevision |
| FieldItemList::equals | public | function | Determines equality to another object implementing FieldItemListInterface. Overrides FieldItemListInterface::equals |
| FieldItemList::filterEmptyItems | public | function | Filters out empty field items and re-numbers the item deltas. Overrides FieldItemListInterface::filterEmptyItems |
| FieldItemList::generateSampleItems | public | function | Populates a specified number of field items with valid sample data. Overrides FieldItemListInterface::generateSampleItems |
| FieldItemList::getConstraints | public | function | Gets a list of validation constraints. Overrides TypedData::getConstraints |
| FieldItemList::getEntity | public | function | Gets the entity that field belongs to. Overrides FieldItemListInterface::getEntity |
| FieldItemList::getFieldDefinition | public | function | Gets the field definition. Overrides FieldItemListInterface::getFieldDefinition |
| FieldItemList::getLangcode | public | function | Gets the langcode of the field values held in the object. Overrides FieldItemListInterface::getLangcode |
| FieldItemList::getSetting | public | function | Returns the value of a given field setting. Overrides FieldItemListInterface::getSetting |
| FieldItemList::getSettings | public | function | Returns the array of field settings. Overrides FieldItemListInterface::getSettings |
| FieldItemList::getValue | public | function | @todo Revisit the need when all entity types are converted to NG entities. Overrides ItemList::getValue |
| FieldItemList::postSave | public | function | Defines custom post-save behavior for field values. Overrides FieldItemListInterface::postSave |
| FieldItemList::preSave | public | function | Defines custom presave behavior for field values. Overrides FieldItemListInterface::preSave |
| FieldItemList::processDefaultValue | public static | function | Processes the default value before being applied. Overrides FieldItemListInterface::processDefaultValue |
| FieldItemList::setLangcode | public | function | Sets the langcode of the field values held in the object. Overrides FieldItemListInterface::setLangcode |
| FieldItemList::setValue | public | function | Overrides \Drupal\Core\TypedData\TypedData::setValue(). Overrides ItemList::setValue |
| FieldItemList::view | public | function | Returns a renderable array for the field items. Overrides FieldItemListInterface::view |
| FieldItemList::__get | public | function | Magic method: Gets a property value of to the first field item. Overrides FieldItemListInterface::__get |
| FieldItemList::__isset | public | function | Magic method: Determines whether a property of the first field item is set. Overrides FieldItemListInterface::__isset |
| FieldItemList::__set | public | function | Magic method: Sets a property value of the first field item. Overrides FieldItemListInterface::__set |
| FieldItemList::__unset | public | function | Magic method: Unsets a property of the first field item. Overrides FieldItemListInterface::__unset |
| ItemList::appendItem | public | function | Appends a new item to the list. Overrides ListInterface::appendItem |
| ItemList::count | public | function | |
| ItemList::filter | public | function | Filters the items in the list using a custom callback. Overrides ListInterface::filter |
| ItemList::first | public | function | Returns the first item in this list. Overrides ListInterface::first |
| ItemList::get | public | function | Returns the item at the specified position in this list. Overrides ListInterface::get |
| ItemList::getItemDefinition | public | function | Gets the definition of a contained item. Overrides ListInterface::getItemDefinition |
| ItemList::getIterator | public | function | |
| ItemList::getString | public | function | Returns a string representation of the data. Overrides TypedData::getString |
| ItemList::isEmpty | public | function | Determines whether the list contains any non-empty items. Overrides ListInterface::isEmpty |
| ItemList::offsetExists | public | function | |
| ItemList::offsetGet | public | function | |
| ItemList::offsetSet | public | function | |
| ItemList::offsetUnset | public | function | |
| ItemList::onChange | public | function | React to changes to a child property or item. Overrides TraversableTypedDataInterface::onChange |
| ItemList::rekey | protected | function | Renumbers the items in the list. |
| ItemList::removeItem | public | function | Removes the item at the specified position. Overrides ListInterface::removeItem |
| ItemList::set | public | function | Sets the value of the item at a given position in the list. Overrides ListInterface::set |
| ItemList::__clone | public | function | Magic method: Implements a deep clone. |
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. |
| StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. |
| StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. |
| StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. |
| StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. |
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
| TypedData::$definition | protected | property | The data definition. |
| TypedData::$name | protected | property | The property name. |
| TypedData::$parent | protected | property | The parent typed data object. |
| TypedData::createInstance | public static | function | Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance |
| TypedData::getDataDefinition | public | function | Gets the data definition. Overrides TypedDataInterface::getDataDefinition |
| TypedData::getName | public | function | Returns the name of a property or item. Overrides TypedDataInterface::getName |
| TypedData::getParent | public | function | Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent |
| TypedData::getPluginDefinition | public | function | Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition |
| TypedData::getPluginId | public | function | Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId |
| TypedData::getPropertyPath | public | function | Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath |
| TypedData::getRoot | public | function | Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot |
| TypedData::setContext | public | function | Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext |
| TypedData::validate | public | function | Validates the currently set data value. Overrides TypedDataInterface::validate |
| TypedData::__construct | public | function | Constructs a TypedData object given its definition and context. |
| TypedData::__sleep | public | function | |
| TypedDataTrait::$typedDataManager | protected | property | The typed data manager used for creating the data types. |
| TypedDataTrait::getTypedDataManager | public | function | Gets the typed data manager. |
| TypedDataTrait::setTypedDataManager | public | function | Sets the typed data manager. |
Please login to continue.