VoterInterface
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
bool supportsAttribute(mixed $attribute) deprecated
deprecated
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) deprecated
deprecated
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)
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 |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Security/Core/Authorization/Voter/VoterInterface.html