Same filename in this branch
  1. 10 core/modules/user/src/Plugin/views/field/Roles.php
  2. 10 core/modules/user/src/Plugin/views/filter/Roles.php
Same filename and directory in other branches
  1. 8.9.x core/modules/user/src/Plugin/views/field/Roles.php
  2. 9 core/modules/user/src/Plugin/views/field/Roles.php

Namespace

Drupal\user\Plugin\views\field

File

core/modules/user/src/Plugin/views/field/Roles.php
View source
<?php

namespace Drupal\user\Plugin\views\field;

use Drupal\Core\Database\Connection;
use Drupal\views\Attribute\ViewsField;
use Drupal\views\Plugin\views\display\DisplayPluginBase;
use Drupal\views\ViewExecutable;
use Drupal\views\Plugin\views\field\PrerenderList;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\user\Entity\Role;

/**
 * Field handler to provide a list of roles.
 *
 * @ingroup views_field_handlers
 */

#[ViewsField("user_roles")]
class Roles extends PrerenderList {

  /**
   * Database Service Object.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

  /**
   * Constructs a \Drupal\user\Plugin\views\field\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\Core\Database\Connection $database
   *   Database Service Object.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, Connection $database) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->database = $database;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('database'));
  }

  /**
   * {@inheritdoc}
   */
  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
    parent::init($view, $display, $options);
    $this->additional_fields['uid'] = [
      'table' => 'users_field_data',
      'field' => 'uid',
    ];
  }
  public function query() {
    $this
      ->addAdditionalFields();
    $this->field_alias = $this->aliases['uid'];
  }
  public function preRender(&$values) {
    $uids = [];
    $this->items = [];
    foreach ($values as $result) {
      $uids[] = $this
        ->getValue($result);
    }
    if ($uids) {
      $roles = Role::loadMultiple();
      $result = $this->database
        ->query('SELECT [u].[entity_id] AS [uid], [u].[roles_target_id] AS [rid] FROM {user__roles} [u] WHERE [u].[entity_id] IN ( :uids[] ) AND [u].[roles_target_id] IN ( :rids[] )', [
        ':uids[]' => $uids,
        ':rids[]' => array_keys($roles),
      ]);
      foreach ($result as $role) {
        $this->items[$role->uid][$role->rid]['role'] = $roles[$role->rid]
          ->label();
        $this->items[$role->uid][$role->rid]['rid'] = $role->rid;
      }

      // Sort the roles for each user by role weight.
      $ordered_roles = array_flip(array_keys($roles));
      foreach ($this->items as &$user_roles) {

        // Create an array of rids that the user has in the role weight order.
        $sorted_keys = array_intersect_key($ordered_roles, $user_roles);

        // Merge with the unsorted array of role information which has the
        // effect of sorting it.
        $user_roles = array_replace($sorted_keys, $user_roles);
      }
    }
  }
  public function render_item($count, $item) {
    return $item['role'];
  }
  protected function documentSelfTokens(&$tokens) {
    $tokens['{{ ' . $this->options['id'] . '__role' . ' }}'] = $this
      ->t('The name of the role.');
    $tokens['{{ ' . $this->options['id'] . '__rid' . ' }}'] = $this
      ->t('The role machine-name of the role.');
  }
  protected function addSelfTokens(&$tokens, $item) {
    if (!empty($item['role'])) {
      $tokens['{{ ' . $this->options['id'] . '__role }}'] = $item['role'];
      $tokens['{{ ' . $this->options['id'] . '__rid }}'] = $item['rid'];
    }
  }

}

Classes

Namesort descending Description
Roles