RoleHierarchyVoter
class RoleHierarchyVoter extends RoleVoter
RoleHierarchyVoter uses a RoleHierarchy to determine the roles granted to the user before voting.
Methods
| __construct(RoleHierarchyInterface $roleHierarchy, string $prefix = 'ROLE_') Constructor. | ||
| Boolean | supportsAttribute(string $attribute) Checks if the voter supports the given attribute. | from RoleVoter |
| Boolean | supportsClass(string $class) Checks if the voter supports the given class. | from RoleVoter |
| integer | vote(TokenInterface $token, object $object, array $attributes) Returns the vote for the given parameters. | from RoleVoter |
Details
__construct(RoleHierarchyInterface $roleHierarchy, string $prefix = 'ROLE_')
Constructor.
Parameters
| RoleHierarchyInterface | $roleHierarchy | |
| string | $prefix | The role prefix |
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 |
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 |
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–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.3/Symfony/Component/Security/Core/Authorization/Voter/RoleHierarchyVoter.html