CBaseUserIdentity
| 包 | system.web.auth |
|---|---|
| 继承 | abstract class CBaseUserIdentity » CComponent |
| 实现 | IUserIdentity |
| 子类 | CUserIdentity |
| 可用自 | 1.0 |
| 源码 | framework/web/auth/CBaseUserIdentity.php |
CBaseUserIdentity is a base class implementing IUserIdentity.
CBaseUserIdentity implements the scheme for representing identity information that needs to be persisted. It also provides the way to represent the authentication errors.
Derived classes should implement IUserIdentity::authenticate and IUserIdentity::getId that are required by the IUserIdentity interface.
CBaseUserIdentity implements the scheme for representing identity information that needs to be persisted. It also provides the way to represent the authentication errors.
Derived classes should implement IUserIdentity::authenticate and IUserIdentity::getId that are required by the IUserIdentity interface.
公共属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| errorCode | integer | the authentication error code. | CBaseUserIdentity |
| errorMessage | string | the authentication error message. | CBaseUserIdentity |
| id | mixed | Returns a value that uniquely represents the identity. | CBaseUserIdentity |
| isAuthenticated | boolean | Returns a value indicating whether the identity is authenticated. | CBaseUserIdentity |
| name | string | Returns the display name for the identity (e.g. username). | CBaseUserIdentity |
| persistentStates | array | Returns the identity states that should be persisted. | CBaseUserIdentity |
公共方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __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 |
| authenticate() | Authenticates the user. | IUserIdentity |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| clearState() | Removes the specified state. | CBaseUserIdentity |
| 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 |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getId() | Returns a value that uniquely represents the identity. | CBaseUserIdentity |
| getIsAuthenticated() | Returns a value indicating whether the identity is authenticated. | CBaseUserIdentity |
| getName() | Returns the display name for the identity (e.g. username). | CBaseUserIdentity |
| getPersistentStates() | Returns the identity states that should be persisted. | CBaseUserIdentity |
| getState() | Gets the persisted state by the specified name. | CBaseUserIdentity |
| 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 |
| setPersistentStates() | Sets an array of persistent states. | CBaseUserIdentity |
| setState() | Sets the named state with a given value. | CBaseUserIdentity |
属性详情
errorCode
属性
public integer $errorCode;
the authentication error code. If there is an error, the error code will be non-zero. Defaults to 100, meaning unknown identity. Calling authenticate will change this value.
errorMessage
属性
public string $errorMessage;
the authentication error message. Defaults to empty.
id
属性
只读
public mixed getId()
Returns a value that uniquely represents the identity.
isAuthenticated
属性
只读
public boolean getIsAuthenticated()
Returns a value indicating whether the identity is authenticated. This method is required by IUserIdentity.
name
属性
只读
public string getName()
Returns the display name for the identity (e.g. username).
persistentStates
属性
Returns the identity states that should be persisted. This method is required by IUserIdentity.
方法详情
clearState()
方法
|
public void clearState(string $name)
| ||
| $name | string | the name of the state |
源码： framework/web/auth/CBaseUserIdentity.php#127 (显示)
public function clearState($name)
{
unset($this->_state[$name]);
}
Removes the specified state.
getId()
方法
|
public mixed getId()
| ||
| {return} | mixed | a value that uniquely represents the identity (e.g. primary key value). The default implementation simply returns name. |
源码： framework/web/auth/CBaseUserIdentity.php#57 (显示)
public function getId()
{
return $this->getName();
}
Returns a value that uniquely represents the identity.
getIsAuthenticated()
方法
|
public boolean getIsAuthenticated()
| ||
| {return} | boolean | whether the authentication is successful. |
源码： framework/web/auth/CBaseUserIdentity.php#97 (显示)
public function getIsAuthenticated()
{
return $this->errorCode==self::ERROR_NONE;
}
Returns a value indicating whether the identity is authenticated. This method is required by IUserIdentity.
getName()
方法
|
public string getName()
| ||
| {return} | string | the display name for the identity. The default implementation simply returns empty string. |
Returns the display name for the identity (e.g. username).
getPersistentStates()
方法
|
public array getPersistentStates()
| ||
| {return} | array | the identity states that should be persisted. |
源码： framework/web/auth/CBaseUserIdentity.php#77 (显示)
public function getPersistentStates()
{
return $this->_state;
}
Returns the identity states that should be persisted. This method is required by IUserIdentity.
getState()
方法
|
public mixed getState(string $name, mixed $defaultValue=NULL)
| ||
| $name | string | the name of the state |
| $defaultValue | mixed | the default value to be returned if the named state does not exist |
| {return} | mixed | the value of the named state |
源码： framework/web/auth/CBaseUserIdentity.php#108 (显示)
public function getState($name,$defaultValue=null)
{
return isset($this->_state[$name])?$this->_state[$name]:$defaultValue;
}
Gets the persisted state by the specified name.
setPersistentStates()
方法
|
public void setPersistentStates(array $states)
| ||
| $states | array | the identity states that should be persisted. |
源码： framework/web/auth/CBaseUserIdentity.php#87 (显示)
public function setPersistentStates($states)
{
$this->_state = $states;
}
Sets an array of persistent states.
setState()
方法
|
public void setState(string $name, mixed $value)
| ||
| $name | string | the name of the state |
| $value | mixed | the value of the named state |
源码： framework/web/auth/CBaseUserIdentity.php#118 (显示)
public function setState($name,$value)
{
$this->_state[$name]=$value;
}
Sets the named state with a given value.