You are here

Home » API reference » Views (for Drupal 7) 8.3 » Role.php

class Role in Views (for Drupal 7) 8.3

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

Views access plugins
The base plugin to handle access to a view.
1 string reference to 'Role'
Role::buildOptionsForm in lib/Views/user/Plugin/views/access/Role.php
Provide the default form for setting options.

File

lib/Views/user/Plugin/views/access/Role.php, line 25
Definition of Views\user\Plugin\views\access\Role.

Namespace

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

  /**
   * Overrides Drupal\views\Plugin\Plugin::$usesOptions.
   */
  protected $usesOptions = TRUE;
  public function access($account) {
    return views_check_roles(array_filter($this->options['role']), $account);
  }
  function get_access_callback() {
    return array(
      'views_check_roles',
      array(
        array_filter($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_roles();
      $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
AccessPluginBase::init public function Initialize the plugin.
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. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. 2
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 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
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
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 2
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::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::get_access_callback function Determine the access callback and arguments. Overrides AccessPluginBase::get_access_callback
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