class UserRole in RNG - Events and Registrations 3.x

Same name and namespace in other branches

8.2 src/Plugin/Condition/UserRole.php \Drupal\rng\Plugin\Condition\UserRole
8 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

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Executable\ExecutablePluginBase implements CacheableDependencyInterface, ExecutableInterface, ContextAwarePluginInterface uses ContextAwarePluginTrait
    class \Drupal\Core\Condition\ConditionPluginBase implements ConditionInterface uses ContextAwarePluginAssignmentTrait
    class \Drupal\user\Plugin\Condition\UserRole
    class \Drupal\rng\Plugin\Condition\UserRole implements RNGConditionInterface

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

Name	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	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	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 protected	function		1
ContextAwarePluginTrait::setContext	public	function		1
ContextAwarePluginTrait::setContextMapping	public	function
ContextAwarePluginTrait::setContextValue	public	function
ContextAwarePluginTrait::validateContexts	public	function
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
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.
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.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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
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	Overrides ContextAwarePluginTrait::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

You are here

class UserRole in RNG - Events and Registrations 3.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation