W3cubDocs

/Symfony 2.7

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.
Boolean 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

public __construct(string $prefix = 'ROLE_')

Constructor.

Parameters

string $prefix The role prefix

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

public Boolean supportsClass(string $class)

Checks if the voter supports the given class.

Parameters

string $class A class name

Return Value

Boolean true if this Voter can process the class

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

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