UserIdentity
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\UserIdentity » CUserIdentity (opens new window) » CBaseUserIdentity (opens new window) » CComponent (opens new window)
- Implements
IUserIdentity- Since
- 1.0
UserIdentity represents the data needed to identify a user. It contains the authentication method that checks if the provided data can identity the user.
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $errorCode (opens new window) | integer (opens new window) – The authentication error code. |
| $errorMessage (opens new window) | string (opens new window) – The authentication error message. |
| $password (opens new window) | string (opens new window) – Password |
| $username (opens new window) | string (opens new window) – Username |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __construct() | UserIdentity constructor. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| authenticate() | Authenticates a user against the database. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| clearState() (opens new window) | Removes the specified state. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getId() | |
| getIsAuthenticated() (opens new window) | Returns a value indicating whether the identity is authenticated. |
| getName() (opens new window) | Returns the display name for the identity (e.g. username). |
| getPersistentStates() (opens new window) | Returns the identity states that should be persisted. |
| getState() (opens new window) | Gets the persisted state by the specified name. |
| getUserModel() | |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| logUserIn() | |
| raiseEvent() (opens new window) | Raises an event. |
| setPersistentStates() (opens new window) | Sets an array of persistent states. |
| setState() (opens new window) | Sets the named state with a given value. |
# __construct()
UserIdentity constructor.
View source (opens new window)
Arguments
$username(string (opens new window)) – Username$password(string (opens new window)) – Password
Signature
public void __construct ( $username, $password )
# authenticate()
Authenticates a user against the database.
View source (opens new window)
Returns
boolean (opens new window) – True, if authentication succeeds, false otherwise.
Signature
public boolean authenticate ( )
# getId()
Signature
public integer getId ( )
# getUserModel()
Signature
public Craft\UserModel getUserModel ( )
# logUserIn()
Signature
public null logUserIn ( $user )
# Constants
| Constant | Description |
|---|---|
ERROR_ACCOUNT_COOLDOWN | |
ERROR_ACCOUNT_LOCKED | |
ERROR_ACCOUNT_SUSPENDED | |
ERROR_NONE | |
ERROR_NO_CP_ACCESS | |
ERROR_NO_CP_OFFLINE_ACCESS | |
ERROR_NO_SITE_OFFLINE_ACCESS | |
ERROR_PASSWORD_INVALID | |
ERROR_PASSWORD_RESET_REQUIRED | |
ERROR_PENDING_VERIFICATION | |
ERROR_UNKNOWN_IDENTITY | |
ERROR_USERNAME_INVALID |