final class CustomEntityDefinitionUpdateManager in Entity Update 2.0.x
Development version of the entity definition update manager.
Hierarchy
- class \Drupal\entity_update\CustomEntityDefinitionUpdateManager implements ContainerInjectionInterface
Expanded class hierarchy of CustomEntityDefinitionUpdateManager
1 string reference to 'CustomEntityDefinitionUpdateManager'
1 service uses CustomEntityDefinitionUpdateManager
File
- src/
CustomEntityDefinitionUpdateManager.php, line 19
Namespace
Drupal\entity_updateView source
final class CustomEntityDefinitionUpdateManager implements ContainerInjectionInterface {
/**
* The entity definition update manager.
*
* @var \Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface
*/
public $entityDefinitionUpdateManager;
/**
* The last installed schema repository.
*
* @var \Drupal\Core\Entity\EntityLastInstalledSchemaRepositoryInterface
*/
public $entityLastInstalledSchemaRepository;
/**
* The entity type manager service.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
public $entityTypeManager;
/**
* The entity type listener service.
*
* @var \Drupal\Core\Entity\EntityTypeListenerInterface
*/
public $entityTypeListener;
/**
* The entity field manager service.
*
* @var \Drupal\Core\Entity\EntityFieldManagerInterface
*/
public $entityFieldManager;
/**
* The field storage definition listener service.
*
* @var \Drupal\Core\Field\FieldStorageDefinitionListenerInterface
*/
public $fieldStorageDefinitionListener;
/**
* Constructs a new EntityDefinitionUpdateManager.
*
* @param \Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface $entity_definition_update_manager
* The entity definition update manager.
* @param \Drupal\Core\Entity\EntityLastInstalledSchemaRepositoryInterface $entity_last_installed_schema_repository
* The last installed schema repository service.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager service.
* @param \Drupal\Core\Entity\EntityTypeListenerInterface $entity_type_listener
* The entity type listener interface.
* @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
* The entity field manager service.
* @param \Drupal\Core\Field\FieldStorageDefinitionListenerInterface $field_storage_definition_listener
* The field storage definition listener service.
*/
public function __construct(EntityDefinitionUpdateManagerInterface $entity_definition_update_manager, EntityLastInstalledSchemaRepositoryInterface $entity_last_installed_schema_repository, EntityTypeManagerInterface $entity_type_manager, EntityTypeListenerInterface $entity_type_listener, EntityFieldManagerInterface $entity_field_manager, FieldStorageDefinitionListenerInterface $field_storage_definition_listener) {
$this->entityDefinitionUpdateManager = $entity_definition_update_manager;
$this->entityLastInstalledSchemaRepository = $entity_last_installed_schema_repository;
$this->entityTypeManager = $entity_type_manager;
$this->entityTypeListener = $entity_type_listener;
$this->entityFieldManager = $entity_field_manager;
$this->fieldStorageDefinitionListener = $field_storage_definition_listener;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('entity.definition_update_manager'), $container
->get('entity.last_installed_schema.repository'), $container
->get('entity_type.manager'), $container
->get('entity_type.listener'), $container
->get('entity_field.manager'), $container
->get('field_storage_definition.listener'));
}
/**
* Applies all the detected valid changes.
*/
public function applyUpdates() {
// Ensure this works also on Drupal 8.6 and earlier.
$reflector = new \ReflectionMethod($this->entityDefinitionUpdateManager, 'getChangeList');
$reflector
->setAccessible(TRUE);
$complete_change_list = $reflector
->invoke($this->entityDefinitionUpdateManager);
if ($complete_change_list) {
// EntityDefinitionUpdateManagerInterface::getChangeList() only disables
// the cache and does not invalidate. In case there are changes,
// explicitly invalidate caches.
$this->entityTypeManager
->clearCachedDefinitions();
$this->entityFieldManager
->clearCachedFieldDefinitions();
}
foreach ($complete_change_list as $entity_type_id => $change_list) {
// Process entity type definition changes before storage definitions ones
// this is necessary when you change an entity type from non-revisionable
// to revisionable and at the same time add revisionable fields to the
// entity type.
if (!empty($change_list['entity_type'])) {
$this
->doEntityUpdate($change_list['entity_type'], $entity_type_id);
}
// Process field storage definition changes.
if (!empty($change_list['field_storage_definitions'])) {
$storage_definitions = $this->entityFieldManager
->getFieldStorageDefinitions($entity_type_id);
$original_storage_definitions = $this->entityLastInstalledSchemaRepository
->getLastInstalledFieldStorageDefinitions($entity_type_id);
foreach ($change_list['field_storage_definitions'] as $field_name => $change) {
$storage_definition = isset($storage_definitions[$field_name]) ? $storage_definitions[$field_name] : NULL;
$original_storage_definition = isset($original_storage_definitions[$field_name]) ? $original_storage_definitions[$field_name] : NULL;
$this
->doFieldUpdate($change, $storage_definition, $original_storage_definition);
}
}
}
}
/**
* Performs an entity type definition update.
*
* @param string $op
* The operation to perform, either static::DEFINITION_CREATED or
* static::DEFINITION_UPDATED.
* @param string $entity_type_id
* The entity type ID.
*/
public function doEntityUpdate($op, $entity_type_id) {
$entity_type = $this->entityTypeManager
->getDefinition($entity_type_id);
switch ($op) {
case EntityDefinitionUpdateManagerInterface::DEFINITION_CREATED:
$this->entityTypeListener
->onEntityTypeCreate($entity_type);
break;
case EntityDefinitionUpdateManagerInterface::DEFINITION_UPDATED:
$original = $this->entityLastInstalledSchemaRepository
->getLastInstalledDefinition($entity_type_id);
$storage = $this->entityTypeManager
->getStorage($entity_type
->id());
if ($storage instanceof EntityStorageSchemaInterface && $storage
->requiresEntityDataMigration($entity_type, $original)) {
throw new \InvalidArgumentException('The entity schema update for the ' . $entity_type
->id() . ' entity type requires a data migration.');
}
$field_storage_definitions = $this->entityFieldManager
->getFieldStorageDefinitions($entity_type_id);
$original_field_Storage_definitions = $this->entityLastInstalledSchemaRepository
->getLastInstalledFieldStorageDefinitions($entity_type_id);
$this->entityTypeListener
->onFieldableEntityTypeUpdate($entity_type, $original, $field_storage_definitions, $original_field_Storage_definitions);
break;
}
}
/**
* Performs a field storage definition update.
*
* @param string $op
* The operation to perform, possible values are:
* - EntityDefinitionUpdateManagerInterface::DEFINITION_CREATED
* - EntityDefinitionUpdateManagerInterface::DEFINITION_UPDATED
* - EntityDefinitionUpdateManagerInterface::DEFINITION_DELETED.
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface|null $storage_definition
* (optional) The new field storage definition. Defaults to none.
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface|null $original_storage_definition
* (optional) The original field storage definition. Defaults to none.
*/
public function doFieldUpdate($op, FieldStorageDefinitionInterface $storage_definition = NULL, FieldStorageDefinitionInterface $original_storage_definition = NULL) {
switch ($op) {
case EntityDefinitionUpdateManagerInterface::DEFINITION_CREATED:
$this->fieldStorageDefinitionListener
->onFieldStorageDefinitionCreate($storage_definition);
break;
case EntityDefinitionUpdateManagerInterface::DEFINITION_UPDATED:
if ($storage_definition && $original_storage_definition) {
$this->fieldStorageDefinitionListener
->onFieldStorageDefinitionUpdate($storage_definition, $original_storage_definition);
}
break;
case EntityDefinitionUpdateManagerInterface::DEFINITION_DELETED:
if ($original_storage_definition) {
$this->fieldStorageDefinitionListener
->onFieldStorageDefinitionDelete($original_storage_definition);
}
break;
}
}
/**
* Gets a list of changes to entity type and field storage definitions.
*
* @return array
* An associative array keyed by entity type id of change descriptors. Every
* entry is an associative array with the following optional keys:
* - entity_type: a scalar having only the DEFINITION_UPDATED value.
* - field_storage_definitions: an associative array keyed by field name of
* scalars having one value among:
* - DEFINITION_CREATED
* - DEFINITION_UPDATED
* - DEFINITION_DELETED
*/
public function getChangeList() {
// Ensure this works also on Drupal 8.6 and earlier.
$reflector = new \ReflectionMethod($this->entityDefinitionUpdateManager, 'getChangeList');
$reflector
->setAccessible(TRUE);
$complete_change_list = $reflector
->invoke($this->entityDefinitionUpdateManager);
if ($complete_change_list) {
// EntityDefinitionUpdateManagerInterface::getChangeList() only disables
// the cache and does not invalidate. In case there are changes,
// explicitly invalidate caches.
$this->entityTypeManager
->clearCachedDefinitions();
$this->entityFieldManager
->clearCachedFieldDefinitions();
}
return $complete_change_list;
}
}