CAuthAssignment
| Package | system.web.auth |
|---|---|
| Inheritance | class CAuthAssignment » CComponent |
| Since | 1.0 |
| Version | $Id: CAuthAssignment.php 1678 2010-01-07 21:02:00Z qiang.xue $ |
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.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| 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 |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __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() | CAuthAssignment | |
| getData() | CAuthAssignment | |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getItemName() | CAuthAssignment | |
| getUserId() | 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() | CAuthAssignment | |
| setData() | CAuthAssignment |
Property Details
bizRule
property
the business rule associated with this assignment
data
property
additional data for this assignment
itemName
property
read-only
public string getItemName()
the authorization item name
userId
property
read-only
public mixed getUserId()
user ID (see IWebUser::getId)
Method Details
__construct()
method
|
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 |
Constructor.
getBizRule()
method
|
public string getBizRule()
| ||
| {return} | string | the business rule associated with this assignment |
getData()
method
|
public mixed getData()
| ||
| {return} | mixed | additional data for this assignment |
getItemName()
method
|
public string getItemName()
| ||
| {return} | string | the authorization item name |
getUserId()
method
|
public mixed getUserId()
| ||
| {return} | mixed | user ID (see IWebUser::getId) |
setBizRule()
method
|
public void setBizRule(string $value)
| ||
| $value | string | the business rule associated with this assignment |
setData()
method
|
public void setData(mixed $value)
| ||
| $value | mixed | additional data for this assignment |