Voter
abstract class Voter implements VoterInterface
Voter is an abstract default implementation of a voter.
Methods
| int | vote(TokenInterface $token, mixed $subject, array $attributes) Returns the vote for the given parameters. | |
| bool | supports(string $attribute, mixed $subject) Determines if the attribute and subject are supported by this voter. | |
| bool | voteOnAttribute(string $attribute, mixed $subject, TokenInterface $token) Perform a single access check operation on a given attribute, subject and token. |
Details
int vote(TokenInterface $token, mixed $subject, 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 |
| mixed | $subject | The subject to secure |
| array | $attributes | An array of attributes associated with the method being invoked |
Return Value
| int | either ACCESS_GRANTED, ACCESS_ABSTAIN, or ACCESS_DENIED |
abstract protected bool supports(string $attribute, mixed $subject)
Determines if the attribute and subject are supported by this voter.
Parameters
| string | $attribute | An attribute |
| mixed | $subject | The subject to secure, e.g. an object the user wants to access or any other PHP type |
Return Value
| bool | True if the attribute and subject are supported, false otherwise |
abstract protected bool voteOnAttribute(string $attribute, mixed $subject, TokenInterface $token)
Perform a single access check operation on a given attribute, subject and token.
It is safe to assume that $attribute and $subject already passed the "supports()" method check.
Parameters
| string | $attribute | |
| mixed | $subject | |
| TokenInterface | $token |
Return Value
| bool |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Security/Core/Authorization/Voter/Voter.html