Methods

Adds a Resource having an identifier unique to the ACL

addResource(\Zend\Permissions\Acl\Resource\ResourceInterface | string $resource, \Zend\Permissions\Acl\Resource\ResourceInterface | string $parent) : \Zend\Permissions\Acl\Acl

The $parent parameter may be a reference to, or the string identifier for, the existing Resource from which the newly added Resource will inherit.

Parameters

Exceptions

\Zend\Permissions\Acl\Exception\InvalidArgumentException

Returns

\Zend\Permissions\Acl\AclProvides a fluent interface

Adds a Role having an identifier unique to the registry

addRole(\Zend\Permissions\Acl\Role\RoleInterface $role, \Zend\Permissions\Acl\Role\RoleInterface | string | array $parents) : \Zend\Permissions\Acl\Acl

The $parents parameter may be a reference to, or the string identifier for, a Role existing in the registry, or $parents may be passed as an array of these - mixing string identifiers and objects is ok - to indicate the Roles from which the newly added Role will directly inherit.

In order to resolve potential ambiguities with conflicting rules inherited from different parents, the most recently added parent takes precedence over parents that were previously added. In other words, the first parent added will have the least priority, and the last parent added will have the highest priority.

Parameters

Exceptions

\Zend\Permissions\Acl\Exception\InvalidArgumentException

Returns

\Zend\Permissions\Acl\AclProvides a fluent interface

Adds an "allow" rule to the ACL

allow(\Zend\Permissions\Acl\Role\RoleInterface | string | array $roles, \Zend\Permissions\Acl\Resource\ResourceInterface | string | array $resources, string | array $privileges, \Zend\Permissions\Acl\Assertion\AssertionInterface $assert) : \Zend\Permissions\Acl\Acl

Parameters

$privileges

stringarray

Returns

\Zend\Permissions\Acl\AclProvides a fluent interface

Adds a "deny" rule to the ACL

deny(\Zend\Permissions\Acl\Role\RoleInterface | string | array $roles, \Zend\Permissions\Acl\Resource\ResourceInterface | string | array $resources, string | array $privileges, \Zend\Permissions\Acl\Assertion\AssertionInterface $assert) : \Zend\Permissions\Acl\Acl

Parameters

$privileges

stringarray

Returns

\Zend\Permissions\Acl\AclProvides a fluent interface

Returns the identified Resource

getResource(\Zend\Permissions\Acl\Resource\ResourceInterface | string $resource) : Resource

The $resource parameter can either be a Resource or a Resource identifier.

Parameters

Exceptions

\Zend\Permissions\Acl\Exception\InvalidArgumentException

Returns

Resource

getResources()

getResources() : array

Returns

arrayof registered resources

Returns the identified Role

getRole(\Zend\Permissions\Acl\Role\RoleInterface | string $role) : \Zend\Permissions\Acl\Role\RoleInterface

The $role parameter can either be a Role or Role identifier.

Parameters

Returns

getRoles()

getRoles() : array

Returns

arrayof registered roles

Returns true if and only if the Resource exists in the ACL

hasResource(\Zend\Permissions\Acl\Resource\ResourceInterface | string $resource) : bool

The $resource parameter can either be a Resource or a Resource identifier.

Parameters

Returns

bool

Returns true if and only if the Role exists in the registry

hasRole(\Zend\Permissions\Acl\Role\RoleInterface | string $role) : bool

The $role parameter can either be a Role or a Role identifier.

Parameters

Returns

bool

Returns true if and only if $resource inherits from $inherit

inheritsResource(\Zend\Permissions\Acl\Resource\ResourceInterface | string $resource, \Zend\Permissions\Acl\Resource\ResourceInterface | string $inherit, bool $onlyParent) : bool

Both parameters may be either a Resource or a Resource identifier. If $onlyParent is true, then $resource must inherit directly from $inherit in order to return true. By default, this method looks through the entire inheritance tree to determine whether $resource inherits from $inherit through its ancestor Resources.

Parameters

$onlyParent

bool

Exceptions

\Zend\Permissions\Acl\Exception\InvalidArgumentException

Returns

bool

Returns true if and only if $role inherits from $inherit

inheritsRole(\Zend\Permissions\Acl\Role\RoleInterface | string $role, \Zend\Permissions\Acl\Role\RoleInterface | string $inherit, bool $onlyParents) : bool

Both parameters may be either a Role or a Role identifier. If $onlyParents is true, then $role must inherit directly from $inherit in order to return true. By default, this method looks through the entire inheritance DAG to determine whether $role inherits from $inherit through its ancestor Roles.

Parameters

$onlyParents

bool

Returns

bool

Returns true if and only if the Role has access to the Resource

isAllowed(\Zend\Permissions\Acl\Role\RoleInterface | string $role, \Zend\Permissions\Acl\Resource\ResourceInterface | string $resource, string $privilege) : bool

