Class CUserIdentity

CUserIdentity is a base class for representing identities that are authenticated based on a username and a password.

Derived classes should implement CUserIdentity::authenticate() with the actual authentication scheme (e.g. checking username and password against a DB table).

By default, CUserIdentity assumes the CUserIdentity::$username is a unique identifier and thus use it as the id ID of the identity.

CComponent

CBaseUserIdentity implements IUserIdentity

CUserIdentity

Direct known subclasses

UserIdentity

Package: system\web\auth
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/web/auth/CUserIdentity.php

Methods summary
`public`	# `__construct( string $username, string $password )` Constructor. Constructor. Parameters `$username` `string` $username username `$password` `string` $password password
`public boolean`	# `authenticate( )` 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.
`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 `CBaseUserIdentity::getId()`
`public string`	# `getName( )` Returns the display name for the identity. The default implementation simply returns `CUserIdentity::$username`. This method is required by `IUserIdentity`. Returns the display name for the identity. The default implementation simply returns `CUserIdentity::$username`. This method is required by `IUserIdentity`. Returns `string` the display name for the identity. Overrides `CBaseUserIdentity::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 inherited from CBaseUserIdentity
`ERROR_NONE, ERROR_PASSWORD_INVALID, ERROR_UNKNOWN_IDENTITY, ERROR_USERNAME_INVALID`

Properties summary
`public string`	`$username`		# username username
`public string`	`$password`		# password password

Properties inherited from CBaseUserIdentity
`$errorCode, $errorMessage`

Magic properties summary
`public string`	`$id`	# The unique identifier for the identity. The unique identifier for the identity.
`public string`	`$name`	# The display name for the identity. The display name for the identity.

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

Packages

Classes

Class CUserIdentity

Direct known subclasses

Parameters

Returns

Returns

Overrides

Returns

Overrides