You are here

public function SearchApiQuery::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 QueryPluginBase::calculateDependencies

See also

\Drupal\Core\Config\Entity\ConfigDependencyManager

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

File

src/Plugin/views/query/SearchApiQuery.php, line 839

Class

SearchApiQuery
Defines a Views query class for searching on Search API indexes.

Namespace

Drupal\search_api\Plugin\views\query

Code

public function calculateDependencies() {
  $dependencies = parent::calculateDependencies();
  $dependencies[$this->index
    ->getConfigDependencyKey()][] = $this->index
    ->getConfigDependencyName();
  return $dependencies;
}