Zend Framework  1.12
Public Member Functions | Protected Attributes | List of all members
Zend_Acl_Role_Registry Class Reference

Public Member Functions

 add (Zend_Acl_Role_Interface $role, $parents=null)
 Adds a Role having an identifier unique to the registry.
 
 get ($role)
 Returns the identified Role.
 
 has ($role)
 Returns true if and only if the Role exists in the registry.
 
 getParents ($role)
 Returns an array of an existing Role's parents.
 
 inherits ($role, $inherit, $onlyParents=false)
 Returns true if and only if $role inherits from $inherit.
 
 remove ($role)
 Removes the Role from the registry.
 
 removeAll ()
 Removes all Roles from the registry.
 
 getRoles ()
 

Protected Attributes

 $_roles = array()
 

Member Function Documentation

add ( Zend_Acl_Role_Interface  $role,
  $parents = null 
)

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.

Parameters
Zend_Acl_Role_Interface$role
Zend_Acl_Role_Interface | string | array$parents
Exceptions
Zend_Acl_Role_Registry_Exception
Returns
Zend_Acl_Role_Registry Provides a fluent interface
See Also
Zend_Acl_Role_Registry_Exception
Zend_Acl_Role_Registry_Exception
get (   $role)

Returns the identified Role.

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

Parameters
Zend_Acl_Role_Interface | string$role
Exceptions
Zend_Acl_Role_Registry_Exception
Returns
Zend_Acl_Role_Interface
See Also
Zend_Acl_Role_Registry_Exception
getParents (   $role)

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.

Parameters
Zend_Acl_Role_Interface | string$roleZend_Acl_Role_Registry::get()
Returns
array
getRoles ( )
has (   $role)

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

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

Parameters
Zend_Acl_Role_Interface | string$role
Returns
boolean
inherits (   $role,
  $inherit,
  $onlyParents = false 
)

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.

Parameters
Zend_Acl_Role_Interface | string$role
Zend_Acl_Role_Interface | string$inherit
boolean$onlyParents
Exceptions
Zend_Acl_Role_Registry_Exception
Returns
boolean
See Also
Zend_Acl_Role_Registry_Exception
remove (   $role)

Removes the Role from the registry.

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

Parameters
Zend_Acl_Role_Interface | string$role
Exceptions
Zend_Acl_Role_Registry_Exception
Returns
Zend_Acl_Role_Registry Provides a fluent interface
See Also
Zend_Acl_Role_Registry_Exception
removeAll ( )

Removes all Roles from the registry.

Returns
Zend_Acl_Role_Registry Provides a fluent interface

Member Data Documentation

$_roles = array()
protected