class AddRoleUser

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

Adds a role to a user.

Attributes

#[Action(id: 'user_add_role_action', label: new TranslatableMarkup('Add a role to the selected users'), type: 'user')]

Hierarchy

Expanded class hierarchy of AddRoleUser

1 file declares its use of AddRoleUser
AddRoleUserTest.php in core/modules/user/tests/src/Unit/Plugin/Action/AddRoleUserTest.php

File

core/modules/user/src/Plugin/Action/AddRoleUser.php, line 11

Namespace

Drupal\user\Plugin\Action
View on git.drupalcode.org
View source 
class AddRoleUser extends ChangeUserRoleBase {
  
  /**
   * {@inheritdoc}
   */
  public function execute($account = NULL) {
    $rid = $this->configuration['rid'];
    // Skip adding the role to the user if they already have it.
    if ($account !== FALSE && !$account->hasRole($rid)) {
      // For efficiency manually save the original account before applying
      // any changes.
      $account->setOriginal(clone $account);
      $account->addRole($rid)
        ->save();
    }
  }

}

Members

Title Deprecated Modifiers Object type Summary Overriden Title Overrides
ActionBase::executeMultiple public function Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple 3
AddRoleUser::execute public function Executes the plugin. Overrides ExecutableInterface::execute
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 ConfigurableTrait::defaultConfiguration
ChangeUserRoleBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
ChangeUserRoleBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides ConfigurableActionBase::__construct
ConfigurableActionBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 2
ConfigurableTrait::$configuration protected property Configuration information passed into the plugin.
ConfigurableTrait::getConfiguration public function Gets this plugin's configuration. 3
ConfigurableTrait::setConfiguration public function Sets the configuration for this plugin instance. 2
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 3
DependencySerializationTrait::__wakeup public function 3
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
MessengerTrait::$messenger protected property The messenger. 25
MessengerTrait::messenger public function Gets the messenger. 25
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin ID.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin ID of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable Deprecated public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language. 1

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