Symfony2 API
Class

Symfony\Component\Security\Core\Authorization\Voter\RoleVoter

class RoleVoter implements VoterInterface

RoleVoter votes if any attribute starts with a given prefix.

Methods

__construct(string $prefix = 'ROLE_')

Constructor.
Boolean supportsAttribute(string $attribute)

Checks if the voter supports the given attribute.
true supportsClass(string $class)

Checks if the voter supports the given class.
integer vote(TokenInterface $token, object $object, array $attributes)

Returns the vote for the given parameters.

Details

at line 30
public __construct(string $prefix = 'ROLE_')

Constructor.

Parameters

string $prefix The role prefix

at line 38
public Boolean supportsAttribute(string $attribute)

Checks if the voter supports the given attribute.

Parameters

string $attribute An attribute

Return Value

Boolean true if this Voter supports the attribute, false otherwise

at line 46
public true supportsClass(string $class)

Checks if the voter supports the given class.

Parameters

string $class A class name

Return Value

true if this Voter can process the class

at line 54
public integer vote(TokenInterface $token, object $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 $object The object to secure
array $attributes An array of attributes associated with the method being invoked

Return Value

integer either ACCESS_GRANTED, ACCESS_ABSTAIN, or ACCESS_DENIED