You are here

public function ChangeUserRoleBase::calculateDependencies in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/user/src/Plugin/Action/ChangeUserRoleBase.php \Drupal\user\Plugin\Action\ChangeUserRoleBase::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 ConfigurableActionBase::calculateDependencies

See also

\Drupal\Core\Config\Entity\ConfigDependencyManager

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

File

core/modules/user/src/Plugin/Action/ChangeUserRoleBase.php, line 83

Class

ChangeUserRoleBase
Provides a base class for operations to change a user's role.

Namespace

Drupal\user\Plugin\Action

Code

public function calculateDependencies() {
  if (!empty($this->configuration['rid'])) {
    $prefix = $this->entityType
      ->getConfigPrefix() . '.';
    $this
      ->addDependency('config', $prefix . $this->configuration['rid']);
  }
  return $this->dependencies;
}