public function DisplayPluginBase::calculateDependencies in Search API 8

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 DependentPluginInterface::calculateDependencies

See also

\Drupal\Core\Config\Entity\ConfigDependencyManager

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

1 call to DisplayPluginBase::calculateDependencies()

ViewsDisplayBase::calculateDependencies in src/Plugin/search_api/display/ViewsDisplayBase.php

Calculates dependencies for the configured plugin.

1 method overrides DisplayPluginBase::calculateDependencies()

ViewsDisplayBase::calculateDependencies in src/Plugin/search_api/display/ViewsDisplayBase.php

Calculates dependencies for the configured plugin.

File

src/Display/DisplayPluginBase.php, line 172

Class

DisplayPluginBase

Defines a base class from which other display classes may extend.

Namespace

Drupal\search_api\Display

Code

public function calculateDependencies() {
  $dependencies = [];

  // By default, add dependencies to the module providing this display and to
  // the index it is based on.
  $definition = $this
    ->getPluginDefinition();
  $dependencies['module'][] = $definition['provider'];
  $index = $this
    ->getIndex();
  $dependencies[$index
    ->getConfigDependencyKey()][] = $index
    ->getConfigDependencyName();
  return $dependencies;
}