The $role and $resource parameters may be references to, or the string identifiers for, an existing Resource and Role combination.

If either $role or $resource is null, then the query applies to all Roles or all Resources, respectively. Both may be null to query whether the ACL has a "blacklist" rule (allow everything to all). By default, Zend\Permissions\Acl creates a "whitelist" rule (deny everything to all), and this method would return false unless this default has been overridden (i.e., by executing $acl->allow()).

If a $privilege is not provided, then this method returns false if and only if the Role is denied access to at least one privilege upon the Resource. In other words, this method returns true if and only if the Role is allowed all privileges on the Resource.

This method checks Role inheritance using a depth-first traversal of the Role registry. The highest priority parent (i.e., the parent most recently added) is checked first, and its respective parents are checked similarly before the lower-priority parents of the Role are checked.

Parameters

$privilege

string

Returns

bool

Removes "allow" permissions from the ACL

removeAllow(\Zend\Permissions\Acl\Role\RoleInterface | string | array $roles, \Zend\Permissions\Acl\Resource\ResourceInterface | string | array $resources, string | array $privileges) : \Zend\Permissions\Acl\Acl

Parameters

$privileges

stringarray

Returns

\Zend\Permissions\Acl\AclProvides a fluent interface

Removes "deny" restrictions from the ACL

removeDeny(\Zend\Permissions\Acl\Role\RoleInterface | string | array $roles, \Zend\Permissions\Acl\Resource\ResourceInterface | string | array $resources, string | array $privileges) : \Zend\Permissions\Acl\Acl

Parameters

$privileges

stringarray

Returns

\Zend\Permissions\Acl\AclProvides a fluent interface

Removes a Resource and all of its children

removeResource(\Zend\Permissions\Acl\Resource\ResourceInterface | string $resource) : \Zend\Permissions\Acl\Acl

The $resource parameter can either be a Resource or a Resource identifier.

Parameters

Exceptions

\Zend\Permissions\Acl\Exception\InvalidArgumentException

Returns

\Zend\Permissions\Acl\AclProvides a fluent interface

Removes all Resources

removeResourceAll() : \Zend\Permissions\Acl\Acl

Returns

\Zend\Permissions\Acl\AclProvides a fluent interface

Removes the Role from the registry

removeRole(\Zend\Permissions\Acl\Role\RoleInterface | string $role) : \Zend\Permissions\Acl\Acl

The $role parameter can either be a Role or a Role identifier.

Parameters

Returns

\Zend\Permissions\Acl\AclProvides a fluent interface

Removes all Roles from the registry

removeRoleAll() : \Zend\Permissions\Acl\Acl

Returns

\Zend\Permissions\Acl\AclProvides a fluent interface

Performs operations on ACL rules

setRule(string $operation, string $type, \Zend\Permissions\Acl\Role\RoleInterface | string | array $roles, \Zend\Permissions\Acl\Resource\ResourceInterface | string | array $resources, string | array $privileges, \Zend\Permissions\Acl\Assertion\AssertionInterface $assert) : \Zend\Permissions\Acl\Acl

The $operation parameter may be either OP_ADD or OP_REMOVE, depending on whether the user wants to add or remove a rule, respectively:

OP_ADD specifics:

 A rule is added that would allow one or more Roles access to [certain $privileges
 upon] the specified Resource(s).

OP_REMOVE specifics:

 The rule is removed only in the context of the given Roles, Resources, and privileges.
 Existing rules to which the remove operation does not apply would remain in the
 ACL.

The $type parameter may be either TYPE_ALLOW or TYPE_DENY, depending on whether the rule is intended to allow or deny permission, respectively.

The $roles and $resources parameters may be references to, or the string identifiers for, existing Resources/Roles, or they may be passed as arrays of these - mixing string identifiers and objects is ok - to indicate the Resources and Roles to which the rule applies. If either $roles or $resources is null, then the rule applies to all Roles or all Resources, respectively. Both may be null in order to work with the default rule of the ACL.

The $privileges parameter may be used to further specify that the rule applies only to certain privileges upon the Resource(s) in question. This may be specified to be a single privilege with a string, and multiple privileges may be specified as an array of strings.

If $assert is provided, then its assert() method must return true in order for the rule to apply. If $assert is provided with $roles, $resources, and $privileges all equal to null, then a rule having a type of:

 TYPE_ALLOW will imply a type of TYPE_DENY, and

 TYPE_DENY will imply a type of TYPE_ALLOW

when the rule's assertion fails. This is because the ACL needs to provide expected behavior when an assertion upon the default ACL rule fails.

Parameters

$operation

string

$type

string

$privileges

stringarray

Exceptions

\Zend\Permissions\Acl\Exception\InvalidArgumentException

