UserController::listInactive() - Code Metrics - Inspection of "Updated User Roles Page" - butcherman/Tech_Bench - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dev5a ( d46f4b...f24c41 )

by Ron

created 2020-05-30 04:19 UTC

UserController::listInactive() A

↳ Parent: UserController

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	3
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	5
ccs	3
cts	3
cp	1
crap	1
rs	10

<?php

namespace App\Http\Controllers\Admin;

use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Log;
use App\Domains\Roles\GetRoles;
use App\Domains\User\GetUserDetails;
use App\Domains\User\GetUserList;
use App\Domains\User\SetUserDetails;
use App\Http\Controllers\Controller;
use App\Http\Requests\Admin\ChangeUserPasswordRequest;
use App\Http\Requests\Admin\EditUserRequest;
use App\Http\Requests\Admin\NewUserRequest;
use Illuminate\Http\Request;

class UserController extends Controller
{
    //  Check if a username is in use
    public function checkUser($username, $type)
    {
        $user = (new GetUserDetails)->checkForDuplicate($type, $username);

        if(!$user)
        {
            return response()->json(['duplicate' => false]);
        }

        return response()->json([
            'duplicate' => true,
            'user'      => $user->full_name,
            'username'  => $user->username,
            'active'    => $user->deleted_at == null ? 1 : 0,
        ]);
    }

    //  Show the add user form
    public function create()
    {
        return view('admin.newUser', [
            'roles' => (new GetRoles)->getRoleList()->makeHidden(['allow_edit', 'user_role_permissions']),
        ]);
    }

    //  Submit the add user form
    public function store(NewUserRequest $request)
    {
        $newID = (new SetUserDetails)->createUser($request);
        Log::notice('New user created by '.Auth::user()->full_name.'. New User ID - '.$newID.'. User Data - ', $request->toArray());

        return response()->json(['success' => true]);
    }

    //  List all active users
    public function listActive()
    {
        return view('admin.userList', [
            'userList' => (new GetUserList)->getActiveUsers(),
            'active'   => true,
        ]);
    }

    //  List all users who have been disabled
    public function listInactive()
    {
        return view('admin.userList', [
            'userList' => (new GetUserList)->getInactiveUsers(),
            'active'   => false,
        ]);
    }

    //  Form to edit an existing user
    public function edit($userID)
    {
        //  Before showing user form, verify that the user does not have more permission
        $user = (new GetUserDetails($userID))->getUserData()->makeVisible(['role_id', 'user_id']);
        if($user->role_id < Auth::user()->role_id)
        {
            return abort(403, 'You cannot update a user with more permissions than you');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        }

        return view('admin.userEdit', [
            'details' => $user,
            'roles' => (new GetRoles)->getRoleList()->makeHidden(['allow_edit', 'user_role_permissions']),
        ]);
    }

    //  Submit the edit user form
    public function update(EditUserRequest $request, $userID)
    {
        //  Before submitting user form, verify that the user does not have more permission
        $user = (new GetUserDetails($userID))->getUserData()->makeVisible(['role_id', 'user_id']);
        if($user->role_id < Auth::user()->role_id)
        {
            return abort(403, 'You cannot update a user with more permissions than you');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        }

        (new SetUserDetails)->updateUser($request, $userID);
        Log::info('User ID '.$userID.' was update by '.Auth::user()->full_name.'.  Details - ', $request->toArray());
        return response()->json(['success' => true]);
    }

    //  Submit the change password form
    public function changePassword(ChangeUserPasswordRequest $request)
    {
        //  Before changing user password, verify that the user does not have more permission
        $user = (new GetUserDetails($request->user_id))->getUserData();
        if($user->role_id < Auth::user()->role_id)
        {
            return abort(403, 'You cannot update a user with more permissions than you');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        }

        (new SetUserDetails)->updatePassword($request->password, $request->user_id, $request->force_change);
        Log::info('Password for User ID '.$request->user_id.' has been updated by '.Auth::user()->full_name);

        return response()->json(['success' => true]);
    }

    //  See the login history for the user
    public function loginHistory($userID, $username)
    {
        return $userID;
    }

    //  Deactivate a user
    public function destroy($userID)
    {
        //  Before disabling user, verify that the user does not have more permission
        $user = (new GetUserDetails($userID))->getUserData();
        if($user->role_id < Auth::user()->role_id)
        {
            return abort(403, 'You cannot disable a user with more permissions than you');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        }

        (new SetUserDetails)->disableUser($userID);
        Log::notice('User '.$user->full_name.' has been disabled by '.Auth::user()->full_name.'.  Details - ', $user->toArray());
        return response()->json(['success' => true]);
    }

    //  Reactivate a disabled user
    public function activate($userID)
    {
        (new SetUserDetails)->reactivateUser($userID);
        Log::notice('User ID '.$userID.' has been reactivated by '.Auth::user()->full_name);
        return response()->json(['success' => true]);
    }
}


