You are here

public function JsonApiFacets::calculateDependencies in JSON:API 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()

File

modules/jsonapi_search_api_facets/src/Plugin/facets/facet_source/JsonApiFacets.php, line 73

Class

JsonApiFacets
Provides a facet source for use in JSON:API.

Namespace

Drupal\jsonapi_search_api_facets\Plugin\facets\facet_source

Code

public function calculateDependencies() {
  $this
    ->addDependency('module', 'jsonapi_search_api_facets');
  return $this->dependencies;
}