AclProviderInterface

interface AclProviderInterface

Provides a common interface for retrieving ACLs.

Methods

array findChildren(ObjectIdentityInterface $parentOid, bool $directChildrenOnly = false)

Retrieves all child object identities from the database

AclInterface findAcl(ObjectIdentityInterface $oid, array $sids = array())

Returns the ACL that belongs to the given object identity

SplObjectStorage findAcls(array $oids, array $sids = array())

Returns the ACLs that belong to the given object identities

Details

array findChildren(ObjectIdentityInterface $parentOid, bool $directChildrenOnly = false)

Retrieves all child object identities from the database

Parameters

ObjectIdentityInterface $parentOid
bool $directChildrenOnly

Return Value

array returns an array of child 'ObjectIdentity's

AclInterface findAcl(ObjectIdentityInterface $oid, array $sids = array())

Returns the ACL that belongs to the given object identity

Parameters

ObjectIdentityInterface $oid
array $sids

Return Value

AclInterface

Exceptions

AclNotFoundException when there is no ACL

SplObjectStorage findAcls(array $oids, array $sids = array())

Returns the ACLs that belong to the given object identities

Parameters

array $oids an array of ObjectIdentityInterface implementations
array $sids an array of SecurityIdentityInterface implementations

Return Value

SplObjectStorage mapping the passed object identities to ACLs

Exceptions

AclNotFoundException when we cannot find an ACL for all identities

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.3/Symfony/Component/Security/Acl/Model/AclProviderInterface.html