AuditableAclInterface
interface AuditableAclInterface implements MutableAclInterface
This interface adds auditing capabilities to the ACL.
Methods
| array | getClassAces() Returns all class-based ACEs associated with this ACL | from AclInterface |
| array | getClassFieldAces(string $field) Returns all class-field-based ACEs associated with this ACL | from AclInterface |
| array | getObjectAces() Returns all object-based ACEs associated with this ACL | from AclInterface |
| array | getObjectFieldAces(string $field) Returns all object-field-based ACEs associated with this ACL | from AclInterface |
| ObjectIdentityInterface | getObjectIdentity() Returns the object identity associated with this ACL | from AclInterface |
| AclInterface|null | getParentAcl() Returns the parent ACL, or null if there is none. | from AclInterface |
| bool | isEntriesInheriting() Whether this ACL is inheriting ACEs from a parent ACL. | from AclInterface |
| bool | isFieldGranted(string $field, array $masks, array $securityIdentities, bool $administrativeMode = false) Determines whether field access is granted | from AclInterface |
| bool | isGranted(array $masks, array $securityIdentities, bool $administrativeMode = false) Determines whether access is granted | from AclInterface |
| bool | isSidLoaded(mixed $securityIdentities) Whether the ACL has loaded ACEs for all of the passed security identities | from AclInterface |
| deleteClassAce(int $index) Deletes a class-based ACE | from MutableAclInterface | |
| deleteClassFieldAce(int $index, string $field) Deletes a class-field-based ACE | from MutableAclInterface | |
| deleteObjectAce(int $index) Deletes an object-based ACE | from MutableAclInterface | |
| deleteObjectFieldAce(int $index, string $field) Deletes an object-field-based ACE | from MutableAclInterface | |
| int | getId() Returns the primary key of this ACL | from MutableAclInterface |
| insertClassAce(SecurityIdentityInterface $sid, int $mask, int $index, bool $granting = true, string $strategy = null) Inserts a class-based ACE | from MutableAclInterface | |
| insertClassFieldAce(string $field, SecurityIdentityInterface $sid, int $mask, int $index, bool $granting = true, string $strategy = null) Inserts a class-field-based ACE | from MutableAclInterface | |
| insertObjectAce(SecurityIdentityInterface $sid, int $mask, int $index, bool $granting = true, string $strategy = null) Inserts an object-based ACE | from MutableAclInterface | |
| insertObjectFieldAce(string $field, SecurityIdentityInterface $sid, int $mask, int $index, bool $granting = true, string $strategy = null) Inserts an object-field-based ACE | from MutableAclInterface | |
| setEntriesInheriting(bool $boolean) Sets whether entries are inherited | from MutableAclInterface | |
| setParentAcl(AclInterface $acl = null) Sets the parent ACL | from MutableAclInterface | |
| updateClassAce(int $index, int $mask, string $strategy = null) Updates a class-based ACE | from MutableAclInterface | |
| updateClassFieldAce(int $index, string $field, int $mask, string $strategy = null) Updates a class-field-based ACE | from MutableAclInterface | |
| updateObjectAce(int $index, int $mask, string $strategy = null) Updates an object-based ACE | from MutableAclInterface | |
| updateObjectFieldAce(int $index, string $field, int $mask, string $strategy = null) Updates an object-field-based ACE | from MutableAclInterface | |
| updateClassAuditing(int $index, bool $auditSuccess, bool $auditFailure) Updates auditing for class-based ACE | ||
| updateClassFieldAuditing(int $index, string $field, bool $auditSuccess, bool $auditFailure) Updates auditing for class-field-based ACE | ||
| updateObjectAuditing(int $index, bool $auditSuccess, bool $auditFailure) Updates auditing for object-based ACE | ||
| updateObjectFieldAuditing(int $index, string $field, bool $auditSuccess, bool $auditFailure) Updates auditing for object-field-based ACE |
Details
array getClassAces()
Returns all class-based ACEs associated with this ACL
Return Value
| array |
array getClassFieldAces(string $field)
Returns all class-field-based ACEs associated with this ACL
Parameters
| string | $field |
Return Value
| array |
array getObjectAces()
Returns all object-based ACEs associated with this ACL
Return Value
| array |
array getObjectFieldAces(string $field)
Returns all object-field-based ACEs associated with this ACL
Parameters
| string | $field |
Return Value
| array |
ObjectIdentityInterface getObjectIdentity()
Returns the object identity associated with this ACL
Return Value
| ObjectIdentityInterface |
AclInterface|null getParentAcl()
Returns the parent ACL, or null if there is none.
Return Value
| AclInterface|null |
bool isEntriesInheriting()
Whether this ACL is inheriting ACEs from a parent ACL.
Return Value
| bool |
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 |
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 |
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 |
deleteClassAce(int $index)
Deletes a class-based ACE
Parameters
| int | $index |
deleteClassFieldAce(int $index, string $field)
Deletes a class-field-based ACE
Parameters
| int | $index | |
| string | $field |
deleteObjectAce(int $index)
Deletes an object-based ACE
Parameters
| int | $index |
deleteObjectFieldAce(int $index, string $field)
Deletes an object-field-based ACE
Parameters
| int | $index | |
| string | $field |
int getId()
Returns the primary key of this ACL
Return Value
| int |
insertClassAce(SecurityIdentityInterface $sid, int $mask, int $index, bool $granting = true, string $strategy = null)
Inserts a class-based ACE
Parameters
| SecurityIdentityInterface | $sid | |
| int | $mask | |
| int | $index | |
| bool | $granting | |
| string | $strategy |
insertClassFieldAce(string $field, SecurityIdentityInterface $sid, int $mask, int $index, bool $granting = true, string $strategy = null)
Inserts a class-field-based ACE
Parameters
| string | $field | |
| SecurityIdentityInterface | $sid | |
| int | $mask | |
| int | $index | |
| bool | $granting | |
| string | $strategy |
insertObjectAce(SecurityIdentityInterface $sid, int $mask, int $index, bool $granting = true, string $strategy = null)
Inserts an object-based ACE
Parameters
| SecurityIdentityInterface | $sid | |
| int | $mask | |
| int | $index | |
| bool | $granting | |
| string | $strategy |
insertObjectFieldAce(string $field, SecurityIdentityInterface $sid, int $mask, int $index, bool $granting = true, string $strategy = null)
Inserts an object-field-based ACE
Parameters
| string | $field | |
| SecurityIdentityInterface | $sid | |
| int | $mask | |
| int | $index | |
| bool | $granting | |
| string | $strategy |
setEntriesInheriting(bool $boolean)
Sets whether entries are inherited
Parameters
| bool | $boolean |
setParentAcl(AclInterface $acl = null)
Sets the parent ACL
Parameters
| AclInterface | $acl |
updateClassAce(int $index, int $mask, string $strategy = null)
Updates a class-based ACE
Parameters
| int | $index | |
| int | $mask | |
| string | $strategy | if null the strategy should not be changed |
updateClassFieldAce(int $index, string $field, int $mask, string $strategy = null)
Updates a class-field-based ACE
Parameters
| int | $index | |
| string | $field | |
| int | $mask | |
| string | $strategy | if null the strategy should not be changed |
updateObjectAce(int $index, int $mask, string $strategy = null)
Updates an object-based ACE
Parameters
| int | $index | |
| int | $mask | |
| string | $strategy | if null the strategy should not be changed |
updateObjectFieldAce(int $index, string $field, int $mask, string $strategy = null)
Updates an object-field-based ACE
Parameters
| int | $index | |
| string | $field | |
| int | $mask | |
| string | $strategy | if null the strategy should not be changed |
updateClassAuditing(int $index, bool $auditSuccess, bool $auditFailure)
Updates auditing for class-based ACE
Parameters
| int | $index | |
| bool | $auditSuccess | |
| bool | $auditFailure |
updateClassFieldAuditing(int $index, string $field, bool $auditSuccess, bool $auditFailure)
Updates auditing for class-field-based ACE
Parameters
| int | $index | |
| string | $field | |
| bool | $auditSuccess | |
| bool | $auditFailure |
updateObjectAuditing(int $index, bool $auditSuccess, bool $auditFailure)
Updates auditing for object-based ACE
Parameters
| int | $index | |
| bool | $auditSuccess | |
| bool | $auditFailure |
updateObjectFieldAuditing(int $index, string $field, bool $auditSuccess, bool $auditFailure)
Updates auditing for object-field-based ACE
Parameters
| int | $index | |
| string | $field | |
| bool | $auditSuccess | |
| bool | $auditFailure |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Security/Acl/Model/AuditableAclInterface.html