You are here

public function Roles::calculateDependencies in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/user/src/Plugin/views/filter/Roles.php \Drupal\user\Plugin\views\filter\Roles::calculateDependencies()
  2. 10 core/modules/user/src/Plugin/views/filter/Roles.php \Drupal\user\Plugin\views\filter\Roles::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/user/src/Plugin/views/filter/Roles.php, line 75

Class

Roles
Filter handler for user roles.

Namespace

Drupal\user\Plugin\views\filter

Code

public function calculateDependencies() {
  $dependencies = [];
  if (in_array($this->operator, [
    'empty',
    'not empty',
  ])) {
    return $dependencies;
  }

  // The value might be a string due to the wrong plugin being used for role
  // field data, and subsequently the incorrect config schema object and
  // value. In the empty case stop early. Otherwise we cast it to an array
  // later.
  if (is_string($this->value) && $this->value === '') {
    return [];
  }
  foreach ((array) $this->value as $role_id) {
    if ($role = $this->roleStorage
      ->load($role_id)) {
      $dependencies[$role
        ->getConfigDependencyKey()][] = $role
        ->getConfigDependencyName();
    }
    else {
      trigger_error("The {$role_id} role does not exist. You should review and fix the configuration of the {$this->view->id()} view.", E_USER_WARNING);
    }
  }
  return $dependencies;
}