Access plugin that provides role-based access control.
@Plugin(
id = "role",
title = @Translation("Role"),
help = @Translation("Access will be granted to users with any of the specified roles.")
)
Expanded class hierarchy of Role
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']);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccessPluginBase:: |
public | function | Initialize the plugin. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
protected | property | The discovery object. | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | function | Provide a list of additional theme functions for the theme information page | |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
public | function | Add anything to the query that we might need to. | 13 |
PluginBase:: |
protected | function | ||
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
PluginBase:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
PluginBase:: |
public | function | Validate that the plugin is correct and can be saved. | 4 |
PluginBase:: |
public | function |
Constructs a Plugin object. Overrides PluginBase:: |
|
Role:: |
protected | property |
Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase:: |
|
Role:: |
public | function |
Determine if the current user has access or not. Overrides AccessPluginBase:: |
|
Role:: |
public | function |
Provide the default form for setting options. Overrides AccessPluginBase:: |
|
Role:: |
protected | function |
Retrieve the options when this is a new access
control plugin Overrides AccessPluginBase:: |
|
Role:: |
function |
Determine the access callback and arguments. Overrides AccessPluginBase:: |
||
Role:: |
public | function |
Provide the default form form for submitting options Overrides AccessPluginBase:: |
|
Role:: |
public | function |
Return a string to display as the clickable title for the
access control. Overrides AccessPluginBase:: |
|
Role:: |
public | function |
Provide the default form form for validating options Overrides AccessPluginBase:: |