Symfony2 API
Class

Symfony\Component\Security\Acl\Domain\Acl

class Acl implements AuditableAclInterface, NotifyPropertyChanged

An ACL implementation.

Each object identity has exactly one associated ACL. Each ACL can have four
different types of ACEs (class ACEs, object ACEs, class field ACEs, object field
ACEs).

You should not iterate over the ACEs yourself, but instead use isGranted(),
or isFieldGranted(). These will utilize an implementation of PermissionGrantingStrategy
internally.

Methods

__construct(integer $id, ObjectIdentityInterface $objectIdentity, PermissionGrantingStrategyInterface $permissionGrantingStrategy, array $loadedSids = array(), Boolean $entriesInheriting)

Constructor
addPropertyChangedListener(PropertyChangedListener $listener)

Adds a property changed listener
deleteClassAce(integer $index)

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

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

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

Deletes an object-field-based ACE
getClassAces()

{@inheritDoc}
getClassFieldAces($field)

{@inheritDoc}
getObjectAces()

{@inheritDoc}
getObjectFieldAces($field)

{@inheritDoc}
integer getId()

Returns the primary key of this ACL
getObjectIdentity()

{@inheritDoc}
getParentAcl()

{@inheritDoc}
insertClassAce(SecurityIdentityInterface $sid, integer $mask, integer $index, Boolean $granting = true, string $strategy = null)

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

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

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

Inserts an object-field-based ACE
isEntriesInheriting()

{@inheritDoc}
isFieldGranted($field, array $masks, array $securityIdentities, $administrativeMode = false)

{@inheritDoc}
isGranted(array $masks, array $securityIdentities, $administrativeMode = false)

{@inheritDoc}
isSidLoaded($sids)

{@inheritDoc}
string serialize()

Implementation for the \Serializable interface
unserialize(string $serialized)

Implementation for the \Serializable interface
setEntriesInheriting(Boolean $boolean)

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

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

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

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

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

Updates an object-field-based ACE
updateClassAuditing(integer $index, Boolean $auditSuccess, Boolean $auditFailure)

Updates auditing for class-based ACE
updateClassFieldAuditing(integer $index, string $field, Boolean $auditSuccess, Boolean $auditFailure)

Updates auditing for class-field-based ACE
updateObjectAuditing(integer $index, Boolean $auditSuccess, Boolean $auditFailure)

Updates auditing for object-based ACE
updateObjectFieldAuditing(integer $index, string $field, Boolean $auditSuccess, Boolean $auditFailure)

Updates auditing for object-field-based ACE

Details

at line 58
public __construct(integer $id, ObjectIdentityInterface $objectIdentity, PermissionGrantingStrategyInterface $permissionGrantingStrategy, array $loadedSids = array(), Boolean $entriesInheriting)

Constructor

Parameters

integer $id
ObjectIdentityInterface $objectIdentity
PermissionGrantingStrategyInterface $permissionGrantingStrategy
array $loadedSids
Boolean $entriesInheriting

at line 78
public addPropertyChangedListener(PropertyChangedListener $listener)

Adds a property changed listener

Parameters

PropertyChangedListener $listener

at line 86
public deleteClassAce(integer $index)

Deletes a class-based ACE

Parameters

integer $index

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

Deletes a class-field-based ACE

Parameters

integer $index
string $field

at line 102
public deleteObjectAce(integer $index)

Deletes an object-based ACE

Parameters

integer $index

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

Deletes an object-field-based ACE

Parameters

integer $index
string $field

at line 118
public getClassAces()

{@inheritDoc}

at line 126
public getClassFieldAces($field)

{@inheritDoc}

Parameters

$field

at line 134
public getObjectAces()

{@inheritDoc}

at line 142
public getObjectFieldAces($field)

{@inheritDoc}

Parameters

$field

at line 150
public integer getId()

Returns the primary key of this ACL

Return Value

integer

at line 158
public getObjectIdentity()

{@inheritDoc}

at line 166
public getParentAcl()

{@inheritDoc}

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

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

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

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

at line 206
public isEntriesInheriting()

{@inheritDoc}

at line 214
public isFieldGranted($field, array $masks, array $securityIdentities, $administrativeMode = false)

{@inheritDoc}

Parameters

$field
array $masks
array $securityIdentities
$administrativeMode

at line 222
public isGranted(array $masks, array $securityIdentities, $administrativeMode = false)

{@inheritDoc}

Parameters

array $masks
array $securityIdentities
$administrativeMode

at line 230
public isSidLoaded($sids)

{@inheritDoc}

Parameters

$sids

at line 263
public string serialize()

Implementation for the \Serializable interface

Return Value

string

at line 283
public unserialize(string $serialized)

Implementation for the \Serializable interface

Parameters

string $serialized

at line 302
public setEntriesInheriting(Boolean $boolean)

Sets whether entries are inherited

Parameters

Boolean $boolean

at line 313
public void setParentAcl(AclInterface $acl = null)

Sets the parent ACL

Parameters

AclInterface $acl

Return Value

void

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

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

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

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

at line 360
public updateClassAuditing(integer $index, Boolean $auditSuccess, Boolean $auditFailure)

Updates auditing for class-based ACE

Parameters

integer $index
Boolean $auditSuccess
Boolean $auditFailure

at line 368
public updateClassFieldAuditing(integer $index, string $field, Boolean $auditSuccess, Boolean $auditFailure)

Updates auditing for class-field-based ACE

Parameters

integer $index
string $field
Boolean $auditSuccess
Boolean $auditFailure

at line 380
public updateObjectAuditing(integer $index, Boolean $auditSuccess, Boolean $auditFailure)

Updates auditing for object-based ACE

Parameters

integer $index
Boolean $auditSuccess
Boolean $auditFailure

at line 388
public updateObjectFieldAuditing(integer $index, string $field, Boolean $auditSuccess, Boolean $auditFailure)

Updates auditing for object-field-based ACE

Parameters

integer $index
string $field
Boolean $auditSuccess
Boolean $auditFailure