Interface for entity field items.
Entity field items are typed data objects containing the field values, i.e. implementing the ComplexDataInterface.
When implementing this interface which extends Traversable, make sure to list IteratorAggregate or Iterator before this interface in the implements clause.
Expanded class hierarchy of FieldItemInterface
All classes that implement FieldItemInterface
\Drupal\Core\Entity\Field\FieldInterface
\Drupal\Core\Entity\Field\FieldItemBase
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ComplexDataInterface:: |
public | function | Gets a property object. | 7 |
ComplexDataInterface:: |
public | function | Gets an array of property objects. | 7 |
ComplexDataInterface:: |
public | function | Gets the definition of a contained property. | 7 |
ComplexDataInterface:: |
public | function | Gets an array of property definitions of contained properties. | 7 |
ComplexDataInterface:: |
public | function | Gets an array of property values. | 7 |
ComplexDataInterface:: |
public | function | Determines whether the data structure is empty. | 7 |
ComplexDataInterface:: |
public | function | React to changes to a child property. | 7 |
ComplexDataInterface:: |
public | function | Sets a property value. | 7 |
ComplexDataInterface:: |
public | function | Sets multiple property values. | 7 |
FieldItemInterface:: |
public | function | Magic method: Gets a property value. | 1 |
FieldItemInterface:: |
public | function | Magic method: Determines whether a property is set. | 1 |
FieldItemInterface:: |
public | function | Magic method: Sets a property value. | 1 |
FieldItemInterface:: |
public | function | Magic method: Unsets a property. | 1 |
TypedDataInterface:: |
public | function | Gets a list of validation constraints. | 4 |
TypedDataInterface:: |
public | function | Gets the data definition. | 4 |
TypedDataInterface:: |
public | function | Returns the name of a property or item. | 4 |
TypedDataInterface:: |
public | function | Returns the parent data structure; i.e. either complex data or a list. | 4 |
TypedDataInterface:: |
public | function | Returns the property path of the data. | 4 |
TypedDataInterface:: |
public | function | Returns the root of the typed data tree. | 4 |
TypedDataInterface:: |
public | function | Returns a string representation of the data. | 4 |
TypedDataInterface:: |
public | function | Gets the data type. | 5 |
TypedDataInterface:: |
public | function | Gets the data value. | 4 |
TypedDataInterface:: |
public | function | Sets the context of a property or item via a context aware parent. | 4 |
TypedDataInterface:: |
public | function | Sets the data value. | 4 |
TypedDataInterface:: |
public | function | Validates the currently set data value. | 4 |