Class dektrium\user\models\LoginForm

Inheritancedektrium\user\models\LoginForm » yii\base\Model
Uses Traitsdektrium\user\traits\ModuleTrait

LoginForm get user's login and password, validates them and logs the user in. If user has been blocked, it adds an error to login form.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$login string User's email or username dektrium\user\models\LoginForm
$password string User's plain password dektrium\user\models\LoginForm
$rememberMe string Whether to remember the user dektrium\user\models\LoginForm

Property Details

$finder protected property
protected dektrium\user\Finder $finder null
$login public property

User's email or username

public string $login null
$password public property

User's plain password

public string $password null
$rememberMe public property

Whether to remember the user

public string $rememberMe false
$user protected property

Method Details

__construct() public method

public void __construct ( dektrium\user\Finder $finder, $config = [] )
$finder dektrium\user\Finder
$config array
attributeLabels() public method

public void attributeLabels ( )
beforeValidate() public method

public void beforeValidate ( )
formName() public method

public void formName ( )
login() public method

Validates form and logs the user in.

public bool login ( )
return bool

Whether the user is logged in successfully

rules() public method

public void rules ( )