yii2mod\user\models\LoginForm

Complexity

Total Complexity

13

Size/Duplication

Total Lines	94
Duplicated Lines	8.51 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	rules()	0	9	1
A	attributeLabels()	8	8	1
A	validatePassword()	0	11	6
A	login()	0	8	3
A	getUser()	0	8	2

<?php

namespace yii2mod\user\models;

use Yii;
use yii\base\Model;
use yii2mod\user\models\enums\UserStatus;

/**
 * Login Form
 *
 * @package yii2mod\user\models
 */
class LoginForm extends Model
{
    /**
     * @var string email
     */
    public $email;

    /**
     * @var string password
     */
    public $password;

    /**
     * @var bool remember me
     */
    public $rememberMe = true;

    /**
     * @var bool|UserModel
     */
    protected $user = false;

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            [['email', 'password'], 'required'],
            ['email', 'email'],
            ['password', 'validatePassword'],
            ['rememberMe', 'boolean'],
        ];
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()

This method seems to be duplicated in your project.

    {
        return [
            'email' => Yii::t('yii2mod.user', 'Email'),
            'password' => Yii::t('yii2mod.user', 'Password'),
            'rememberMe' => Yii::t('yii2mod.user', 'Remember Me'),
        ];
    }

    /**
     * Validates the password.
     * This method serves as the inline validation for password.
     *
     * @param $attribute
     * @param $params
     */
    public function validatePassword($attribute, $params)

The parameter $params is not used and could be removed.

    {
        if (!$this->hasErrors()) {
            $user = $this->getUser();
            if ($user && $user->status === UserStatus::DELETED) {
                $this->addError($attribute, Yii::t('yii2mod.user', 'Your account has been deactivated, please contact support for details.'));
            } elseif (!$user || !$user->validatePassword($this->password)) {
                $this->addError($attribute, Yii::t('yii2mod.user', 'Incorrect email or password.'));
            }
        }
    }

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

    /**
     * Finds user by [[email]]
     *
     * @return UserModel|null
     */
    public function getUser()
    {
        if ($this->user === false) {
            $this->user = UserModel::findByEmail($this->email);

It seems like \yii2mod\user\models\UserModel::findByEmail($this->email) can also be of type object<yii\db\ActiveRecordInterface> or array. However, the property $user is declared as type boolean|object<yii2mod\user\models\UserModel>. Maybe add an additional type check?

        }

        return $this->user;
    }
}