UsersController - Code Metrics - yajra/cms-core - Measure and Improve Code Quality continuously with Scrutinizer

UsersController A
last analyzed 2017-02-08 14:31 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	275
Duplicated Lines	8 %

Coupling/Cohesion

Components	2
Dependencies	9

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	22
loc	275
rs	10
c	1
b	0
f	0
wmc	22
lcom	2
cbo	9

15 Methods

Rating	Name	Duplication	Size	Complexity
A	edit()	0	7	1
A	password()	0	4	1
A	__construct()	0	7	1
A	index()	0	6	1
A	create()	0	12	1
A	getAllowedRoles()	0	10	2
A	store()	0	16	1
A	updatePassword()	0	17	1
A	show()	0	4	1
A	update()	0	19	2
A	forceDelete()	0	6	1
A	destroy()	0	18	4
A	restore()	0	7	1
A	ban()	11	11	2
A	activate()	11	11	2

How to fix Duplicated Code

<?php

namespace Yajra\CMS\Http\Controllers;

use App\User;
use Illuminate\Database\QueryException;
use Illuminate\Http\Request;
use Yajra\Acl\Models\Role;
use Yajra\CMS\Contracts\Validators\StoreUserValidator;
use Yajra\CMS\Contracts\Validators\UpdateUserValidator;
use Yajra\CMS\DataTables\UsersDataTable;
use Yajra\CMS\Events\Users\PasswordWasUpdated;
use Yajra\CMS\Events\Users\UserWasCreated;
use Yajra\CMS\Events\Users\UserWasUpdated;

class UsersController extends Controller
{
    /**
     * @var \Illuminate\Http\Request
     */
    protected $request;

    /**
     * @var \Yajra\Acl\Models\Role
     */
    protected $role;

    /**
     * Controller specific permission ability map.
     *
     * @var array
     */
    protected $customPermissionMap = [
        'activate'       => 'update',
        'ban'            => 'update',
        'forceDelete'    => 'delete',
        'restore'        => 'update',
        'password'       => 'update',
        'updatePassword' => 'update',
    ];

    /**
     * @param \Illuminate\Http\Request $request
     * @param \Yajra\Acl\Models\Role $role
     */
    public function __construct(Request $request, Role $role)

    {
        $this->request = $request;
        $this->role    = $role;

        $this->authorizePermissionResource('user');
    }

    /**
     * Display list of users.
     *
     * @param \Yajra\CMS\DataTables\UsersDataTable $dataTable
     * @return \Illuminate\Http\JsonResponse|\Illuminate\View\View
     */
    public function index(UsersDataTable $dataTable)
    {
        $roles = $this->role->pluck('name', 'id');

        return $dataTable->render('administrator.users.index', compact('roles'));
    }

    /**
     * Show user form.
     *
     * @return \Illuminate\View\View
     */
    public function create()
    {
        $roles = $this->getAllowedRoles();

        $selectedRoles = $this->request->old('roles');
        $user          = new User([
            'blocked'   => 0,
            'confirmed' => 1,
        ]);

        return view('administrator.users.create', compact('user', 'roles', 'selectedRoles'));
    }

    /**
     * Get allowed roles for the current user.
     *
     * @return mixed
     */
    protected function getAllowedRoles()
    {
        if ($this->request->user('administrator')->isRole('super-administrator')) {
            $roles = $this->role->get();
        } else {
            $roles = $this->role->where('slug', '!=', 'super-administrator')->get();
        }

        return $roles;
    }

    /**
     * Store a newly created user.
     *
     * @param \Yajra\CMS\Contracts\Validators\StoreUserValidator $request
     * @return \Illuminate\Http\RedirectResponse
     */
    public function store(StoreUserValidator $request)

    {
        $user                = new User($this->request->all());
        $user->password      = bcrypt($this->request->get('password'));
        $user->confirmed     = $this->request->get('confirmed', false);
        $user->blocked       = $this->request->get('blocked', false);
        $user->administrator = $this->request->get('administrator', false);
        $user->save();
        $user->syncRoles($this->request->get('roles'));

        event(new UserWasCreated($user));

        flash()->success('User ' . $user->first_name . 'successfully created!');

        return redirect()->route('administrator.users.index');
    }

    /**
     * Show and edit selected user.
     *
     * @param \App\User $user
     * @return \Illuminate\View\View
     */
    public function edit(User $user)
    {
        $roles         = $this->getAllowedRoles();
        $selectedRoles = $user->roles()->pluck('roles.id')->toArray();

        return view('administrator.users.edit', compact('user', 'roles', 'selectedRoles'));
    }