Returns

\Zend\Permissions\Acl\AclProvides a fluent interface

Returns all child resources from the given resource.

getChildResources(\Zend\Permissions\Acl\Resource\ResourceInterface $resource) : \Zend\Permissions\Acl\Resource\ResourceInterface[]

Returns the Role registry for this ACL

getRoleRegistry() : \Zend\Permissions\Acl\Role\Registry

If no Role registry has been created yet, a new default Role registry is created and returned.

Returns

Returns the rule type associated with the specified Resource, Role, and privilege combination.

getRuleType(\Zend\Permissions\Acl\Resource\ResourceInterface $resource, \Zend\Permissions\Acl\Role\RoleInterface $role, null | string $privilege) : string | null

If a rule does not exist or its attached assertion fails, which means that the rule is not applicable, then this method returns null. Otherwise, the rule type applies and is returned as either TYPE_ALLOW or TYPE_DENY.

If $resource or $role is null, then this means that the rule must apply to all Resources or Roles, respectively.

If $privilege is null, then the rule must apply to all privileges.

If all three parameters are null, then the default ACL rule type is returned, based on whether its assertion method passes.

Parameters

$privilege

nullstring

Returns

stringnull

Returns the rules associated with a Resource and a Role, or null if no such rules exist

getRules(\Zend\Permissions\Acl\Resource\ResourceInterface $resource, \Zend\Permissions\Acl\Role\RoleInterface $role, bool $create) : array | null

If either $resource or $role is null, this means that the rules returned are for all Resources or all Roles, respectively. Both can be null to return the default rule set for all Resources and all Roles.

If the $create parameter is true, then a rule set is first created and then returned to the caller.

Parameters

$create

bool

Returns

arraynull

Performs a depth-first search of the Role DAG, starting at $role, in order to find a rule allowing/denying $role access to all privileges upon $resource

roleDFSAllPrivileges(\Zend\Permissions\Acl\Role\RoleInterface $role, \Zend\Permissions\Acl\Resource\ResourceInterface $resource) : bool | null

This method returns true if a rule is found and allows access. If a rule exists and denies access, then this method returns false. If no applicable rule is found, then this method returns null.

Parameters

Returns

boolnull

Performs a depth-first search of the Role DAG, starting at $role, in order to find a rule allowing/denying $role access to a $privilege upon $resource

roleDFSOnePrivilege(\Zend\Permissions\Acl\Role\RoleInterface $role, \Zend\Permissions\Acl\Resource\ResourceInterface $resource, string $privilege) : bool | null

This method returns true if a rule is found and allows access. If a rule exists and denies access, then this method returns false. If no applicable rule is found, then this method returns null.

Parameters

$privilege

string

Exceptions

\Zend\Permissions\Acl\Exception\RuntimeException

Returns

boolnull

Visits an $role in order to look for a rule allowing/denying $role access to all privileges upon $resource

roleDFSVisitAllPrivileges(\Zend\Permissions\Acl\Role\RoleInterface $role, \Zend\Permissions\Acl\Resource\ResourceInterface $resource, array $dfs) : bool | null

This method returns true if a rule is found and allows access. If a rule exists and denies access, then this method returns false. If no applicable rule is found, then this method returns null.

This method is used by the internal depth-first search algorithm and may modify the DFS data structure.

Parameters

$dfs

array

Exceptions

\Zend\Permissions\Acl\Exception\RuntimeException

Returns

boolnull

Visits an $role in order to look for a rule allowing/denying $role access to a $privilege upon $resource

roleDFSVisitOnePrivilege(\Zend\Permissions\Acl\Role\RoleInterface $role, \Zend\Permissions\Acl\Resource\ResourceInterface $resource, string $privilege, array $dfs) : bool | null

This method returns true if a rule is found and allows access. If a rule exists and denies access, then this method returns false. If no applicable rule is found, then this method returns null.

This method is used by the internal depth-first search algorithm and may modify the DFS data structure.

Parameters

$privilege

string

$dfs

array

Exceptions

\Zend\Permissions\Acl\Exception\RuntimeException

Returns

boolnull

 Properties

 

$isAllowedPrivilege

$isAllowedPrivilege : string

 

$isAllowedResource

$isAllowedResource : Resource

 

$isAllowedRole

$isAllowedRole : \Zend\Permissions\Acl\Role\RoleInterface

 

Resource tree

$resources : array

 

Role registry

$roleRegistry : \Zend\Permissions\Acl\Role\Registry

 

ACL rules; whitelist (deny everything to all) by default

$rules : array

 Constants

 

Rule operation: add

OP_ADD 

 

Rule operation: remove

OP_REMOVE 

 

Rule type: allow

TYPE_ALLOW 

 

Rule type: deny

TYPE_DENY