W3cubDocs

/Symfony 4.1

RoleHierarchyVoter

class RoleHierarchyVoter extends RoleVoter

RoleHierarchyVoter uses a RoleHierarchy to determine the roles granted to the user before voting.

Methods

__construct(RoleHierarchyInterface $roleHierarchy, string $prefix = 'ROLE_')
int vote(TokenInterface $token, mixed $subject, array $attributes)

Returns the vote for the given parameters.

from RoleVoter
extractRoles(TokenInterface $token)

Details

__construct(RoleHierarchyInterface $roleHierarchy, string $prefix = 'ROLE_')

Parameters

RoleHierarchyInterface $roleHierarchy
string $prefix

int vote(TokenInterface $token, mixed $subject, array $attributes)

Returns the vote for the given parameters.

This method must return one of the following constants: ACCESS_GRANTED, ACCESS_DENIED, or ACCESS_ABSTAIN.

Parameters

TokenInterface $token A TokenInterface instance
mixed $subject The subject to secure
array $attributes An array of attributes associated with the method being invoked

Return Value

int either ACCESS_GRANTED, ACCESS_ABSTAIN, or ACCESS_DENIED

protected extractRoles(TokenInterface $token)

Parameters

TokenInterface $token