RequestPasswordResetAction - Code Metrics - yii2mod/yii2-user - Measure and Improve Code Quality continuously with Scrutinizer

RequestPasswordResetAction A
last analyzed 2019-11-02 17:51 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	72
Duplicated Lines	20.83 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
wmc	5
lcom	1
cbo	4
dl	15
loc	72
rs	10
c	0
b	0
f	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	run()	15	30	5

How to fix Duplicated Code

<?php

namespace yii2mod\user\actions;

use Yii;
use yii\web\Response;
use yii\widgets\ActiveForm;
use yii2mod\user\traits\EventTrait;

/**
 * Class RequestPasswordResetAction
 *
 * @package yii2mod\user\actions
 */
class RequestPasswordResetAction extends Action
{
    use EventTrait;

    /**
     * Event is triggered before requesting password reset.
     * Triggered with \yii2mod\user\events\FormEvent.
     */
    const EVENT_BEFORE_REQUEST = 'beforeRequest';

    /**
     * Event is triggered after requesting password reset.
     * Triggered with \yii2mod\user\events\FormEvent.
     */
    const EVENT_AFTER_REQUEST = 'afterRequest';

    /**
     * @var string name of the view, which should be rendered
     */
    public $view = '@vendor/yii2mod/yii2-user/views/requestPasswordResetToken';

    /**
     * @var string password reset request form class
     */
    public $modelClass = 'yii2mod\user\models\PasswordResetRequestForm';

    /**
     * @var string success message to the user when the mail is sent successfully
     */
    public $successMessage = 'Check your email for further instructions.';

    /**
     * @var string error message for the user when the email was not sent
     */
    public $errorMessage = 'Sorry, we are unable to reset password for email provided.';

    /**
     * Request password reset for a user.
     *
     * @return string|\yii\web\Response
     */
    public function run()
    {
        $model = Yii::createObject($this->modelClass);
        $event = $this->getFormEvent($model);

        $this->trigger(self::EVENT_BEFORE_REQUEST, $event);

        $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->validate()) {

            if ($model->sendEmail()) {
                $this->trigger(self::EVENT_AFTER_REQUEST, $event);
                Yii::$app->getSession()->setFlash('success', $this->successMessage);
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->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.
}
            } else {
                Yii::$app->getSession()->setFlash('error', $this->errorMessage);
            }
        }

        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		use yii2mod\user\traits\EventTrait;
9
10		/**
11		* Class RequestPasswordResetAction
12		*
13		* @package yii2mod\user\actions
14		*/
15		class RequestPasswordResetAction extends Action
16		{
17		use EventTrait;
18
19		/**
20		* Event is triggered before requesting password reset.
21		* Triggered with \yii2mod\user\events\FormEvent.
22		*/
23		const EVENT_BEFORE_REQUEST = 'beforeRequest';
24
25		/**
26		* Event is triggered after requesting password reset.
27		* Triggered with \yii2mod\user\events\FormEvent.
28		*/
29		const EVENT_AFTER_REQUEST = 'afterRequest';
30
31		/**
32		* @var string name of the view, which should be rendered
33		*/
34		public $view = '@vendor/yii2mod/yii2-user/views/requestPasswordResetToken';
35
36		/**
37		* @var string password reset request form class
38		*/
39		public $modelClass = 'yii2mod\user\models\PasswordResetRequestForm';
40
41		/**
42		* @var string success message to the user when the mail is sent successfully
43		*/
44		public $successMessage = 'Check your email for further instructions.';
45
46		/**
47		* @var string error message for the user when the email was not sent
48		*/
49		public $errorMessage = 'Sorry, we are unable to reset password for email provided.';
50
51		/**
52		* Request password reset for a user.
53		*
54		* @return string\|\yii\web\Response
55		*/
56		public function run()
57		{
58		$model = Yii::createObject($this->modelClass);
59		$event = $this->getFormEvent($model);
60
61		$this->trigger(self::EVENT_BEFORE_REQUEST, $event);
62
63		$load = $model->load(Yii::$app->request->post());
64
65	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...
66		Yii::$app->response->format = Response::FORMAT_JSON;
67
68		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\Req...asswordResetAction::run` of type `string\|yii\web\Response`. 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...
69		}
70
71	View Code Duplication	if ($load && $model->validate()) {
		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...
72		if ($model->sendEmail()) {
73		$this->trigger(self::EVENT_AFTER_REQUEST, $event);
74		Yii::$app->getSession()->setFlash('success', $this->successMessage);
		0 ignored issues – show Bug introduced 2017-08-20 09:06 UTC by Report Bug Copy Issue Report The method `getSession` 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...
75
76		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...
77		} else {
78		Yii::$app->getSession()->setFlash('error', $this->errorMessage);
79		}
80		}
81
82		return $this->controller->render($this->view, [
83		'model' => $model,
84		]);
85		}
86		}
87

yii2mod / yii2-user

RequestPasswordResetAction A last analyzed 2019-11-02 17:51 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

1 Method

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

RequestPasswordResetAction A
last analyzed 2019-11-02 17:51 UTC