Alexander Kochetov
12 years ago
6 changed files with 705 additions and 15 deletions
@ -0,0 +1,97 @@ |
|||||||
|
<?php |
||||||
|
/** |
||||||
|
* @link http://www.yiiframework.com/ |
||||||
|
* @copyright Copyright (c) 2008 Yii Software LLC |
||||||
|
* @license http://www.yiiframework.com/license/ |
||||||
|
*/ |
||||||
|
|
||||||
|
namespace yii\web; |
||||||
|
|
||||||
|
use Yii; |
||||||
|
use yii\base\Object; |
||||||
|
|
||||||
|
/** |
||||||
|
* |
||||||
|
* @author Qiang Xue <qiang.xue@gmail.com> |
||||||
|
* @author Alexander Kochetov <creocoder@gmail.com> |
||||||
|
* @since 2.0 |
||||||
|
*/ |
||||||
|
class AuthAssignment extends Object |
||||||
|
{ |
||||||
|
private $_auth; |
||||||
|
private $_itemName; |
||||||
|
private $_userId; |
||||||
|
private $_bizRule; |
||||||
|
private $_data; |
||||||
|
|
||||||
|
/** |
||||||
|
* Constructor. |
||||||
|
* @param IAuthManager $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 |
||||||
|
* @param mixed $data additional data for this assignment |
||||||
|
*/ |
||||||
|
public function __construct($auth, $itemName, $userId, $bizRule = null, $data = null) |
||||||
|
{ |
||||||
|
$this->_auth = $auth; |
||||||
|
$this->_itemName = $itemName; |
||||||
|
$this->_userId = $userId; |
||||||
|
$this->_bizRule = $bizRule; |
||||||
|
$this->_data = $data; |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* @return mixed user ID (see [[User::id]]) |
||||||
|
*/ |
||||||
|
public function getUserId() |
||||||
|
{ |
||||||
|
return $this->_userId; |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* @return string the authorization item name |
||||||
|
*/ |
||||||
|
public function getItemName() |
||||||
|
{ |
||||||
|
return $this->_itemName; |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* @return string the business rule associated with this assignment |
||||||
|
*/ |
||||||
|
public function getBizRule() |
||||||
|
{ |
||||||
|
return $this->_bizRule; |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* @param string $value the business rule associated with this assignment |
||||||
|
*/ |
||||||
|
public function setBizRule($value) |
||||||
|
{ |
||||||
|
if ($this->_bizRule !== $value) { |
||||||
|
$this->_bizRule = $value; |
||||||
|
$this->_auth->saveAuthAssignment($this); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* @return mixed additional data for this assignment |
||||||
|
*/ |
||||||
|
public function getData() |
||||||
|
{ |
||||||
|
return $this->_data; |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* @param mixed $value additional data for this assignment |
||||||
|
*/ |
||||||
|
public function setData($value) |
||||||
|
{ |
||||||
|
if ($this->_data !== $value) { |
||||||
|
$this->_data = $value; |
||||||
|
$this->_auth->saveAuthAssignment($this); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
@ -0,0 +1,261 @@ |
|||||||
|
<?php |
||||||
|
/** |
||||||
|
* @link http://www.yiiframework.com/ |
||||||
|
* @copyright Copyright (c) 2008 Yii Software LLC |
||||||
|
* @license http://www.yiiframework.com/license/ |
||||||
|
*/ |
||||||
|
|
||||||
|
namespace yii\web; |
||||||
|
|
||||||
|
use Yii; |
||||||
|
use yii\base\Object; |
||||||
|
|
||||||
|
/** |
||||||
|
* |
||||||
|
* @author Qiang Xue <qiang.xue@gmail.com> |
||||||
|
* @author Alexander Kochetov <creocoder@gmail.com> |
||||||
|
* @since 2.0 |
||||||
|
*/ |
||||||
|
class AuthItem extends Object |
||||||
|
{ |
||||||
|
const TYPE_OPERATION = 0; |
||||||
|
const TYPE_TASK = 1; |
||||||
|
const TYPE_ROLE = 2; |
||||||
|
|
||||||
|
private $_auth; |
||||||
|
private $_type; |
||||||
|
private $_name; |
||||||
|
private $_description; |
||||||
|
private $_bizRule; |
||||||
|
private $_data; |
||||||
|
|
||||||
|
/** |
||||||
|
* Constructor. |
||||||
|
* @param IAuthManager $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 |
||||||
|
* @param string $bizRule the business rule associated with this item |
||||||
|
* @param mixed $data additional data for this item |
||||||
|
*/ |
||||||
|
public function __construct($auth, $name, $type, $description = '', $bizRule = null, $data = null) |
||||||
|
{ |
||||||
|
$this->_type = (int)$type; |
||||||
|
$this->_auth = $auth; |
||||||
|
$this->_name = $name; |
||||||
|
$this->_description = $description; |
||||||
|
$this->_bizRule = $bizRule; |
||||||
|
$this->_data = $data; |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* 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()]]. |
||||||
|
* @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. |
||||||
|
*/ |
||||||
|
public function checkAccess($itemName, $params = array()) |
||||||
|
{ |
||||||
|
Yii::trace('Checking permission: ' . $this->_name, __METHOD__); |
||||||
|
if ($this->_auth->executeBizRule($this->_bizRule, $params, $this->_data)) { |
||||||
|
if ($this->_name == $itemName) { |
||||||
|
return true; |
||||||
|
} |
||||||
|
foreach ($this->_auth->getItemChildren($this->_name) as $item) { |
||||||
|
if ($item->checkAccess($itemName, $params)) { |
||||||
|
return true; |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* @return IAuthManager the authorization manager |
||||||
|
*/ |
||||||
|
public function getAuthManager() |
||||||
|
{ |
||||||
|
return $this->_auth; |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* @return integer the authorization item type. This could be 0 (operation), 1 (task) or 2 (role). |
||||||
|
*/ |
||||||
|
public function getType() |
||||||
|
{ |
||||||
|
return $this->_type; |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* @return string the item name |
||||||
|
*/ |
||||||
|
public function getName() |
||||||
|
{ |
||||||
|
return $this->_name; |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* @param string $value the item name |
||||||
|
*/ |
||||||
|
public function setName($value) |
||||||
|
{ |
||||||
|
if ($this->_name !== $value) { |
||||||
|
$oldName = $this->_name; |
||||||
|
$this->_name = $value; |
||||||
|
$this->_auth->saveAuthItem($this, $oldName); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* @return string the item description |
||||||
|
*/ |
||||||
|
public function getDescription() |
||||||
|
{ |
||||||
|
return $this->_description; |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* @param string $value the item description |
||||||
|
*/ |
||||||
|
public function setDescription($value) |
||||||
|
{ |
||||||
|
if ($this->_description !== $value) { |
||||||
|
$this->_description = $value; |
||||||
|
$this->_auth->saveAuthItem($this); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* @return string the business rule associated with this item |
||||||
|
*/ |
||||||
|
public function getBizRule() |
||||||
|
{ |
||||||
|
return $this->_bizRule; |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* @param string $value the business rule associated with this item |
||||||
|
*/ |
||||||
|
public function setBizRule($value) |
||||||
|
{ |
||||||
|
if ($this->_bizRule !== $value) { |
||||||
|
$this->_bizRule = $value; |
||||||
|
$this->_auth->saveAuthItem($this); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* @return mixed the additional data associated with this item |
||||||
|
*/ |
||||||
|
public function getData() |
||||||
|
{ |
||||||
|
return $this->_data; |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* @param mixed $value the additional data associated with this item |
||||||
|
*/ |
||||||
|
public function setData($value) |
||||||
|
{ |
||||||
|
if ($this->_data !== $value) { |
||||||
|
$this->_data = $value; |
||||||
|
$this->_auth->saveAuthItem($this); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Adds a child item. |
||||||
|
* @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 |
||||||
|
*/ |
||||||
|
public function addChild($name) |
||||||
|
{ |
||||||
|
return $this->_auth->addItemChild($this->_name, $name); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Removes a child item. |
||||||
|
* 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 |
||||||
|
*/ |
||||||
|
public function removeChild($name) |
||||||
|
{ |
||||||
|
return $this->_auth->removeItemChild($this->_name, $name); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Returns a value indicating whether a child exists |
||||||
|
* @param string $name the child item name |
||||||
|
* @return boolean whether the child exists |
||||||
|
* @see IAuthManager::hasItemChild |
||||||
|
*/ |
||||||
|
public function hasChild($name) |
||||||
|
{ |
||||||
|
return $this->_auth->hasItemChild($this->_name, $name); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Returns the children of this item. |
||||||
|
* @return array all child items of this item. |
||||||
|
* @see IAuthManager::getItemChildren |
||||||
|
*/ |
||||||
|
public function getChildren() |
||||||
|
{ |
||||||
|
return $this->_auth->getItemChildren($this->_name); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Assigns this item to a user. |
||||||
|
* @param mixed $userId the user ID (see [[User::id]]) |
||||||
|
* @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 has already been assigned to the user |
||||||
|
* @see IAuthManager::assign |
||||||
|
*/ |
||||||
|
public function assign($userId, $bizRule = null, $data = null) |
||||||
|
{ |
||||||
|
return $this->_auth->assign($this->_name, $userId, $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 |
||||||
|
*/ |
||||||
|
public function revoke($userId) |
||||||
|
{ |
||||||
|
return $this->_auth->revoke($this->_name, $userId); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* 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 |
||||||
|
*/ |
||||||
|
public function isAssigned($userId) |
||||||
|
{ |
||||||
|
return $this->_auth->isAssigned($this->_name, $userId); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Returns the item assignment information. |
||||||
|
* @param mixed $userId the user ID (see [[User::id]]) |
||||||
|
* @return AuthAssignment the item assignment information. Null is returned if |
||||||
|
* this item is not assigned to the user. |
||||||
|
* @see IAuthManager::getAuthAssignment |
||||||
|
*/ |
||||||
|
public function getAssignment($userId) |
||||||
|
{ |
||||||
|
return $this->_auth->getAuthAssignment($this->_name, $userId); |
||||||
|
} |
||||||
|
} |
@ -0,0 +1,143 @@ |
|||||||
|
<?php |
||||||
|
/** |
||||||
|
* @link http://www.yiiframework.com/ |
||||||
|
* @copyright Copyright (c) 2008 Yii Software LLC |
||||||
|
* @license http://www.yiiframework.com/license/ |
||||||
|
*/ |
||||||
|
|
||||||
|
namespace yii\web; |
||||||
|
|
||||||
|
use Yii; |
||||||
|
use yii\base\Component; |
||||||
|
use yii\base\Exception; |
||||||
|
|
||||||
|
/** |
||||||
|
* |
||||||
|
* @author Qiang Xue <qiang.xue@gmail.com> |
||||||
|
* @author Alexander Kochetov <creocoder@gmail.com> |
||||||
|
* @since 2.0 |
||||||
|
*/ |
||||||
|
abstract class AuthManager extends Component implements IAuthManager |
||||||
|
{ |
||||||
|
/** |
||||||
|
* @var boolean Enable error reporting for bizRules. |
||||||
|
*/ |
||||||
|
public $showErrors = false; |
||||||
|
|
||||||
|
/** |
||||||
|
* @var array list of role names that are assigned to all users implicitly. |
||||||
|
* These roles do not need to be explicitly assigned to any user. |
||||||
|
* When calling [[checkAccess()]], these roles will be checked first. |
||||||
|
* For performance reason, you should minimize the number of such roles. |
||||||
|
* A typical usage of such roles is to define an 'authenticated' role and associate |
||||||
|
* it with a biz rule which checks if the current user is authenticated. |
||||||
|
* And then declare 'authenticated' in this property so that it can be applied to |
||||||
|
* every authenticated user. |
||||||
|
*/ |
||||||
|
public $defaultRoles = array(); |
||||||
|
|
||||||
|
/** |
||||||
|
* Creates a role. |
||||||
|
* This is a shortcut method to [[IAuthManager::createAuthItem()]]. |
||||||
|
* @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 |
||||||
|
*/ |
||||||
|
public function createRole($name, $description = '', $bizRule = null, $data = null) |
||||||
|
{ |
||||||
|
return $this->createAuthItem($name, AuthItem::TYPE_ROLE, $description, $bizRule, $data); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Creates a task. |
||||||
|
* This is a shortcut method to [[IAuthManager::createAuthItem()]]. |
||||||
|
* @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 |
||||||
|
*/ |
||||||
|
public function createTask($name, $description = '', $bizRule = null, $data = null) |
||||||
|
{ |
||||||
|
return $this->createAuthItem($name, AuthItem::TYPE_TASK, $description, $bizRule, $data); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Creates an operation. |
||||||
|
* This is a shortcut method to [[IAuthManager::createAuthItem()]]. |
||||||
|
* @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 |
||||||
|
*/ |
||||||
|
public function createOperation($name, $description = '', $bizRule = null, $data = null) |
||||||
|
{ |
||||||
|
return $this->createAuthItem($name, AuthItem::TYPE_OPERATION, $description, $bizRule, $data); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Returns roles. |
||||||
|
* This is a shortcut method to [[IAuthManager::getAuthItems()]]. |
||||||
|
* @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); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Returns tasks. |
||||||
|
* This is a shortcut method to [[IAuthManager::getAuthItems()]]. |
||||||
|
* @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); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Returns operations. |
||||||
|
* This is a shortcut method to [[IAuthManager::getAuthItems()]]. |
||||||
|
* @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); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Executes the specified business rule. |
||||||
|
* @param string $bizRule the business rule to be executed. |
||||||
|
* @param array $params parameters passed to [[IAuthManager::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. |
||||||
|
*/ |
||||||
|
public function executeBizRule($bizRule, $params, $data) |
||||||
|
{ |
||||||
|
return $bizRule === '' || $bizRule === null || ($this->showErrors ? eval($bizRule) != 0 : @eval($bizRule) != 0); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Checks the item types to make sure a child can be added to a parent. |
||||||
|
* @param integer $parentType parent item type |
||||||
|
* @param integer $childType child item type |
||||||
|
* @throws Exception if the item cannot be added as a child due to its incompatible type. |
||||||
|
*/ |
||||||
|
protected function checkItemChildType($parentType, $childType) |
||||||
|
{ |
||||||
|
static $types = array('operation', 'task', 'role'); |
||||||
|
if ($parentType < $childType) { |
||||||
|
throw new Exception("Cannot add an item of type '$types[$childType]' to an item of type '$types[$parentType]'."); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
@ -0,0 +1,173 @@ |
|||||||
|
<?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); |
||||||
|
} |
Loading…
Reference in new issue