Zend Framework API Documentation » \Zend

Constants

category	Zend
package	Zend_Acl
copyright	Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license	New BSD License

Methods

Adds a Resource having an identifier unique to the ACL

add(\Zend_Acl_Resource_Interface $resource, \Zend_Acl_Resource_Interface|string $parent = null) : \Zend_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.

deprecated	in version 1.9.1 and will be available till 2.0. New code should use addResource() instead.

Parameters

$resource

\Zend_Acl_Resource_Interface

$parent

\Zend_Acl_Resource_Interfacestring

Exceptions

`\Zend_Acl_Exception`

Returns

\Zend_AclProvides a fluent interface

Adds a Resource having an identifier unique to the ACL

addResource(\Zend_Acl_Resource_Interface|string $resource, \Zend_Acl_Resource_Interface|string $parent = null) : \Zend_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

$resource

\Zend_Acl_Resource_Interfacestring

$parent

\Zend_Acl_Resource_Interfacestring

Exceptions

`\Zend_Acl_Exception`

Returns

\Zend_AclProvides a fluent interface

Adds a Role having an identifier unique to the registry

addRole(\Zend_Acl_Role_Interface|string $role, \Zend_Acl_Role_Interface|string|array $parents = null) : \Zend_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.

uses

Parameters

$role

\Zend_Acl_Role_Interfacestring

$parents

\Zend_Acl_Role_Interfacestringarray

Returns

\Zend_AclProvides a fluent interface

Adds an "allow" rule to the ACL

allow(\Zend_Acl_Role_Interface|string|array $roles = null, \Zend_Acl_Resource_Interface|string|array $resources = null, string|array $privileges = null, \Zend_Acl_Assert_Interface $assert = null) : \Zend_Acl

uses

Parameters

$roles

\Zend_Acl_Role_Interfacestringarray

$resources

\Zend_Acl_Resource_Interfacestringarray

$privileges

stringarray

$assert

\Zend_Acl_Assert_Interface

Returns

\Zend_AclProvides a fluent interface

Adds a "deny" rule to the ACL

deny(\Zend_Acl_Role_Interface|string|array $roles = null, \Zend_Acl_Resource_Interface|string|array $resources = null, string|array $privileges = null, \Zend_Acl_Assert_Interface $assert = null) : \Zend_Acl

uses

Parameters

$roles

\Zend_Acl_Role_Interfacestringarray

$resources

\Zend_Acl_Resource_Interfacestringarray

$privileges

stringarray

$assert

\Zend_Acl_Assert_Interface

Returns

\Zend_AclProvides a fluent interface

Returns the identified Resource

get(\Zend_Acl_Resource_Interface|string $resource) : \Zend_Acl_Resource_Interface

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

Parameters

$resource

\Zend_Acl_Resource_Interfacestring

Exceptions

`\Zend_Acl_Exception`

Returns

\Zend_Acl_Resource_Interface

getRegisteredRoles()

getRegisteredRoles() : array

deprecated	Deprecated since version 1.10 (December 2009)

Returns

arrayof registered roles (Deprecated)

getResources()

getResources() : array

Returns

arrayof registered resources

Returns the identified Role

getRole(\Zend_Acl_Role_Interface|string $role) : \Zend_Acl_Role_Interface

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

uses

Parameters

$role

\Zend_Acl_Role_Interfacestring

Returns

\Zend_Acl_Role_Interface

Returns an array of registered roles.

getRoles() : array

Note that this method does not return instances of registered roles, but only the role identifiers.

Returns

arrayof registered roles

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

has(\Zend_Acl_Resource_Interface|string $resource) : boolean

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

Parameters

$resource

\Zend_Acl_Resource_Interfacestring

Returns

boolean

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

hasRole(\Zend_Acl_Role_Interface|string $role) : boolean

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

uses

Parameters

$role

\Zend_Acl_Role_Interfacestring

Returns

boolean

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

inherits(\Zend_Acl_Resource_Interface|string $resource, \Zend_Acl_Resource_Interface|string $inherit, boolean $onlyParent = false) : boolean

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

$resource

\Zend_Acl_Resource_Interfacestring

$inherit

\Zend_Acl_Resource_Interfacestring

$onlyParent

boolean

Exceptions

`\Zend_Acl_Resource_Registry_Exception`

Returns

boolean

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

inheritsRole(\Zend_Acl_Role_Interface|string $role, \Zend_Acl_Role_Interface|string $inherit, boolean $onlyParents = false) : boolean

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.

uses

Parameters

$role

\Zend_Acl_Role_Interfacestring

$inherit

\Zend_Acl_Role_Interfacestring

$onlyParents

boolean

Returns

boolean

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

isAllowed(\Zend_Acl_Role_Interface|string $role = null, \Zend_Acl_Resource_Interface|string $resource = null, string $privilege = null) : boolean

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_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.

uses
uses

Parameters

$role

\Zend_Acl_Role_Interfacestring

$resource

\Zend_Acl_Resource_Interfacestring

$privilege

string

Returns

boolean

Removes a Resource and all of its children

remove(\Zend_Acl_Resource_Interface|string $resource) : \Zend_Acl

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

Parameters

$resource

\Zend_Acl_Resource_Interfacestring

Exceptions

