PiiUserIdentity
| Package | pii.core.user |
|---|---|
| Inheritance | class PiiUserIdentity » CUserIdentity » CBaseUserIdentity » CComponent |
| Implements | IUserIdentity |
| Since | 2.0 |
| Version | $Id$ |
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| errorCode | integer | the authentication error code. | CBaseUserIdentity |
| errorMessage | string | the authentication error message. | CBaseUserIdentity |
| id | PiiUserIdentity | ||
| isAuthenticated | whether | Returns a value indicating whether the identity is authenticated. | CBaseUserIdentity |
| model | PiiUserIdentity | ||
| name | string | Returns the display name for the identity. | CUserIdentity |
| password | string | password | CUserIdentity |
| persistentStates | array | Returns the identity states that should be persisted. | CBaseUserIdentity |
| username | string | username | CUserIdentity |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __construct() | Constructor. | CUserIdentity |
| __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() | PiiUserIdentity | |
| 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 |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getId() | PiiUserIdentity | |
| getIsAuthenticated() | Returns a value indicating whether the identity is authenticated. | CBaseUserIdentity |
| getModel() | PiiUserIdentity | |
| getName() | Returns the display name for the identity. | CUserIdentity |
| 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 |
| setState() | Sets the named state with a given value. | CBaseUserIdentity |
Property Details
id
property
read-only
public void getId()
model
property
read-only
public void getModel()
Method Details
authenticate()
method
|
public void authenticate()
|
getId()
method
|
public void getId()
|
getModel()
method
|
public void getModel()
|