class FieldItemDataDefinition

A typed data definition class for defining field items.

This class is just a small wrapper around field definitions to expose metadata about field item's via the Typed Data API. As the work is done by the field definitions, this class does not benefit and thus does not extend from MapDefinition or ComplexDataDefinitionBase.

Hierarchy

• class \Drupal\Core\TypedData\DataDefinition implements \ArrayAccess, DataDefinitionInterface
  • class \Drupal\Core\Field\TypedData\FieldItemDataDefinition implements ComplexDataDefinitionInterface

File

core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php, line 17

Namespace

Drupal\Core\Field\TypedData

Members

Name	Modifiers	Type	Description
DataDefinition::$definition	protected	property	The array holding values for all definition keys.
DataDefinition::addConstraint	public	function	Adds a validation constraint. Overrides DataDefinitionInterface::addConstraint
DataDefinition::getClass	public	function	Returns the class used for creating the typed data object. Overrides DataDefinitionInterface::getClass
DataDefinition::getConstraint	public	function	Returns a validation constraint. Overrides DataDefinitionInterface::getConstraint
DataDefinition::getConstraints	public	function	Returns an array of validation constraints. Overrides DataDefinitionInterface::getConstraints
DataDefinition::getDataType	public	function	Returns the data type of the data. Overrides DataDefinitionInterface::getDataType
DataDefinition::getDescription	public	function	Returns a human readable description. Overrides DataDefinitionInterface::getDescription
DataDefinition::getLabel	public	function	Returns a human readable label. Overrides DataDefinitionInterface::getLabel
DataDefinition::getSetting	public	function	Returns the value of a given setting. Overrides DataDefinitionInterface::getSetting
DataDefinition::getSettings	public	function	Returns the array of settings, as required by the used class. Overrides DataDefinitionInterface::getSettings
DataDefinition::isComputed	public	function	Determines whether the data value is computed. Overrides DataDefinitionInterface::isComputed
DataDefinition::isList	public	function	Returns whether the data is multi-valued, i.e. a list of data items. Overrides DataDefinitionInterface::isList
DataDefinition::isReadOnly	public	function	Determines whether the data is read-only. Overrides DataDefinitionInterface::isReadOnly
DataDefinition::isRequired	public	function	Determines whether a data value is required. Overrides DataDefinitionInterface::isRequired
DataDefinition::offsetExists	public	function	This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetGet	public	function	This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetSet	public	function	This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetUnset	public	function	This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868.
DataDefinition::setClass	public	function	Sets the class used for creating the typed data object.
DataDefinition::setComputed	public	function	Sets whether the data is computed.
DataDefinition::setConstraints	public	function
DataDefinition::setDataType	public	function	Sets the data type.
DataDefinition::setDescription	public	function	Sets the human-readable description.
DataDefinition::setLabel	public	function	Sets the human-readable label.
DataDefinition::setReadOnly	public	function	Sets whether the data is read-only.
DataDefinition::setRequired	public	function	Sets whether the data is required.
DataDefinition::setSetting	public	function	Sets a definition setting.
DataDefinition::setSettings	public	function	Sets the array of settings, as required by the used class.
DataDefinition::toArray	public	function	Returns all definition values as array.
DataDefinition::__construct	public	function	Constructs a new data definition object.
FieldItemDataDefinition::$fieldDefinition	protected	property	The field definition the item definition belongs to.
FieldItemDataDefinition::create	public static	function	Creates a new field item definition. Overrides DataDefinition::create
FieldItemDataDefinition::createFromDataType	public static	function	Creates a new data definition object. Overrides DataDefinition::createFromDataType
FieldItemDataDefinition::getFieldDefinition	public	function	Gets the field item's field definition.
FieldItemDataDefinition::getMainPropertyName	public	function	Returns the name of the main property, if any. Overrides ComplexDataDefinitionInterface::getMainPropertyName
FieldItemDataDefinition::getPropertyDefinition	public	function	Gets the definition of a contained property. Overrides ComplexDataDefinitionInterface::getPropertyDefinition
FieldItemDataDefinition::getPropertyDefinitions	public	function	Gets an array of property definitions of contained properties. Overrides ComplexDataDefinitionInterface::getPropertyDefinitions