IUserIdentity
| 包 | system.base |
|---|---|
| 继承 | interface IUserIdentity |
| 子类 | CBaseUserIdentity, CUserIdentity |
| 可用自 | 1.0 |
| 版本 | $Id$ |
IUserIdentity interface is implemented by a user identity class.
An identity represents a way to authenticate a user and retrieve information needed to uniquely identity the user. It is normally used with the user application component.
An identity represents a way to authenticate a user and retrieve information needed to uniquely identity the user. It is normally used with the user application component.
公共方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| authenticate() | Authenticates the user. | IUserIdentity |
| getId() | Returns a value that uniquely represents the identity. | IUserIdentity |
| getIsAuthenticated() | Returns a value indicating whether the identity is authenticated. | IUserIdentity |
| getName() | Returns the display name for the identity (e.g. username). | IUserIdentity |
| getPersistentStates() | Returns the additional identity information that needs to be persistent during the user session. | IUserIdentity |
方法详情
authenticate()
方法
|
abstract public boolean authenticate()
| ||
| {return} | boolean | whether authentication succeeds. |
Authenticates the user. The information needed to authenticate the user are usually provided in the constructor.
getId()
方法
|
abstract public mixed getId()
| ||
| {return} | mixed | a value that uniquely represents the identity (e.g. primary key value). |
Returns a value that uniquely represents the identity.
getIsAuthenticated()
方法
|
abstract public boolean getIsAuthenticated()
| ||
| {return} | boolean | whether the identity is valid. |
Returns a value indicating whether the identity is authenticated.
getName()
方法
|
abstract public string getName()
| ||
| {return} | string | the display name for the identity. |
Returns the display name for the identity (e.g. username).
getPersistentStates()
方法
|
abstract public array getPersistentStates()
| ||
| {return} | array | additional identity information that needs to be persistent during the user session (excluding id). |
Returns the additional identity information that needs to be persistent during the user session.