You are here

public function DisplayPluginBase::calculateDependencies in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/views/src/Plugin/views/display/DisplayPluginBase.php \Drupal\views\Plugin\views\display\DisplayPluginBase::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()

3 calls to DisplayPluginBase::calculateDependencies()
DisplayTest::calculateDependencies in core/modules/views/tests/modules/views_test_data/src/Plugin/views/display/DisplayTest.php
Calculates dependencies for the configured plugin.
Page::calculateDependencies in core/modules/views/src/Plugin/views/display/Page.php
Calculates dependencies for the configured plugin.
RestExport::calculateDependencies in core/modules/rest/src/Plugin/views/display/RestExport.php
Calculates dependencies for the configured plugin.
3 methods override DisplayPluginBase::calculateDependencies()
DisplayTest::calculateDependencies in core/modules/views/tests/modules/views_test_data/src/Plugin/views/display/DisplayTest.php
Calculates dependencies for the configured plugin.
Page::calculateDependencies in core/modules/views/src/Plugin/views/display/Page.php
Calculates dependencies for the configured plugin.
RestExport::calculateDependencies in core/modules/rest/src/Plugin/views/display/RestExport.php
Calculates dependencies for the configured plugin.

File

core/modules/views/src/Plugin/views/display/DisplayPluginBase.php, line 955

Class

DisplayPluginBase
Base class for views display plugins.

Namespace

Drupal\views\Plugin\views\display

Code

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

  // Collect all the dependencies of handlers and plugins. Only calculate
  // their dependencies if they are configured by this display.
  $plugins = array_merge($this
    ->getAllHandlers(TRUE), $this
    ->getAllPlugins(TRUE));
  array_walk($plugins, [
    $this,
    'calculatePluginDependencies',
  ]);
  return $this->dependencies;
}