Interface IUserIdentity

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 CWebApplication::user user application component.

Direct known implementers

CBaseUserIdentity

Indirect known implementers

CUserIdentity, UserIdentity

Package: system\base
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/base/interfaces.php

Methods summary
`public boolean`	# `authenticate( )` Authenticates the user. The information needed to authenticate the user are usually provided in the constructor. Authenticates the user. The information needed to authenticate the user are usually provided in the constructor. Returns `boolean` whether authentication succeeds.
`public boolean`	# `getIsAuthenticated( )` Returns a value indicating whether the identity is authenticated. Returns a value indicating whether the identity is authenticated. Returns `boolean` whether the identity is valid.
`public mixed`	# `getId( )` Returns a value that uniquely represents the identity. Returns a value that uniquely represents the identity. Returns `mixed` a value that uniquely represents the identity (e.g. primary key value).
`public string`	# `getName( )` Returns the display name for the identity (e.g. username). Returns the display name for the identity (e.g. username). Returns `string` the display name for the identity.
`public array`	# `getPersistentStates( )` Returns the additional identity information that needs to be persistent during the user session. Returns the additional identity information that needs to be persistent during the user session. Returns `array` additional identity information that needs to be persistent during the user session (excluding id).

Packages

Classes

Interfaces

Exceptions

Interface IUserIdentity

Direct known implementers

Indirect known implementers

Returns

Returns

Returns

Returns

Returns