LoginForm Class Reference

Inheritance diagram for LoginForm:

Public Member Functions
	rules ()
	attributeLabels ()
	authenticate ($attribute, $params)
	login ()

Data Fields
	$username
	$password
	$rememberMe

Detailed Description

LoginForm class. LoginForm is the data structure for keeping user login form data. It is used by the 'login' action of 'SiteController'.

Definition at line 8 of file LoginForm.php.

Member Function Documentation

attributeLabels

(

)

Declares attribute labels.

Definition at line 36 of file LoginForm.php.

authenticate	(		$attribute,
			$params
	)

Authenticates the password. This is the 'authenticate' validator as declared in rules().

Definition at line 47 of file LoginForm.php.

login

(

)

Logs in the user using the given username and password in the model.

Returns

boolean whether login is successful

Definition at line 61 of file LoginForm.php.

rules

(

)

Declares the validation rules. The rules state that username and password are required, and password needs to be authenticated.

Definition at line 21 of file LoginForm.php.

Field Documentation

$password

Definition at line 11 of file LoginForm.php.

$rememberMe

Definition at line 12 of file LoginForm.php.

$username

Definition at line 10 of file LoginForm.php.

---

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

• test/protected/models/LoginForm.php