Docs For Class Zend_Acl_Aro

## Class Zend_Acl_Aro

Description

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

Located in /Zend/Acl/Aro.php (line 29)

Variable Summary
string $_id
array $_parent
Zend_Acl_Aro_Registry $_registry
Method Summary
void __construct (Zend_Acl_Aro_Registry $registry, string $id, [mixed $inherit = null])
boolean canAccess (Zend_Acl $aco, [ $context = null], [ $path = null])
string getId ()
array getParent ()
Zend_Acl_Aro_Registry getRegistry ()
array getValidAco (Zend_Acl $aco, [string $context = null], mixed $aro)
Zend_Acl_Aro _addParent ( $parent)
void _getValidAco (Zend_Acl $aco, $context)
Variables
string $_id (line 35)

Unique id of ARO

- access: protected

array $_parent = array() (line 47)

Collection of parents

- access: protected

Zend_Acl_Aro_Registry $_registry (line 41)

Reference to parent ARO registry

- access: protected

Methods
Constructor __construct (line 60)

Class constructor

If $inherit contains a string or array of values, then iterate through the parents, retrieving their ids and store in LIFO order. The first element of the $_parent array will always refer to the current object

- access: public

void __construct (Zend_Acl_Aro_Registry $registry, string $id, [mixed $inherit = null])

- string $id
- mixed $inherit
- Zend_Acl_Aro_Registry $registry

canAccess (line 121)

Performs a validation on an ACO using the current ARO

- access: public

boolean canAccess (Zend_Acl $aco, [ $context = null], [ $path = null])

- Zend_Acl $aco
- $context
- $path

getId (line 91)

Retrieves ARO id

- access: public

string getId ()
getParent (line 111)

Retrieves ARO parent ids

- access: public

array getParent ()
getRegistry (line 101)

Retrieves ARO registry

- access: public

Zend_Acl_Aro_Registry getRegistry ()
getValidAco (line 145)

Returns an ACO tree that the current ARO has access to

This function will determine which AROs - from either a list of AROs or the entire ARO registry - have access to the current ARO.

AROs can be supplied either an an ARO object, an array of ARO objects, a string id or an array of string ids. If the ARO parameter is left empty then the ARO registry is used to return all members.

To allow fine-grain control, a specific context can also be used to validate the AROs

An array of ARO objects is returned upon success or empty

- access: public

array getValidAco (Zend_Acl $aco, [string $context = null], mixed $aro)

- mixed $aro
- string $context
- Zend_Acl $aco

_addParent (line 165)

Add parent to current ARO

- access: protected

Zend_Acl_Aro _addParent ( $parent)

- $parent

_getValidAco (line 150)

- access: protected

void _getValidAco (Zend_Acl $aco, $context)

- Zend_Acl $aco
- $context

Documentation generated on Sun, 29 Oct 2006 21:27:51 -0600 by phpDocumentor 1.3.0RC6