Completed
Push — settings ( bea8d4...96499a )
by Tony
05:40
created

UserController::preferences()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 9
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 1 Features 0
Metric Value
c 1
b 1
f 0
dl 0
loc 9
rs 9.6666
cc 1
eloc 5
nc 1
nop 0
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');
37
        }
38
        return redirect('preferences');
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' => trans('user.text.created', ['username' => $user->username])]);
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)
0 ignored issues
show
Unused Code introduced by
The parameter $user_id 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...
71
    {
72
        // show read only view of user info here
73
    }
74
75
    /**
76
     * Show the form for editing the specified resource.
77
     *
78
     * @param  int $user_id
79
     * @return \Illuminate\Http\Response
80
     */
81
    public function edit($user_id)
82
    {
83
        $user = User::with('devices', 'ports')->findOrFail($user_id);
84
85
        if (Auth::user()->isAdmin()) {
86
            return view('users.edit')->withUser($user);
87
        }
88
89
        return redirect('preferences');
0 ignored issues
show
Bug Best Practice introduced by
The return type of return redirect('preferences'); (Illuminate\Http\RedirectResponse) is incompatible with the return type documented by App\Http\Controllers\UserController::edit 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...
90
    }
91
92
    /**
93
     * Show the user's preference page
94
     *
95
     * @return \Illuminate\Http\Response
96
     */
97
    public function preferences()
98
    {
99
        $user = Auth::user();
100
101
        $device_count = $user->devices()->count();
102
        $port_count = $user->ports()->count();
103
104
        return view('users.preferences', compact('device_count', 'port_count'));
105
    }
106
107
    /**
108
     * Update the specified resource in storage.
109
     *
110
     * @param UpdateUserRequest|Request $request
111
     * @param $user_id
112
     * @return \Illuminate\Http\Response
113
     */
114
    public function update(UpdateUserRequest $request, $user_id)
115
    {
116
        $user = User::find($user_id);
117
        $user->update($request->all());
118
        if ($request->input('update') == 'password') {
119
            $message = trans('user.text.pwdupdated');
120
        }
121
        else {
122
            $message = trans('user.text.updated', ['username' => $user->username]);
123
        }
124
125
        return redirect()->back()->with(['type' => 'success', 'message' => $message]);
126
    }
127
128
    /**
129
     * Remove the specified resource from storage.
130
     *
131
     * @param  int $user_id
132
     * @return \Illuminate\Http\Response
133
     */
134
    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...
135
    {
136
        $user = User::find($user_id);
137
        $user->delete();
138
139
        return response()->json(['message' => trans('user.text.deleted', ['username' => $user->username])]);
140
    }
141
}
142