class ConfigDependencyManager

Same name in other branches
  1. 9 core/lib/Drupal/Core/Config/Entity/ConfigDependencyManager.php \Drupal\Core\Config\Entity\ConfigDependencyManager
  2. 8.9.x core/lib/Drupal/Core/Config/Entity/ConfigDependencyManager.php \Drupal\Core\Config\Entity\ConfigDependencyManager
  3. 11.x core/lib/Drupal/Core/Config/Entity/ConfigDependencyManager.php \Drupal\Core\Config\Entity\ConfigDependencyManager

Provides a class to discover configuration entity dependencies.

Configuration entities can depend on modules, themes and other configuration entities. The dependency system is used during configuration installation, uninstallation, and synchronization to ensure that configuration entities are handled in the correct order. For example, node types are created before their fields, and both are created before the view display configuration.

The configuration dependency value is structured like this:


[
  'config' => [
    // An array of configuration entity object names. Recalculated on save.
  ],
  'content' => [
    // An array of content entity configuration dependency names. The default
    // format is "ENTITY_TYPE_ID:BUNDLE:UUID". Recalculated on save.
  ],
  'module' => [
    // An array of module names. Recalculated on save.
  ],
  'theme' => [
    // An array of theme names. Recalculated on save.
  ],
  'enforced' => [
    // An array of configuration dependencies that the config entity is
    // ensured to have regardless of the details of the configuration. These
    // dependencies are not recalculated on save.
    'config' => [],
    'content' => [],
    'module' => [],
    'theme' => [],
  ),
];

Configuration entity dependencies are recalculated on save based on the current values of the configuration. For example, a filter format will depend on the modules that provide the filter plugins it configures. The filter format can be reconfigured to use a different filter plugin provided by another module. If this occurs, the dependencies will be recalculated on save and the old module will be removed from the list of dependencies and replaced with the new one.

Configuration entity classes usually extend \Drupal\Core\Config\Entity\ConfigEntityBase. The base class provides a generic implementation of the calculateDependencies() method that can discover dependencies due to plugins, and third party settings. If the configuration entity has dependencies that cannot be discovered by the base class's implementation, then it needs to implement \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies() to calculate the dependencies. In this method, use \Drupal\Core\Config\Entity\ConfigEntityBase::addDependency() to add dependencies. Implementations should call the base class implementation to inherit the generic functionality.

Some configuration entities have dependencies from plugins and third-party settings; these dependencies can be collected by \Drupal\Core\Config\Entity\ConfigEntityBase::calculateDependencies(). Entities with third-party settings need to implement \Drupal\Core\Config\Entity\ThirdPartySettingsInterface in order to trigger this generic dependency collection. Entities with plugin dependencies need to implement \Drupal\Core\Entity\EntityWithPluginCollectionInterface; this causes the base calculateDependencies() method to add the plugins' providers as dependencies, as well as dependencies declared in the "config_dependencies" key from the plugins' definitions. In addition, plugins that implement \Drupal\Component\Plugin\ConfigurablePluginInterface can declare additional dependencies using \Drupal\Component\Plugin\DependentPluginInterface::calculateDependencies(), and these will also be collected by the base method.

If an extension author wants a configuration entity to depend on something that is not calculable then they can add these dependencies to the enforced dependencies key. For example, a custom module that provides a node type can have that type deleted when the module is uninstalled, if it has an enforced dependency on the module. The dependency on the custom module can not be calculated since there is nothing inherent in the state of the node type configuration entity that depends on functionality provided by the custom module.

Once declared properly, dependencies are saved to the configuration entity's configuration object so that they can be checked without the module that provides the configuration entity class being installed. This is important for configuration synchronization, which needs to be able to validate configuration in the sync directory before the synchronization has occurred. Also, if you have a configuration entity object and you want to get the current dependencies (without recalculation), you can use \Drupal\Core\Config\Entity\ConfigEntityInterface::getDependencies().

When uninstalling a module or a theme, configuration entities that are dependent will also be removed. This default behavior can lead to undesirable side effects, such as a node view mode being entirely removed when the module defining a field or formatter it uses is uninstalled. To prevent this, configuration entity classes can implement \Drupal\Core\Config\Entity\ConfigEntityInterface::onDependencyRemoval(), which allows the entity class to remove dependencies instead of being deleted themselves. Implementations should save the entity if dependencies have been successfully removed, in order to register the newly cleaned-out dependency list. So, for example, the node view mode configuration entity class should implement this method to remove references to formatters if the plugin that supplies them depends on a module that is being uninstalled.

If a configuration entity is provided as default configuration by an extension (module, theme, or profile), the extension has to depend on any modules or themes that the configuration depends on. For example, if a view configuration entity is provided by an installation profile and the view will not work without a certain module, the profile must declare a dependency on this module in its info.yml file. If you do not want your extension to always depend on a particular module that one of its default configuration entities depends on, you can use a sub-module: move the configuration entity to the sub-module instead of including it in the main extension, and declare the module dependency in the sub-module only.

