1. class
  2. Symfony
  3. Component
  4. Security
  5. Acl
  6. Voter
  7. AclVoter

AclVoter

class AclVoter implements VoterInterface

This voter can be used as a base class for implementing your own permissions.

Methods

__construct(AclProviderInterface $aclProvider, ObjectIdentityRetrievalStrategyInterface $oidRetrievalStrategy, SecurityIdentityRetrievalStrategyInterface $sidRetrievalStrategy, PermissionMapInterface $permissionMap, LoggerInterface $logger = null, $allowIfObjectIdentityUnavailable = true)

No description

bool
supportsAttribute(string $attribute)

Checks if the voter supports the given attribute.

int
vote(TokenInterface $token, object|null $object, array $attributes)

Returns the vote for the given parameters.

bool
supportsClass(string $class)

You can override this method when writing a voter for a specific domain class.

Details

at line line 39
__construct(AclProviderInterface $aclProvider, ObjectIdentityRetrievalStrategyInterface $oidRetrievalStrategy, SecurityIdentityRetrievalStrategyInterface $sidRetrievalStrategy, PermissionMapInterface $permissionMap, LoggerInterface $logger = null, $allowIfObjectIdentityUnavailable = true)

Parameters

AclProviderInterface $aclProvider
ObjectIdentityRetrievalStrategyInterface $oidRetrievalStrategy
SecurityIdentityRetrievalStrategyInterface $sidRetrievalStrategy
PermissionMapInterface $permissionMap
LoggerInterface $logger
$allowIfObjectIdentityUnavailable

at line line 49
bool supportsAttribute(string $attribute)

Checks if the voter supports the given attribute.

Parameters

string $attribute An attribute

Return Value

bool true if this Voter supports the attribute, false otherwise

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

at line line 143
bool supportsClass(string $class)

You can override this method when writing a voter for a specific domain class.

Parameters

string $class A class name

Return Value

bool true if this Voter can process the class