class Role

Same name in this branch

Access plugin that provides role-based access control.

Plugin annotation


@Plugin(
  id = "role",
  title = @Translation("Role"),
  help = @Translation("Access will be granted to users with any of the specified roles.")
)

Hierarchy

Expanded class hierarchy of Role

Related topics

1 file declares its use of Role
AccessRoleTest.php in drupal/core/modules/user/lib/Drupal/user/Tests/Views/AccessRoleTest.php
Contains \Drupal\user\Tests\Views\AccessRoleTest.
10 string references to 'Role'
block.schema.yml in drupal/core/modules/block/config/schema/block.schema.yml
drupal/core/modules/block/config/schema/block.schema.yml
ChangeUserRoleBase::form in drupal/core/modules/user/lib/Drupal/user/Plugin/Action/ChangeUserRoleBase.php
Form constructor.
filter.schema.yml in drupal/core/modules/filter/config/schema/filter.schema.yml
drupal/core/modules/filter/config/schema/filter.schema.yml
Role::buildOptionsForm in drupal/core/modules/user/lib/Drupal/user/Plugin/views/access/Role.php
Provide the default form for setting options.
SimpleTestTest::confirmStubTestResults in drupal/core/modules/simpletest/lib/Drupal/simpletest/Tests/SimpleTestTest.php
Confirm that the stub test produced the desired results.

... See full list

File

drupal/core/modules/user/lib/Drupal/user/Plugin/views/access/Role.php, line 27
Definition of Drupal\user\Plugin\views\access\Role.

Namespace

Drupal\user\Plugin\views\access
View source
class Role extends AccessPluginBase {

  /**
   * Overrides Drupal\views\Plugin\Plugin::$usesOptions.
   */
  protected $usesOptions = TRUE;

  /**
   * {@inheritdoc}
   */
  public function access(AccountInterface $account) {
    return user_access('access all views', $account) || array_intersect(array_filter($this->options['role']), $account->roles);
  }

  /**
   * {@inheritdoc}
   */
  public function alterRouteDefinition(Route $route) {
    $route
      ->setRequirement('_role_id', $this->options['role']);
  }
  public function summaryTitle() {
    $count = count($this->options['role']);
    if ($count < 1) {
      return t('No role(s) selected');
    }
    elseif ($count > 1) {
      return t('Multiple roles');
    }
    else {
      $rids = user_role_names();
      $rid = reset($this->options['role']);
      return check_plain($rids[$rid]);
    }
  }
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['role'] = array(
      'default' => array(),
    );
    return $options;
  }
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['role'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Role'),
      '#default_value' => $this->options['role'],
      '#options' => array_map('check_plain', $this
        ->getRoles()),
      '#description' => t('Only the checked roles will be able to access this display. Note that users with "access all views" can see any view, regardless of role.'),
    );
  }
  public function validateOptionsForm(&$form, &$form_state) {
    if (!array_filter($form_state['values']['access_options']['role'])) {
      form_error($form['role'], t('You must select at least one role if type is "by role"'));
    }
  }
  public function submitOptionsForm(&$form, &$form_state) {

    // I hate checkboxes.
    $form_state['values']['access_options']['role'] = array_filter($form_state['values']['access_options']['role']);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContainerFactoryPluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$view public property The top object of a view. 1
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::init public function Initialize the plugin. 8
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::query public function Add anything to the query that we might need to. 13
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. 4
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct
Role::$usesOptions protected property Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions
Role::access public function Determine if the current user has access or not. Overrides AccessPluginBase::access
Role::alterRouteDefinition public function Allows access plugins to alter the route definition of a view. Overrides AccessPluginBase::alterRouteDefinition
Role::buildOptionsForm public function Provide the default form for setting options. Overrides AccessPluginBase::buildOptionsForm
Role::defineOptions protected function Retrieve the options when this is a new access control plugin Overrides AccessPluginBase::defineOptions
Role::submitOptionsForm public function Provide the default form form for submitting options Overrides AccessPluginBase::submitOptionsForm
Role::summaryTitle public function Return a string to display as the clickable title for the access control. Overrides AccessPluginBase::summaryTitle
Role::validateOptionsForm public function Provide the default form form for validating options Overrides AccessPluginBase::validateOptionsForm