You are here

public function SearchApiSolrBackend::calculateDependencies in Search API Solr 8.2

Same name and namespace in other branches
  1. 8.3 src/Plugin/search_api/backend/SearchApiSolrBackend.php \Drupal\search_api_solr\Plugin\search_api\backend\SearchApiSolrBackend::calculateDependencies()
  2. 8 src/Plugin/search_api/backend/SearchApiSolrBackend.php \Drupal\search_api_solr\Plugin\search_api\backend\SearchApiSolrBackend::calculateDependencies()
  3. 4.x src/Plugin/search_api/backend/SearchApiSolrBackend.php \Drupal\search_api_solr\Plugin\search_api\backend\SearchApiSolrBackend::calculateDependencies()

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

See also

\Drupal\Core\Config\Entity\ConfigDependencyManager

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

File

src/Plugin/search_api/backend/SearchApiSolrBackend.php, line 2806

Class

SearchApiSolrBackend
Apache Solr backend for search api.

Namespace

Drupal\search_api_solr\Plugin\search_api\backend

Code

public function calculateDependencies() {
  $this
    ->calculatePluginDependencies($this
    ->getSolrConnector());

  /** @var \Drupal\search_api_solr\Controller\SolrFieldTypeListBuilder $list_builder */
  $list_builder = \Drupal::entityTypeManager()
    ->getListBuilder('solr_field_type');
  $list_builder
    ->setBackend($this);
  $solr_field_types = $list_builder
    ->load();

  /** @var \Drupal\search_api_solr\Entity\SolrFieldType $solr_field_type */
  foreach ($solr_field_types as $solr_field_type) {
    $this
      ->addDependency('config', $solr_field_type
      ->getConfigDependencyName());
  }
  return $this->dependencies;
}