EntityDefinitionUpdateManagerInterface
interface EntityDefinitionUpdateManagerInterface (View source)
Defines an interface for managing entity definition updates.
During the application lifetime, the definitions of various entity types and their data components (e.g., fields for fieldable entity types) can change. For example, updated code can be deployed. Some entity handlers may need to perform complex or long-running logic in response to the change. For example, a SQL-based storage handler may need to update the database schema.
To support this, \Drupal\Core\Entity\EntityLastInstalledSchemaRepositoryInterface has methods to retrieve the last installed definitions as well as the definitions specified by the current codebase. It also has create/update/delete methods to bring the former up to date with the latter.
However, it is not the responsibility of the entity manager to decide how to report the differences or when to apply each update. This interface is for managing that.
This interface also provides methods to retrieve instances of the definitions to be updated ready to be manipulated. In fact when definitions change in code the system needs to be notified about that and the definitions stored in state need to be reconciled with the ones living in code. This typically happens in Update API functions, which need to take the system from a known state to another known state. Relying on the definitions living in code might prevent this, as the system might transition directly to the last available state, and thus skipping the intermediate steps. Manipulating the definitions in state allows to avoid this and ensures that the various steps of the update process are predictable and repeatable.
Constants
| DEFINITION_CREATED |
Indicates that a definition has just been created. |
| DEFINITION_UPDATED |
Indicates that a definition has changes. |
| DEFINITION_DELETED |
Indicates that a definition has just been deleted. |
Methods
Checks if there are any definition updates that need to be applied.
Gets a human readable summary of the detected changes.
Gets a list of changes to entity type and field storage definitions.
Returns an entity type definition ready to be manipulated.
Returns all the entity type definitions, ready to be manipulated.
Installs a new fieldable entity type definition.
Applies any change performed to the passed entity type definition.
Applies any change performed to a fieldable entity type definition.
Returns a field storage definition ready to be manipulated.
Installs a new field storage definition.
Applies any change performed to the passed field storage definition.
Uninstalls a field storage definition.
Details
bool
needsUpdates()
Checks if there are any definition updates that need to be applied.
array
getChangeSummary()
Gets a human readable summary of the detected changes.
array
getChangeList()
Gets a list of changes to entity type and field storage definitions.
applyUpdates()
deprecated
deprecated
Applies all the detected valid changes.
Use this with care, as it will apply updates for any module, which will lead to unpredictable results.
EntityTypeInterface
getEntityType(string $entity_type_id)
Returns an entity type definition ready to be manipulated.
When needing to apply updates to existing entity type definitions, this method should always be used to retrieve a definition ready to be manipulated.
EntityTypeInterface[]
getEntityTypes()
Returns all the entity type definitions, ready to be manipulated.
When needing to apply updates to existing entity type definitions, this method should always be used to retrieve all the definitions ready to be manipulated.
installEntityType(EntityTypeInterface $entity_type)
Installs a new entity type definition.
installFieldableEntityType(EntityTypeInterface $entity_type, array $field_storage_definitions)
Installs a new fieldable entity type definition.
updateEntityType(EntityTypeInterface $entity_type)
Applies any change performed to the passed entity type definition.
uninstallEntityType(EntityTypeInterface $entity_type)
Uninstalls an entity type definition.
updateFieldableEntityType(EntityTypeInterface $entity_type, array $field_storage_definitions, array $sandbox = NULL)
Applies any change performed to a fieldable entity type definition.
FieldStorageDefinitionInterface
getFieldStorageDefinition(string $name, string $entity_type_id)
Returns a field storage definition ready to be manipulated.
When needing to apply updates to existing field storage definitions, this method should always be used to retrieve a storage definition ready to be manipulated.
installFieldStorageDefinition(string $name, string $entity_type_id, string $provider, FieldStorageDefinitionInterface $storage_definition)
Installs a new field storage definition.
updateFieldStorageDefinition(FieldStorageDefinitionInterface $storage_definition)
Applies any change performed to the passed field storage definition.
uninstallFieldStorageDefinition(FieldStorageDefinitionInterface $storage_definition)
Uninstalls a field storage definition.