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 identi

AclProviderInterface::findAcls()

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

AclProvider::findAcl()

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

AclProvider::findAcls()

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

AclProvider

class AclProvider implements AclProviderInterface An ACL provider implementation. This provider assumes that all ACLs share the same PermissionGrantingStrategy. Constants MAX_BATCH_SIZE Methods __construct(Connection $connection, PermissionGrantingStrategyInterface $permissionGrantingStrategy, array $options, AclCacheInterface $cache = null) Constructor. array findChildren(ObjectIdentityInterface $parentOid, bool $directChildrenOnly = false) Retrieves all child object identiti

AclProvider::findChildren()

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::isFieldGranted()

bool isFieldGranted(string $field, array $masks, array $securityIdentities, bool $administrativeMode = false) Determines whether field access is granted Parameters string $field array $masks array $securityIdentities bool $administrativeMode Return Value bool

AclInterface::isGranted()

bool isGranted(array $masks, array $securityIdentities, bool $administrativeMode = false) Determines whether access is granted Parameters array $masks array $securityIdentities bool $administrativeMode Return Value bool Exceptions NoAceFoundException when no ACE was applicable for this request

AclNotFoundException

class AclNotFoundException extends Exception This exception is thrown when we cannot locate an ACL for a passed ObjectIdentity implementation.

AclInterface::isSidLoaded()

bool isSidLoaded(mixed $securityIdentities) Whether the ACL has loaded ACEs for all of the passed security identities Parameters mixed $securityIdentities an implementation of SecurityIdentityInterface, or an array thereof Return Value bool