Completed
Push — user-management ( d87e21 )
by Tony
03:32
created

UserController::preferences()   B

Complexity

Conditions 5
Paths 8

Size

Total Lines 34
Code Lines 21

Duplication

Lines 0
Ratio 0 %
Metric Value
dl 0
loc 34
rs 8.439
cc 5
eloc 21
nc 8
nop 1

1 Method

Rating   Name   Duplication   Size   Complexity  
A UserController::index() 0 7 2
1
<?php
2
3
namespace App\Http\Controllers;
4
5
use App\DataTables\General\UserDataTable;
6
use App\Http\Requests\CreateUserRequest;
7
use App\Http\Requests\DeleteUserRequest;
8
use App\Http\Requests\UpdateUserRequest;
9
use App\Models\User;
10
use Auth;
11
use Dingo\Api\Http;
12
use Dingo\Api\Routing\Helpers;
13
use Illuminate\Http\Request;
14
15
class UserController extends Controller
16
{
17
    use Helpers;
18
19
    /**
20
     * Constructor
21
     */
22
    public function __construct(Request $request)
1 ignored issue
show
Unused Code introduced by
The parameter $request is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
23
    {
24
        $this->middleware('auth');
25
    }
26
27
    /**
28
     * Display a listing of the resource.
29
     *
30
     * @param UserDataTable $dataTable
31
     * @return \Illuminate\Http\Response
32
     */
33
    public function index(UserDataTable $dataTable)
34
    {
35
        if (Auth::user()->isAdmin()) {
36
            return $dataTable->render('users.manage');
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $dataTable->render('users.manage'); (Illuminate\Http\JsonResponse|Illuminate\View\View) is incompatible with the return type documented by App\Http\Controllers\UserController::index of type Illuminate\Http\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...
37
        }
38
        return $this->edit(Auth::id());
39
    }
40
41
    /**
42
     * Show the form for creating a new resource.
43
     *
44
     * @return \Illuminate\Http\Response
45
     */
46
    public function create()
47
    {
48
        return view('users.create');
49
    }
50
51
    /**
52
     * Store a newly created resource in storage.
53
     *
54
     * @param CreateUserRequest $request
55
     * @return \Illuminate\Http\Response
56
     */
57
    public function store(CreateUserRequest $request)
58
    {
59
        $user = User::create($request->all());
60
61
        return response()->json(['message' => "User ".$user->username." created."]);
62
    }
63
64
    /**
65
     * Display the specified resource.
66
     *
67
     * @param  int $user_id
68
     * @return \Illuminate\Http\Response
69
     */
70
    public function show($user_id)
71
    {
72
        $user = User::with('devices', 'ports')->findOrFail($user_id);
73
        return view('users.preferences', ['updated' => false])->withUser($user);
74
        // show read only view of user info here
75
    }
76
77
    /**
78
     * Show the form for editing the specified resource.
79
     *
80
     * @param  int $user_id
81
     * @return \Illuminate\Http\Response
82
     */
83
    public function edit($user_id)
84
    {
85
        $user = User::with('devices', 'ports')->findOrFail($user_id);
86
87
        if (Auth::user()->isAdmin()) {
88
            return view('users.edit')->withUser($user);
89
        }
90
    }
91
92
    /**
93
     * Update the specified resource in storage.
94
     *
95
     * @param UpdateUserRequest|Request $request
96
     * @param $user_id
97
     * @param $type Type of update info|password|adddevice|removedevice|addpor|removeport
98
     * @param  int $id
0 ignored issues
show
Bug introduced by
There is no parameter named $id. 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...
99
     * @return \Illuminate\Http\Response
100
     */
101
    public function update(UpdateUserRequest $request, $user_id)
102
    {
103
        $user = User::find($user_id);
104
        $user->update($request->all());
105
106
107
        return redirect()->back()->with(['type' => 'success', 'message' => 'User '.$user->username.' updated.']);
108
    }
109
110
    /**
111
     * Remove the specified resource from storage.
112
     *
113
     * @param  int $user_id
114
     * @return \Illuminate\Http\Response
115
     */
116
    public function destroy(DeleteUserRequest $request, $user_id)
1 ignored issue
show
Unused Code introduced by
The parameter $request is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
117
    {
118
        $user = User::find($user_id);
119
        $user->delete();
120
121
        return response()->json(['message' => "User ".$user->username." deleted."]);
122
    }
123
}
124