Symfony2 API
Interface

Symfony\Component\Security\Acl\Model\MutableAclInterface

interface MutableAclInterface implements AclInterface

This interface adds mutators for the AclInterface.

All changes to Access Control Entries must go through this interface. Access
Control Entries must never be modified directly.

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
Boolean isEntriesInheriting()

Whether this ACL is inheriting ACEs from a parent ACL.

 from AclInterface
Boolean isFieldGranted(string $field, array $masks, array $securityIdentities, Boolean $administrativeMode = false)

Determines whether field access is granted

 from AclInterface
Boolean isGranted(array $masks, array $securityIdentities, Boolean $administrativeMode = false)

Determines whether access is granted

 from AclInterface
Boolean isSidLoaded(mixed $securityIdentities)

Whether the ACL has loaded ACEs for all of the passed security identities

 from AclInterface
void deleteClassAce(integer $index)

Deletes a class-based ACE
void deleteClassFieldAce(integer $index, string $field)

Deletes a class-field-based ACE
void deleteObjectAce(integer $index)

Deletes an object-based ACE
void deleteObjectFieldAce(integer $index, string $field)

Deletes an object-field-based ACE
integer getId()

Returns the primary key of this ACL
void insertClassAce(SecurityIdentityInterface $sid, integer $mask, integer $index, Boolean $granting = true, string $strategy = null)

Inserts a class-based ACE
void insertClassFieldAce(string $field, SecurityIdentityInterface $sid, integer $mask, integer $index, Boolean $granting = true, string $strategy = null)

Inserts a class-field-based ACE
void insertObjectAce(SecurityIdentityInterface $sid, integer $mask, integer $index, Boolean $granting = true, string $strategy = null)

Inserts an object-based ACE
void insertObjectFieldAce(string $field, SecurityIdentityInterface $sid, integer $mask, integer $index, Boolean $granting = true, string $strategy = null)

Inserts an object-field-based ACE
void setEntriesInheriting(Boolean $boolean)

Sets whether entries are inherited
void setParentAcl(AclInterface $acl)

Sets the parent ACL
void updateClassAce(integer $index, integer $mask, string $strategy = null)

Updates a class-based ACE
void updateClassFieldAce(integer $index, string $field, integer $mask, string $strategy = null)

Updates a class-field-based ACE
void updateObjectAce(integer $index, integer $mask, string $strategy = null)

Updates an object-based ACE
void updateObjectFieldAce(integer $index, string $field, integer $mask, string $strategy = null)

Updates an object-field-based ACE

Details

in AclInterface at line 31
public array getClassAces()

Returns all class-based ACEs associated with this ACL

Return Value

array

in AclInterface at line 39
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 46
public array getObjectAces()

Returns all object-based ACEs associated with this ACL

Return Value

array

in AclInterface at line 54
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 61
public ObjectIdentityInterface getObjectIdentity()

Returns the object identity associated with this ACL

Return Value

ObjectIdentityInterface

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

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

Return Value

AclInterface|null

in AclInterface at line 75
public Boolean isEntriesInheriting()

Whether this ACL is inheriting ACEs from a parent ACL.

Return Value

Boolean

in AclInterface at line 86
public Boolean isFieldGranted(string $field, array $masks, array $securityIdentities, Boolean $administrativeMode = false)

Determines whether field access is granted

Parameters

string $field
array $masks
array $securityIdentities
Boolean $administrativeMode

Return Value

Boolean

in AclInterface at line 97
public Boolean isGranted(array $masks, array $securityIdentities, Boolean $administrativeMode = false)

Determines whether access is granted

Parameters

array $masks
array $securityIdentities
Boolean $administrativeMode

Return Value

Boolean

Exceptions

NoAceFoundException when no ACE was applicable for this request

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

Boolean

at line 30
public void deleteClassAce(integer $index)

Deletes a class-based ACE

Parameters

integer $index

Return Value

void

at line 39
public void deleteClassFieldAce(integer $index, string $field)

Deletes a class-field-based ACE

Parameters

integer $index
string $field

Return Value

void

at line 47
public void deleteObjectAce(integer $index)

Deletes an object-based ACE

Parameters

integer $index

Return Value

void

at line 56
public void deleteObjectFieldAce(integer $index, string $field)

Deletes an object-field-based ACE

Parameters

integer $index
string $field

Return Value

void

at line 63
public integer getId()

Returns the primary key of this ACL

Return Value

integer

at line 75
public void insertClassAce(SecurityIdentityInterface $sid, integer $mask, integer $index, Boolean $granting = true, string $strategy = null)

Inserts a class-based ACE

Parameters

SecurityIdentityInterface $sid
integer $mask
integer $index
Boolean $granting
string $strategy

Return Value

void

at line 88
public void insertClassFieldAce(string $field, SecurityIdentityInterface $sid, integer $mask, integer $index, Boolean $granting = true, string $strategy = null)

Inserts a class-field-based ACE

Parameters

string $field
SecurityIdentityInterface $sid
integer $mask
integer $index
Boolean $granting
string $strategy

Return Value

void

at line 100
public void insertObjectAce(SecurityIdentityInterface $sid, integer $mask, integer $index, Boolean $granting = true, string $strategy = null)

Inserts an object-based ACE

Parameters

SecurityIdentityInterface $sid
integer $mask
integer $index
Boolean $granting
string $strategy

Return Value

void

at line 113
public void insertObjectFieldAce(string $field, SecurityIdentityInterface $sid, integer $mask, integer $index, Boolean $granting = true, string $strategy = null)

Inserts an object-field-based ACE

Parameters

string $field
SecurityIdentityInterface $sid
integer $mask
integer $index
Boolean $granting
string $strategy

Return Value

void

at line 121
public void setEntriesInheriting(Boolean $boolean)

Sets whether entries are inherited

Parameters

Boolean $boolean

Return Value

void

at line 129
public void setParentAcl(AclInterface $acl)

Sets the parent ACL

Parameters

AclInterface $acl

Return Value

void

at line 139
public void updateClassAce(integer $index, integer $mask, string $strategy = null)

Updates a class-based ACE

Parameters

integer $index
integer $mask
string $strategy if null the strategy should not be changed

Return Value

void

at line 150
public void updateClassFieldAce(integer $index, string $field, integer $mask, string $strategy = null)

Updates a class-field-based ACE

Parameters

integer $index
string $field
integer $mask
string $strategy if null the strategy should not be changed

Return Value

void

at line 160
public void updateObjectAce(integer $index, integer $mask, string $strategy = null)

Updates an object-based ACE

Parameters

integer $index
integer $mask
string $strategy if null the strategy should not be changed

Return Value

void

at line 171
public void updateObjectFieldAce(integer $index, string $field, integer $mask, string $strategy = null)

Updates an object-field-based ACE

Parameters

integer $index
string $field
integer $mask
string $strategy if null the strategy should not be changed

Return Value

void