Class dektrium\user\models\LoginForm

All Classes | Properties | Methods

Inheritance	dektrium\user\models\LoginForm » yii\base\Model

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

Property	Type	Description	Defined 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	Type	Defined By
$finder	dektrium\user\Finder	dektrium\user\models\LoginForm
$module	dektrium\user\Module	dektrium\user\models\LoginForm
$user	dektrium\user\models\User	dektrium\user\models\LoginForm

Method	Description	Defined By
__construct()		dektrium\user\models\LoginForm
attributeLabels()		dektrium\user\models\LoginForm
beforeValidate()		dektrium\user\models\LoginForm
formName()		dektrium\user\models\LoginForm
login()	Validates form and logs the user in.	dektrium\user\models\LoginForm
rules()		dektrium\user\models\LoginForm

$finder protected property

User's email or username

public string $login = null

$module protected property

$password public property

User's plain password

public string $password = null

$rememberMe public property

Whether to remember the user

$user protected property

__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 ( )

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 ( )