DbManager added + other classes comments fixes

framework/rbac/Assignment.php

@@ -19,24 +19,24 @@ use yii\base\Object;
 class Assignment extends Object
 {
 	private $_auth;
-	private $_itemName;
 	private $_userId;
+	private $_itemName;
 	private $_bizRule;
 	private $_data;
 
 	/**
 	 * Constructor.
 	 * @param IManager $auth the authorization manager
-	 * @param string $itemName authorization item name
 	 * @param mixed $userId user ID (see [[User::id]])
+	 * @param string $itemName authorization item name
 	 * @param string $bizRule the business rule associated with this assignment
 	 * @param mixed $data additional data for this assignment
 	 */
-	public function __construct($auth, $itemName, $userId, $bizRule = null, $data = null)
+	public function __construct($auth, $userId, $itemName, $bizRule = null, $data = null)
 	{
 		$this->_auth = $auth;
-		$this->_itemName = $itemName;
 		$this->_userId = $userId;
+		$this->_itemName = $itemName;
 		$this->_bizRule = $bizRule;
 		$this->_data = $data;
 	}

framework/rbac/IManager.php

+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\rbac;
+
+/**
+ * IManager interface is implemented by an auth manager application component.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @author Alexander Kochetov <creocoder@gmail.com>
+ * @since 2.0
+ */
+interface IManager
+{
+	/**
+	 * Performs access check for the specified user.
+	 * @param mixed $userId the user ID. This should be either an integer or a string representing
+	 * the unique identifier of a user. See [[User::id]].
+	 * @param string $itemName the name of the operation that we are checking access to
+	 * @param array $params name-value pairs that would be passed to biz rules associated
+	 * with the tasks and roles assigned to the user.
+	 * @return boolean whether the operations can be performed by the user.
+	 */
+	public function checkAccess($userId, $itemName, $params = array());
+
+	/**
+	 * Creates an authorization item.
+	 * An authorization item represents an action permission (e.g. creating a post).
+	 * It has three types: operation, task and role.
+	 * Authorization items form a hierarchy. Higher level items inheirt permissions representing
+	 * by lower level items.
+	 * @param string $name the item name. This must be a unique identifier.
+	 * @param integer $type the item type (0: operation, 1: task, 2: role).
+	 * @param string $description description of the item
+	 * @param string $bizRule business rule associated with the item. This is a piece of
+	 * PHP code that will be executed when [[checkAccess()]] is called for the item.
+	 * @param mixed $data additional data associated with the item.
+	 * @throws \yii\base\Exception if an item with the same name already exists
+	 * @return Item the authorization item
+	 */
+	public function createItem($name, $type, $description = '', $bizRule = null, $data = null);
+	/**
+	 * Removes the specified authorization item.
+	 * @param string $name the name of the item to be removed
+	 * @return boolean whether the item exists in the storage and has been removed
+	 */
+	public function removeItem($name);
+	/**
+	 * Returns the authorization items of the specific type and user.
+	 * @param mixed $userId the user ID. Defaults to null, meaning returning all items even if
+	 * they are not assigned to a user.
+	 * @param integer $type the item type (0: operation, 1: task, 2: role). Defaults to null,
+	 * meaning returning all items regardless of their type.
+	 * @return Item[] the authorization items of the specific type.
+	 */
+	public function getItems($userId = null, $type = null);
+	/**
+	 * Returns the authorization item with the specified name.
+	 * @param string $name the name of the item
+	 * @return Item the authorization item. Null if the item cannot be found.
+	 */
+	public function getItem($name);
+	/**
+	 * Saves an authorization item to persistent storage.
+	 * @param Item $item the item to be saved.
+	 * @param string $oldName the old item name. If null, it means the item name is not changed.
+	 */
+	public function saveItem($item, $oldName = null);
+
+	/**
+	 * Adds an item as a child of another item.
+	 * @param string $itemName the parent item name
+	 * @param string $childName the child item name
+	 * @throws \yii\base\Exception if either parent or child doesn't exist or if a loop has been detected.
+	 */
+	public function addItemChild($itemName, $childName);
+	/**
+	 * Removes a child from its parent.
+	 * Note, the child item is not deleted. Only the parent-child relationship is removed.
+	 * @param string $itemName the parent item name
+	 * @param string $childName the child item name
+	 * @return boolean whether the removal is successful
+	 */
+	public function removeItemChild($itemName, $childName);
+	/**
+	 * Returns a value indicating whether a child exists within a parent.
+	 * @param string $itemName the parent item name
+	 * @param string $childName the child item name
+	 * @return boolean whether the child exists
+	 */
+	public function hasItemChild($itemName, $childName);
+	/**
+	 * Returns the children of the specified item.
+	 * @param mixed $itemName the parent item name. This can be either a string or an array.
+	 * The latter represents a list of item names.
+	 * @return Item[] all child items of the parent
+	 */
+	public function getItemChildren($itemName);
+
+	/**
+	 * Assigns an authorization item to a user.
+	 * @param mixed $userId the user ID (see [[User::id]])
+	 * @param string $itemName the item name
+	 * @param string $bizRule the business rule to be executed when [[checkAccess()]] is called
+	 * for this particular authorization item.
+	 * @param mixed $data additional data associated with this assignment
+	 * @return Assignment the authorization assignment information.
+	 * @throws \yii\base\Exception if the item does not exist or if the item has already been assigned to the user
+	 */
+	public function assign($userId, $itemName, $bizRule = null, $data = null);
+	/**
+	 * Revokes an authorization assignment from a user.
+	 * @param mixed $userId the user ID (see [[User::id]])
+	 * @param string $itemName the item name
+	 * @return boolean whether removal is successful
+	 */
+	public function revoke($userId, $itemName);
+	/**
+	 * Returns a value indicating whether the item has been assigned to the user.
+	 * @param mixed $userId the user ID (see [[User::id]])
+	 * @param string $itemName the item name
+	 * @return boolean whether the item has been assigned to the user.
+	 */
+	public function isAssigned($userId, $itemName);
+	/**
+	 * Returns the item assignment information.
+	 * @param mixed $userId the user ID (see [[User::id]])
+	 * @param string $itemName the item name
+	 * @return Assignment the item assignment information. Null is returned if
+	 * the item is not assigned to the user.
+	 */
+	public function getAssignment($userId, $itemName);
+	/**
+	 * Returns the item assignments for the specified user.
+	 * @param mixed $userId the user ID (see [[User::id]])
+	 * @return Item[] the item assignment information for the user. An empty array will be
+	 * returned if there is no item assigned to the user.
+	 */
+	public function getAssignments($userId);
+	/**
+	 * Saves the changes to an authorization assignment.
+	 * @param Assignment $assignment the assignment that has been changed.
+	 */
+	public function saveAssignment($assignment);
+	/**
+	 * Removes all authorization data.
+	 */
+	public function clearAll();
+	/**
+	 * Removes all authorization assignments.
+	 */
+	public function clearAssignments();
+	/**
+	 * Saves authorization data into persistent storage.
+	 * If any change is made to the authorization data, please make
+	 * sure you call this method to save the changed data into persistent storage.
+	 */
+	public function save();
+	/**
+	 * Executes a business rule.
+	 * A business rule is a piece of PHP code that will be executed when [[checkAccess()]] is called.
+	 * @param string $bizRule the business rule to be executed.
+	 * @param array $params additional parameters to be passed to the business rule when being executed.
+	 * @param mixed $data additional data that is associated with the corresponding authorization item or assignment
+	 * @return boolean whether the execution returns a true value.
+	 * If the business rule is empty, it will also return true.
+	 */
+	public function executeBizRule($bizRule, $params, $data);
+}

framework/rbac/Item.php

@@ -202,7 +202,7 @@ class Item extends Object
 
 	/**
 	 * Returns the children of this item.
-	 * @return array all child items of this item.
+	 * @return Item[] all child items of this item.
 	 * @see IManager::getItemChildren
 	 */
 	public function getChildren()

framework/rbac/Manager.php

@@ -83,7 +83,7 @@ abstract class Manager extends Component implements IManager
 	 * This is a shortcut method to [[IManager::getItems()]].
 	 * @param mixed $userId the user ID. If not null, only the roles directly assigned to the user
 	 * will be returned. Otherwise, all roles will be returned.
-	 * @return array roles (name=>AuthItem)
+	 * @return Item[] roles (name=>AuthItem)
 	 */
 	public function getRoles($userId = null)
 	{
@@ -95,7 +95,7 @@ abstract class Manager extends Component implements IManager
 	 * This is a shortcut method to [[IManager::getItems()]].
 	 * @param mixed $userId the user ID. If not null, only the tasks directly assigned to the user
 	 * will be returned. Otherwise, all tasks will be returned.
-	 * @return array tasks (name=>AuthItem)
+	 * @return Item[] tasks (name=>AuthItem)
 	 */
 	public function getTasks($userId = null)
 	{
@@ -107,7 +107,7 @@ abstract class Manager extends Component implements IManager
 	 * This is a shortcut method to [[IManager::getItems()]].
 	 * @param mixed $userId the user ID. If not null, only the operations directly assigned to the user
 	 * will be returned. Otherwise, all operations will be returned.
-	 * @return array operations (name=>AuthItem)
+	 * @return Item[] operations (name=>AuthItem)
 	 */
 	public function getOperations($userId = null)
 	{

framework/rbac/PhpManager.php

@@ -52,8 +52,8 @@ class PhpManager extends Manager
 	 * @param string $itemName the name of the operation that need access check
 	 * the unique identifier of a user. See [[User::id]].
 	 * @param array $params name-value pairs that would be passed to biz rules associated
-	 * with the tasks and roles assigned to the user.
-	 * Since version 1.1.11 a param with name 'userId' is added to this array, which holds the value of <code>$userId</code>.
+	 * with the tasks and roles assigned to the user. A param with name 'userId' is added to
+	 * this array, which holds the value of `$userId`.
 	 * @return boolean whether the operations can be performed by the user.
 	 */
 	public function checkAccess($userId, $itemName, $params = array())
@@ -61,6 +61,7 @@ class PhpManager extends Manager
 		if (!isset($this->_items[$itemName])) {
 			return false;
 		}
+		/** @var $item Item */
 		$item = $this->_items[$itemName];
 		Yii::trace('Checking permission: ' . $item->getName(), __METHOD__);
 		if (!isset($params['userId'])) {
@@ -71,6 +72,7 @@ class PhpManager extends Manager
 				return true;
 			}
 			if (isset($this->_assignments[$userId][$itemName])) {
+				/** @var $assignment Assignment */
 				$assignment = $this->_assignments[$userId][$itemName];
 				if ($this->executeBizRule($assignment->getBizRule(), $params, $assignment->getData())) {
 					return true;
@@ -97,7 +99,9 @@ class PhpManager extends Manager
 		if (!isset($this->_items[$childName], $this->_items[$itemName])) {
 			throw new Exception("Either '$itemName' or '$childName' does not exist.");
 		}
+		/** @var $child Item */
 		$child = $this->_items[$childName];
+		/** @var $item Item */
 		$item = $this->_items[$itemName];
 		$this->checkItemChildType($item->getType(), $child->getType());
 		if ($this->detectLoop($itemName, $childName)) {
@@ -142,7 +146,7 @@ class PhpManager extends Manager
 	 * Returns the children of the specified item.
 	 * @param mixed $names the parent item name. This can be either a string or an array.
 	 * The latter represents a list of item names.
-	 * @return array all child items of the parent
+	 * @return Item[] all child items of the parent
 	 */
 	public function getItemChildren($names)
 	{
@@ -176,7 +180,7 @@ class PhpManager extends Manager
 		} elseif (isset($this->_assignments[$userId][$itemName])) {
 			throw new Exception("Authorization item '$itemName' has already been assigned to user '$userId'.");
 		} else {
-			return $this->_assignments[$userId][$itemName] = new Assignment($this, $itemName, $userId, $bizRule, $data);
+			return $this->_assignments[$userId][$itemName] = new Assignment($this, $userId, $itemName, $bizRule, $data);
 		}
 	}
 
@@ -222,7 +226,7 @@ class PhpManager extends Manager
 	/**
 	 * Returns the item assignments for the specified user.
 	 * @param mixed $userId the user ID (see [[User::id]])
-	 * @return array the item assignment information for the user. An empty array will be
+	 * @return Assignment[] the item assignment information for the user. An empty array will be
 	 * returned if there is no item assigned to the user.
 	 */
 	public function getAssignments($userId)
@@ -236,22 +240,24 @@ class PhpManager extends Manager
 	 * they are not assigned to a user.
 	 * @param integer $type the item type (0: operation, 1: task, 2: role). Defaults to null,
 	 * meaning returning all items regardless of their type.
-	 * @return array the authorization items of the specific type.
+	 * @return Item[] the authorization items of the specific type.
 	 */
 	public function getItems($userId = null, $type = null)
 	{
-		if ($type === null && $userId === null) {
+		if ($userId === null && $type === null) {
 			return $this->_items;
 		}
 		$items = array();
 		if ($userId === null) {
 			foreach ($this->_items as $name => $item) {
+				/** @var $item Item */
 				if ($item->getType() == $type) {
 					$items[$name] = $item;
 				}
 			}
 		} elseif (isset($this->_assignments[$userId])) {
 			foreach ($this->_assignments[$userId] as $assignment) {
+				/** @var $assignment Assignment */
 				$name = $assignment->getItemName();
 				if (isset($this->_items[$name]) && ($type === null || $this->_items[$name]->getType() == $type)) {
 					$items[$name] = $this->_items[$name];
@@ -368,6 +374,7 @@ class PhpManager extends Manager
 	{
 		$items = array();
 		foreach ($this->_items as $name => $item) {
+			/** @var $item Item */
 			$items[$name] = array(
 				'type' => $item->getType(),
 				'description' => $item->getDescription(),
@@ -376,6 +383,7 @@ class PhpManager extends Manager
 			);
 			if (isset($this->_children[$name])) {
 				foreach ($this->_children[$name] as $child) {
+					/** @var $child Item */
 					$items[$name]['children'][] = $child->getName();
 				}
 			}
@@ -383,6 +391,7 @@ class PhpManager extends Manager
 
 		foreach ($this->_assignments as $userId => $assignments) {
 			foreach ($assignments as $name => $assignment) {
+				/** @var $assignment Assignment */
 				if (isset($items[$name])) {
 					$items[$name]['assignments'][$userId] = array(
 						'bizRule' => $assignment->getBizRule(),
@@ -457,6 +466,7 @@ class PhpManager extends Manager
 			return false;
 		}
 		foreach ($this->_children[$childName] as $child) {
+			/** @var $child Item */
 			if ($this->detectLoop($itemName, $child->getName())) {
 				return true;
 			}