FieldStorageConfigInterface

Checks data value access.

The cache contexts associated with this object.

These identify a specific variation/representation of the object.

Cache contexts are tokens: placeholders that are converted to cache keys by the @cache_contexts_manager service. The replacement value depends on the request context (the current URL, language, and so on). They're converted before storing an object in cache.

The cache tags associated with this object.

When this object is modified, these cache tags will be invalidated.

The maximum age for which this object may be cached.

Adds cache contexts.

Adds cache tags.

Merges the maximum age (in seconds) with the existing maximum age.

The max age will be set to the given value if it is lower than the existing value.

Adds a dependency on an object: merges its cacheability metadata.

Gets the entity UUID (Universally Unique Identifier).

The UUID is guaranteed to be unique and can be used to identify an entity across multiple systems.

Gets the identifier.

Gets the language of the entity.

Determines whether the entity is new.

Usually an entity is new if no ID exists for it yet. However, entities may be enforced to be new with existing IDs too.

Enforces an entity to be new.

Allows migrations to create entities with pre-defined IDs by forcing the entity to be new before saving.

Gets the ID of the type of the entity.

Gets the bundle of the entity.

Gets the label of the entity.

Gets the URL object for the entity.

The entity must have an id already. Content entities usually get their IDs by saving them.

URI templates might be set in the links array in an annotation, for example:

Generates the HTML for a link to this entity.

Indicates if a link template exists for a given key.

Gets a list of URI relationships supported by this entity.

Loads an entity.

Loads one or more entities.

Constructs a new entity object, without permanently saving it.

Saves an entity permanently.

When saving existing entities, the entity is assumed to be complete, partial updates of entities are not supported.

Deletes an entity permanently.

Acts on an entity before the presave hook is invoked.

Used before the entity is saved and before invoking the presave hook. Note that in case of translatable content entities this callback is only fired on their current translation. It is up to the developer to iterate over all translations if needed. This is different from its counterpart in the Field API, FieldItemListInterface::preSave(), which is fired on all field translations automatically.

Adjust existing implementations and the documentation according to https://www.drupal.org/node/2577609 to have a consistent API.

Acts on a saved entity before the insert or update hook is invoked.

Used after the entity is saved, but before invoking the insert or update hook. Note that in case of translatable content entities this callback is only fired on their current translation. It is up to the developer to iterate over all translations if needed.

Changes the values of an entity before it is created.

Load defaults for example.

Acts on a created entity before hooks are invoked.

Used after the entity is created, but before saving the entity and before any of the presave hooks are invoked.

See the @link entity_crud Entity CRUD topic @endlink for more information.

Acts on entities before they are deleted and before hooks are invoked.

Used before the entities are deleted and before invoking the delete hook.

Acts on deleted entities before the delete hook is invoked.

Used after the entities are deleted but before invoking the delete hook.

Acts on loaded entities.

Creates a duplicate of the entity.

Gets the entity type definition.

Gets a list of entities referenced by this entity.

Gets the original ID.

Returns the cache tags that should be used to invalidate caches.

This will not return additional cache tags added through addCacheTags().

Sets the original ID.

Gets an array of all property values.

Gets a typed data object for this entity object.

The returned typed data object wraps this entity and allows dealing with entities based on the generic typed data API.

Gets the key that is used to store configuration dependencies.

Gets the configuration dependency name.

Configuration entities can depend on content and configuration entities. They store an array of content and config dependency names in their "dependencies" key.

Gets the configuration target identifier for the entity.

Used to supply the correct format for storing a reference targeting this entity in configuration.

Sets the value of a third-party setting.

Gets the value of a third-party setting.

Gets all third-party settings of a given module.

Unsets a third-party setting.

Gets the list of third parties that store information.

Sets the status of the synchronization flag.

Returns whether this entity is being changed as part of a synchronization.

If you are writing code that responds to a change in this entity (insert, update, delete, presave, etc.), and your code would result in a change to this entity itself, a configuration change (whether related to this entity, another entity, or non-entity configuration), you need to check and see if this entity change is part of a synchronization process, and skip executing your code if that is the case.

For example, \Drupal\node\Entity\NodeType::postSave() adds the default body field to newly created node type configuration entities, which is a configuration change. You would not want this code to run during an import, because imported entities were already given the body field when they were originally created, and the imported configuration includes all of their currently-configured fields. On the other hand, \Drupal\field\Entity\FieldStorageConfig::preSave() and the methods it calls make sure that the storage tables are created or updated for the field storage configuration entity, which is not a configuration change, and it must be done whether due to an import or not. So, the first method should check $entity->isSyncing() and skip executing if it returns TRUE, and the second should not perform this check.

Enables the configuration entity.

Disables the configuration entity.

Sets the status of the configuration entity.

Returns whether the configuration entity is enabled.

Status implementations for configuration entities should follow these general rules:

