RolesRid.php

Same filename in other branches
  1. 9 core/modules/user/src/Plugin/views/argument/RolesRid.php
  2. 8.9.x core/modules/user/src/Plugin/views/argument/RolesRid.php
  3. 11.x core/modules/user/src/Plugin/views/argument/RolesRid.php

Namespace

Drupal\user\Plugin\views\argument

File

core/modules/user/src/Plugin/views/argument/RolesRid.php

View source
<?php

namespace Drupal\user\Plugin\views\argument;

use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\views\Attribute\ViewsArgument;
use Drupal\views\Plugin\views\argument\ManyToOne;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Allow role ID(s) as argument.
 *
 * @ingroup views_argument_handlers
 */
class RolesRid extends ManyToOne {
    
    /**
     * The role entity storage.
     *
     * @var \Drupal\user\RoleStorage
     */
    protected $roleStorage;
    
    /**
     * Constructs a \Drupal\user\Plugin\views\argument\RolesRid 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\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->roleStorage = $entity_type_manager->getStorage('user_role');
    }
    
    /**
     * {@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'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function titleQuery() {
        $entities = $this->roleStorage
            ->loadMultiple($this->value);
        $titles = [];
        foreach ($entities as $entity) {
            $titles[] = $entity->label();
        }
        return $titles;
    }

}

Classes

Title Deprecated Summary
RolesRid Allow role ID(s) as argument.

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