Permissions.php

Same filename in this branch
  1. 11.x core/modules/content_moderation/src/Permissions.php
  2. 11.x core/modules/user/src/Plugin/views/filter/Permissions.php
Same filename and directory in other branches
  1. 9 core/modules/content_moderation/src/Permissions.php
  2. 9 core/modules/user/src/Plugin/views/field/Permissions.php
  3. 9 core/modules/user/src/Plugin/views/filter/Permissions.php
  4. 8.9.x core/modules/content_moderation/src/Permissions.php
  5. 8.9.x core/modules/user/src/Plugin/views/field/Permissions.php
  6. 8.9.x core/modules/user/src/Plugin/views/filter/Permissions.php
  7. 10 core/modules/content_moderation/src/Permissions.php
  8. 10 core/modules/user/src/Plugin/views/field/Permissions.php
  9. 10 core/modules/user/src/Plugin/views/filter/Permissions.php

Namespace

Drupal\user\Plugin\views\field

File

core/modules/user/src/Plugin/views/field/Permissions.php

View source
<?php

namespace Drupal\user\Plugin\views\field;

use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
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;

/**
 * Field handler to provide a list of permissions.
 *
 * @ingroup views_field_handlers
 */
class Permissions extends PrerenderList {
    
    /**
     * The role storage.
     *
     * @var \Drupal\user\RoleStorageInterface
     */
    protected $roleStorage;
    
    /**
     * The module handler.
     *
     * @var \Drupal\Core\Extension\ModuleHandlerInterface
     */
    protected $moduleHandler;
    
    /**
     * Constructs a \Drupal\user\Plugin\views\field\Permissions 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\Extension\ModuleHandlerInterface $module_handler
     *   The module handler.
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, ModuleHandlerInterface $module_handler, EntityTypeManagerInterface $entity_type_manager) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->roleStorage = $entity_type_manager->getStorage('user_role');
        $this->moduleHandler = $module_handler;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('module_handler'), $container->get('entity_type.manager'));
    }
    
    /**
     * {@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) {
        $this->items = [];
        $permission_names = \Drupal::service('user.permissions')->getPermissions();
        $rids = [];
        foreach ($values as $result) {
            $user = $this->getEntity($result);
            if ($user) {
                $user_rids = $user->getRoles();
                $uid = $this->getValue($result);
                foreach ($user_rids as $rid) {
                    $rids[$rid][] = $uid;
                }
            }
        }
        if ($rids) {
            $roles = $this->roleStorage
                ->loadMultiple(array_keys($rids));
            foreach ($rids as $rid => $role_uids) {
                foreach ($roles[$rid]->getPermissions() as $permission) {
                    foreach ($role_uids as $uid) {
                        $this->items[$uid][$permission]['permission'] = $permission_names[$permission]['title'];
                    }
                }
            }
            foreach ($this->items as &$permission) {
                ksort($permission);
            }
        }
    }
    public function render_item($count, $item) {
        return $item['permission'];
    }

}

Classes

Title Deprecated Summary
Permissions Field handler to provide a list of permissions.

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