MutableAclProviderInterface
interface MutableAclProviderInterface implements AclProviderInterface
Provides support for creating and storing ACL instances.
Methods
| array | findChildren(ObjectIdentityInterface $parentOid, Boolean $directChildrenOnly = false) Retrieves all child object identities from the database | from AclProviderInterface |
| AclInterface | findAcl(ObjectIdentityInterface $oid, array $sids = array()) Returns the ACL that belongs to the given object identity | from AclProviderInterface |
| SplObjectStorage | findAcls(array $oids, array $sids = array()) Returns the ACLs that belong to the given object identities | from AclProviderInterface |
| MutableAclInterface | createAcl(ObjectIdentityInterface $oid) Creates a new ACL for the given object identity. | |
| deleteAcl(ObjectIdentityInterface $oid) Deletes the ACL for a given object identity. | ||
| updateAcl(MutableAclInterface $acl) Persists any changes which were made to the ACL, or any associated access control entries. |
Details
array findChildren(ObjectIdentityInterface $parentOid, Boolean $directChildrenOnly = false)
Retrieves all child object identities from the database
Parameters
| ObjectIdentityInterface | $parentOid | |
| Boolean | $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 |
MutableAclInterface createAcl(ObjectIdentityInterface $oid)
Creates a new ACL for the given object identity.
Parameters
| ObjectIdentityInterface | $oid |
Return Value
| MutableAclInterface |
Exceptions
| AclAlreadyExistsException | when there already is an ACL for the given object identity |
deleteAcl(ObjectIdentityInterface $oid)
Deletes the ACL for a given object identity.
This will automatically trigger a delete for any child ACLs. If you don't want child ACLs to be deleted, you will have to set their parent ACL to null.
Parameters
| ObjectIdentityInterface | $oid |
updateAcl(MutableAclInterface $acl)
Persists any changes which were made to the ACL, or any associated access control entries.
Changes to parent ACLs are not persisted.
Parameters
| MutableAclInterface | $acl |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Security/Acl/Model/MutableAclProviderInterface.html