Acl.php
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Acl
- Version
- $Id$
\Zend_Acl
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
Properties


array $_rules = array('allResources' => array('allRoles' => array('allPrivileges' => array('type' => self::TYPE_DENY, 'assert' => null), 'byPrivilegeId' => array()), 'byRoleId' => array()), 'byResourceId' => array())
array('allResources' => array('allRoles' => array('allPrivileges' => array('type' => self::TYPE_DENY, 'assert' => null), 'byPrivilegeId' => array()), 'byRoleId' => array()), 'byResourceId' => array())
Details- Type
- array
Methods


_getRoleRegistry() : \Zend_Acl_Role_Registry
Returns the Role registry for this ACL
Type | Description |
---|---|
\Zend_Acl_Role_Registry |


_getRuleType(\Zend_Acl_Resource_Interface $resource = null, \Zend_Acl_Role_Interface $role = null, string $privilege = null) : string | null
Returns the rule type associated with the specified Resource, Role, and privilege combination.
Name | Type | Description |
---|---|---|
$resource | \Zend_Acl_Resource_Interface | |
$role | \Zend_Acl_Role_Interface | |
$privilege | string |
Type | Description |
---|---|
string | null |


_getRules(\Zend_Acl_Resource_Interface $resource = null, \Zend_Acl_Role_Interface $role = null, boolean $create = false) : array | null
Returns the rules associated with a Resource and a Role, or null if no such rules exist
Name | Type | Description |
---|---|---|
$resource | \Zend_Acl_Resource_Interface | |
$role | \Zend_Acl_Role_Interface | |
$create | boolean |
Type | Description |
---|---|
array | null |


_roleDFSAllPrivileges(\Zend_Acl_Role_Interface $role, \Zend_Acl_Resource_Interface $resource = null) : boolean | null
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
Name | Type | Description |
---|---|---|
$role | \Zend_Acl_Role_Interface | |
$resource | \Zend_Acl_Resource_Interface |
Type | Description |
---|---|
boolean | null |


_roleDFSOnePrivilege(\Zend_Acl_Role_Interface $role, \Zend_Acl_Resource_Interface $resource = null, string $privilege = null) : boolean | null
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
Name | Type | Description |
---|---|---|
$role | \Zend_Acl_Role_Interface | |
$resource | \Zend_Acl_Resource_Interface | |
$privilege | string |
Type | Description |
---|---|
boolean | null |
Exception | Description |
---|---|
\Zend_Acl_Exception |


_roleDFSVisitAllPrivileges(\Zend_Acl_Role_Interface $role, \Zend_Acl_Resource_Interface $resource = null, array $dfs = null) : boolean | null
Visits an $role in order to look for a rule allowing/denying $role access to all privileges upon $resource
Name | Type | Description |
---|---|---|
$role | \Zend_Acl_Role_Interface | |
$resource | \Zend_Acl_Resource_Interface | |
$dfs | array |
Type | Description |
---|---|
boolean | null |
Exception | Description |
---|---|
\Zend_Acl_Exception |


_roleDFSVisitOnePrivilege(\Zend_Acl_Role_Interface $role, \Zend_Acl_Resource_Interface $resource = null, string $privilege = null, array $dfs = null) : boolean | null
Visits an $role in order to look for a rule allowing/denying $role access to a $privilege upon $resource
Name | Type | Description |
---|---|---|
$role | \Zend_Acl_Role_Interface | |
$resource | \Zend_Acl_Resource_Interface | |
$privilege | string | |
$dfs | array |
Type | Description |
---|---|
boolean | null |
Exception | Description |
---|---|
\Zend_Acl_Exception |


add(\Zend_Acl_Resource_Interface $resource, \Zend_Acl_Resource_Interface | string $parent = null) : \Zend_Acl
Adds a Resource having an identifier unique to the ACL
Name | Type | Description |
---|---|---|
$resource | \Zend_Acl_Resource_Interface | |
$parent | \Zend_Acl_Resource_Interface | string |
Type | Description |
---|---|
\Zend_Acl | Provides a fluent interface |
Exception | Description |
---|---|
\Zend_Acl_Exception |
- Deprecated
- in version 1.9.1 and will be available till 2.0. New code should use addResource() instead.


addResource(\Zend_Acl_Resource_Interface | string $resource, \Zend_Acl_Resource_Interface | string $parent = null) : \Zend_Acl
Adds a Resource having an identifier unique to the ACL
Name | Type | Description |
---|---|---|
$resource | \Zend_Acl_Resource_Interface | string | |
$parent | \Zend_Acl_Resource_Interface | string |
Type | Description |
---|---|
\Zend_Acl | Provides a fluent interface |
Exception | Description |
---|---|
\Zend_Acl_Exception |


addRole(\Zend_Acl_Role_Interface | string $role, \Zend_Acl_Role_Interface | string | array $parents = null) : \Zend_Acl
Adds a Role having an identifier unique to the registry
Name | Type | Description |
---|---|---|
$role | \Zend_Acl_Role_Interface | string | |
$parents | \Zend_Acl_Role_Interface | string | array |
Type | Description |
---|---|
\Zend_Acl | Provides a fluent interface |


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
Adds an "allow" rule to the ACL
Name | Type | Description |
---|---|---|
$roles | \Zend_Acl_Role_Interface | string | array | |
$resources | \Zend_Acl_Resource_Interface | string | array | |
$privileges | string | array | |
$assert | \Zend_Acl_Assert_Interface |
Type | Description |
---|---|
\Zend_Acl | Provides a fluent interface |


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
Adds a "deny" rule to the ACL
Name | Type | Description |
---|---|---|
$roles | \Zend_Acl_Role_Interface | string | array | |
$resources | \Zend_Acl_Resource_Interface | string | array | |
$privileges | string | array | |
$assert | \Zend_Acl_Assert_Interface |
Type | Description |
---|---|
\Zend_Acl | Provides a fluent interface |