Hierarchy

Expanded class hierarchy of ConfigDependencyManager

See also

\Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies()

\Drupal\Core\Config\Entity\ConfigEntityInterface::getDependencies()

\Drupal\Core\Config\Entity\ConfigEntityInterface::onDependencyRemoval()

\Drupal\Core\Config\Entity\ConfigEntityBase::addDependency()

\Drupal\Core\Config\Entity\ConfigEntityBase::calculateDependencies()

\Drupal\Core\Config\ConfigInstallerInterface::installDefaultConfig()

\Drupal\Core\Config\ConfigManagerInterface::uninstall()

\Drupal\Core\Config\Entity\ConfigEntityDependency

\Drupal\Core\Entity\EntityInterface::getConfigDependencyName()

\Drupal\Core\Plugin\PluginDependencyTrait

6 files declare their use of ConfigDependencyManager
ConfigDependencyManagerTest.php in core/tests/Drupal/Tests/Core/Config/ConfigDependencyManagerTest.php
ConfigDependencyManagerTest.php in core/tests/Drupal/Tests/Core/Config/Entity/ConfigDependencyManagerTest.php
ConfigInstaller.php in core/lib/Drupal/Core/Config/ConfigInstaller.php
ConfigManager.php in core/lib/Drupal/Core/Config/ConfigManager.php
RecipeConfigInstaller.php in core/lib/Drupal/Core/Recipe/RecipeConfigInstaller.php

... See full list

File

core/lib/Drupal/Core/Config/Entity/ConfigDependencyManager.php, line 132

Namespace

Drupal\Core\Config\Entity
View source
class ConfigDependencyManager {
    
    /**
     * The config entity data.
     *
     * @var \Drupal\Core\Config\Entity\ConfigEntityDependency[]
     */
    protected $data = [];
    
    /**
     * The directed acyclic graph.
     *
     * @var array
     */
    protected $graph;
    
    /**
     * Gets dependencies.
     *
     * @param string $type
     *   The type of dependency being checked. Either 'module', 'theme', 'config'
     *   or 'content'.
     * @param string $name
     *   The specific name to check. If $type equals 'module' or 'theme' then it
     *   should be a module name or theme name. In the case of entity it should be
     *   the full configuration object name.
     *
     * @return \Drupal\Core\Config\Entity\ConfigEntityDependency[]
     *   An array of config entity dependency objects that are dependent.
     */
    public function getDependentEntities($type, $name) {
        $dependent_entities = [];
        $entities_to_check = [];
        if ($type == 'config') {
            $entities_to_check[] = $name;
        }
        else {
            if ($type == 'module' || $type == 'theme' || $type == 'content') {
                $dependent_entities = array_filter($this->data, function (ConfigEntityDependency $entity) use ($type, $name) {
                    return $entity->hasDependency($type, $name);
                });
            }
            // If checking content, module, or theme dependencies, discover which
            // entities are dependent on the entities that have a direct dependency.
            foreach ($dependent_entities as $entity) {
                $entities_to_check[] = $entity->getConfigDependencyName();
            }
        }
        $dependencies = array_merge($this->createGraphConfigEntityDependencies($entities_to_check), $dependent_entities);
        // Sort dependencies in the reverse order of the graph. So the least
        // dependent is at the top. For example, this ensures that fields are
        // always after field storages. This is because field storages need to be
        // created before a field.
        $graph = $this->getGraph();
        $sorts = $this->prepareMultisort($graph, [
            'weight',
            'name',
        ]);
        array_multisort($sorts['weight'], SORT_DESC, SORT_NUMERIC, $sorts['name'], SORT_ASC, SORT_NATURAL | SORT_FLAG_CASE, $graph);
        return array_replace(array_intersect_key($graph, $dependencies), $dependencies);
    }
    
    /**
     * Extracts data from the graph for use in array_multisort().
     *
     * @param array $graph
     *   The graph to extract data from.
     * @param array $keys
     *   The keys whose values to extract.
     *
     * @return array
     *   An array keyed by the $keys passed in. The values are arrays keyed by the
     *   row from the graph and the value is the corresponding value for the key
     *   from the graph.
     */
    protected function prepareMultisort($graph, $keys) {
        $return = array_fill_keys($keys, []);
        foreach ($graph as $graph_key => $graph_row) {
            foreach ($keys as $key) {
                $return[$key][$graph_key] = $graph_row[$key];
            }
        }
        return $return;
    }
    