    /**
     * Show and edit password.
     *
     * @param \App\User $user
     * @return \Illuminate\View\View
     */
    public function password(User $user)
    {
        return view('administrator.users.password', compact('user'));
    }

    /**
     * @param \App\User $user
     * @return \Illuminate\Http\RedirectResponse
     */
    public function updatePassword(User $user)
    {
        $this->validate($this->request, [
            'password'              => 'required|min:4|confirmed',
            'password_confirmation' => 'required|min:4',
        ]);

        $password       = $this->request->get('password');
        $user->password = bcrypt($password);
        $user->save();

        event(new PasswordWasUpdated($user, $password));

        flash()->success($user->name . "'s password successfully updated!");

        return redirect()->route('administrator.users.index');
    }

    /**
     * @param \App\User $user
     * @return \Illuminate\View\View
     */
    public function show(User $user)
    {
        return view('administrator.users.profile', compact('user'));
    }

    /**
     * @param \App\User $user
     * @param \Yajra\CMS\Contracts\Validators\UpdateUserValidator $request
     * @return \Illuminate\Http\RedirectResponse
     */
    public function update(User $user, UpdateUserValidator $request)

    {
        $user->fill($this->request->except('password'));
        $password = $this->request->get('password');
        if (! empty($password)) {
            $user->password = bcrypt($password);
        }
        $user->confirmed     = $this->request->get('confirmed', false);
        $user->blocked       = $this->request->get('blocked', false);
        $user->administrator = $this->request->get('administrator', false);
        $user->save();
        $user->syncRoles($this->request->get('roles'));

        event(new UserWasUpdated($user));

        flash()->success('User ' . $user->first_name . ' successfully updated!');

        return redirect()->route('administrator.users.index');
    }

    /**
     * @param int $id
     * @return \Illuminate\Http\RedirectResponse
     */
    public function forceDelete($id)
    {
        $user = User::withTrashed()->findOrFail($id);

        return $this->delete($user, true);

    }

    /**
     * Remove selected user.
     *
     * @param \App\User $user
     * @param bool|false $force
     * @return \Illuminate\Http\JsonResponse
     * @throws \Exception
     */
    public function destroy(User $user, $force = false)
    {
        if ($user->id <> auth('administrator')->id()) {
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.
}
            try {
                if ($force) {
                    $user->forceDelete();
                } else {
                    $user->delete();
                }

                return $this->notifySuccess('User successfully deleted!');
            } catch (QueryException $e) {
                return $this->notifyError($e->getMessage());
            }
        }

        return $this->notifyError('You cannot delete your own record!');
    }

    /**
     * @param int $id
     * @return \Illuminate\Http\JsonResponse
     */
    public function restore($id)
    {
        $user = User::withTrashed()->findOrFail($id);
        $user->restore();

        return $this->notifySuccess($user->name . ' successfully restored!');
    }

    /**
     * Toggle ban status of a user.
     *
     * @param \App\User $user
     * @return \Illuminate\Http\JsonResponse
     */
    public function ban(User $user)

    {
        $user->blocked = ! $user->blocked;
        $user->save();

        if ($user->blocked) {
            return $this->notifySuccess('User ' . $user->name . ' blocked!');
        } else {
            return $this->notifySuccess('User ' . $user->name . ' un-blocked!');
        }
    }

    /**
     * Toggle user activation status.
     *
     * @param \App\User $user
     * @return \Illuminate\Http\JsonResponse
     */
    public function activate(User $user)

    {
        $user->confirmed = ! $user->confirmed;
        $user->save();

        if ($user->confirmed) {
            return $this->notifySuccess('User ' . $user->name . ' activated!');
        } else {
            return $this->notifySuccess('User ' . $user->name . ' deactivated!');
        }
    }
}


