Class UserIdentity

The data needed to identity a user.

It contains the authentication method that checks if the provided data can identity the user.

CComponent

Extended by

CBaseUserIdentity implements IUserIdentity

Extended by

CUserIdentity

Extended by

UserIdentity

Package: application\components
Located at x2engine/protected/components/UserIdentity.php

Methods summary
`public boolean`	# `authenticate( mixed $google = false )` Authenticates a user based on `CUserIdentity::$username` and `CUserIdentity::$password`. Derived classes should override this method, or an exception will be thrown. This method is required by IUserIdentity. Authenticates a user based on `CUserIdentity::$username` and `CUserIdentity::$password`. Derived classes should override this method, or an exception will be thrown. This method is required by IUserIdentity. Returns `boolean` whether authentication succeeds. Overrides `CUserIdentity::authenticate()`
`public string`	# `getId( )` Returns the unique identifier for the identity. The default implementation simply returns `CUserIdentity::$username`. This method is required by IUserIdentity. Returns the unique identifier for the identity. The default implementation simply returns `CUserIdentity::$username`. This method is required by IUserIdentity. Returns `string` the unique identifier for the identity. Overrides `CUserIdentity::getId()`
`public`	# `getUserModel( )`

Methods inherited from CUserIdentity
`__construct(), getName()`

Methods inherited from CBaseUserIdentity
`clearState(), getIsAuthenticated(), getPersistentStates(), getState(), setPersistentStates(), setState()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Constants summary
`integer`	`ERROR_DISABLED`	`3`	#

Constants inherited from CBaseUserIdentity
`ERROR_NONE, ERROR_PASSWORD_INVALID, ERROR_UNKNOWN_IDENTITY, ERROR_USERNAME_INVALID`

Properties inherited from CUserIdentity
`$password, $username`

Properties inherited from CBaseUserIdentity
`$errorCode, $errorMessage`

Magic properties inherited from CUserIdentity
`$id, $name`

Magic properties inherited from CBaseUserIdentity
`$isAuthenticated, $persistentStates`