Class app\models\LoginForm

All Classes | Properties | Methods
Inheritanceapp\models\LoginForm » yii\base\Model

LoginForm is the model behind the login form.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$password app\models\LoginForm
$rememberMe app\models\LoginForm
$username app\models\LoginForm

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getUser() Finds user by $username app\models\LoginForm
login() Logs in a user using the provided username and password. app\models\LoginForm
rules() app\models\LoginForm
validatePassword() Validates the password. app\models\LoginForm

Property Details

$password public property
public $password = null
$rememberMe public property
public $rememberMe = true
$username public property
public $username = null

Method Details

getUser() public method

Finds user by $username

public app\models\User|null getUser ( )
login() public method

Logs in a user using the provided username and password.

public boolean login ( )
return boolean

Whether the user is logged in successfully
rules() public method

public array rules ( )
return array

The validation rules.
validatePassword() public method

Validates the password.

This method serves as the inline validation for password.

public void validatePassword ( $attribute, $params )
$attribute string

The attribute currently being validated
$params array

The additional name-value pairs given in the rule