FieldEntry

class FieldEntry extends Entry implements FieldEntryInterface

Field-aware ACE implementation which is auditable

Methods

__construct(int $id, AclInterface $acl, string $field, SecurityIdentityInterface $sid, string $strategy, int $mask, bool $granting, bool $auditFailure, bool $auditSuccess)

Constructor

AclInterface getAcl()

The ACL this ACE is associated with.

from Entry
int getMask()

The permission mask of this ACE

from Entry
int getId()

The primary key of this ACE

from Entry
SecurityIdentityInterface getSecurityIdentity()

The security identity associated with this ACE

from Entry
string getStrategy()

The strategy for comparing masks

from Entry
bool isAuditFailure()

Whether auditing for successful grants is turned on

from Entry
bool isAuditSuccess()

Whether auditing for successful denies is turned on

from Entry
bool isGranting()

Returns whether this ACE is granting, or denying

from Entry
setAuditFailure(bool $boolean)

Turns on/off auditing on permissions denials.

from Entry
setAuditSuccess(bool $boolean)

Turns on/off auditing on permission grants.

from Entry
setMask(int $mask)

Sets the permission mask

from Entry
setStrategy(string $strategy)

Sets the mask comparison strategy

from Entry
string serialize()

Implementation of \Serializable

unserialize(string $serialized)

Implementation of \Serializable

string getField()

Returns the field used for this entry.

Details

__construct(int $id, AclInterface $acl, string $field, SecurityIdentityInterface $sid, string $strategy, int $mask, bool $granting, bool $auditFailure, bool $auditSuccess)

Constructor

Parameters

int $id
AclInterface $acl
string $field
SecurityIdentityInterface $sid
string $strategy
int $mask
bool $granting
bool $auditFailure
bool $auditSuccess

AclInterface getAcl()

The ACL this ACE is associated with.

Return Value

AclInterface

int getMask()

The permission mask of this ACE

Return Value

int

int getId()

The primary key of this ACE

Return Value

int

SecurityIdentityInterface getSecurityIdentity()

The security identity associated with this ACE

Return Value

SecurityIdentityInterface

string getStrategy()

The strategy for comparing masks

Return Value

string

bool isAuditFailure()

Whether auditing for successful grants is turned on

Return Value

bool

bool isAuditSuccess()

Whether auditing for successful denies is turned on

Return Value

bool

bool isGranting()

Returns whether this ACE is granting, or denying

Return Value

bool

setAuditFailure(bool $boolean)

Turns on/off auditing on permissions denials.

Do never call this method directly. Use the respective methods on the AclInterface instead.

Parameters

bool $boolean

setAuditSuccess(bool $boolean)

Turns on/off auditing on permission grants.

Do never call this method directly. Use the respective methods on the AclInterface instead.

Parameters

bool $boolean

setMask(int $mask)

Sets the permission mask

Do never call this method directly. Use the respective methods on the AclInterface instead.

Parameters

int $mask

setStrategy(string $strategy)

Sets the mask comparison strategy

Do never call this method directly. Use the respective methods on the AclInterface instead.

Parameters

string $strategy

string serialize()

Implementation of \Serializable

Return Value

string

unserialize(string $serialized)

Implementation of \Serializable

Parameters

string $serialized

string getField()

Returns the field used for this entry.

Return Value

string

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/Security/Acl/Domain/FieldEntry.html