1		<?php
2
3		namespace App\Http\Controllers\Admin;
4
5		use Illuminate\Support\Facades\Auth;
6		use Illuminate\Support\Facades\Log;
7		use App\Domains\Roles\GetRoles;
8		use App\Domains\User\GetUserDetails;
9		use App\Domains\User\GetUserList;
10		use App\Domains\User\SetUserDetails;
11		use App\Http\Controllers\Controller;
12		use App\Http\Requests\Admin\ChangeUserPasswordRequest;
13		use App\Http\Requests\Admin\EditUserRequest;
14		use App\Http\Requests\Admin\NewUserRequest;
15		use Illuminate\Http\Request;
16
17		class UserController extends Controller
18		{
19		// Check if a username is in use
20	4	public function checkUser($username, $type)
21		{
22	4	$user = (new GetUserDetails)->checkForDuplicate($type, $username);
23
24	4	if(!$user)
25		{
26	2	return response()->json(['duplicate' => false]);
27		}
28
29	2	return response()->json([
30	2	'duplicate' => true,
31	2	'user' => $user->full_name,
32	2	'username' => $user->username,
33	2	'active' => $user->deleted_at == null ? 1 : 0,
34		]);
35		}
36
37		// Show the add user form
38	2	public function create()
39		{
40	2	return view('admin.newUser', [
41	2	'roles' => (new GetRoles)->getRoleList()->makeHidden(['allow_edit', 'user_role_permissions']),
42		]);
43		}
44
45		// Submit the add user form
46	2	public function store(NewUserRequest $request)
47		{
48	2	$newID = (new SetUserDetails)->createUser($request);
49	2	Log::notice('New user created by '.Auth::user()->full_name.'. New User ID - '.$newID.'. User Data - ', $request->toArray());
50
51	2	return response()->json(['success' => true]);
52		}
53
54		// List all active users
55	2	public function listActive()
56		{
57	2	return view('admin.userList', [
58	2	'userList' => (new GetUserList)->getActiveUsers(),
59		'active' => true,
60		]);
61		}
62
63		// List all users who have been disabled
64	2	public function listInactive()
65		{
66	2	return view('admin.userList', [
67	2	'userList' => (new GetUserList)->getInactiveUsers(),
68		'active' => false,
69		]);
70		}
71
72		// Form to edit an existing user
73	4	public function edit($userID)
74		{
75		// Before showing user form, verify that the user does not have more permission
76	4	$user = (new GetUserDetails($userID))->getUserData()->makeVisible(['role_id', 'user_id']);
77	4	if($user->role_id < Auth::user()->role_id)
78		{
79	2	return abort(403, 'You cannot update a user with more permissions than you');
		1 ignored issue – show Bug introduced 2020-05-28 23:56 UTC by Report Bug Copy Issue Report Are you sure the usage of `abort(403, 'You cannot u... permissions than you')` is correct as it seems to always return `null`. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
80		}
81
82	2	return view('admin.userEdit', [
83	2	'details' => $user,
84	2	'roles' => (new GetRoles)->getRoleList()->makeHidden(['allow_edit', 'user_role_permissions']),
85		]);
86		}
87
88		// Submit the edit user form
89	4	public function update(EditUserRequest $request, $userID)
90		{
91		// Before submitting user form, verify that the user does not have more permission
92	4	$user = (new GetUserDetails($userID))->getUserData()->makeVisible(['role_id', 'user_id']);
93	4	if($user->role_id < Auth::user()->role_id)
94		{
95	2	return abort(403, 'You cannot update a user with more permissions than you');
		1 ignored issue – show Bug introduced 2020-05-28 23:56 UTC by Report Bug Copy Issue Report Are you sure the usage of `abort(403, 'You cannot u... permissions than you')` is correct as it seems to always return `null`. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
96		}
97
98	2	(new SetUserDetails)->updateUser($request, $userID);
99	2	Log::info('User ID '.$userID.' was update by '.Auth::user()->full_name.'. Details - ', $request->toArray());
100	2	return response()->json(['success' => true]);
101		}
102
103		// Submit the change password form
104	4	public function changePassword(ChangeUserPasswordRequest $request)
105		{
106		// Before changing user password, verify that the user does not have more permission
107	4	$user = (new GetUserDetails($request->user_id))->getUserData();
108	4	if($user->role_id < Auth::user()->role_id)
109		{
110	2	return abort(403, 'You cannot update a user with more permissions than you');
		1 ignored issue – show Bug introduced 2020-05-28 23:56 UTC by Report Bug Copy Issue Report Are you sure the usage of `abort(403, 'You cannot u... permissions than you')` is correct as it seems to always return `null`. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
111		}
112
113	2	(new SetUserDetails)->updatePassword($request->password, $request->user_id, $request->force_change);
114	2	Log::info('Password for User ID '.$request->user_id.' has been updated by '.Auth::user()->full_name);
115
116	2	return response()->json(['success' => true]);
117		}
118
119		// See the login history for the user
120	2	public function loginHistory($userID, $username)
121		{
122	2	return $userID;
123		}
124
125		// Deactivate a user
126	4	public function destroy($userID)
127		{
128		// Before disabling user, verify that the user does not have more permission
129	4	$user = (new GetUserDetails($userID))->getUserData();
130	4	if($user->role_id < Auth::user()->role_id)
131		{
132	2	return abort(403, 'You cannot disable a user with more permissions than you');
		1 ignored issue – show Bug introduced 2020-05-28 23:56 UTC by Report Bug Copy Issue Report Are you sure the usage of `abort(403, 'You cannot d... permissions than you')` is correct as it seems to always return `null`. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
133		}
134
135	2	(new SetUserDetails)->disableUser($userID);
136	2	Log::notice('User '.$user->full_name.' has been disabled by '.Auth::user()->full_name.'. Details - ', $user->toArray());
137	2	return response()->json(['success' => true]);
138		}
139
140		// Reactivate a disabled user
141	2	public function activate($userID)
142		{
143	2	(new SetUserDetails)->reactivateUser($userID);
144	2	Log::notice('User ID '.$userID.' has been reactivated by '.Auth::user()->full_name);
145	2	return response()->json(['success' => true]);
146		}
147		}
148

butcherman / Tech_Bench

Push — dev5a ( d46f4b...f24c41 )

UserController::listInactive() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like