class Roles in Drupal 10

Filter handler for user roles.

Plugin annotation

@ViewsFilter("user_roles");

Hierarchy

• class \Drupal\views\Plugin\views\filter\FilterPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements CacheableDependencyInterface
  • class \Drupal\views\Plugin\views\filter\InOperator
    • class \Drupal\views\Plugin\views\filter\ManyToOne
      • class \Drupal\user\Plugin\views\filter\Roles

Related topics

Views filter handler plugins

Plugins that handle views filtering.

19 string references to 'Roles'

AccountForm::form in core/modules/user/src/AccountForm.php

Gets the actual form array to be built.

BlockForm::buildVisibilityInterface in core/modules/block/src/BlockForm.php

Helper function for building the visibility UI form.

drupal6.php in core/modules/migrate_drupal/tests/fixtures/drupal6.php

A database agnostic dump for testing purposes.

drupal7.php in core/modules/tracker/tests/fixtures/drupal7.php

A database agnostic dump for testing purposes.

drupal7.php in core/modules/rdf/tests/fixtures/drupal7.php

A database agnostic dump for testing purposes.

... See full list

File

core/modules/user/src/Plugin/views/filter/Roles.php, line 17

Namespace

Drupal\user\Plugin\views\filter

class Roles extends ManyToOne {

  /**
   * The role storage.
   *
   * @var \Drupal\user\RoleStorageInterface
   */
  protected $roleStorage;

