Zend_Acl_Role_Registry Class Reference

Inheritance diagram for Zend_Acl_Role_Registry:

Public Member Functions
	add (Zend_Acl_Role_Interface $role, $parents=null)
	get ($role)
	has ($role)
	getParents ($role)
	inherits ($role, $inherit, $onlyParents=false)
	remove ($role)
	removeAll ()
	getRoles ()

Protected Attributes
	$_roles = array()

Detailed Description

Definition at line 35 of file Registry.php.

Member Function Documentation

add()

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

Definition at line 63 of file Registry.php.

    {
        $roleId = $role->getRoleId();

        if ($this->has($roleId)) {
            #require_once 'Zend/Acl/Role/Registry/Exception.php';
            throw new Zend_Acl_Role_Registry_Exception("Role id '$roleId' already exists in the registry");
        }

        $roleParents = array();

        if (null !== $parents) {
            if (!is_array($parents)) {
                $parents = array($parents);
            }
            #require_once 'Zend/Acl/Role/Registry/Exception.php';
            foreach ($parents as $parent) {
                try {
                    if ($parent instanceof Zend_Acl_Role_Interface) {
                        $roleParentId = $parent->getRoleId();
                    } else {
                        $roleParentId = $parent;
                    }
                    $roleParent = $this->get($roleParentId);
                } catch (Zend_Acl_Role_Registry_Exception $e) {
                    throw new Zend_Acl_Role_Registry_Exception("Parent Role id '$roleParentId' does not exist", 0, $e);
                }
                $roleParents[$roleParentId] = $roleParent;
                $this->_roles[$roleParentId]['children'][$roleId] = $role;
            }
        }

        $this->_roles[$roleId] = array(
            'instance' => $role,
            'parents'  => $roleParents,
            'children' => array()
            );

        return $this;
    }

get()

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

Definition at line 119 of file Registry.php.

    {
        if ($role instanceof Zend_Acl_Role_Interface) {
            $roleId = $role->getRoleId();
        } else {
            $roleId = (string) $role;
        }

        if (!$this->has($role)) {
            #require_once 'Zend/Acl/Role/Registry/Exception.php';
            throw new Zend_Acl_Role_Registry_Exception("Role '$roleId' not found");
        }

        return $this->_roles[$roleId]['instance'];
    }

getParents()

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

$role

@uses Zend_Acl_Role_Registry::get()

Returns

array

Definition at line 171 of file Registry.php.

    {
        $roleId = $this->get($role)->getRoleId();

        return $this->_roles[$roleId]['parents'];
    }

getRoles()

getRoles

(

)

Definition at line 266 of file Registry.php.

    {
        return $this->_roles;
    }

has()

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

Definition at line 146 of file Registry.php.

    {
        if ($role instanceof Zend_Acl_Role_Interface) {
            $roleId = $role->getRoleId();
        } else {
            $roleId = (string) $role;
        }

        return isset($this->_roles[$roleId]);
    }

inherits()

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

Definition at line 193 of file Registry.php.

    {
        #require_once 'Zend/Acl/Role/Registry/Exception.php';
        try {
            $roleId     = $this->get($role)->getRoleId();
            $inheritId = $this->get($inherit)->getRoleId();
        } catch (Zend_Acl_Role_Registry_Exception $e) {
            throw new Zend_Acl_Role_Registry_Exception($e->getMessage(), $e->getCode(), $e);
        }

        $inherits = isset($this->_roles[$roleId]['parents'][$inheritId]);

        if ($inherits || $onlyParents) {
            return $inherits;
        }

        foreach ($this->_roles[$roleId]['parents'] as $parentId => $parent) {
            if ($this->inherits($parentId, $inheritId)) {
                return true;
            }
        }

        return false;
    }

remove()

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

Definition at line 230 of file Registry.php.

    {
        #require_once 'Zend/Acl/Role/Registry/Exception.php';
        try {
            $roleId = $this->get($role)->getRoleId();
        } catch (Zend_Acl_Role_Registry_Exception $e) {
            throw new Zend_Acl_Role_Registry_Exception($e->getMessage(), $e->getCode(), $e);
        }

        foreach ($this->_roles[$roleId]['children'] as $childId => $child) {
            unset($this->_roles[$childId]['parents'][$roleId]);
        }
        foreach ($this->_roles[$roleId]['parents'] as $parentId => $parent) {
            unset($this->_roles[$parentId]['children'][$roleId]);
        }

        unset($this->_roles[$roleId]);

        return $this;
    }

removeAll()

removeAll

(

)

Removes all Roles from the registry

Returns

Zend_Acl_Role_Registry Provides a fluent interface

Definition at line 259 of file Registry.php.

    {
        $this->_roles = array();

        return $this;
    }

Field Documentation

$_roles

$_roles = array()

protected

Definition at line 42 of file Registry.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Acl/Role/Registry.php