You are here

public function ConfigurablePluginBase::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()

2 calls to ConfigurablePluginBase::calculateDependencies()
ContentEntity::calculateDependencies in src/Plugin/search_api/datasource/ContentEntity.php
Calculates dependencies for the configured plugin.
RenderedItem::calculateDependencies in src/Plugin/search_api/processor/RenderedItem.php
Calculates dependencies for the configured plugin.
6 methods override ConfigurablePluginBase::calculateDependencies()
ContentEntity::calculateDependencies in src/Plugin/search_api/datasource/ContentEntity.php
Calculates dependencies for the configured plugin.
RenderedItem::calculateDependencies in src/Plugin/search_api/processor/RenderedItem.php
Calculates dependencies for the configured plugin.
TestBackend::calculateDependencies in tests/search_api_test/src/Plugin/search_api/backend/TestBackend.php
Calculates dependencies for the configured plugin.
TestDatasource::calculateDependencies in tests/search_api_test/src/Plugin/search_api/datasource/TestDatasource.php
Calculates dependencies for the configured plugin.
TestProcessor::calculateDependencies in tests/search_api_test/src/Plugin/search_api/processor/TestProcessor.php
Calculates dependencies for the configured plugin.

... See full list

File

src/Plugin/ConfigurablePluginBase.php, line 88

Class

ConfigurablePluginBase
Provides a base class for all configurable Search API plugins.

Namespace

Drupal\search_api\Plugin

Code

public function calculateDependencies() {
  return [];
}