interface VoterInterface

VoterInterface is the interface implemented by all voters.

Constants

ACCESS_GRANTED

ACCESS_ABSTAIN

ACCESS_DENIED

Methods

bool
supportsAttribute(mixed $attribute) deprecated

Checks if the voter supports the given attribute.

bool
supportsClass(string $class) deprecated

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

at line line 36
bool supportsAttribute(mixed $attribute) deprecated

deprecated since version 2.8, to be removed in 3.0.

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

at line line 47
bool supportsClass(string $class) deprecated

deprecated since version 2.8, to be removed in 3.0.

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

at line line 61
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