Class Zend_Acl_Role_Registry

Description
  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Acl/Role/Registry.php (line 35)


	
			
Variable Summary
 array $_roles
Method Summary
 array getParents (Zend_Acl_Role_Interface|string $role)
 void getRoles ()
 boolean has (Zend_Acl_Role_Interface|string $role)
 boolean inherits (Zend_Acl_Role_Interface|string $role, Zend_Acl_Role_Interface|string $inherit, [boolean $onlyParents = false])
Variables
array $_roles = array() (line 42)

Internal Role registry data storage

  • access: protected
Methods
add (line 63)

Adds a Role having an identifier unique to the registry

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.

  • return: Provides a fluent interface
  • throws: Zend_Acl_Role_Registry_Exception
  • access: public
  • usedby: Zend_Acl::addRole()
Zend_Acl_Role_Registry add (Zend_Acl_Role_Interface $role, [Zend_Acl_Role_Interface|string|array $parents = null])
get (line 119)

Returns the identified Role

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

getParents (line 171)

Returns an array of an existing Role's parents

The array keys are the identifiers of the parent Roles, and the values are the parent Role instances. The parent Roles are ordered in this array by ascending priority. The highest priority parent Role, last in the array, corresponds with the parent Role most recently added.

If the Role does not have any parents, then an empty array is returned.

array getParents (Zend_Acl_Role_Interface|string $role)
getRoles (line 266)
  • access: public
void getRoles ()
has (line 146)

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

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

boolean has (Zend_Acl_Role_Interface|string $role)
inherits (line 193)

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

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.

boolean inherits (Zend_Acl_Role_Interface|string $role, Zend_Acl_Role_Interface|string $inherit, [boolean $onlyParents = false])
remove (line 230)

Removes the Role from the registry

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

  • return: Provides a fluent interface
  • throws: Zend_Acl_Role_Registry_Exception
  • access: public
  • usedby: Zend_Acl::removeRole()
removeAll (line 259)

Removes all Roles from the registry

Zend_Acl_Role_Registry removeAll ()

Documentation generated on Mon, 21 Jun 2010 15:41:42 -0400 by phpDocumentor 1.4.3