You are here

public function SearchApiRelationship::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 RelationshipPluginBase::calculateDependencies

See also

\Drupal\Core\Config\Entity\ConfigDependencyManager

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

File

src/Plugin/views/relationship/SearchApiRelationship.php, line 84

Class

SearchApiRelationship
Views relationship plugin for datasources.

Namespace

Drupal\search_api\Plugin\views\relationship

Code

public function calculateDependencies() {
  $dependencies = [];
  if (!empty($this->definition['entity type'])) {
    $entity_type = $this
      ->getEntityTypeManager()
      ->getDefinition($this->definition['entity type']);
    if ($entity_type) {
      $dependencies['module'][] = $entity_type
        ->getProvider();
    }
  }
  return $dependencies;
}