class FieldItemBase
Same name in other branches
- 9 core/lib/Drupal/Core/Field/FieldItemBase.php \Drupal\Core\Field\FieldItemBase
- 8.9.x core/lib/Drupal/Core/Field/FieldItemBase.php \Drupal\Core\Field\FieldItemBase
- 10 core/lib/Drupal/Core/Field/FieldItemBase.php \Drupal\Core\Field\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 \Drupal\Core\TypedData\TypedDataInterface, \Drupal\Component\Plugin\PluginInspectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\TypedData\TypedDataTrait
- class \Drupal\Core\TypedData\Plugin\DataType\Map extends \Drupal\Core\TypedData\TypedData implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, \Drupal\Core\TypedData\ComplexDataInterface
- class \Drupal\Core\Field\FieldItemBase extends \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\Field\FieldItemInterface
- class \Drupal\Core\TypedData\Plugin\DataType\Map extends \Drupal\Core\TypedData\TypedData implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, \Drupal\Core\TypedData\ComplexDataInterface
Expanded class hierarchy of FieldItemBase
See also
\Drupal\Core\Field\FieldItemInterface
Related topics
28 files declare their use of FieldItemBase
- BaseFieldDefinitionTest.php in core/
tests/ Drupal/ Tests/ Core/ Entity/ BaseFieldDefinitionTest.php - BooleanItem.php in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ BooleanItem.php - CommentItem.php in core/
modules/ comment/ src/ Plugin/ Field/ FieldType/ CommentItem.php - DateTimeIso8601NormalizerTest.php in core/
modules/ serialization/ tests/ src/ Unit/ Normalizer/ DateTimeIso8601NormalizerTest.php - DateTimeItem.php in core/
modules/ datetime/ src/ Plugin/ Field/ FieldType/ DateTimeItem.php
File
-
core/
lib/ Drupal/ Core/ Field/ FieldItemBase.php, line 20
Namespace
Drupal\Core\FieldView source
abstract class FieldItemBase extends Map implements FieldItemInterface {
/**
* {@inheritdoc}
*/
public static function defaultStorageSettings() {
return [];
}
/**
* {@inheritdoc}
*/
public static function defaultFieldSettings() {
return [];
}
/**
* {@inheritdoc}
*/
public static function storageSettingsSummary(FieldStorageDefinitionInterface $storage_definition) : array {
return [];
}
/**
* {@inheritdoc}
*/
public static function fieldSettingsSummary(FieldDefinitionInterface $field_definition) : array {
return [];
}
/**
* {@inheritdoc}
*/
public static function mainPropertyName() {
return 'value';
}
/**
* {@inheritdoc}
*/
public function __construct(ComplexDataDefinitionInterface $definition, $name = NULL, ?TypedDataInterface $parent = NULL) {
parent::__construct($definition, $name, $parent);
// Initialize computed properties by default, such that they get cloned
// with the whole item.
foreach ($this->definition
->getPropertyDefinitions() as $name => $definition) {
if ($definition->isComputed()) {
$this->properties[$name] = \Drupal::typedDataManager()->getPropertyInstance($this, $name);
}
}
}
/**
* {@inheritdoc}
*/
public function getEntity() {
return $this->getParent()
->getEntity();
}
/**
* {@inheritdoc}
*/
public function getLangcode() {
return $this->getParent()
->getLangcode();
}
/**
* {@inheritdoc}
*/
public function getFieldDefinition() {
return $this->definition
->getFieldDefinition();
}
/**
* Returns the array of field settings.
*
* @return array
* The array of settings.
*/
protected function getSettings() {
return $this->getFieldDefinition()
->getSettings();
}
/**
* Returns the value of a field setting.
*
* @param string $setting_name
* The setting name.
*
* @return mixed
* The setting value.
*/
protected function getSetting($setting_name) {
return $this->getFieldDefinition()
->getSetting($setting_name);
}
/**
* {@inheritdoc}
*/
public function setValue($values, $notify = TRUE) {
// Treat the values as property value of the first property, if no array is
// given.
if (isset($values) && !is_array($values)) {
$keys = array_keys($this->definition
->getPropertyDefinitions());
$values = [
$keys[0] => $values,
];
}
parent::setValue($values, $notify);
}
/**
* {@inheritdoc}
*
* 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.
*/
protected function writePropertyValue($property_name, $value) {
// For defined properties there is either a property object or a plain
// value that needs to be updated.
if (isset($this->properties[$property_name])) {
$this->properties[$property_name]
->setValue($value, FALSE);
}
else {
$this->values[$property_name] = $value;
}
}
/**
* {@inheritdoc}
*/
public function __get($name) {
// There is either a property object or a plain value - possibly for a
// not-defined property. If we have a plain value, directly return it.
if (isset($this->properties[$name])) {
return $this->properties[$name]
->getValue();
}
elseif (isset($this->values[$name])) {
return $this->values[$name];
}
}
/**
* {@inheritdoc}
*/
public function __set($name, $value) {
// Support setting values via property objects, but take care in as the
// value of the 'entity' property is typed data also.
if ($value instanceof TypedDataInterface && !$value instanceof EntityInterface) {
$value = $value->getValue();
}
$this->set($name, $value);
}
/**
* {@inheritdoc}
*/
public function __isset($name) {
if (isset($this->properties[$name])) {
return $this->properties[$name]
->getValue() !== NULL;
}
return isset($this->values[$name]);
}
/**
* {@inheritdoc}
*/
public function __unset($name) {
if ($this->definition
->getPropertyDefinition($name)) {
$this->set($name, NULL);
}
else {
// Explicitly unset the property in $this->values if a non-defined
// property is unset, such that its key is removed from $this->values.
unset($this->values[$name]);
}
}
/**
* {@inheritdoc}
*/
public function view($display_options = []) {
$view_builder = \Drupal::entityTypeManager()->getViewBuilder($this->getEntity()
->getEntityTypeId());
return $view_builder->viewFieldItem($this, $display_options);
}
/**
* {@inheritdoc}
*/
public function preSave() {
}
/**
* {@inheritdoc}
*/
public function postSave($update) {
}
/**
* {@inheritdoc}
*/
public function delete() {
}
/**
* {@inheritdoc}
*/
public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
}
/**
* {@inheritdoc}
*/
public function deleteRevision() {
}
/**
* {@inheritdoc}
*/
public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
return [];
}
/**
* {@inheritdoc}
*/
public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
return [];
}
/**
* {@inheritdoc}
*/
public static function storageSettingsToConfigData(array $settings) {
return $settings;
}
/**
* {@inheritdoc}
*/
public static function storageSettingsFromConfigData(array $settings) {
return $settings;
}
/**
* {@inheritdoc}
*/
public static function fieldSettingsToConfigData(array $settings) {
return $settings;
}
/**
* {@inheritdoc}
*/
public static function fieldSettingsFromConfigData(array $settings) {
return $settings;
}
/**
* {@inheritdoc}
*/
public static function calculateDependencies(FieldDefinitionInterface $field_definition) {
return [];
}
/**
* {@inheritdoc}
*/
public static function calculateStorageDependencies(FieldStorageDefinitionInterface $field_definition) {
return [];
}
/**
* {@inheritdoc}
*/
public static function onDependencyRemoval(FieldDefinitionInterface $field_definition, array $dependencies) {
return FALSE;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
DependencySerializationTrait::__sleep | public | function | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | ||
FieldItemBase::calculateDependencies | public static | function | Calculates dependencies for field items. | Overrides FieldItemInterface::calculateDependencies | 2 |
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 | 6 |
FieldItemBase::defaultStorageSettings | public static | function | Defines the storage-level settings for this plugin. | Overrides FieldItemInterface::defaultStorageSettings | 9 |
FieldItemBase::delete | public | function | Defines custom delete behavior for field values. | Overrides FieldItemInterface::delete | 2 |
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 | 6 |
FieldItemBase::fieldSettingsFromConfigData | public static | function | Returns a settings array in the field type's canonical representation. | Overrides FieldItemInterface::fieldSettingsFromConfigData | 1 |
FieldItemBase::fieldSettingsSummary | public static | function | Returns a short summary of the field's field-level settings. | Overrides FieldItemInterface::fieldSettingsSummary | |
FieldItemBase::fieldSettingsToConfigData | public static | function | Returns a settings array that can be stored as a configuration value. | Overrides FieldItemInterface::fieldSettingsToConfigData | 1 |
FieldItemBase::generateSampleValue | public static | function | Generates placeholder field values. | Overrides FieldItemInterface::generateSampleValue | 17 |
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 | 8 |
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 | 2 |
FieldItemBase::preSave | public | function | Defines custom presave behavior for field values. | Overrides FieldItemInterface::preSave | 6 |
FieldItemBase::setValue | public | function | Overrides \Drupal\Core\TypedData\TypedData::setValue(). | Overrides Map::setValue | 3 |
FieldItemBase::storageSettingsForm | public | function | Returns a form for the storage-level settings. | Overrides FieldItemInterface::storageSettingsForm | 7 |
FieldItemBase::storageSettingsFromConfigData | public static | function | Returns a settings array in the field type's canonical representation. | Overrides FieldItemInterface::storageSettingsFromConfigData | 2 |
FieldItemBase::storageSettingsSummary | public static | function | Returns a short summary of the field's storage-level settings. | Overrides FieldItemInterface::storageSettingsSummary | |
FieldItemBase::storageSettingsToConfigData | public static | function | Returns a settings array that can be stored as a configuration value. | Overrides FieldItemInterface::storageSettingsToConfigData | 2 |
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 | 2 |
FieldItemBase::__get | public | function | Magic method: Gets a property value. | Overrides FieldItemInterface::__get | 2 |
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 | 1 |
FieldItemBase::__unset | public | function | Magic method: Unsets a property. | Overrides FieldItemInterface::__unset | |
FieldItemInterface::propertyDefinitions | public static | function | Defines field item properties. | 29 | |
FieldItemInterface::schema | public static | function | Returns the schema for the field. | 32 | |
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 | 4 |
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 | 16 |
Map::onChange | public | function | Overrides TraversableTypedDataInterface::onChange | 3 | |
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 | 1 |
Map::__clone | public | function | Magic method: Implements a deep clone. | ||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
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. | 2 | |
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 | 8 |
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 | |
TypedDataTrait::$typedDataManager | protected | property | The typed data manager used for creating the data types. | ||
TypedDataTrait::getTypedDataManager | public | function | Gets the typed data manager. | 2 | |
TypedDataTrait::setTypedDataManager | public | function | Sets the typed data manager. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.