`\Zend_Acl_Exception`

Returns

\Zend_AclProvides a fluent interface

Removes all Resources

removeAll() : \Zend_Acl

Returns

\Zend_AclProvides a fluent interface

Removes "allow" permissions from the ACL

removeAllow(\Zend_Acl_Role_Interface|string|array $roles = null, \Zend_Acl_Resource_Interface|string|array $resources = null, string|array $privileges = null) : \Zend_Acl

uses

Parameters

$roles

\Zend_Acl_Role_Interfacestringarray

$resources

\Zend_Acl_Resource_Interfacestringarray

$privileges

stringarray

Returns

\Zend_AclProvides a fluent interface

Removes "deny" restrictions from the ACL

removeDeny(\Zend_Acl_Role_Interface|string|array $roles = null, \Zend_Acl_Resource_Interface|string|array $resources = null, string|array $privileges = null) : \Zend_Acl

uses

Parameters

$roles

\Zend_Acl_Role_Interfacestringarray

$resources

\Zend_Acl_Resource_Interfacestringarray

$privileges

stringarray

Returns

\Zend_AclProvides a fluent interface

Removes the Role from the registry

removeRole(\Zend_Acl_Role_Interface|string $role) : \Zend_Acl

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

uses

Parameters

$role

\Zend_Acl_Role_Interfacestring

Returns

\Zend_AclProvides a fluent interface

Removes all Roles from the registry

removeRoleAll() : \Zend_Acl

uses

Returns

\Zend_AclProvides a fluent interface

Performs operations on ACL rules

setRule(string $operation, string $type, \Zend_Acl_Role_Interface|string|array $roles = null, \Zend_Acl_Resource_Interface|string|array $resources = null, string|array $privileges = null, \Zend_Acl_Assert_Interface $assert = null) : \Zend_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.

uses
uses

Parameters

$operation

string

$type

string

$roles

\Zend_Acl_Role_Interfacestringarray

$resources

\Zend_Acl_Resource_Interfacestringarray

$privileges

stringarray

$assert

\Zend_Acl_Assert_Interface

Exceptions

`\Zend_Acl_Exception`

Returns

\Zend_AclProvides a fluent interface

Returns the Role registry for this ACL

_getRoleRegistry() : \Zend_Acl_Role_Registry

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

Returns

\Zend_Acl_Role_Registry

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

_getRuleType(\Zend_Acl_Resource_Interface $resource = null, \Zend_Acl_Role_Interface $role = null, string $privilege = null) : 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

$resource

\Zend_Acl_Resource_Interface

$role

\Zend_Acl_Role_Interface

$privilege

string

Returns

stringnull

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

_getRules(\Zend_Acl_Resource_Interface $resource = null, \Zend_Acl_Role_Interface $role = null, boolean $create = false) : 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

$resource

\Zend_Acl_Resource_Interface

$role

\Zend_Acl_Role_Interface

$create

boolean

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_Acl_Role_Interface $role, \Zend_Acl_Resource_Interface $resource = null) : boolean | 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

$role

\Zend_Acl_Role_Interface

$resource

\Zend_Acl_Resource_Interface

Returns

booleannull

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_Acl_Role_Interface $role, \Zend_Acl_Resource_Interface $resource = null, string $privilege = null) : boolean | 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

$role

\Zend_Acl_Role_Interface

$resource

\Zend_Acl_Resource_Interface

$privilege

string

Exceptions

`\Zend_Acl_Exception`

Returns

booleannull

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

_roleDFSVisitAllPrivileges(\Zend_Acl_Role_Interface $role, \Zend_Acl_Resource_Interface $resource = null, array $dfs = null) : boolean | 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

$role

\Zend_Acl_Role_Interface

$resource

\Zend_Acl_Resource_Interface

$dfs

array

Exceptions

`\Zend_Acl_Exception`

Returns

booleannull

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

_roleDFSVisitOnePrivilege(\Zend_Acl_Role_Interface $role, \Zend_Acl_Resource_Interface $resource = null, string $privilege = null, array $dfs = null) : boolean | 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

$role

\Zend_Acl_Role_Interface

$resource

\Zend_Acl_Resource_Interface

$privilege

string

$dfs

array

Exceptions

`\Zend_Acl_Exception`

Returns

booleannull

Properties

$_isAllowedPrivilege

$_isAllowedPrivilege : String

Default

null

$_isAllowedResource

$_isAllowedResource : \Zend_Acl_Resource_Interface

Default

null

$_isAllowedRole

$_isAllowedRole : \Zend_Acl_Role_Interface

Default

null

Resource tree

$_resources : array

Default

array()

Role registry

$_roleRegistry : \Zend_Acl_Role_Registry

Default

null

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

$_rules : array

Default

array('allResources' => array('allRoles' => array('allPrivileges' => array('type' => self::TYPE_DENY, 'assert' => null), 'byPrivilegeId' => array()), 'byRoleId' => array()), 'byResourceId' => array())

Constants

Rule operation: add

OP_ADD = 'OP_ADD'

Rule operation: remove

OP_REMOVE = 'OP_REMOVE'

Rule type: allow

TYPE_ALLOW = 'TYPE_ALLOW'

Rule type: deny

TYPE_DENY = 'TYPE_DENY'