Source of file Registry.php
Size: 7,467 Bytes - Last Modified: 2014-03-12T23:21:18+01:00
/home/theseer/Downloads/ZendFramework-2.3.0/library/Zend/Permissions/Acl/Role/Registry.php
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241 | <?php /** * Zend Framework (http://framework.zend.com/) * * @link http://github.com/zendframework/zf2 for the canonical source repository * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com) * @license http://framework.zend.com/license/new-bsd New BSD License */ namespace Zend\Permissions\Acl\Role; use Traversable; use Zend\Permissions\Acl\Exception; class Registry { /** * Internal Role registry data storage * * @var array */ protected $roles = array(); /** * 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. * * @param RoleInterface $role * @param RoleInterface|string|array|Traversable $parents * @throws Exception\InvalidArgumentException * @return Registry Provides a fluent interface */ public function add(RoleInterface $role, $parents = null) { $roleId = $role->getRoleId(); if ($this->has($roleId)) { throw new Exception\InvalidArgumentException(sprintf( 'Role id "%s" already exists in the registry', $roleId )); } $roleParents = array(); if (null !== $parents) { if (!is_array($parents) && !$parents instanceof Traversable) { $parents = array($parents); } foreach ($parents as $parent) { try { if ($parent instanceof RoleInterface) { $roleParentId = $parent->getRoleId(); } else { $roleParentId = $parent; } $roleParent = $this->get($roleParentId); } catch (\Exception $e) { throw new Exception\InvalidArgumentException(sprintf( 'Parent Role id "%s" does not exist', $roleParentId ), 0, $e); } $roleParents[$roleParentId] = $roleParent; $this->roles[$roleParentId]['children'][$roleId] = $role; } } $this->roles[$roleId] = array( 'instance' => $role, 'parents' => $roleParents, 'children' => array(), ); return $this; } /** * Returns the identified Role * * The $role parameter can either be a Role or a Role identifier. * * @param RoleInterface|string $role * @throws Exception\InvalidArgumentException * @return RoleInterface */ public function get($role) { if ($role instanceof RoleInterface) { $roleId = $role->getRoleId(); } else { $roleId = (string) $role; } if (!$this->has($role)) { throw new Exception\InvalidArgumentException("Role '$roleId' not found"); } return $this->roles[$roleId]['instance']; } /** * Returns true if and only if the Role exists in the registry * * The $role parameter can either be a Role or a Role identifier. * * @param RoleInterface|string $role * @return bool */ public function has($role) { if ($role instanceof RoleInterface) { $roleId = $role->getRoleId(); } else { $roleId = (string) $role; } return isset($this->roles[$roleId]); } /** * 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. * * @param RoleInterface|string $role * @return array */ public function getParents($role) { $roleId = $this->get($role)->getRoleId(); return $this->roles[$roleId]['parents']; } /** * 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. * * @param RoleInterface|string $role * @param RoleInterface|string $inherit * @param bool $onlyParents * @throws Exception\InvalidArgumentException * @return bool */ public function inherits($role, $inherit, $onlyParents = false) { try { $roleId = $this->get($role)->getRoleId(); $inheritId = $this->get($inherit)->getRoleId(); } catch (Exception\ExceptionInterface $e) { throw new Exception\InvalidArgumentException($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; } /** * Removes the Role from the registry * * The $role parameter can either be a Role or a Role identifier. * * @param RoleInterface|string $role * @throws Exception\InvalidArgumentException * @return Registry Provides a fluent interface */ public function remove($role) { try { $roleId = $this->get($role)->getRoleId(); } catch (Exception\ExceptionInterface $e) { throw new Exception\InvalidArgumentException($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; } /** * Removes all Roles from the registry * * @return Registry Provides a fluent interface */ public function removeAll() { $this->roles = array(); return $this; } /** * Get all roles in the registry * * @return array */ public function getRoles() { return $this->roles; } } |