Interface

Symfony\Component\Security\Acl\Model\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

in AclInterface at line 33
public array getClassAces()

Returns all class-based ACEs associated with this ACL

Return Value

array

in AclInterface at line 41
public array getClassFieldAces(string $field)

Returns all class-field-based ACEs associated with this ACL

Parameters

string $field

Return Value

array

in AclInterface at line 48
public array getObjectAces()

Returns all object-based ACEs associated with this ACL

Return Value

array

in AclInterface at line 56
public array getObjectFieldAces(string $field)

Returns all object-field-based ACEs associated with this ACL

Parameters

string $field

Return Value

array

in AclInterface at line 63
public ObjectIdentityInterface getObjectIdentity()

Returns the object identity associated with this ACL

in AclInterface at line 70
public AclInterface|null getParentAcl()

Returns the parent ACL, or null if there is none.

Return Value

AclInterface|null

in AclInterface at line 77
public bool isEntriesInheriting()

Whether this ACL is inheriting ACEs from a parent ACL.

Return Value

bool

in AclInterface at line 88
public 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

in AclInterface at line 99
public 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

in AclInterface at line 107
public 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

in MutableAclInterface at line 29
public deleteClassAce(int $index)

Deletes a class-based ACE

Parameters

int $index

in MutableAclInterface at line 37
public deleteClassFieldAce(int $index, string $field)

Deletes a class-field-based ACE

Parameters

int $index
string $field

in MutableAclInterface at line 44
public deleteObjectAce(int $index)

Deletes an object-based ACE

Parameters

int $index

in MutableAclInterface at line 52
public deleteObjectFieldAce(int $index, string $field)

Deletes an object-field-based ACE

Parameters

int $index
string $field

in MutableAclInterface at line 59
public int getId()

Returns the primary key of this ACL

Return Value

int

in MutableAclInterface at line 70
public 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

in MutableAclInterface at line 82
public 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

in MutableAclInterface at line 93
public 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

in MutableAclInterface at line 105
public 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

in MutableAclInterface at line 112
public setEntriesInheriting(bool $boolean)

Sets whether entries are inherited

Parameters

bool $boolean

in MutableAclInterface at line 119
public setParentAcl(AclInterface $acl = null)

Sets the parent ACL

Parameters

AclInterface $acl

in MutableAclInterface at line 128
public 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

in MutableAclInterface at line 138
public 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

in MutableAclInterface at line 147
public 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

in MutableAclInterface at line 157
public 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

at line 28
public updateClassAuditing(int $index, bool $auditSuccess, bool $auditFailure)

Updates auditing for class-based ACE

Parameters

int $index
bool $auditSuccess
bool $auditFailure

at line 38
public 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

at line 47
public updateObjectAuditing(int $index, bool $auditSuccess, bool $auditFailure)

Updates auditing for object-based ACE

Parameters

int $index
bool $auditSuccess
bool $auditFailure

at line 57
public 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