abstract class FieldItemBase
An entity field item.
Entity field items making use of this base class have to implement the static method propertyDefinitions().
Hierarchy
- class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \IteratorAggregate, ComplexDataInterface
- class \Drupal\Core\Field\FieldItemBase implements FieldItemInterface
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \IteratorAggregate, ComplexDataInterface
See also
\Drupal\Core\Field\FieldItemInterface
Related topics
- Field Types API
- Defines field, widget, display formatter, and storage types.
File
- core/lib/Drupal/Core/Field/FieldItemBase.php, line 20
Namespace
Drupal\Core\FieldMembers
| Name | Modifiers | Type | Description |
|---|---|---|---|
| FieldItemBase::calculateDependencies | public static | function | Calculates dependencies for field items. Overrides FieldItemInterface::calculateDependencies |
| FieldItemBase::calculateStorageDependencies | public static | function | Calculates dependencies for field items on the storage level. Overrides FieldItemInterface::calculateStorageDependencies |
| FieldItemBase::defaultFieldSettings | public static | function | Defines the field-level settings for this plugin. Overrides FieldItemInterface::defaultFieldSettings |
| FieldItemBase::defaultStorageSettings | public static | function | Defines the storage-level settings for this plugin. Overrides FieldItemInterface::defaultStorageSettings |
| FieldItemBase::delete | public | function | Defines custom delete behavior for field values. Overrides FieldItemInterface::delete |
| FieldItemBase::deleteRevision | public | function | Defines custom revision delete behavior for field values. Overrides FieldItemInterface::deleteRevision |
| FieldItemBase::fieldSettingsForm | public | function | Returns a form for the field-level settings. Overrides FieldItemInterface::fieldSettingsForm |
| FieldItemBase::fieldSettingsFromConfigData | public static | function | Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::fieldSettingsFromConfigData |
| FieldItemBase::fieldSettingsToConfigData | public static | function | Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::fieldSettingsToConfigData |
| FieldItemBase::generateSampleValue | public static | function | Generates placeholder field values. Overrides FieldItemInterface::generateSampleValue |
| FieldItemBase::getEntity | public | function | Gets the entity that field belongs to. Overrides FieldItemInterface::getEntity |
| FieldItemBase::getFieldDefinition | public | function | Gets the field definition. Overrides FieldItemInterface::getFieldDefinition |
| FieldItemBase::getLangcode | public | function | Gets the langcode of the field values held in the object. Overrides FieldItemInterface::getLangcode |
| FieldItemBase::getSetting | protected | function | Returns the value of a field setting. |
| FieldItemBase::getSettings | protected | function | Returns the array of field settings. |
| FieldItemBase::mainPropertyName | public static | function | Returns the name of the main property, if any. Overrides FieldItemInterface::mainPropertyName |
| FieldItemBase::onDependencyRemoval | public static | function | Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface::onDependencyRemoval |
| FieldItemBase::postSave | public | function | Defines custom post-save behavior for field values. Overrides FieldItemInterface::postSave |
| FieldItemBase::preSave | public | function | Defines custom presave behavior for field values. Overrides FieldItemInterface::preSave |
| FieldItemBase::setValue | public | function | Overrides \Drupal\Core\TypedData\TypedData::setValue(). Overrides Map::setValue |
| FieldItemBase::storageSettingsForm | public | function | Returns a form for the storage-level settings. Overrides FieldItemInterface::storageSettingsForm |
| FieldItemBase::storageSettingsFromConfigData | public static | function | Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::storageSettingsFromConfigData |
| FieldItemBase::storageSettingsToConfigData | public static | function | Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::storageSettingsToConfigData |
| FieldItemBase::view | public | function | Returns a renderable array for a single field item. Overrides FieldItemInterface::view |
| FieldItemBase::writePropertyValue | protected | function | Different to the parent Map class, we avoid creating property objects as far as possible in order to optimize performance. Thus we just update $this->values if no property object has been created yet. Overrides Map::writePropertyValue |
| FieldItemBase::__construct | public | function | Constructs a TypedData object given its definition and context. Overrides TypedData::__construct |
| FieldItemBase::__get | public | function | Magic method: Gets a property value. Overrides FieldItemInterface::__get |
| FieldItemBase::__isset | public | function | Magic method: Determines whether a property is set. Overrides FieldItemInterface::__isset |
| FieldItemBase::__set | public | function | Magic method: Sets a property value. Overrides FieldItemInterface::__set |
| FieldItemBase::__unset | public | function | Magic method: Unsets a property. Overrides FieldItemInterface::__unset |
| FieldItemInterface::propertyDefinitions | public static | function | Defines field item properties. |
| FieldItemInterface::schema | public static | function | Returns the schema for the field. |
| Map::$definition | protected | property | The data definition. Overrides TypedData::$definition |
| Map::$properties | protected | property | The array of properties. |
| Map::$values | protected | property | An array of values for the contained properties. |
| Map::applyDefaultValue | public | function | Applies the default value. Overrides TypedData::applyDefaultValue |
| Map::get | public | function | Gets a property object. Overrides ComplexDataInterface::get |
| Map::getIterator | public | function | |
| Map::getProperties | public | function | Gets an array of property objects. Overrides ComplexDataInterface::getProperties |
| Map::getString | public | function | Returns a string representation of the data. Overrides TypedData::getString |
| Map::getValue | public | function | Gets the data value. Overrides TypedData::getValue |
| Map::isEmpty | public | function | Determines whether the data structure is empty. Overrides ComplexDataInterface::isEmpty |
| Map::onChange | public | function | Overrides TraversableTypedDataInterface::onChange |
| Map::set | public | function | Sets a property value. Overrides ComplexDataInterface::set |
| Map::toArray | public | function | Returns an array of all property values. Overrides ComplexDataInterface::toArray |
| Map::__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::$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::getConstraints | public | function | Gets a list of validation constraints. Overrides TypedDataInterface::getConstraints |
| 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::__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. |
© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Field!FieldItemBase.php/class/FieldItemBase/8.1.x