class UserRole

Same name in other branches
  1. 8.9.x core/modules/user/src/Plugin/Condition/UserRole.php \Drupal\user\Plugin\Condition\UserRole
  2. 10 core/modules/user/src/Plugin/Condition/UserRole.php \Drupal\user\Plugin\Condition\UserRole
  3. 11.x core/modules/user/src/Plugin/Condition/UserRole.php \Drupal\user\Plugin\Condition\UserRole

Provides a 'User Role' condition.

Plugin annotation


@Condition(
  id = "user_role",
  label = @Translation("User Role"),
  context_definitions = {
    "user" = @ContextDefinition("entity:user", label = @Translation("User"))
  }
)

Hierarchy

Expanded class hierarchy of UserRole

File

core/modules/user/src/Plugin/Condition/UserRole.php, line 19

Namespace

Drupal\user\Plugin\Condition
View source
class UserRole extends ConditionPluginBase {
    
    /**
     * {@inheritdoc}
     */
    public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
        $form['roles'] = [
            '#type' => 'checkboxes',
            '#title' => $this->t('When the user has the following roles'),
            '#default_value' => $this->configuration['roles'],
            '#options' => array_map('\\Drupal\\Component\\Utility\\Html::escape', user_role_names()),
            '#description' => $this->t('If you select no roles, the condition will evaluate to TRUE for all users.'),
        ];
        return parent::buildConfigurationForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function defaultConfiguration() {
        return [
            'roles' => [],
        ] + parent::defaultConfiguration();
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
        $this->configuration['roles'] = array_filter($form_state->getValue('roles'));
        parent::submitConfigurationForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function summary() {
        // Use the role labels. They will be sanitized below.
        $roles = array_intersect_key(user_role_names(), $this->configuration['roles']);
        if (count($roles) > 1) {
            $roles = implode(', ', $roles);
        }
        else {
            $roles = reset($roles);
        }
        if (!empty($this->configuration['negate'])) {
            return $this->t('The user is not a member of @roles', [
                '@roles' => $roles,
            ]);
        }
        else {
            return $this->t('The user is a member of @roles', [
                '@roles' => $roles,
            ]);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function evaluate() {
        if (empty($this->configuration['roles']) && !$this->isNegated()) {
            return TRUE;
        }
        $user = $this->getContextValue('user');
        return (bool) array_intersect($this->configuration['roles'], $user->getRoles());
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheContexts() {
        // Optimize cache context, if a user cache context is provided, only use
        // user.roles, since that's the only part this condition cares about.
        $contexts = [];
        foreach (parent::getCacheContexts() as $context) {
            $contexts[] = $context == 'user' ? 'user.roles' : $context;
        }
        return $contexts;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConditionPluginBase::$executableManager protected property The condition manager to proxy execute calls through.
ConditionPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
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::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ConditionPluginBase::__construct public function 5
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::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::getContextValue 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
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.
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
UserRole::buildConfigurationForm public function Form constructor. Overrides ConditionPluginBase::buildConfigurationForm
UserRole::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConditionPluginBase::defaultConfiguration
UserRole::evaluate public function Evaluates the condition and returns TRUE or FALSE accordingly. Overrides ConditionInterface::evaluate
UserRole::getCacheContexts public function Overrides ContextAwarePluginTrait::getCacheContexts
UserRole::submitConfigurationForm public function Form submission handler. Overrides ConditionPluginBase::submitConfigurationForm
UserRole::summary public function Provides a human readable summary of the condition's configuration. Overrides ConditionInterface::summary

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.