modules\users\models\LoginForm

Complexity

Total Complexity

12

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	rules()	0	10	1
A	getUser()	0	6	2
A	attributeLabels()	0	7	1
A	login()	0	6	3
A	validatePassword()	0	6	4
A	logout()	0	3	1

<?php

namespace modules\users\models;

use Yii;
use yii\base\Model;
use modules\users\Module;

/**
 * Class LoginForm
 * @package modules\users\models
 *
 * @property string $email Email
 * @property string $password Password
 * @property-read null|array|User $user
 * @property bool $rememberMe Remember Me
 */
class LoginForm extends Model
{
    public $email;
    public $password;
    public $rememberMe = false;

    private $user;

    /**
     * @inheritdoc
     * @return array
     */
    public function rules()
    {
        return [
            // username and password are both required
            [['email', 'password'], 'required'],
            [['email'], 'email'],
            // rememberMe must be a boolean value
            ['rememberMe', 'boolean'],
            // password is validated by validatePassword()
            ['password', 'validatePassword'],
        ];
    }

    /**
     * @inheritdoc
     * @return array
     */
    public function attributeLabels()
    {
        return [
            'username' => Module::t('module', 'Username'),
            'email' => Module::t('module', 'Email'),
            'password' => Module::t('module', 'Password'),
            'rememberMe' => Module::t('module', 'Remember Me'),
        ];
    }

    /**
     * Validates the password.
     * This method serves as the inline validation for password.
     *
     * @param string $attribute the attribute currently being validated
     */
    public function validatePassword($attribute)
    {
        if (!$this->hasErrors()) {
            $user = $this->getUser();
            if (!$user || !$user->validatePassword($this->password)) {
                $this->addError($attribute, Module::t('module', 'Invalid email or password.'));
            }
        }
    }

    /**
     * Logs in a users using the provided username and password.
     *
     * @return bool whether the users is logged in successfully
     */
    public function login()
    {
        if ($this->validate()) {
            return Yii::$app->user->login($this->getUser(), $this->rememberMe ? 3600 * 24 * 30 : 0);

The method login() does not exist on null.

It seems like $this->getUser() can also be of type array; however, parameter $identity of yii\web\User::login() does only seem to accept yii\web\IdentityInterface, maybe add an additional type check?

        } else {
            return false;
        }
    }

    /**
     * Logout users
     * @return bool
     */
    public function logout()
    {
        return Yii::$app->user->logout();
    }

    /**
     * Finds users by [[username]]
     *
     * @return array|null|User
     */
    protected function getUser()
    {
        if ($this->user === null) {
            $this->user = User::findByUsernameEmail($this->email);

The property user is declared read-only in modules\users\models\LoginForm.

        }
        return $this->user;
    }
}