class ChangeUserRoleBase

Same name and namespace in other branches
  1. 9 core/modules/user/src/Plugin/Action/ChangeUserRoleBase.php \Drupal\user\Plugin\Action\ChangeUserRoleBase
  2. 8.9.x core/modules/user/src/Plugin/Action/ChangeUserRoleBase.php \Drupal\user\Plugin\Action\ChangeUserRoleBase
  3. 11.x core/modules/user/src/Plugin/Action/ChangeUserRoleBase.php \Drupal\user\Plugin\Action\ChangeUserRoleBase

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

Hierarchy

Expanded class hierarchy of ChangeUserRoleBase

File

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

Namespace

Drupal\user\Plugin\Action
View source
abstract class ChangeUserRoleBase extends ConfigurableActionBase implements ContainerFactoryPluginInterface {
  use DependencyTrait;
  
  /**
   * The user role entity type.
   *
   * @var \Drupal\Core\Entity\EntityTypeInterface
   */
  protected $entityType;
  
  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeInterface $entity_type) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityType = $entity_type;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity_type.manager')
      ->getDefinition('user_role'));
  }
  
  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'rid' => '',
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $roles = Role::loadMultiple();
    unset($roles[RoleInterface::ANONYMOUS_ID]);
    unset($roles[RoleInterface::AUTHENTICATED_ID]);
    $roles = array_map(fn(RoleInterface $role) => $role->label(), $roles);
    $form['rid'] = [
      '#type' => 'radios',
      '#title' => $this->t('Role'),
      '#options' => $roles,
      '#default_value' => $this->configuration['rid'],
      '#required' => TRUE,
    ];
    return $form;
  }
  
  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration['rid'] = $form_state->getValue('rid');
  }
  
  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    if (!empty($this->configuration['rid'])) {
      $prefix = $this->entityType
        ->getConfigPrefix() . '.';
      $this->addDependency('config', $prefix . $this->configuration['rid']);
    }
    return $this->dependencies;
  }
  
  /**
   * {@inheritdoc}
   */
  public function access($object, ?AccountInterface $account = NULL, $return_as_object = FALSE) {
    /** @var \Drupal\user\UserInterface $object */
    $access = $object->access('update', $account, TRUE)
      ->andIf($object->roles
      ->access('edit', $account, TRUE));
    return $return_as_object ? $access : $access->isAllowed();
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ActionBase::executeMultiple public function Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple 3
ChangeUserRoleBase::$entityType protected property The user role entity type.
ChangeUserRoleBase::access public function Checks object access. Overrides ActionInterface::access
ChangeUserRoleBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
ChangeUserRoleBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides ConfigurableActionBase::calculateDependencies
ChangeUserRoleBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ChangeUserRoleBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableActionBase::defaultConfiguration
ChangeUserRoleBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
ChangeUserRoleBase::__construct public function Overrides ConfigurableActionBase::__construct
ConfigurableActionBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurableActionBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConfigurableActionBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
ExecutableInterface::execute public function Executes the plugin. 22
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.