UserRolesAccessPolicy.php

Same filename in other branches
  1. 11.x core/lib/Drupal/Core/Session/UserRolesAccessPolicy.php

Namespace

Drupal\Core\Session

File

core/lib/Drupal/Core/Session/UserRolesAccessPolicy.php

View source
<?php

declare (strict_types=1);
namespace Drupal\Core\Session;

use Drupal\Core\Entity\EntityTypeManagerInterface;

/**
 * Grants permissions based on a user's roles.
 */
final class UserRolesAccessPolicy extends AccessPolicyBase {
    public function __construct(EntityTypeManagerInterface $entityTypeManager) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function calculatePermissions(AccountInterface $account, string $scope) : RefinableCalculatedPermissionsInterface {
        $calculated_permissions = parent::calculatePermissions($account, $scope);
        
        /** @var \Drupal\user\RoleInterface[] $user_roles */
        $user_roles = $this->entityTypeManager
            ->getStorage('user_role')
            ->loadMultiple($account->getRoles());
        foreach ($user_roles as $user_role) {
            $calculated_permissions->addItem(new CalculatedPermissionsItem($user_role->getPermissions(), $user_role->isAdmin()))
                ->addCacheableDependency($user_role);
        }
        return $calculated_permissions;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getPersistentCacheContexts() : array {
        return [
            'user.roles',
        ];
    }

}

Classes

Title Deprecated Summary
UserRolesAccessPolicy Grants permissions based on a user's roles.

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