Skip to content

Y
yii2
Commit cd338706 by Alexander Kochetov
Options

Moved to framework/rbac + method names refactoring

parent 9158e110
Showing with 47 additions and 220 deletions
framework/web/AuthAssignment.php → framework/rbac/Assignment.php
......@@ -5,7 +5,7 @@
* @license http://www.yiiframework.com/license/
*/
namespace yii\web;
namespace yii\rbac;
use Yii;
use yii\base\Object;
......@@ -16,7 +16,7 @@ use yii\base\Object;
* @author Alexander Kochetov <creocoder@gmail.com>
* @since 2.0
*/
class AuthAssignment extends Object
class Assignment extends Object
{
private $_auth;
private $_itemName;
......@@ -26,7 +26,7 @@ class AuthAssignment extends Object
/**
* Constructor.
* @param IAuthManager $auth the authorization manager
* @param IManager $auth the authorization manager
* @param string $itemName authorization item name
* @param mixed $userId user ID (see [[User::id]])
* @param string $bizRule the business rule associated with this assignment
......@@ -72,7 +72,7 @@ class AuthAssignment extends Object
{
if ($this->_bizRule !== $value) {
$this->_bizRule = $value;
$this->_auth->saveAuthAssignment($this);
$this->_auth->saveAssignment($this);
}
}
......@@ -91,7 +91,7 @@ class AuthAssignment extends Object
{
if ($this->_data !== $value) {
$this->_data = $value;
$this->_auth->saveAuthAssignment($this);
$this->_auth->saveAssignment($this);
}
}
}
framework/web/AuthItem.php → framework/rbac/Item.php
......@@ -5,7 +5,7 @@
* @license http://www.yiiframework.com/license/
*/
namespace yii\web;
namespace yii\rbac;
use Yii;
use yii\base\Object;
......@@ -16,7 +16,7 @@ use yii\base\Object;
* @author Alexander Kochetov <creocoder@gmail.com>
* @since 2.0
*/
class AuthItem extends Object
class Item extends Object
{
const TYPE_OPERATION = 0;
const TYPE_TASK = 1;
......@@ -31,7 +31,7 @@ class AuthItem extends Object
/**
* Constructor.
* @param IAuthManager $auth authorization manager
* @param IManager $auth authorization manager
* @param string $name authorization item name
* @param integer $type authorization item type. This can be 0 (operation), 1 (task) or 2 (role).
* @param string $description the description
......@@ -51,7 +51,7 @@ class AuthItem extends Object
/**
* Checks to see if the specified item is within the hierarchy starting from this item.
* This method is expected to be internally used by the actual implementations
* of the [[IAuthManager::checkAccess()]].
* of the [[IManager::checkAccess()]].
* @param string $itemName the name of the item to be checked
* @param array $params the parameters to be passed to business rule evaluation
* @return boolean whether the specified item is within the hierarchy starting from this item.
......@@ -73,9 +73,9 @@ class AuthItem extends Object
}
/**
* @return IAuthManager the authorization manager
* @return IManager the authorization manager
*/
public function getAuthManager()
public function getManager()
{
return $this->_auth;
}
......@@ -104,7 +104,7 @@ class AuthItem extends Object
if ($this->_name !== $value) {
$oldName = $this->_name;
$this->_name = $value;
$this->_auth->saveAuthItem($this, $oldName);
$this->_auth->saveItem($this, $oldName);
}
}
......@@ -123,7 +123,7 @@ class AuthItem extends Object
{
if ($this->_description !== $value) {
$this->_description = $value;
$this->_auth->saveAuthItem($this);
$this->_auth->saveItem($this);
}
}
......@@ -142,7 +142,7 @@ class AuthItem extends Object
{
if ($this->_bizRule !== $value) {
$this->_bizRule = $value;
$this->_auth->saveAuthItem($this);
$this->_auth->saveItem($this);
}
}
......@@ -161,7 +161,7 @@ class AuthItem extends Object
{
if ($this->_data !== $value) {
$this->_data = $value;
$this->_auth->saveAuthItem($this);
$this->_auth->saveItem($this);
}
}
......@@ -170,7 +170,7 @@ class AuthItem extends Object
* @param string $name the name of the child item
* @return boolean whether the item is added successfully
* @throws \yii\base\Exception if either parent or child doesn't exist or if a loop has been detected.
* @see IAuthManager::addItemChild
* @see IManager::addItemChild
*/
public function addChild($name)
{
......@@ -182,7 +182,7 @@ class AuthItem extends Object
* Note, the child item is not deleted. Only the parent-child relationship is removed.
* @param string $name the child item name
* @return boolean whether the removal is successful
* @see IAuthManager::removeItemChild
* @see IManager::removeItemChild
*/
public function removeChild($name)
{
......@@ -193,7 +193,7 @@ class AuthItem extends Object
* Returns a value indicating whether a child exists
* @param string $name the child item name
* @return boolean whether the child exists
* @see IAuthManager::hasItemChild
* @see IManager::hasItemChild
*/
public function hasChild($name)
{
......@@ -203,7 +203,7 @@ class AuthItem extends Object
/**
* Returns the children of this item.
* @return array all child items of this item.
* @see IAuthManager::getItemChildren
* @see IManager::getItemChildren
*/
public function getChildren()
{
......@@ -216,46 +216,46 @@ class AuthItem extends Object
* @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 AuthAssignment the authorization assignment information.
* @return Assignment the authorization assignment information.
* @throws \yii\base\Exception if the item has already been assigned to the user
* @see IAuthManager::assign
* @see IManager::assign
*/
public function assign($userId, $bizRule = null, $data = null)
{
return $this->_auth->assign($this->_name, $userId, $bizRule, $data);
return $this->_auth->assign($userId, $this->_name, $bizRule, $data);
}
/**
* Revokes an authorization assignment from a user.
* @param mixed $userId the user ID (see [[User::id]])
* @return boolean whether removal is successful
* @see IAuthManager::revoke
* @see IManager::revoke
*/
public function revoke($userId)
{
return $this->_auth->revoke($this->_name, $userId);
return $this->_auth->revoke($userId, $this->_name);
}
/**
* Returns a value indicating whether this item has been assigned to the user.
* @param mixed $userId the user ID (see [[User::id]])
* @return boolean whether the item has been assigned to the user.
* @see IAuthManager::isAssigned
* @see IManager::isAssigned
*/
public function isAssigned($userId)
{
return $this->_auth->isAssigned($this->_name, $userId);
return $this->_auth->isAssigned($userId, $this->_name);
}
/**
* Returns the item assignment information.
* @param mixed $userId the user ID (see [[User::id]])
* @return AuthAssignment the item assignment information. Null is returned if
* @return Assignment the item assignment information. Null is returned if
* this item is not assigned to the user.
* @see IAuthManager::getAuthAssignment
* @see IManager::getAssignment
*/
public function getAssignment($userId)
{
return $this->_auth->getAuthAssignment($this->_name, $userId);
return $this->_auth->getAssignment($userId, $this->_name);
}
}
framework/web/AuthManager.php → framework/rbac/Manager.php
......@@ -5,7 +5,7 @@
* @license http://www.yiiframework.com/license/
*/
namespace yii\web;
namespace yii\rbac;
use Yii;
use yii\base\Component;
......@@ -17,7 +17,7 @@ use yii\base\Exception;
* @author Alexander Kochetov <creocoder@gmail.com>
* @since 2.0
*/
abstract class AuthManager extends Component implements IAuthManager
abstract class Manager extends Component implements IManager
{
/**
* @var boolean Enable error reporting for bizRules.
......@@ -38,86 +38,86 @@ abstract class AuthManager extends Component implements IAuthManager
/**
* Creates a role.
* This is a shortcut method to [[IAuthManager::createAuthItem()]].
* This is a shortcut method to [[IManager::createItem()]].
* @param string $name the item name
* @param string $description the item description.
* @param string $bizRule the business rule associated with this item
* @param mixed $data additional data to be passed when evaluating the business rule
* @return AuthItem the authorization item
* @return Item the authorization item
*/
public function createRole($name, $description = '', $bizRule = null, $data = null)
{
return $this->createAuthItem($name, AuthItem::TYPE_ROLE, $description, $bizRule, $data);
return $this->createItem($name, Item::TYPE_ROLE, $description, $bizRule, $data);
}
/**
* Creates a task.
* This is a shortcut method to [[IAuthManager::createAuthItem()]].
* This is a shortcut method to [[IManager::createItem()]].
* @param string $name the item name
* @param string $description the item description.
* @param string $bizRule the business rule associated with this item
* @param mixed $data additional data to be passed when evaluating the business rule
* @return AuthItem the authorization item
* @return Item the authorization item
*/
public function createTask($name, $description = '', $bizRule = null, $data = null)
{
return $this->createAuthItem($name, AuthItem::TYPE_TASK, $description, $bizRule, $data);
return $this->createItem($name, Item::TYPE_TASK, $description, $bizRule, $data);
}
/**
* Creates an operation.
* This is a shortcut method to [[IAuthManager::createAuthItem()]].
* This is a shortcut method to [[IManager::createItem()]].
* @param string $name the item name
* @param string $description the item description.
* @param string $bizRule the business rule associated with this item
* @param mixed $data additional data to be passed when evaluating the business rule
* @return AuthItem the authorization item
* @return Item the authorization item
*/
public function createOperation($name, $description = '', $bizRule = null, $data = null)
{
return $this->createAuthItem($name, AuthItem::TYPE_OPERATION, $description, $bizRule, $data);
return $this->createItem($name, Item::TYPE_OPERATION, $description, $bizRule, $data);
}
/**
* Returns roles.
* This is a shortcut method to [[IAuthManager::getAuthItems()]].
* 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)
*/
public function getRoles($userId = null)
{
return $this->getAuthItems(AuthItem::TYPE_ROLE, $userId);
return $this->getItems($userId, Item::TYPE_ROLE);
}
/**
* Returns tasks.
* This is a shortcut method to [[IAuthManager::getAuthItems()]].
* 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)
*/
public function getTasks($userId = null)
{
return $this->getAuthItems(AuthItem::TYPE_TASK, $userId);
return $this->getItems($userId, Item::TYPE_TASK);
}
/**
* Returns operations.
* This is a shortcut method to [[IAuthManager::getAuthItems()]].
* 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)
*/
public function getOperations($userId = null)
{
return $this->getAuthItems(AuthItem::TYPE_OPERATION, $userId);
return $this->getItems($userId, Item::TYPE_OPERATION);
}
/**
* Executes the specified business rule.
* @param string $bizRule the business rule to be executed.
* @param array $params parameters passed to [[IAuthManager::checkAccess()]].
* @param array $params parameters passed to [[IManager::checkAccess()]].
* @param mixed $data additional data associated with the authorization item or assignment.
* @return boolean whether the business rule returns true.
* If the business rule is empty, it will still return true.
......
framework/web/IAuthManager.php deleted 100644 → 0
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\web;
/**
* IAuthManager 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 IAuthManager
{
/**
* 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 AuthItem the authorization item
*/
public function createAuthItem($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 removeAuthItem($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 array the authorization items of the specific type.
*/
public function getAuthItems($userId = null, $type = null);
/**
* Returns the authorization item with the specified name.
* @param string $name the name of the item
* @return AuthItem the authorization item. Null if the item cannot be found.
*/
public function getAuthItem($name);
/**
* Saves an authorization item to persistent storage.
* @param AuthItem $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 saveAuthItem($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 array 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 AuthAssignment 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 AuthAssignment the item assignment information. Null is returned if
* the item is not assigned to the user.
*/
public function getAuthAssignment($userId, $itemName);
/**
* 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
* returned if there is no item assigned to the user.
*/
public function getAuthAssignments($userId);
/**
* Saves the changes to an authorization assignment.
* @param AuthAssignment $assignment the assignment that has been changed.
*/
public function saveAuthAssignment($assignment);
/**
* Removes all authorization data.
*/
public function clearAll();
/**
* Removes all authorization assignments.
*/
public function clearAuthAssignments();
/**
* 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);
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment