class UserHasRole
Provides a 'User has roles(s)' condition.
@todo Add access callback information from Drupal 7.
Plugin annotation
@Condition(
id = "rules_user_has_role",
label = @Translation("User has role(s)"),
category = @Translation("User"),
context_definitions = {
"user" = @ContextDefinition("entity:user",
label = @Translation("User"),
description = @Translation("Specifies the user account to check."),
),
"roles" = @ContextDefinition("entity:user_role",
label = @Translation("Roles"),
description = @Translation("Specifies the roles to check for."),
multiple = TRUE,
options_provider = "\Drupal\rules\TypedData\Options\RolesOptions"
),
"operation" = @ContextDefinition("string",
label = @Translation("Matching multiple roles"),
description = @Translation("Specify if the user must have <em>all</em> the roles selected or <em>any</em> of the roles selected."),
assignment_restriction = "input",
default_value = "AND",
options_provider = "\Drupal\rules\TypedData\Options\AndOrOptions",
required = FALSE
),
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Executable\ExecutablePluginBase extends \Drupal\Core\Executable\ExecutableInterface, \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Condition\ConditionPluginBase extends \Drupal\Core\Condition\ConditionInterface uses \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait implements \Drupal\Core\Executable\ExecutablePluginBase
- class \Drupal\rules\Core\RulesConditionBase extends \Drupal\rules\Core\RulesConditionInterface uses \Drupal\rules\Context\ContextProviderTrait, \Drupal\rules\Core\ExecutablePluginTrait, \Drupal\rules\Core\ConfigurationAccessControlTrait implements \Drupal\Core\Condition\ConditionPluginBase
- class \Drupal\rules\Plugin\Condition\UserHasRole implements \Drupal\rules\Core\RulesConditionBase
- class \Drupal\rules\Core\RulesConditionBase extends \Drupal\rules\Core\RulesConditionInterface uses \Drupal\rules\Context\ContextProviderTrait, \Drupal\rules\Core\ExecutablePluginTrait, \Drupal\rules\Core\ConfigurationAccessControlTrait implements \Drupal\Core\Condition\ConditionPluginBase
- class \Drupal\Core\Condition\ConditionPluginBase extends \Drupal\Core\Condition\ConditionInterface uses \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait implements \Drupal\Core\Executable\ExecutablePluginBase
- class \Drupal\Core\Executable\ExecutablePluginBase extends \Drupal\Core\Executable\ExecutableInterface, \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of UserHasRole
File
-
src/
Plugin/ Condition/ UserHasRole.php, line 40
Namespace
Drupal\rules\Plugin\ConditionView source
class UserHasRole extends RulesConditionBase {
/**
* Evaluate if user has role(s).
*
* @param \Drupal\user\UserInterface $user
* The account to check.
* @param \Drupal\user\RoleInterface[] $roles
* Array of user roles.
* @param string $operation
* Either "AND": user has all of roles.
* Or "OR": user has at least one of all roles.
* Defaults to "AND".
*
* @return bool
* TRUE if the user has the role(s).
*/
protected function doEvaluate(UserInterface $user, array $roles, $operation = 'AND') {
$rids = array_map(function ($role) {
return $role->id();
}, $roles);
switch (strtoupper($operation)) {
case 'OR':
return (bool) array_intersect($rids, $user->getRoles());
case 'AND':
return (bool) (!array_diff($rids, $user->getRoles()));
default:
throw new InvalidArgumentException('Either use "AND" or "OR". Leave empty for default "AND" behavior.');
}
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ConditionPluginBase::$executableManager | protected | property | The condition manager to proxy execute calls through. | ||
ConditionPluginBase::buildConfigurationForm | public | function | Form constructor. | Overrides PluginFormInterface::buildConfigurationForm | 6 |
ConditionPluginBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | |
ConditionPluginBase::defaultConfiguration | public | function | Gets default configuration for this plugin. | Overrides ConfigurableInterface::defaultConfiguration | 6 |
ConditionPluginBase::execute | public | function | Executes the plugin. | Overrides ExecutableInterface::execute | |
ConditionPluginBase::getConfiguration | public | function | Gets this plugin's configuration. | Overrides ConfigurableInterface::getConfiguration | |
ConditionPluginBase::isNegated | public | function | Determines whether condition result will be negated. | Overrides ConditionInterface::isNegated | |
ConditionPluginBase::setConfiguration | public | function | Sets the configuration for this plugin instance. | Overrides ConfigurableInterface::setConfiguration | |
ConditionPluginBase::setExecutableManager | public | function | Sets the executable manager class. | Overrides ConditionInterface::setExecutableManager | |
ConditionPluginBase::submitConfigurationForm | public | function | Form submission handler. | Overrides PluginFormInterface::submitConfigurationForm | 6 |
ConditionPluginBase::validateConfigurationForm | public | function | Form validation handler. | Overrides PluginFormInterface::validateConfigurationForm | |
ConditionPluginBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | Overrides PluginBase::__construct | 5 |
ConfigurationAccessControlTrait::checkConfigurationAccess | public | function | Checks configuration permission. | ||
ContextAwarePluginAssignmentTrait::addContextAssignmentElement | protected | function | Builds a form element for assigning a context to a given slot. | ||
ContextAwarePluginAssignmentTrait::contextHandler | protected | function | Wraps the context handler. | ||
ContextAwarePluginAssignmentTrait::t | abstract protected | function | Ensures the t() method is available. | ||
ContextAwarePluginTrait::$context | protected | property | The data objects representing the context of this plugin. | ||
ContextAwarePluginTrait::$initializedContextConfig | protected | property | Tracks whether the context has been initialized from configuration. | ||
ContextAwarePluginTrait::getCacheContexts | public | function | 9 | ||
ContextAwarePluginTrait::getCacheMaxAge | public | function | 7 | ||
ContextAwarePluginTrait::getCacheTags | public | function | 4 | ||
ContextAwarePluginTrait::getContext | public | function | |||
ContextAwarePluginTrait::getContextDefinition | public | function | |||
ContextAwarePluginTrait::getContextDefinitions | public | function | |||
ContextAwarePluginTrait::getContextMapping | public | function | |||
ContextAwarePluginTrait::getContexts | public | function | |||
ContextAwarePluginTrait::getContextValues | public | function | |||
ContextAwarePluginTrait::getPluginDefinition | abstract public | function | 1 | ||
ContextAwarePluginTrait::setContext | public | function | 1 | ||
ContextAwarePluginTrait::setContextMapping | public | function | |||
ContextAwarePluginTrait::setContextValue | public | function | |||
ContextAwarePluginTrait::validateContexts | public | function | |||
ContextProviderTrait::$providedContext | protected | property | The data objects that are provided by this plugin. | ||
ContextProviderTrait::getProvidedContext | public | function | |||
ContextProviderTrait::getProvidedContextDefinition | public | function | |||
ContextProviderTrait::getProvidedContextDefinitions | public | function | |||
ContextProviderTrait::setProvidedValue | public | function | |||
ContextProviderTrait::upcastEntityId | public | function | Upcasts an entity id to a full entity object. | ||
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||
DependencySerializationTrait::__sleep | public | function | 2 | ||
DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
ExecutablePluginBase::getConfig | public | function | Gets all configuration values. | ||
ExecutablePluginBase::getConfigDefinition | public | function | Gets the definition of a configuration option. | ||
ExecutablePluginBase::getConfigDefinitions | public | function | Gets an array of definitions of available configuration options. | ||
ExecutablePluginBase::setConfig | public | function | Sets the value of a particular configuration option. | ||
ExecutablePluginTrait::getLabelValue | protected | function | Get the translated label from the plugin definition. | ||
ExecutablePluginTrait::summary | public | function | Get the translated summary from the label annotation. | 4 | |
MessengerTrait::$messenger | protected | property | The messenger. | 27 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 27 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | |
PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | |
PluginBase::$pluginId | protected | property | The plugin_id. | ||
PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | |||
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::getPluginId | public | function | Gets the plugin_id of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |
PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
RulesConditionBase::assertMetadata | public | function | Asserts additional metadata for the selected data. | Overrides ContextAwarePluginInterface::assertMetadata | 1 |
RulesConditionBase::evaluate | public | function | Evaluates the condition and returns TRUE or FALSE accordingly. | Overrides ConditionInterface::evaluate | 5 |
RulesConditionBase::getContextValue | public | function | Gets the value for a defined context. | Overrides ContextAwarePluginTrait::getContextValue | |
RulesConditionBase::negate | public | function | Negates the result after evaluating this condition. | Overrides RulesConditionInterface::negate | |
RulesConditionBase::refineContextDefinitions | public | function | Refines used and provided context definitions based upon context values. | Overrides ContextAwarePluginInterface::refineContextDefinitions | 1 |
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |
UserHasRole::doEvaluate | protected | function | Evaluate if user has role(s). |