UserIdentity Class Reference

Public Member Functions
	authenticate ()
	authenticate ()
	getId ()

Public Attributes
const	ERROR_EMAIL_INVALID = 3
const	ERROR_STATUS_NOTACTIV = 4
const	ERROR_STATUS_BAN = 5

Private Attributes
	$_id

Detailed Description

UserIdentity represents the data needed to identity a user. It contains the authentication method that checks if the provided data can identity the user.

Definition at line 8 of file UserIdentity.php.

Member Function Documentation

UserIdentity::authenticate

(

)

Authenticates a user. The example implementation makes sure if the username and password are both 'demo'. In practical applications, this should be changed to authenticate against some persistent user identity storage (e.g. database).

Returns

boolean whether authentication succeeds.

Definition at line 18 of file UserIdentity.php.

UserIdentity::authenticate

(

)

Authenticates a user. The example implementation makes sure if the username and password are both 'demo'. In practical applications, this should be changed to authenticate against some persistent user identity storage (e.g. database).

Returns

boolean whether authentication succeeds.

Definition at line 23 of file UserIdentity.php.

Here is the call graph for this function:

UserIdentity::getId

(

)

Returns

integer the ID of the user record

Definition at line 54 of file UserIdentity.php.

Member Data Documentation

UserIdentity::$_id

private

Definition at line 10 of file UserIdentity.php.

const UserIdentity::ERROR_EMAIL_INVALID = 3

Definition at line 11 of file UserIdentity.php.

const UserIdentity::ERROR_STATUS_BAN = 5

Definition at line 13 of file UserIdentity.php.

const UserIdentity::ERROR_STATUS_NOTACTIV = 4

Definition at line 12 of file UserIdentity.php.

---

The documentation for this class was generated from the following files:

• app/protected/components/UserIdentity.php
• app/protected/modules/user/components/UserIdentity.php