ChangeUserRoleBase.php

Same filename in other branches
  1. 9 core/modules/user/src/Plugin/Action/ChangeUserRoleBase.php
  2. 8.9.x core/modules/user/src/Plugin/Action/ChangeUserRoleBase.php
  3. 11.x core/modules/user/src/Plugin/Action/ChangeUserRoleBase.php

Namespace

Drupal\user\Plugin\Action

File

core/modules/user/src/Plugin/Action/ChangeUserRoleBase.php

View source
<?php

namespace Drupal\user\Plugin\Action;

use Drupal\Core\Action\ConfigurableActionBase;
use Drupal\Core\Entity\DependencyTrait;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\user\Entity\Role;
use Drupal\user\RoleInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides a base class for operations to change a user's role.
 */
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();
    }

}

Classes

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

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