class Role in Drupal 10
Same name in this branch
- 10 core/modules/user/src/Entity/Role.php \Drupal\user\Entity\Role
- 10 core/modules/user/src/Plugin/views/access/Role.php \Drupal\user\Plugin\views\access\Role
- 10 core/modules/user/src/Plugin/migrate/source/d6/Role.php \Drupal\user\Plugin\migrate\source\d6\Role
- 10 core/modules/user/src/Plugin/migrate/source/d7/Role.php \Drupal\user\Plugin\migrate\source\d7\Role
Same name and namespace in other branches
- 8 core/modules/user/src/Plugin/views/access/Role.php \Drupal\user\Plugin\views\access\Role
- 9 core/modules/user/src/Plugin/views/access/Role.php \Drupal\user\Plugin\views\access\Role
Access plugin that provides role-based access control.
Plugin annotation
@ViewsAccess(
id = "role",
title = @Translation("Role"),
help = @Translation("Access will be granted to users with any of the specified roles.")
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\views\Plugin\views\access\AccessPluginBase
- class \Drupal\user\Plugin\views\access\Role implements CacheableDependencyInterface
- class \Drupal\views\Plugin\views\access\AccessPluginBase
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Role
Related topics
1 file declares its use of Role
- AccessRoleTest.php in core/
modules/ user/ tests/ src/ Functional/ Views/ AccessRoleTest.php
9 string references to 'Role'
- ChangeUserRoleBase::buildConfigurationForm in core/
modules/ user/ src/ Plugin/ Action/ ChangeUserRoleBase.php - filter.schema.yml in core/
modules/ filter/ config/ schema/ filter.schema.yml - core/modules/filter/config/schema/filter.schema.yml
- Role::buildOptionsForm in core/
modules/ user/ src/ Plugin/ views/ access/ Role.php - Provide a form to edit options for this plugin.
- user.schema.yml in core/
modules/ user/ config/ schema/ user.schema.yml - core/modules/user/config/schema/user.schema.yml
- user.views.schema.yml in core/
modules/ user/ config/ schema/ user.views.schema.yml - core/modules/user/config/schema/user.views.schema.yml
File
- core/
modules/ user/ src/ Plugin/ views/ access/ Role.php, line 25
Namespace
Drupal\user\Plugin\views\accessView source
class Role extends AccessPluginBase implements CacheableDependencyInterface {
/**
* {@inheritdoc}
*/
protected $usesOptions = TRUE;
/**
* The role storage.
*
* @var \Drupal\user\RoleStorageInterface
*/
protected $roleStorage;
/**
* Constructs a Role object.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin_id for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\user\RoleStorageInterface $role_storage
* The role storage.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, RoleStorageInterface $role_storage) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->roleStorage = $role_storage;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('entity_type.manager')
->getStorage('user_role'));
}
/**
* {@inheritdoc}
*/
public function access(AccountInterface $account) {
return !empty(array_intersect(array_filter($this->options['role']), $account
->getRoles()));
}
/**
* {@inheritdoc}
*/
public function alterRouteDefinition(Route $route) {
if ($this->options['role']) {
$route
->setRequirement('_role', (string) implode('+', $this->options['role']));
}
}
public function summaryTitle() {
$count = count($this->options['role']);
if ($count < 1) {
return $this
->t('No role(s) selected');
}
elseif ($count > 1) {
return $this
->t('Multiple roles');
}
else {
$rids = user_role_names();
$rid = reset($this->options['role']);
return $rids[$rid];
}
}
protected function defineOptions() {
$options = parent::defineOptions();
$options['role'] = [
'default' => [],
];
return $options;
}
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
$form['role'] = [
'#type' => 'checkboxes',
'#title' => $this
->t('Role'),
'#default_value' => $this->options['role'],
'#options' => array_map('\\Drupal\\Component\\Utility\\Html::escape', user_role_names()),
'#description' => $this
->t('Only the checked roles will be able to access this display.'),
];
}
public function validateOptionsForm(&$form, FormStateInterface $form_state) {
$role = $form_state
->getValue([
'access_options',
'role',
]);
$role = array_filter($role);
if (!$role) {
$form_state
->setError($form['role'], $this
->t('You must select at least one role if type is "by role"'));
}
$form_state
->setValue([
'access_options',
'role',
], $role);
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
$dependencies = parent::calculateDependencies();
foreach (array_keys($this->options['role']) as $rid) {
if ($role = $this->roleStorage
->load($rid)) {
$dependencies[$role
->getConfigDependencyKey()][] = $role
->getConfigDependencyName();
}
}
return $dependencies;
}
/**
* {@inheritdoc}
*/
public function getCacheMaxAge() {
return Cache::PERMANENT;
}
/**
* {@inheritdoc}
*/
public function getCacheContexts() {
return [
'user.roles',
];
}
/**
* {@inheritdoc}
*/
public function getCacheTags() {
return [];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 18 |
MessengerTrait:: |
public | function | Gets the messenger. | 18 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition. | |
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 implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Stores the render API renderer. | |
PluginBase:: |
public | property | The top object of a view. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function | 1 | |
PluginBase:: |
protected | function | Do the work to filter out stored options depending on the defined options. | |
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | 2 | |
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | ||
PluginBase:: |
protected | function | Returns the render API renderer. | |
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | ||
PluginBase:: |
constant | Include entity row languages when listing languages. | ||
PluginBase:: |
constant | Include negotiated languages when listing languages. | ||
PluginBase:: |
public | function | 2 | |
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
protected | function | Makes an array of languages, optionally including special languages. | |
PluginBase:: |
public | function | ||
PluginBase:: |
public static | function | ||
PluginBase:: |
public static | function | ||
PluginBase:: |
public | function | 4 | |
PluginBase:: |
public static | function | Returns substitutions for Views queries for languages. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function | 4 | |
PluginBase:: |
public | function | ||
PluginBase:: |
public static | function | 1 | |
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | 6 | |
PluginBase:: |
public | function | 2 | |
PluginBase:: |
protected | function | Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. | |
PluginBase:: |
constant | Query string to indicate the site default language. | ||
Role:: |
protected | property | The role storage. | |
Role:: |
protected | property |
Denotes whether the plugin has an additional options form. Overrides PluginBase:: |
|
Role:: |
public | function |
Determine if the current user has access or not. Overrides AccessPluginBase:: |
|
Role:: |
public | function |
Allows access plugins to alter the route definition of a view. Overrides AccessPluginBase:: |
|
Role:: |
public | function |
Provide a form to edit options for this plugin. Overrides PluginBase:: |
|
Role:: |
public | function |
Calculates dependencies for the configured plugin. Overrides PluginBase:: |
|
Role:: |
public static | function |
Creates an instance of the plugin. Overrides PluginBase:: |
|
Role:: |
protected | function |
Information about options for all kinds of purposes will be held here. Overrides PluginBase:: |
|
Role:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyInterface:: |
|
Role:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyInterface:: |
|
Role:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyInterface:: |
|
Role:: |
public | function |
Returns the summary of the settings in the display. Overrides AccessPluginBase:: |
|
Role:: |
public | function |
Validate the options form. Overrides PluginBase:: |
|
Role:: |
public | function |
Constructs a Role object. Overrides PluginBase:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 3 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 1 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TrustedCallbackInterface:: |
constant | Untrusted callbacks throw exceptions. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger E_USER_WARNING errors. |