RoleVoter

class RoleVoter implements VoterInterface

RoleVoter votes if any attribute starts with a given prefix.

Methods

__construct(string $prefix = 'ROLE_')
bool supportsAttribute(mixed $attribute)

Checks if the voter supports the given attribute.

bool supportsClass(string $class)

Checks if the voter supports the given class.

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

Returns the vote for the given parameters.

Details

__construct(string $prefix = 'ROLE_')

Parameters

string $prefix The role prefix

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

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

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: ACCESSGRANTED, ACCESSDENIED, 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 ACCESSGRANTED, ACCESSABSTAIN, or ACCESS_DENIED

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Security/Core/Authorization/Voter/RoleVoter.html