AbstractVoter

class AbstractVoter implements VoterInterface

Abstract Voter implementation that reduces boilerplate code required to create a custom Voter.

Methods

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) Iteratively check all given attributes by calling isGranted.

Details

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)

Iteratively check all given attributes by calling isGranted.

This method terminates as soon as it is able to return ACCESSGRANTED If at least one attribute is supported, but access not granted, then ACCESSDENIED is returned Otherwise it will return 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/AbstractVoter.html