You are here

public function Entity::calculateDependencies in Drupal 9

Same name in this branch
  1. 9 core/modules/views/src/Plugin/views/area/Entity.php \Drupal\views\Plugin\views\area\Entity::calculateDependencies()
  2. 9 core/modules/views/src/Plugin/views/argument_validator/Entity.php \Drupal\views\Plugin\views\argument_validator\Entity::calculateDependencies()
  3. 9 core/modules/migrate/src/Plugin/migrate/destination/Entity.php \Drupal\migrate\Plugin\migrate\destination\Entity::calculateDependencies()
Same name and namespace in other branches
  1. 8 core/modules/views/src/Plugin/views/area/Entity.php \Drupal\views\Plugin\views\area\Entity::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 HandlerBase::calculateDependencies

See also

\Drupal\Core\Config\Entity\ConfigDependencyManager

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

File

core/modules/views/src/Plugin/views/area/Entity.php, line 207

Class

Entity
Provides an area handler which renders an entity in a certain view mode.

Namespace

Drupal\views\Plugin\views\area

Code

public function calculateDependencies() {
  $dependencies = parent::calculateDependencies();

  // Ensure that we don't add dependencies for placeholders.
  // @todo Use a method to check for tokens in
  //   https://www.drupal.org/node/2396607.
  if (strpos($this->options['target'], '{{') === FALSE) {
    if ($entity = $this->entityRepository
      ->loadEntityByConfigTarget($this->entityType, $this->options['target'])) {
      $dependencies[$this->entityTypeManager
        ->getDefinition($this->entityType)
        ->getConfigDependencyKey()][] = $entity
        ->getConfigDependencyName();
    }
  }
  return $dependencies;
}