You are here

public function HandlerBase::calculateDependencies in Drupal 9

Same name and namespace in other branches

8 core/modules/views/src/Plugin/views/HandlerBase.php \Drupal\views\Plugin\views\HandlerBase::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',
  ),
);

Overrides PluginBase::calculateDependencies

See also

\Drupal\Core\Config\Entity\ConfigDependencyManager

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

8 calls to HandlerBase::calculateDependencies()

Bundle::calculateDependencies in core/modules/views/src/Plugin/views/filter/Bundle.php: Calculates dependencies for the configured plugin.
Entity::calculateDependencies in core/modules/views/src/Plugin/views/area/Entity.php: Calculates dependencies for the configured plugin.
EntityField::calculateDependencies in core/modules/views/src/Plugin/views/field/EntityField.php: Calculates dependencies for the configured plugin.
ModerationStateFilter::calculateDependencies in core/modules/content_moderation/src/Plugin/views/filter/ModerationStateFilter.php: Calculates dependencies for the configured plugin.
RelationshipPluginBase::calculateDependencies in core/modules/views/src/Plugin/views/relationship/RelationshipPluginBase.php: Calculates dependencies for the configured plugin.

... See full list

10 methods override HandlerBase::calculateDependencies()

ArgumentPluginBase::calculateDependencies in core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php: Calculates dependencies for the configured plugin.
Bundle::calculateDependencies in core/modules/views/src/Plugin/views/filter/Bundle.php: Calculates dependencies for the configured plugin.
Entity::calculateDependencies in core/modules/views/src/Plugin/views/area/Entity.php: Calculates dependencies for the configured plugin.
EntityField::calculateDependencies in core/modules/views/src/Plugin/views/field/EntityField.php: Calculates dependencies for the configured plugin.
ModerationStateFilter::calculateDependencies in core/modules/content_moderation/src/Plugin/views/filter/ModerationStateFilter.php: Calculates dependencies for the configured plugin.

... See full list

File

core/modules/views/src/Plugin/views/HandlerBase.php, line 858

Class

HandlerBase: Base class for Views handler plugins.

Namespace

Drupal\views\Plugin\views

Code

public function calculateDependencies() {
  $dependencies = parent::calculateDependencies();
  if ($this->table) {

    // Ensure that the view depends on the module that provides the table.
    $data = $this
      ->getViewsData()
      ->get($this->table);
    if (isset($data['table']['provider'])) {
      $dependencies['module'][] = $data['table']['provider'];
    }
  }
  return $dependencies;
}