You are here

Home » API reference » RNG - Events and Registrations 8.2 » UserRole.php

class UserRole in RNG - Events and Registrations 8.2

Same name and namespace in other branches
  1. 8 src/Plugin/Condition/UserRole.php \Drupal\rng\Plugin\Condition\UserRole
  2. 3.x src/Plugin/Condition/UserRole.php \Drupal\rng\Plugin\Condition\UserRole

Provides a user role condition where all roles are matched.

Plugin annotation


@Condition(
  id = "rng_user_role",
  label = @Translation("User Role"),
  context = {
    "user" = @ContextDefinition("entity:user",
      label = @Translation("User"),
      required = TRUE
    )
  }
)

Hierarchy

Expanded class hierarchy of UserRole

File

src/Plugin/Condition/UserRole.php, line 25

Namespace

Drupal\rng\Plugin\Condition
View source 
class UserRole extends CoreUserRole implements RNGConditionInterface {

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['roles']['#title'] = $this
      ->t('When the user has all of the following roles');
    $form['roles']['#options'] = array_map('\\Drupal\\Component\\Utility\\SafeMarkup::checkPlain', $this
      ->getRoles());
    $form['roles']['#description'] = $this
      ->t('If you select no roles, the condition will evaluate to TRUE for all logged-in users.');
    $form['negate']['#access'] = FALSE;
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function summary() {

    // Ensure roles in configuration are still existing or valid roles.
    $roles = array_intersect_key($this
      ->getRoles(), $this->configuration['roles']);
    if (!count($roles)) {
      return $this
        ->t('Any registered user');
    }
    return $this
      ->t(empty($this->configuration['negate']) ? 'User is a member of @roles' : 'User is not a member of @roles', [
      '@roles' => count($roles) > 1 ? implode(' and ', $roles) : reset($roles),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function alterQuery(&$query) {
    if ($query
      ->getEntityTypeId() != 'user') {
      throw new \Exception('Query only operates on user entity type.');
    }

    // Ensure roles in configuration are still existing or valid roles.
    $roles = array_intersect_key($this
      ->getRoles(), $this->configuration['roles']);
    if (count($roles)) {
      foreach (array_keys($roles) as $role) {
        $group = $query
          ->andConditionGroup();
        $group
          ->condition('roles', $role, '=');
        $query
          ->condition($group);
      }
    }
  }

  /**
   * Get a list of valid roles permitted by global settings.
   *
   * Anonymous and authenticated roles are automatically removed.
   *
   * @return array
   *   An array of role labels keyed by role ID.
   */
  private function getRoles() {
    $options = [];
    foreach (Role::loadMultiple() as $role) {

      /** @var \Drupal\user\RoleInterface $role */
      if ($role
        ->getThirdPartySetting('rng', 'condition_rng_role', FALSE)) {
        $options[$role
          ->id()] = $role
          ->label();
      }
    }

    // If there are no roles enabled, then expose all roles.
    if (!count($options)) {
      $options = user_role_names(TRUE);
    }
    unset($options[AccountInterface::ANONYMOUS_ROLE]);
    unset($options[AccountInterface::AUTHENTICATED_ROLE]);
    return $options;
  }

}

Members

Namesort descending Modifiers Type Description 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 Overrides \Drupal\Component\Plugin\PluginBase::__construct(). Overrides ContextAwarePluginBase::__construct 4
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.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated private property Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
ContextAwarePluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 4
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get public function Implements magic __get() method.
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 1
DependencySerializationTrait::__wakeup public function 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.
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::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.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2
UserRole::alterQuery public function Modify a query with condition configuration. Overrides RNGConditionInterface::alterQuery
UserRole::buildConfigurationForm public function Form constructor. Overrides UserRole::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 The cache contexts associated with this object. Overrides ContextAwarePluginBase::getCacheContexts
UserRole::getRoles private function Get a list of valid roles permitted by global settings.
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 UserRole::summary