1		<?php
2
3		namespace Yajra\CMS\Http\Controllers;
4
5		use App\User;
6		use Illuminate\Database\QueryException;
7		use Illuminate\Http\Request;
8		use Yajra\Acl\Models\Role;
9		use Yajra\CMS\Contracts\Validators\StoreUserValidator;
10		use Yajra\CMS\Contracts\Validators\UpdateUserValidator;
11		use Yajra\CMS\DataTables\UsersDataTable;
12		use Yajra\CMS\Events\Users\PasswordWasUpdated;
13		use Yajra\CMS\Events\Users\UserWasCreated;
14		use Yajra\CMS\Events\Users\UserWasUpdated;
15
16		class UsersController extends Controller
17		{
18		/**
19		* @var \Illuminate\Http\Request
20		*/
21		protected $request;
22
23		/**
24		* @var \Yajra\Acl\Models\Role
25		*/
26		protected $role;
27
28		/**
29		* Controller specific permission ability map.
30		*
31		* @var array
32		*/
33		protected $customPermissionMap = [
34		'activate' => 'update',
35		'ban' => 'update',
36		'forceDelete' => 'delete',
37		'restore' => 'update',
38		'password' => 'update',
39		'updatePassword' => 'update',
40		];
41
42		/**
43		* @param \Illuminate\Http\Request $request
44		* @param \Yajra\Acl\Models\Role $role
45		*/
46		public function __construct(Request $request, Role $role)
		0 ignored issues – show Bug introduced 2016-06-13 15:10 UTC by Report Bug Copy Issue Report You have injected the Request via parameter `$request`. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via `getCurrentRequest()`. Loading history...
47		{
48		$this->request = $request;
49		$this->role = $role;
50
51		$this->authorizePermissionResource('user');
52		}
53
54		/**
55		* Display list of users.
56		*
57		* @param \Yajra\CMS\DataTables\UsersDataTable $dataTable
58		* @return \Illuminate\Http\JsonResponse\|\Illuminate\View\View
59		*/
60		public function index(UsersDataTable $dataTable)
61		{
62		$roles = $this->role->pluck('name', 'id');
63
64		return $dataTable->render('administrator.users.index', compact('roles'));
65		}
66
67		/**
68		* Show user form.
69		*
70		* @return \Illuminate\View\View
71		*/
72		public function create()
73		{
74		$roles = $this->getAllowedRoles();
75
76		$selectedRoles = $this->request->old('roles');
77		$user = new User([
78		'blocked' => 0,
79		'confirmed' => 1,
80		]);
81
82		return view('administrator.users.create', compact('user', 'roles', 'selectedRoles'));
83		}
84
85		/**
86		* Get allowed roles for the current user.
87		*
88		* @return mixed
89		*/
90		protected function getAllowedRoles()
91		{
92		if ($this->request->user('administrator')->isRole('super-administrator')) {
93		$roles = $this->role->get();
94		} else {
95		$roles = $this->role->where('slug', '!=', 'super-administrator')->get();
96		}
97
98		return $roles;
99		}
100
101		/**
102		* Store a newly created user.
103		*
104		* @param \Yajra\CMS\Contracts\Validators\StoreUserValidator $request
105		* @return \Illuminate\Http\RedirectResponse
106		*/
107		public function store(StoreUserValidator $request)
		0 ignored issues – show Unused Code introduced 2017-02-08 14:31 UTC by Report Bug Copy Issue Report 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...
108		{
109		$user = new User($this->request->all());
110		$user->password = bcrypt($this->request->get('password'));
111		$user->confirmed = $this->request->get('confirmed', false);
112		$user->blocked = $this->request->get('blocked', false);
113		$user->administrator = $this->request->get('administrator', false);
114		$user->save();
115		$user->syncRoles($this->request->get('roles'));
116
117		event(new UserWasCreated($user));
118
119		flash()->success('User ' . $user->first_name . 'successfully created!');
120
121		return redirect()->route('administrator.users.index');
122		}
123
124		/**
125		* Show and edit selected user.
126		*
127		* @param \App\User $user
128		* @return \Illuminate\View\View
129		*/
130		public function edit(User $user)
131		{
132		$roles = $this->getAllowedRoles();
133		$selectedRoles = $user->roles()->pluck('roles.id')->toArray();
134
135		return view('administrator.users.edit', compact('user', 'roles', 'selectedRoles'));
136		}
137
138		/**
139		* Show and edit password.
140		*
141		* @param \App\User $user
142		* @return \Illuminate\View\View
143		*/
144		public function password(User $user)
145		{
146		return view('administrator.users.password', compact('user'));
147		}
148
149		/**
150		* @param \App\User $user
151		* @return \Illuminate\Http\RedirectResponse
152		*/
153		public function updatePassword(User $user)
154		{
155		$this->validate($this->request, [
156		'password' => 'required\|min:4\|confirmed',
157		'password_confirmation' => 'required\|min:4',
158		]);
159
160		$password = $this->request->get('password');
161		$user->password = bcrypt($password);
162		$user->save();
163
164		event(new PasswordWasUpdated($user, $password));
165
166		flash()->success($user->name . "'s password successfully updated!");
167
168		return redirect()->route('administrator.users.index');
169		}
170
171		/**
172		* @param \App\User $user
173		* @return \Illuminate\View\View
174		*/
175		public function show(User $user)
176		{
177		return view('administrator.users.profile', compact('user'));
178		}
179
180		/**
181		* @param \App\User $user
182		* @param \Yajra\CMS\Contracts\Validators\UpdateUserValidator $request
183		* @return \Illuminate\Http\RedirectResponse
184		*/
185		public function update(User $user, UpdateUserValidator $request)
		0 ignored issues – show Unused Code introduced 2017-02-08 14:31 UTC by Report Bug Copy Issue Report 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...
186		{
187		$user->fill($this->request->except('password'));
188		$password = $this->request->get('password');
189		if (! empty($password)) {
190		$user->password = bcrypt($password);
191		}
192		$user->confirmed = $this->request->get('confirmed', false);
193		$user->blocked = $this->request->get('blocked', false);
194		$user->administrator = $this->request->get('administrator', false);
195		$user->save();
196		$user->syncRoles($this->request->get('roles'));
197
198		event(new UserWasUpdated($user));
199
200		flash()->success('User ' . $user->first_name . ' successfully updated!');
201
202		return redirect()->route('administrator.users.index');
203		}
204
205		/**
206		* @param int $id
207		* @return \Illuminate\Http\RedirectResponse
208		*/
209		public function forceDelete($id)
210		{
211		$user = User::withTrashed()->findOrFail($id);
212
213		return $this->delete($user, true);
		0 ignored issues – show Bug introduced 2016-06-13 15:10 UTC by Report Bug Copy Issue Report The method `delete()` does not exist on `Yajra\CMS\Http\Controllers\UsersController`. Did you maybe mean `forceDelete()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
214		}
215
216		/**
217		* Remove selected user.
218		*
219		* @param \App\User $user
220		* @param bool\|false $force
221		* @return \Illuminate\Http\JsonResponse
222		* @throws \Exception
223		*/
224		public function destroy(User $user, $force = false)
225		{
226		if ($user->id <> auth('administrator')->id()) {
		0 ignored issues – show Bug introduced 2016-08-04 01:31 UTC by Report Bug Copy Issue Report The method `id` does only exist in `Illuminate\Contracts\Auth\Guard`, but not in `Illuminate\Contracts\Auth\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 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...
227		try {
228		if ($force) {
229		$user->forceDelete();
230		} else {
231		$user->delete();
232		}
233
234		return $this->notifySuccess('User successfully deleted!');
235		} catch (QueryException $e) {
236		return $this->notifyError($e->getMessage());
237		}
238		}
239
240		return $this->notifyError('You cannot delete your own record!');
241		}
242
243		/**
244		* @param int $id
245		* @return \Illuminate\Http\JsonResponse
246		*/
247		public function restore($id)
248		{
249		$user = User::withTrashed()->findOrFail($id);
250		$user->restore();
251
252		return $this->notifySuccess($user->name . ' successfully restored!');
253		}
254
255		/**
256		* Toggle ban status of a user.
257		*
258		* @param \App\User $user
259		* @return \Illuminate\Http\JsonResponse
260		*/
261	View Code Duplication	public function ban(User $user)
		0 ignored issues – show Duplication introduced 2016-06-13 15:10 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
262		{
263		$user->blocked = ! $user->blocked;
264		$user->save();
265
266		if ($user->blocked) {
267		return $this->notifySuccess('User ' . $user->name . ' blocked!');
268		} else {
269		return $this->notifySuccess('User ' . $user->name . ' un-blocked!');
270		}
271		}
272
273		/**
274		* Toggle user activation status.
275		*
276		* @param \App\User $user
277		* @return \Illuminate\Http\JsonResponse
278		*/
279	View Code Duplication	public function activate(User $user)
		0 ignored issues – show Duplication introduced 2016-06-13 15:10 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
280		{
281		$user->confirmed = ! $user->confirmed;
282		$user->save();
283
284		if ($user->confirmed) {
285		return $this->notifySuccess('User ' . $user->name . ' activated!');
286		} else {
287		return $this->notifySuccess('User ' . $user->name . ' deactivated!');
288		}
289		}
290		}
291

yajra / cms-core

UsersController A last analyzed 2017-02-08 14:31 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like

UsersController A
last analyzed 2017-02-08 14:31 UTC