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_')

No description

bool
supportsAttribute(mixed $attribute)

Checks if the voter supports the given attribute.

from RoleVoter
bool
supportsClass(string $class)

Checks if the voter supports the given class.

from RoleVoter
int
vote(TokenInterface $token, object|null $object, array $attributes)

Returns the vote for the given parameters.

from RoleVoter
extractRoles(TokenInterface $token)

No description

Details

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

Parameters

RoleHierarchyInterface $roleHierarchy
string $prefix The role prefix

in RoleVoter at line 37
bool supportsAttribute(mixed $attribute)

Checks if the voter supports the given attribute.

Parameters

mixed $attribute An attribute (usually the attribute name string)

Return Value

bool true if this Voter supports the attribute, false otherwise

in RoleVoter at line 45
bool supportsClass(string $class)

Checks if the voter supports the given class.

Parameters

string $class A class name

Return Value

bool true if this Voter can process the class

in RoleVoter at line 53
int vote(TokenInterface $token, object|null $object, 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
object|null $object The object 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

at line 37
protected extractRoles(TokenInterface $token)

Parameters

TokenInterface $token