• Status does not affect the loading of entities. I.e. Disabling configuration entities should only have UI/access implications.
• It should only take effect when a 'status' key is explicitly declared in the entity_keys info of a configuration entity's annotation data.
• Each entity implementation (entity/controller) is responsible for checking and managing the status.

Returns whether this entity is being changed during the uninstall process.

If you are writing code that responds to a change in this entity (insert, update, delete, presave, etc.), and your code would result in a configuration change (whether related to this configuration entity, another configuration entity, or non-entity configuration) or your code would result in a change to this entity itself, you need to check and see if this entity change is part of an uninstall process, and skip executing your code if that is the case.

For example, \Drupal\language\Entity\ConfigurableLanguage::preDelete() prevents the API from deleting the default language. However during an uninstall of the language module it is expected that the default language should be deleted.

Returns the value of a property.

Sets the value of a property.

Calculates dependencies and stores them in the dependency property.

Informs the entity that entities it depends on will be deleted.

This method allows configuration entities to remove dependencies instead of being deleted themselves. Configuration entities can use this method to avoid being unnecessarily deleted during an extension uninstallation. For example, entity displays remove references to widgets and formatters if the plugin that supplies them depends on a module that is being uninstalled.

If this method returns TRUE then the entity needs to be re-saved by the caller for the changes to take effect. Implementations should not save the entity.

Gets the configuration dependencies.

Checks whether this entity is installable.

For example, a default view might not be installable if the base table doesn't exist.

Sets that the data should be trusted.

If the data is trusted then dependencies will not be calculated on save and schema will not be used to cast the values. Generally this is only used during module and theme installation. Once the config entity has been saved the data will no longer be marked as trusted. This is an optimization for creation of configuration during installation.

Gets whether on not the data is trusted.

Returns the machine name of the field.

This defines how the field data is accessed from the entity. For example, if the field name is "foo", then $entity->foo returns its data.

Returns the field type.

Returns the storage settings.

Each field type defines the settings that are meaningful for that type. For example, a text field can define a 'max_length' setting, and an image field can define an 'alt_field_required' setting.

The method always returns an array of all available settings for this field type, possibly with the default values merged in if values have not been provided for all available settings.

Returns the value of a given storage setting.

Returns whether the field supports translation.

Sets whether the field is translatable.

Returns whether the field storage is revisionable.

Note that if the entity type is revisionable and the field storage has a cardinality higher than 1, the field storage is considered revisionable by default.

Returns the human-readable label for the field.

Returns the human-readable description for the field.

This is displayed in addition to the label in places where additional descriptive information is helpful. For example, as help text below the form element in entity edit forms.

Gets an options provider for the given field item property.

Returns whether the field can contain multiple items.

Returns the maximum number of items allowed for the field.

Possible values are positive integers or FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.

Gets the definition of a contained property.

Gets an array of property definitions of contained properties.

Returns the names of the field's subproperties.

A field is a list of items, and each item can contain one or more properties. All items for a given field contain the same property names, but the values can be different for each item.

For example, an email field might just contain a single 'value' property, while a link field might contain 'title' and 'url' properties, and a text field might contain 'value', 'summary', and 'format' properties.

Returns the name of the main property, if any.

Some field items consist mainly of one main property, e.g. the value of a text field or the @code target_id @endcode of an entity reference. If the field item has no main property, the method returns NULL.

Returns the ID of the entity type the field is attached to.

This method should not be confused with EntityInterface::getEntityTypeId() (configurable fields are config entities, and thus implement both interfaces):

• FieldStorageDefinitionInterface::getTargetEntityTypeId() answers "as a field storage, which entity type are you attached to?".
• EntityInterface::getEntityTypeId() answers "as a (config) entity, what is your own entity type?".

Returns the field schema.

Note that this method returns an empty array for computed fields which have no schema.

Returns the field columns, as defined in the field schema.

Returns an array of validation constraints.

See \Drupal\Core\TypedData\DataDefinitionInterface::getConstraints() for details.

Returns a validation constraint.

See \Drupal\Core\TypedData\DataDefinitionInterface::getConstraints() for details.

Returns the name of the provider of this field.

Returns the storage behavior for this field.

Indicates whether the entity type's storage should take care of storing the field values or whether it is handled separately; e.g. by the module providing the field.

Determines whether the field is a base field.

Base fields are not specific to a given bundle or a set of bundles. This excludes configurable fields, as they are always attached to a specific bundle.

Returns a unique identifier for the field storage.

Returns whether the field is deleted or not.

Returns the name of the module providing the field type.

Returns the list of bundles where the field storage has fields.

Checks if the field storage can be deleted.

Returns whether the field storage is locked or not.

Sets the locked flag.

Sets the maximum number of items allowed for the field.

Sets the value for a field setting by name.

Sets field storage settings.

Note that the method does not unset existing settings not specified in the incoming $settings array.

For example:

Returns the custom storage indexes for the field data storage.

Sets the custom storage indexes for the field data storage.

.