  /**
   * Constructs a Roles 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'));
  }
  public function getValueOptions() {
    $this->valueOptions = user_role_names(TRUE);
    unset($this->valueOptions[RoleInterface::AUTHENTICATED_ID]);
    return $this->valueOptions;
  }

  /**
   * Override empty and not empty operator labels to be clearer for user roles.
   */
  public function operators() {
    $operators = parent::operators();
    $operators['empty']['title'] = $this
      ->t("Only has the 'authenticated user' role");
    $operators['not empty']['title'] = $this
      ->t("Has roles in addition to 'authenticated user'");
    return $operators;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $dependencies = [];
    if (in_array($this->operator, [
      'empty',
      'not empty',
    ])) {
      return $dependencies;
    }

    // The value might be a string due to the wrong plugin being used for role
    // field data, and subsequently the incorrect config schema object and
    // value. In the empty case stop early. Otherwise we cast it to an array
    // later.
    if (is_string($this->value) && $this->value === '') {
      return [];
    }
    foreach ((array) $this->value as $role_id) {
      if ($role = $this->roleStorage
        ->load($role_id)) {
        $dependencies[$role
          ->getConfigDependencyKey()][] = $role
          ->getConfigDependencyName();
      }
      else {
        trigger_error("The {$role_id} role does not exist. You should review and fix the configuration of the {$this->view->id()} view.", E_USER_WARNING);
      }
    }
    return $dependencies;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FilterPluginBase::$alwaysMultiple	protected	property	Disable the possibility to force a single value.	4
FilterPluginBase::$always_required	public	property	Disable the possibility to allow an exposed input to be optional.
FilterPluginBase::$group_info	public	property	Contains the information of the selected item in a grouped filter.
FilterPluginBase::$no_operator	public	property	Disable the possibility to use operators.	1
FilterPluginBase::$operator	public	property	Contains the operator which is used on the query.
FilterPluginBase::$value	public	property	Contains the actual value of the field,either configured in the views ui or entered in the exposed filters.
FilterPluginBase::addGroupForm	public	function	Add a new group to the exposed filter groups.
FilterPluginBase::arrayFilterZero	protected static	function	Filter by no empty values, though allow the use of (string) "0".
FilterPluginBase::buildExposedFiltersGroupForm	protected	function	Build the form to let users create the group of exposed filters.
FilterPluginBase::buildExposedForm	public	function	Render our chunk of the exposed filter form when selecting.
FilterPluginBase::buildGroupForm	public	function	Displays the Build Group form.
FilterPluginBase::buildGroupOptions	protected	function	Provide default options for exposed filters.
FilterPluginBase::buildGroupSubmit	protected	function	Save new group items, re-enumerates and remove groups marked to delete.
FilterPluginBase::buildGroupValidate	protected	function	Validate the build group options form.
FilterPluginBase::buildOptionsForm	public	function	Provide the basic form which calls through to subforms.	1
FilterPluginBase::buildValueWrapper	protected	function	Builds wrapper for value and operator forms.
FilterPluginBase::canBuildGroup	protected	function	Determine if a filter can be converted into a group.
FilterPluginBase::canExpose	public	function	Determine if a filter can be exposed.	5
FilterPluginBase::canGroup	public	function	Can this filter be used in OR groups?	1
FilterPluginBase::convertExposedInput	public	function	Transform the input from a grouped filter into a standard filter.
FilterPluginBase::exposedInfo	public	function	Tell the renderer about our exposed form. This only needs to be overridden for particularly complex forms. And maybe not even then.
FilterPluginBase::exposedTranslate	protected	function	Make some translations to a form item to make it more suitable to exposing.
FilterPluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	5
FilterPluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
FilterPluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	1
FilterPluginBase::groupForm	public	function	Build a form containing a group of operator | values to apply as a single filter.
FilterPluginBase::groupMultipleExposedInput	public	function	Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected.
FilterPluginBase::hasValidGroupedValue	protected	function	Determines if the given grouped filter entry has a valid value.	1
FilterPluginBase::isAGroup	public	function	Returns TRUE if the exposed filter works like a grouped filter.
FilterPluginBase::multipleExposedInput	public	function	Returns TRUE if users can select multiple groups items of a grouped exposed filter.
FilterPluginBase::operatorForm	protected	function	Options form subform for setting the operator.	5
FilterPluginBase::operatorSubmit	public	function	Perform any necessary changes to the form values prior to storage.
FilterPluginBase::operatorValidate	protected	function	Validate the operator form.
FilterPluginBase::prepareFilterSelectOptions	protected	function	Sanitizes the HTML select element's options.
FilterPluginBase::showBuildGroupButton	protected	function	Shortcut to display the build_group/hide button.
FilterPluginBase::showBuildGroupForm	public	function	Shortcut to display the exposed options form.
FilterPluginBase::showExposeButton	public	function	Shortcut to display the expose/hide button.
FilterPluginBase::showOperatorForm	public	function	Shortcut to display the operator form.
FilterPluginBase::showValueForm	protected	function	Shortcut to display the value form.
FilterPluginBase::storeExposedInput	public	function
FilterPluginBase::storeGroupInput	public	function	If set to remember exposed input in the session, store it there.
FilterPluginBase::submitOptionsForm	public	function	Simple submit handler.
FilterPluginBase::trustedCallbacks	public static	function
FilterPluginBase::validateExposeForm	public	function	Validate the options form.
FilterPluginBase::validateIdentifier	protected	function	Validates a filter identifier.
FilterPluginBase::validateOptionsForm	public	function	Simple validate handler.	1
FilterPluginBase::valueValidate	protected	function	Validate the options form.	2
InOperator::$valueOptions	protected	property	Stores all operations which are available on the form.
InOperator::$valueTitle	protected	property	The filter title.
InOperator::acceptExposedInput	public	function	Determines if the input from a filter should change the generated query. Overrides FilterPluginBase::acceptExposedInput	2
InOperator::adminSummary	public	function	Display the filter on the administrative summary. Overrides FilterPluginBase::adminSummary	2
InOperator::buildExposeForm	public	function	Options form subform for exposed filter options. Overrides FilterPluginBase::buildExposeForm	1
InOperator::defaultExposeOptions	public	function	Provide default options for exposed filters. Overrides FilterPluginBase::defaultExposeOptions
InOperator::opEmpty	protected	function
InOperator::operatorOptions	public	function	Build strings from the operators() for 'select' options. Overrides FilterPluginBase::operatorOptions	1
InOperator::operatorValues	protected	function
InOperator::opSimple	protected	function		1
InOperator::query	public	function	Add this filter to the query. Overrides FilterPluginBase::query	5
InOperator::reduceValueOptions	public	function	When using exposed filters, we may be required to reduce the set.
InOperator::validate	public	function	Overrides FilterPluginBase::validate
InOperator::valueSubmit	protected	function	Perform any necessary changes to the form values prior to storage. Overrides FilterPluginBase::valueSubmit	2
ManyToOne::$helper	public	property	Stores the Helper object which handles the many_to_one complexity.
ManyToOne::$valueFormType	protected	property	Overrides InOperator::$valueFormType
ManyToOne::defineOptions	protected	function	Overrides InOperator::defineOptions	1
ManyToOne::ensureMyTable	public	function	Override ensureMyTable so we can control how this joins in. The operator actually has influence over joining.
ManyToOne::init	public	function	Overrides \Drupal\views\Plugin\views\HandlerBase::init(). Overrides InOperator::init	2
ManyToOne::opHelper	protected	function
ManyToOne::valueForm	protected	function	Options form subform for setting options. Overrides InOperator::valueForm	1
Roles::$roleStorage	protected	property	The role storage.
Roles::calculateDependencies	public	function
Roles::create	public static	function
Roles::getValueOptions	public	function	Child classes should be used to override this function and set the 'value options', unless 'options callback' is defined as a valid function or static public method to generate these values. Overrides InOperator::getValueOptions
Roles::operators	public	function	Override empty and not empty operator labels to be clearer for user roles. Overrides ManyToOne::operators
Roles::__construct	public	function	Constructs a Roles object.