public static function FieldItemInterface::schema in Drupal 10

Same name and namespace in other branches

8 core/lib/Drupal/Core/Field/FieldItemInterface.php \Drupal\Core\Field\FieldItemInterface::schema()
9 core/lib/Drupal/Core/Field/FieldItemInterface.php \Drupal\Core\Field\FieldItemInterface::schema()

Returns the schema for the field.

This method is static because the field schema information is needed on creation of the field. FieldItemInterface objects instantiated at that time are not reliable as field settings might be missing.

Computed fields having no schema should return an empty array.

Parameters

\Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition: The field definition.

Return value

array An empty array if there is no schema, or an associative array with the following key/value pairs:

columns: An array of Schema API column specifications, keyed by column name. The columns need to be a subset of the properties defined in propertyDefinitions(). The 'not null' property is ignored if present, as it is determined automatically by the storage controller depending on the table layout and the property definitions. It is recommended to avoid having the column definitions depend on field settings when possible. No assumptions should be made on how storage engines internally use the original column name to structure their storage.
unique keys: (optional) An array of Schema API unique key definitions. Only columns that appear in the 'columns' array are allowed.
indexes: (optional) An array of Schema API index definitions. Only columns that appear in the 'columns' array are allowed. Those indexes will be used as default indexes. Field definitions can specify additional indexes or, at their own risk, modify the default indexes specified by the field-type module. Some storage engines might not support indexes.
foreign keys: (optional) An array of Schema API foreign key definitions. Note, however, that the field data is not necessarily stored in SQL. Also, the possible usage is limited, as you cannot specify another field as related, only existing SQL tables, such as {taxonomy_term_data}.

31 methods override FieldItemInterface::schema()

BooleanItem::schema in core/lib/Drupal/Core/Field/Plugin/Field/FieldType/BooleanItem.php: Returns the schema for the field.
CommentItem::schema in core/modules/comment/src/Plugin/Field/FieldType/CommentItem.php: Returns the schema for the field.
DateTimeItem::schema in core/modules/datetime/src/Plugin/Field/FieldType/DateTimeItem.php: Returns the schema for the field.
DecimalItem::schema in core/lib/Drupal/Core/Field/Plugin/Field/FieldType/DecimalItem.php: Returns the schema for the field.
DummyAjaxItem::schema in core/modules/image/tests/modules/image_module_test/src/Plugin/Field/FieldType/DummyAjaxItem.php: Returns the schema for the field.

... See full list

File

core/lib/Drupal/Core/Field/FieldItemInterface.php, line 88

Class

FieldItemInterface: Interface for entity field items.

Namespace

Drupal\Core\Field

Code

public static function schema(FieldStorageDefinitionInterface $field_definition);

You are here