get(\Zend_Acl_Resource_Interface | string $resource) : \Zend_Acl_Resource_Interface
Returns the identified Resource
Name | Type | Description |
---|---|---|
$resource | \Zend_Acl_Resource_Interface | string |
Type | Description |
---|---|
\Zend_Acl_Resource_Interface |
Exception | Description |
---|---|
\Zend_Acl_Exception |


getRegisteredRoles() : array
Type | Description |
---|---|
array | of registered roles (Deprecated) |
- Deprecated
- Deprecated since version 1.10 (December 2009)


getRole(\Zend_Acl_Role_Interface | string $role) : \Zend_Acl_Role_Interface
Returns the identified Role
Name | Type | Description |
---|---|---|
$role | \Zend_Acl_Role_Interface | string |
Type | Description |
---|---|
\Zend_Acl_Role_Interface |


getRoles() : array
Returns an array of registered roles.
Type | Description |
---|---|
array | of registered roles |


has(\Zend_Acl_Resource_Interface | string $resource) : boolean
Returns true if and only if the Resource exists in the ACL
Name | Type | Description |
---|---|---|
$resource | \Zend_Acl_Resource_Interface | string |
Type | Description |
---|---|
boolean |


hasRole(\Zend_Acl_Role_Interface | string $role) : boolean
Returns true if and only if the Role exists in the registry
Name | Type | Description |
---|---|---|
$role | \Zend_Acl_Role_Interface | string |
Type | Description |
---|---|
boolean |


inherits(\Zend_Acl_Resource_Interface | string $resource, \Zend_Acl_Resource_Interface | string $inherit, boolean $onlyParent = false) : boolean
Returns true if and only if $resource inherits from $inherit
Name | Type | Description |
---|---|---|
$resource | \Zend_Acl_Resource_Interface | string | |
$inherit | \Zend_Acl_Resource_Interface | string | |
$onlyParent | boolean |
Type | Description |
---|---|
boolean |
Exception | Description |
---|---|
\Zend_Acl_Resource_Registry_Exception |


inheritsRole(\Zend_Acl_Role_Interface | string $role, \Zend_Acl_Role_Interface | string $inherit, boolean $onlyParents = false) : boolean
Returns true if and only if $role inherits from $inherit
Name | Type | Description |
---|---|---|
$role | \Zend_Acl_Role_Interface | string | |
$inherit | \Zend_Acl_Role_Interface | string | |
$onlyParents | boolean |
Type | Description |
---|---|
boolean |


isAllowed(\Zend_Acl_Role_Interface | string $role = null, \Zend_Acl_Resource_Interface | string $resource = null, string $privilege = null) : boolean
Returns true if and only if the Role has access to the Resource
Name | Type | Description |
---|---|---|
$role | \Zend_Acl_Role_Interface | string | |
$resource | \Zend_Acl_Resource_Interface | string | |
$privilege | string |
Type | Description |
---|---|
boolean |


remove(\Zend_Acl_Resource_Interface | string $resource) : \Zend_Acl
Removes a Resource and all of its children
Name | Type | Description |
---|---|---|
$resource | \Zend_Acl_Resource_Interface | string |
Type | Description |
---|---|
\Zend_Acl | Provides a fluent interface |
Exception | Description |
---|---|
\Zend_Acl_Exception |


removeAll() : \Zend_Acl
Removes all Resources
Type | Description |
---|---|
\Zend_Acl | Provides a fluent interface |


removeAllow(\Zend_Acl_Role_Interface | string | array $roles = null, \Zend_Acl_Resource_Interface | string | array $resources = null, string | array $privileges = null) : \Zend_Acl
Removes "allow" permissions from the ACL
Name | Type | Description |
---|---|---|
$roles | \Zend_Acl_Role_Interface | string | array | |
$resources | \Zend_Acl_Resource_Interface | string | array | |
$privileges | string | array |
Type | Description |
---|---|
\Zend_Acl | Provides a fluent interface |


removeDeny(\Zend_Acl_Role_Interface | string | array $roles = null, \Zend_Acl_Resource_Interface | string | array $resources = null, string | array $privileges = null) : \Zend_Acl
Removes "deny" restrictions from the ACL
Name | Type | Description |
---|---|---|
$roles | \Zend_Acl_Role_Interface | string | array | |
$resources | \Zend_Acl_Resource_Interface | string | array | |
$privileges | string | array |
Type | Description |
---|---|
\Zend_Acl | Provides a fluent interface |


removeRole(\Zend_Acl_Role_Interface | string $role) : \Zend_Acl
Removes the Role from the registry
Name | Type | Description |
---|---|---|
$role | \Zend_Acl_Role_Interface | string |
Type | Description |
---|---|
\Zend_Acl | Provides a fluent interface |


removeRoleAll() : \Zend_Acl
Removes all Roles from the registry
Type | Description |
---|---|
\Zend_Acl | Provides a fluent interface |


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
Performs operations on ACL rules
Name | Type | Description |
---|---|---|
$operation | string | |
$type | string | |
$roles | \Zend_Acl_Role_Interface | string | array | |
$resources | \Zend_Acl_Resource_Interface | string | array | |
$privileges | string | array | |
$assert | \Zend_Acl_Assert_Interface |
Type | Description |
---|---|
\Zend_Acl | Provides a fluent interface |
Exception | Description |
---|---|
\Zend_Acl_Exception |