ResetPasswordController   A
last analyzed

Complexity

Total Complexity 7

Size/Duplication

Total Lines 93
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 2

Importance

Changes 0
Metric Value
wmc 7
lcom 1
cbo 2
dl 0
loc 93
rs 10
c 0
b 0
f 0

5 Methods

Rating   Name   Duplication   Size   Complexity  
A redirectTo() 0 4 1
A __construct() 0 13 3
A showResetForm() 0 8 1
A broker() 0 6 1
A guard() 0 4 1
1
<?php
2
3
namespace Backpack\Base\app\Http\Controllers\Auth;
4
5
use Backpack\Base\app\Http\Controllers\Controller;
6
use Illuminate\Foundation\Auth\ResetsPasswords;
7
use Illuminate\Http\Request;
8
use Illuminate\Support\Facades\Password;
9
10
class ResetPasswordController extends Controller
11
{
12
    protected $data = []; // the information we send to the view
13
14
    /*
15
    |--------------------------------------------------------------------------
16
    | Password Reset Controller
17
    |--------------------------------------------------------------------------
18
    |
19
    | This controller is responsible for handling password reset requests
20
    | and uses a simple trait to include this behavior. You're free to
21
    | explore this trait and override any methods you wish to tweak.
22
    |
23
    */
24
25
    use ResetsPasswords;
26
27
    /**
28
     * Get the path the user should be redirected to after password reset.
29
     *
30
     * @param \Illuminate\Http\Request $request
0 ignored issues
show
Bug introduced by
There is no parameter named $request. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
31
     *
32
     * @return string
33
     */
34
    public function redirectTo()
35
    {
36
        return backpack_url();
37
    }
38
39
    /**
40
     * Create a new controller instance.
41
     *
42
     * @return void
0 ignored issues
show
Comprehensibility Best Practice introduced by
Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

Adding a @return annotation to a constructor is not recommended, since a constructor does not have a meaningful return value.

Please refer to the PHP core documentation on constructors.

Loading history...
43
     */
44
    public function __construct()
45
    {
46
        $guard = backpack_guard_name();
47
48
        $this->middleware("guest:$guard");
49
50
        if (!backpack_users_have_email()) {
51
            abort(501, trans('backpack::base.no_email_column'));
52
        }
53
54
        // where to redirect after password was reset
55
        $this->redirectTo = property_exists($this, 'redirectTo') ? $this->redirectTo : config('backpack.base.route_prefix', 'admin').'/dashboard';
0 ignored issues
show
Bug introduced by
The property redirectTo does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
56
    }
57
58
    // -------------------------------------------------------
59
    // Laravel overwrites for loading backpack views
60
    // -------------------------------------------------------
61
62
    /**
63
     * Display the password reset view for the given token.
64
     *
65
     * If no token is present, display the link request form.
66
     *
67
     * @param \Illuminate\Http\Request $request
68
     * @param string|null              $token
69
     *
70
     * @return \Illuminate\Http\Response
71
     */
72
    public function showResetForm(Request $request, $token = null)
73
    {
74
        $this->data['title'] = trans('backpack::base.reset_password'); // set the page title
75
76
        return view('backpack::auth.passwords.reset', $this->data)->with(
0 ignored issues
show
Bug introduced by
The method with does only exist in Illuminate\View\View, but not in Illuminate\Contracts\View\Factory.

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

  1. Add an additional type-check:

    /**
     * @param A|B $x
     */
    function someFunction($x)
    {
        $x->foo();
    
        if ($x instanceof B) {
            $x->bar();
        }
    }
    
  2. Only allow a single type to be passed if the variable comes from a parameter:

    function someFunction(B $x) { /** ... */ }
    
Loading history...
77
            ['token' => $token, 'email' => $request->email]
78
        );
79
    }
80
81
    /**
82
     * Get the broker to be used during password reset.
83
     *
84
     * @return \Illuminate\Contracts\Auth\PasswordBroker
85
     */
86
    public function broker()
87
    {
88
        $passwords = config('backpack.base.passwords', config('auth.defaults.passwords'));
89
90
        return Password::broker($passwords);
91
    }
92
93
    /**
94
     * Get the guard to be used during password reset.
95
     *
96
     * @return \Illuminate\Contracts\Auth\StatefulGuard
97
     */
98
    protected function guard()
99
    {
100
        return backpack_auth();
101
    }
102
}
103