You are here

public function RenderedItem::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 ConfigurablePluginBase::calculateDependencies

See also

\Drupal\Core\Config\Entity\ConfigDependencyManager

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

File

src/Plugin/search_api/processor/RenderedItem.php, line 321

Class

RenderedItem
Adds an additional field containing the rendered item.

Namespace

Drupal\search_api\Plugin\search_api\processor

Code

public function calculateDependencies() {
  $this->dependencies = parent::calculateDependencies();
  $fields = $this
    ->getFieldsHelper()
    ->filterForPropertyPath($this->index
    ->getFields(), NULL, 'rendered_item');
  foreach ($fields as $field) {
    $view_modes = $field
      ->getConfiguration()['view_mode'];
    foreach ($this->index
      ->getDatasources() as $datasource_id => $datasource) {
      if (($entity_type_id = $datasource
        ->getEntityTypeId()) && !empty($view_modes[$datasource_id])) {
        foreach ($view_modes[$datasource_id] as $view_mode) {
          if ($view_mode) {

            /** @var \Drupal\Core\Entity\EntityViewModeInterface $view_mode_entity */
            $view_mode_entity = EntityViewMode::load($entity_type_id . '.' . $view_mode);
            if ($view_mode_entity) {
              $this
                ->addDependency($view_mode_entity
                ->getConfigDependencyKey(), $view_mode_entity
                ->getConfigDependencyName());
            }
          }
        }
      }
    }
  }
  return $this->dependencies;
}