LoginAction::run() - Code Metrics - yii2mod/yii2-user - Measure and Improve Code Quality continuously with Scrutinizer

LoginAction::run() A
last analyzed 2019-11-02 17:51 UTC

↳ Parent: LoginAction

Complexity

Conditions	5
Paths	4

Size

Total Lines

Duplication

Lines	5
Ratio	21.74 %

Importance

Changes

Metric	Value
dl	5
loc	23
rs	9.2408
c	0
b	0
f	0
cc	5
nc	4
nop	0

<?php

namespace yii2mod\user\actions;

use Yii;
use yii\web\Response;
use yii\widgets\ActiveForm;

/**
 * Class LoginAction
 *
 * @package yii2mod\user\actions
 */
class LoginAction extends Action
{
    /**
     * @var string name of the view, which should be rendered
     */
    public $view = '@vendor/yii2mod/yii2-user/views/login';

    /**
     * @var string Login Form className
     */
    public $modelClass = 'yii2mod\user\models\LoginForm';

    /**
     * @var string layout the name of the layout to be applied to this view
     */
    public $layout;

    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();

        if ($this->layout !== null) {
            $this->controller->layout = $this->layout;
        }
    }

    /**
     * Logs in a user.
     *
     * @return string
     */
    public function run()
    {
        if (!Yii::$app->user->isGuest) {
            return $this->redirectTo(Yii::$app->getHomeUrl());
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        }

        $model = Yii::createObject($this->modelClass);
        $load = $model->load(Yii::$app->request->post());

        if (Yii::$app->request->isAjax) {

            Yii::$app->response->format = Response::FORMAT_JSON;

            return ActiveForm::validate($model);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        if ($load && $model->login()) {
            return $this->redirectTo(Yii::$app->getUser()->getReturnUrl());
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        }

        return $this->controller->render($this->view, [
            'model' => $model,
        ]);
    }
}


1		<?php
2
3		namespace yii2mod\user\actions;
4
5		use Yii;
6		use yii\web\Response;
7		use yii\widgets\ActiveForm;
8
9		/**
10		* Class LoginAction
11		*
12		* @package yii2mod\user\actions
13		*/
14		class LoginAction extends Action
15		{
16		/**
17		* @var string name of the view, which should be rendered
18		*/
19		public $view = '@vendor/yii2mod/yii2-user/views/login';
20
21		/**
22		* @var string Login Form className
23		*/
24		public $modelClass = 'yii2mod\user\models\LoginForm';
25
26		/**
27		* @var string layout the name of the layout to be applied to this view
28		*/
29		public $layout;
30
31		/**
32		* @inheritdoc
33		*/
34		public function init()
35		{
36		parent::init();
37
38		if ($this->layout !== null) {
39		$this->controller->layout = $this->layout;
40		}
41		}
42
43		/**
44		* Logs in a user.
45		*
46		* @return string
47		*/
48		public function run()
49		{
50		if (!Yii::$app->user->isGuest) {
51		return $this->redirectTo(Yii::$app->getHomeUrl());
		0 ignored issues – show Bug introduced 2017-08-20 09:06 UTC by Report Bug Copy Issue Report The method `getHomeUrl` does only exist in `yii\web\Application`, but not in `yii\console\Application`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... / } Loading history... Bug Best Practice introduced 2017-08-20 09:06 UTC by Report Bug Copy Issue Report The return type of `return $this->redirectTo...i::$app->getHomeUrl());` (`yii\web\Response`) is incompatible with the return type documented by `yii2mod\user\actions\LoginAction::run` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { / ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
52		}
53
54		$model = Yii::createObject($this->modelClass);
55		$load = $model->load(Yii::$app->request->post());
56
57	View Code Duplication	if (Yii::$app->request->isAjax) {
		0 ignored issues – show Duplication introduced 2017-08-20 09:06 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
58		Yii::$app->response->format = Response::FORMAT_JSON;
59
60		return ActiveForm::validate($model);
		0 ignored issues – show Bug Best Practice introduced 2017-08-20 09:06 UTC by Report Bug Copy Issue Report The return type of `return \yii\widgets\ActiveForm::validate($model);` (`array`) is incompatible with the return type documented by `yii2mod\user\actions\LoginAction::run` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
61		}
62
63		if ($load && $model->login()) {
64		return $this->redirectTo(Yii::$app->getUser()->getReturnUrl());
		0 ignored issues – show Bug introduced 2017-08-20 09:06 UTC by Report Bug Copy Issue Report The method `getUser` does only exist in `yii\web\Application`, but not in `yii\console\Application`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... / } Loading history... Bug Best Practice introduced 2017-08-20 09:06 UTC by Report Bug Copy Issue Report The return type of `return $this->redirectTo...ser()->getReturnUrl());` (`yii\web\Response`) is incompatible with the return type documented by `yii2mod\user\actions\LoginAction::run` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { / ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
65		}
66
67		return $this->controller->render($this->view, [
68		'model' => $model,
69		]);
70		}
71		}
72

yii2mod / yii2-user

LoginAction::run() A last analyzed 2019-11-02 17:51 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

LoginAction::run() A
last analyzed 2019-11-02 17:51 UTC