public function DependentPluginInterface::calculateDependencies in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Component/Plugin/DependentPluginInterface.php \Drupal\Component\Plugin\DependentPluginInterface::calculateDependencies()

Calculates dependencies for the configured plugin.

Dependencies are saved in the plugin's configuration entity and are used to determine configuration synchronization order. For example, if the plugin integrates with specific user roles, this method should return an array of dependencies listing the specified roles.

Return value

array An array of dependencies grouped by type (config, content, module, theme). For example:

array(
  'config' => array(
    'user.role.anonymous',
    'user.role.authenticated',
  ),
  'content' => array(
    'node:article:f0a189e6-55fb-47fb-8005-5bef81c44d6d',
  ),
  'module' => array(
    'node',
    'user',
  ),
  'theme' => array(
    'seven',
  ),
);

See also

\Drupal\Core\Config\Entity\ConfigDependencyManager

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

20 methods override DependentPluginInterface::calculateDependencies()

AggregatorPluginSettingsBase::calculateDependencies in core/modules/aggregator/src/Plugin/AggregatorPluginSettingsBase.php

Calculates dependencies for the configured plugin.

ConditionPluginBase::calculateDependencies in core/lib/Drupal/Core/Condition/ConditionPluginBase.php

Calculates dependencies for the configured plugin.

Config::calculateDependencies in core/modules/migrate/src/Plugin/migrate/destination/Config.php

Calculates dependencies for the configured plugin.

ConfigurableActionBase::calculateDependencies in core/lib/Drupal/Core/Action/ConfigurableActionBase.php

Calculates dependencies for the configured plugin.

ConfigurableSearchPluginBase::calculateDependencies in core/modules/search/src/Plugin/ConfigurableSearchPluginBase.php

Calculates dependencies for the configured plugin.

... See full list

File

core/lib/Drupal/Component/Plugin/DependentPluginInterface.php, line 35

Class

DependentPluginInterface

Provides an interface for a plugin that has dependencies.

Namespace

Drupal\Component\Plugin

Code

public function calculateDependencies();