You are here

AddRoleUser.php in Zircon Profile 8

Same filename and directory in other branches
  1. 8.0 core/modules/user/src/Plugin/Action/AddRoleUser.php

File

core/modules/user/src/Plugin/Action/AddRoleUser.php
View source
<?php

/**
 * @file
 * Contains \Drupal\user\Plugin\Action\AddRoleUser.
 */
namespace Drupal\user\Plugin\Action;


/**
 * Adds a role to a user.
 *
 * @Action(
 *   id = "user_add_role_action",
 *   label = @Translation("Add a role to the selected users"),
 *   type = "user"
 * )
 */
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->original = clone $account;
      $account
        ->addRole($rid);
      $account
        ->save();
    }
  }

}

Classes

Namesort descending Description
AddRoleUser Adds a role to a user.