FieldStorageDefinitionInterface

Defines an interface for entity field storage definitions.

Field storage definitions represent the part of full field definitions (see FieldDefinitionInterface) that is responsible for defining how the field is stored. While field definitions may differ by entity bundle, all of those bundle fields have to share the same common field storage definition. Thus, the storage definitions can be defined by entity type only. The bundle fields corresponding to a field storage definition may provide additional information; e.g., they may provide bundle-specific settings or constraints that are not present in the storage definition. However bundle fields may not override or alter any information provided by the storage definition except for the label and the description; e.g., any constraints and settings on the storage definition must be present on the bundle field as well.

Hierarchy

interface \Drupal\Core\Cache\CacheableDependencyInterface
- interface \Drupal\Core\Field\FieldStorageDefinitionInterface

File

core/lib/Drupal/Core/Field/FieldStorageDefinitionInterface.php, line 26

Namespace

Drupal\Core\Field

Members

Name	Modifiers	Type	Description
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.
FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED		constant	Value indicating a field accepts an unlimited number of values.
FieldStorageDefinitionInterface::getCardinality	public	function	Returns the maximum number of items allowed for the field.
FieldStorageDefinitionInterface::getColumns	public	function	Returns the field columns, as defined in the field schema.
FieldStorageDefinitionInterface::getConstraint	public	function	Returns a validation constraint.
FieldStorageDefinitionInterface::getConstraints	public	function	Returns an array of validation constraints.
FieldStorageDefinitionInterface::getDescription	public	function	Returns the human-readable description for the field.
FieldStorageDefinitionInterface::getLabel	public	function	Returns the human-readable label for the field.
FieldStorageDefinitionInterface::getMainPropertyName	public	function	Returns the name of the main property, if any.
FieldStorageDefinitionInterface::getName	public	function	Returns the machine name of the field.
FieldStorageDefinitionInterface::getOptionsProvider	public	function	Gets an options provider for the given field item property.
FieldStorageDefinitionInterface::getPropertyDefinition	public	function	Gets the definition of a contained property.
FieldStorageDefinitionInterface::getPropertyDefinitions	public	function	Gets an array of property definitions of contained properties.
FieldStorageDefinitionInterface::getPropertyNames	public	function	Returns the names of the field's subproperties.
FieldStorageDefinitionInterface::getProvider	public	function	Returns the name of the provider of this field.
FieldStorageDefinitionInterface::getSchema	public	function	Returns the field schema.
FieldStorageDefinitionInterface::getSetting	public	function	Returns the value of a given storage setting.
FieldStorageDefinitionInterface::getSettings	public	function	Returns the storage settings.
FieldStorageDefinitionInterface::getTargetEntityTypeId	public	function	Returns the ID of the entity type the field is attached to.
FieldStorageDefinitionInterface::getType	public	function	Returns the field type.
FieldStorageDefinitionInterface::getUniqueStorageIdentifier	public	function	Returns a unique identifier for the field.
FieldStorageDefinitionInterface::hasCustomStorage	public	function	Returns the storage behavior for this field.
FieldStorageDefinitionInterface::isBaseField	public	function	Determines whether the field is a base field.
FieldStorageDefinitionInterface::isMultiple	public	function	Returns whether the field can contain multiple items.
FieldStorageDefinitionInterface::isQueryable	public	function	Determines whether the field is queryable via QueryInterface.
FieldStorageDefinitionInterface::isRevisionable	public	function	Returns whether the field is revisionable.
FieldStorageDefinitionInterface::isTranslatable	public	function	Returns whether the field supports translation.
FieldStorageDefinitionInterface::setTranslatable	public	function	Sets whether the field supports translation.

Links:

https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Field%21FieldStorageDefinitionInterface.php/interface/FieldStorageDefinitionInterface/8.2.x

doc_Drupal

2016-10-29 09:12:43

Comments

FieldStorageDefinitionInterface

Hierarchy

See also

File

Namespace

Members