Entity Definition Update Manager Class

PreviousConfigure Level of Logging and Errors NextModule Installer Factory Class

Last updated 1 year ago

Entity Definition Update Manager Class

Provides developers with a class to perform automatic entity updates.

Use only in the development environment. Not to use on production websites.

Support for automatic entity updates has been removed

User deprecated function: EntityDefinitionUpdateManagerInterface::applyUpdates() was deprecated in Drupal 8.7.0 and was removed before Drupal 9.0.0.

How to Use Entity Definition Update Manager Class

Customized class for the entity definition update manager.

1. Require the Package in Your Module or Project

$ composer require vardot/entity-definition-update-manager:~1.0

Or add the package to your composer.json file

    "vardot/entity-definition-update-manager": "~1.0",

2. Add The Needed Namespaces

Add the following namespace in custom modules or custom installation profiles.

use Vardot\Entity\EntityDefinitionUpdateManager;

3. Do Any Type of Configuration Import or Updates

Import or update configs in hook install or hook update, or any post install or post update.

4. Run the Drupal Class Resolver for the Instance From the Definition Class

  // Entity updates to clear up any mismatched entity and/or field definitions
  // And Fix changes were detected in the entity type and field definitions.
  \Drupal::classResolver()
    ->getInstanceFromDefinition(EntityDefinitionUpdateManager::class)
    ->applyUpdates();

Example Use On Installations

Varbase Core is important number of managed configurations on install. It needed to update entity definitions after that.

Have a look at the varbase_core_install hook function

Example Use On Updates

Varbase API in some point needed to update configurations in a hook update. It needed to update entity definitions after that. Which did not work without entity definition update.

Have a look at the varbase_api_update_8702 hook function

Example Use On Custom Template Config Imports

Having custom and managed config templates. Which on import to the active config for selected entity types or fields.
Entity definitions need to be auto updated
Field definitions need to be auto updated.

Have a look at the following commit to use in Custom Config Import Classes

When to Use and When Not to Use?

Do not use when the import/update of configs works in the normal way.

If all configs are in the config/install and no issues on install.

Use when custom managed configs just have been imported or updated in a custom order, And custom actions or changes in between imports are being involved.

If the module or profile has number of optional or managed configs. Which located in config/optional or config/managed or any other custom physical locations.

When importing or updating with custom Drupal Config Factory or Drupal Install Factory.

PreviousConfigure Level of Logging and Errors NextModule Installer Factory Class

Last updated 1 year ago

Provides developers with a class to perform automatic entity updates.

Use only in the development environment. Not to use on production websites.

Support for automatic entity updates has been removed

User deprecated function: EntityDefinitionUpdateManagerInterface::applyUpdates() was deprecated in Drupal 8.7.0 and was removed before Drupal 9.0.0.

How to Use Entity Definition Update Manager Class

Customized class for the entity definition update manager.

1. Require the Package in Your Module or Project

$ composer require vardot/entity-definition-update-manager:~1.0

Or add the package to your composer.json file

    "vardot/entity-definition-update-manager": "~1.0",

2. Add The Needed Namespaces

Add the following namespace in custom modules or custom installation profiles.

use Vardot\Entity\EntityDefinitionUpdateManager;

3. Do Any Type of Configuration Import or Updates

Import or update configs in hook install or hook update, or any post install or post update.

4. Run the Drupal Class Resolver for the Instance From the Definition Class

  // Entity updates to clear up any mismatched entity and/or field definitions
  // And Fix changes were detected in the entity type and field definitions.
  \Drupal::classResolver()
    ->getInstanceFromDefinition(EntityDefinitionUpdateManager::class)
    ->applyUpdates();

Example Use On Installations

Varbase Core is important number of managed configurations on install. It needed to update entity definitions after that.

Have a look at the varbase_core_install hook function

Example Use On Updates

Varbase API in some point needed to update configurations in a hook update. It needed to update entity definitions after that. Which did not work without entity definition update.

Have a look at the varbase_api_update_8702 hook function

Example Use On Custom Template Config Imports

Having custom and managed config templates. Which on import to the active config for selected entity types or fields.
Entity definitions need to be auto updated
Field definitions need to be auto updated.

Have a look at the following commit to use in Custom Config Import Classes

When to Use and When Not to Use?

Do not use when the import/update of configs works in the normal way.

If all configs are in the config/install and no issues on install.

Use when custom managed configs just have been imported or updated in a custom order, And custom actions or changes in between imports are being involved.

If the module or profile has number of optional or managed configs. Which located in config/optional or config/managed or any other custom physical locations.

When importing or updating with custom Drupal Config Factory or Drupal Install Factory.

Must run at least ones at the end of each installation steps for installation profiles like , , .