    /**
     * Sorts the dependencies in order of most dependent last.
     *
     * @return array
     *   The list of entities in order of most dependent last, otherwise
     *   alphabetical.
     */
    public function sortAll() {
        $graph = $this->getGraph();
        // Sort by weight and alphabetically. The most dependent entities
        // are last and entities with the same weight are alphabetically ordered.
        $sorts = $this->prepareMultisort($graph, [
            'weight',
            'name',
        ]);
        array_multisort($sorts['weight'], SORT_ASC, SORT_NUMERIC, $sorts['name'], SORT_ASC, SORT_NATURAL | SORT_FLAG_CASE, $graph);
        // Use array_intersect_key() to exclude modules and themes from the list.
        return array_keys(array_intersect_key($graph, $this->data));
    }
    
    /**
     * Creates a graph of config entity dependencies.
     *
     * @param array $entities_to_check
     *   The configuration entity full configuration names to determine the
     *   dependencies for.
     *
     * @return \Drupal\Core\Config\Entity\ConfigEntityDependency[]
     *   A graph of config entity dependency objects that are dependent on the
     *   supplied entities to check.
     */
    protected function createGraphConfigEntityDependencies($entities_to_check) {
        $dependent_entities = [];
        $graph = $this->getGraph();
        foreach ($entities_to_check as $entity) {
            if (isset($graph[$entity]) && !empty($graph[$entity]['paths'])) {
                foreach ($graph[$entity]['paths'] as $dependency => $value) {
                    if (isset($this->data[$dependency])) {
                        $dependent_entities[$dependency] = $this->data[$dependency];
                    }
                }
            }
        }
        return $dependent_entities;
    }
    
    /**
     * Gets the dependency graph of all the config entities.
     *
     * @return array
     *   The dependency graph of all the config entities.
     */
    protected function getGraph() {
        if (!isset($this->graph)) {
            $graph = [];
            foreach ($this->data as $entity) {
                $graph_key = $entity->getConfigDependencyName();
                if (!isset($graph[$graph_key])) {
                    $graph[$graph_key] = [
                        'edges' => [],
                        'name' => $graph_key,
                    ];
                }
                // Include all dependencies in the graph so that topographical sorting
                // works.
                foreach (array_merge($entity->getDependencies('config'), $entity->getDependencies('module'), $entity->getDependencies('theme')) as $dependency) {
                    $graph[$dependency]['edges'][$graph_key] = TRUE;
                    $graph[$dependency]['name'] = $dependency;
                }
            }
            // Ensure that order of the graph is consistent.
            krsort($graph);
            $graph_object = new Graph($graph);
            $this->graph = $graph_object->searchAndSort();
        }
        return $this->graph;
    }
    
    /**
     * Sets data to calculate dependencies for.
     *
     * The data is converted into lightweight ConfigEntityDependency objects.
     *
     * @param array $data
     *   Configuration data keyed by configuration object name. Typically the
     *   output of \Drupal\Core\Config\StorageInterface::loadMultiple().
     *
     * @return $this
     */
    public function setData(array $data) {
        array_walk($data, function (&$config, $name) {
            $config = new ConfigEntityDependency($name, $config);
        });
        $this->data = $data;
        $this->graph = NULL;
        return $this;
    }
    
    /**
     * Updates one of the lightweight ConfigEntityDependency objects.
     *
     * @param $name
     *   The configuration dependency name.
     * @param array $dependencies
     *   The configuration dependencies. The array is structured like this:
     *   @code
     *   [
     *     'config' => [
     *       // An array of configuration entity object names.
     *     ],
     *     'content' => [
     *       // An array of content entity configuration dependency names. The default
     *       // format is "ENTITY_TYPE_ID:BUNDLE:UUID".
     *     ],
     *     'module' => [
     *       // An array of module names.
     *     ],
     *     'theme' => [
     *       // An array of theme names.
     *     ],
     *   ];
     *   @endcode
     *
     * @return $this
     */
    public function updateData($name, array $dependencies) {
        $this->graph = NULL;
        $this->data[$name] = new ConfigEntityDependency($name, [
            'dependencies' => $dependencies,
        ]);
        return $this;
    }

}

Members

Title Sort descending Modifiers Object type Summary
ConfigDependencyManager::$data protected property The config entity data.
ConfigDependencyManager::$graph protected property The directed acyclic graph.
ConfigDependencyManager::createGraphConfigEntityDependencies protected function Creates a graph of config entity dependencies.
ConfigDependencyManager::getDependentEntities public function Gets dependencies.
ConfigDependencyManager::getGraph protected function Gets the dependency graph of all the config entities.
ConfigDependencyManager::prepareMultisort protected function Extracts data from the graph for use in array_multisort().
ConfigDependencyManager::setData public function Sets data to calculate dependencies for.
ConfigDependencyManager::sortAll public function Sorts the dependencies in order of most dependent last.
ConfigDependencyManager::updateData public function Updates one of the lightweight ConfigEntityDependency objects.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.