CAuthAssignment
包 | system.web.auth |
---|---|
继承 | class CAuthAssignment » CComponent |
可用自 | 1.0 |
源码 | framework/web/auth/CAuthAssignment.php |
CAuthAssignment represents an assignment of a role to a user.
It includes additional assignment information such as bizRule and data.
Do not create a CAuthAssignment instance using the 'new' operator.
Instead, call IAuthManager::assign.
公共属性
属性 | 类型 | 描述 | 被定义在 |
---|---|---|---|
bizRule | string | the business rule associated with this assignment | CAuthAssignment |
data | mixed | additional data for this assignment | CAuthAssignment |
itemName | string | the authorization item name | CAuthAssignment |
userId | mixed | user ID (see IWebUser::getId) | CAuthAssignment |
公共方法
方法 | 描述 | 被定义在 |
---|---|---|
__call() | Calls the named method which is not a class method. | CComponent |
__construct() | Constructor. | CAuthAssignment |
__get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
__isset() | Checks if a property value is null. | CComponent |
__set() | Sets value of a component property. | CComponent |
__unset() | Sets a component property to be null. | CComponent |
asa() | Returns the named behavior object. | CComponent |
attachBehavior() | Attaches a behavior to this component. | CComponent |
attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
attachEventHandler() | Attaches an event handler to an event. | CComponent |
canGetProperty() | Determines whether a property can be read. | CComponent |
canSetProperty() | Determines whether a property can be set. | CComponent |
detachBehavior() | Detaches a behavior from the component. | CComponent |
detachBehaviors() | Detaches all behaviors from the component. | CComponent |
detachEventHandler() | Detaches an existing event handler. | CComponent |
disableBehavior() | Disables an attached behavior. | CComponent |
disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
enableBehavior() | Enables an attached behavior. | CComponent |
enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
getBizRule() | Returns the business rule associated with this assignment | CAuthAssignment |
getData() | Returns additional data for this assignment | CAuthAssignment |
getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
getItemName() | Returns the authorization item name | CAuthAssignment |
getUserId() | Returns user ID (see IWebUser::getId) | CAuthAssignment |
hasEvent() | Determines whether an event is defined. | CComponent |
hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
hasProperty() | Determines whether a property is defined. | CComponent |
raiseEvent() | Raises an event. | CComponent |
setBizRule() | Sets the business rule associated with this assignment | CAuthAssignment |
setData() | Sets additional data for this assignment | CAuthAssignment |
属性详情
bizRule
属性
the business rule associated with this assignment
data
属性
additional data for this assignment
itemName
属性
只读
public string getItemName()
the authorization item name
userId
属性
只读
public mixed getUserId()
user ID (see IWebUser::getId)
方法详情
__construct()
方法
public void __construct(IAuthManager $auth, string $itemName, mixed $userId, string $bizRule=NULL, mixed $data=NULL)
| ||
$auth | IAuthManager | the authorization manager |
$itemName | string | authorization item name |
$userId | mixed | user ID (see IWebUser::getId) |
$bizRule | string | the business rule associated with this assignment |
$data | mixed | additional data for this assignment |
源码: framework/web/auth/CAuthAssignment.php#42 (显示)
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;
}
Constructor.
getBizRule()
方法
public string getBizRule()
| ||
{return} | string | the business rule associated with this assignment |
源码: framework/web/auth/CAuthAssignment.php#70 (显示)
public function getBizRule()
{
return $this->_bizRule;
}
getData()
方法
public mixed getData()
| ||
{return} | mixed | additional data for this assignment |
getItemName()
方法
public string getItemName()
| ||
{return} | string | the authorization item name |
源码: framework/web/auth/CAuthAssignment.php#62 (显示)
public function getItemName()
{
return $this->_itemName;
}
getUserId()
方法
public mixed getUserId()
| ||
{return} | mixed | user ID (see IWebUser::getId) |
源码: framework/web/auth/CAuthAssignment.php#54 (显示)
public function getUserId()
{
return $this->_userId;
}
setBizRule()
方法
public void setBizRule(string $value)
| ||
$value | string | the business rule associated with this assignment |
源码: framework/web/auth/CAuthAssignment.php#78 (显示)
public function setBizRule($value)
{
if($this->_bizRule!==$value)
{
$this->_bizRule=$value;
$this->_auth->saveAuthAssignment($this);
}
}
setData()
方法
public void setData(mixed $value)
| ||
$value | mixed | additional data for this assignment |
源码: framework/web/auth/CAuthAssignment.php#98 (显示)
public function setData($value)
{
if($this->_data!==$value)
{
$this->_data=$value;
$this->_auth->saveAuthAssignment($this);
}
}