UserCrudController::addUserFields() - Code Metrics - Inspection of "Use authentication column" - Laravel-Backpack/PermissionManager - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#236)

unknown

created 2020-05-17 06:46 UTC

UserCrudController::addUserFields() B

↳ Parent: UserCrudController

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	7
Ratio	11.29 %

Importance

Changes

Metric	Value
dl	7
loc	62
rs	8.829
c	0
b	0
f	0
cc	2
nc	2
nop	0

How to fix Long Method

<?php

namespace Backpack\PermissionManager\app\Http\Controllers;

use Backpack\CRUD\app\Http\Controllers\CrudController;
use Backpack\PermissionManager\app\Http\Requests\UserStoreCrudRequest as StoreRequest;
use Backpack\PermissionManager\app\Http\Requests\UserUpdateCrudRequest as UpdateRequest;
use Illuminate\Support\Facades\Hash;

class UserCrudController extends CrudController
{
    use \Backpack\CRUD\app\Http\Controllers\Operations\ListOperation;
    use \Backpack\CRUD\app\Http\Controllers\Operations\CreateOperation { store as traitStore; }
    use \Backpack\CRUD\app\Http\Controllers\Operations\UpdateOperation { update as traitUpdate; }
    use \Backpack\CRUD\app\Http\Controllers\Operations\DeleteOperation;

    public function setup()
    {
        $this->crud->setModel(config('backpack.permissionmanager.models.user'));
        $this->crud->setEntityNameStrings(trans('backpack::permissionmanager.user'), trans('backpack::permissionmanager.users'));
        $this->crud->setRoute(backpack_url('user'));

    }

    public function setupListOperation()
    {
        $this->crud->setColumns([
            [
                'name'  => 'name',
                'label' => trans('backpack::permissionmanager.name'),
                'type'  => 'text',
            ],
            [
                'name'  => 'email',
                'label' => trans('backpack::permissionmanager.email'),
                'type'  => 'email',
            ],
            [ // n-n relationship (with pivot table)
                'label'     => trans('backpack::permissionmanager.roles'), // Table column heading
                'type'      => 'select_multiple',
                'name'      => 'roles', // the method that defines the relationship in your Model
                'entity'    => 'roles', // the method that defines the relationship in your Model
                'attribute' => 'name', // foreign key attribute that is shown to user
                'model'     => config('permission.models.role'), // foreign key model
            ],
            [ // n-n relationship (with pivot table)
                'label'     => trans('backpack::permissionmanager.extra_permissions'), // Table column heading
                'type'      => 'select_multiple',
                'name'      => 'permissions', // the method that defines the relationship in your Model
                'entity'    => 'permissions', // the method that defines the relationship in your Model
                'attribute' => 'name', // foreign key attribute that is shown to user
                'model'     => config('permission.models.permission'), // foreign key model
            ],
        ]);

        if (config('backpack.base.authentication_column') !== 'email') {

            $this->crud->addColumn([
                'name'  => config('backpack.base.authentication_column'),
                'type'  => 'text',
                'label' => config('backpack.base.authentication_column_name'),
            ])->afterColumn('name');
        }

        // Role Filter
        $this->crud->addFilter(
            [
                'name'  => 'role',
                'type'  => 'dropdown',
                'label' => trans('backpack::permissionmanager.role'),
            ],
            config('permission.models.role')::all()->pluck('name', 'id')->toArray(),
            function ($value) { // if the filter is active
                $this->crud->addClause('whereHas', 'roles', function ($query) use ($value) {
                    $query->where('role_id', '=', $value);
                });
            }
        );

        // Extra Permission Filter
        $this->crud->addFilter(
            [
                'name'  => 'permissions',
                'type'  => 'select2',
                'label' => trans('backpack::permissionmanager.extra_permissions'),
            ],
            config('permission.models.permission')::all()->pluck('name', 'id')->toArray(),
            function ($value) { // if the filter is active
                $this->crud->addClause('whereHas', 'permissions', function ($query) use ($value) {
                    $query->where('permission_id', '=', $value);
                });
            }
        );
    }

    public function setupCreateOperation()
    {
        $this->addUserFields();
        $this->crud->setValidation(StoreRequest::class);
    }

    public function setupUpdateOperation()
    {
        $this->addUserFields();
        $this->crud->setValidation(UpdateRequest::class);
    }

    /**
     * Store a newly created resource in the database.
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function store()

    {
        $this->crud->setRequest($this->crud->validateRequest());
        $this->crud->setRequest($this->handlePasswordInput($this->crud->getRequest()));
        $this->crud->unsetValidation(); // validation has already been run

        return $this->traitStore();
    }

    /**
     * Update the specified resource in the database.
     *
     * @return \Illuminate\Http\RedirectResponse

     */
    public function update()

    {
        $this->crud->setRequest($this->crud->validateRequest());
        $this->crud->setRequest($this->handlePasswordInput($this->crud->getRequest()));
        $this->crud->unsetValidation(); // validation has already been run

        return $this->traitUpdate();
    }

    /**
     * Handle password input fields.
     */
    protected function handlePasswordInput($request)

    {
        // Remove fields not present on the user.
        $request->request->remove('password_confirmation');
        $request->request->remove('roles_show');
        $request->request->remove('permissions_show');

        // Encrypt password if specified.
        if ($request->input('password')) {
            $request->request->set('password', Hash::make($request->input('password')));
        } else {
            $request->request->remove('password');
        }

        return $request;
    }

    protected function addUserFields()
    {
        $this->crud->addFields([
            [
                'name'  => 'name',
                'label' => trans('backpack::permissionmanager.name'),
                'type'  => 'text',
            ],
            [
                'name'  => 'email',
                'label' => trans('backpack::permissionmanager.email'),
                'type'  => 'email',
            ],
            [
                'name'  => 'password',
                'label' => trans('backpack::permissionmanager.password'),
                'type'  => 'password',
            ],
            [
                'name'  => 'password_confirmation',
                'label' => trans('backpack::permissionmanager.password_confirmation'),
                'type'  => 'password',
            ],
            [
                // two interconnected entities
                'label'             => trans('backpack::permissionmanager.user_role_permission'),
                'field_unique_name' => 'user_role_permission',
                'type'              => 'checklist_dependency',
                'name'              => ['roles', 'permissions'],
                'subfields'         => [
                    'primary' => [
                        'label'            => trans('backpack::permissionmanager.roles'),
                        'name'             => 'roles', // the method that defines the relationship in your Model
                        'entity'           => 'roles', // the method that defines the relationship in your Model
                        'entity_secondary' => 'permissions', // the method that defines the relationship in your Model
                        'attribute'        => 'name', // foreign key attribute that is shown to user
                        'model'            => config('permission.models.role'), // foreign key model
                        'pivot'            => true, // on create&update, do you need to add/delete pivot table entries?]
                        'number_columns'   => 3, //can be 1,2,3,4,6
                    ],
                    'secondary' => [
                        'label'          => ucfirst(trans('backpack::permissionmanager.permission_singular')),
                        'name'           => 'permissions', // the method that defines the relationship in your Model
                        'entity'         => 'permissions', // the method that defines the relationship in your Model
                        'entity_primary' => 'roles', // the method that defines the relationship in your Model
                        'attribute'      => 'name', // foreign key attribute that is shown to user
                        'model'          => config('permission.models.permission'), // foreign key model
                        'pivot'          => true, // on create&update, do you need to add/delete pivot table entries?]
                        'number_columns' => 3, //can be 1,2,3,4,6
                    ],
                ],
            ],
        ]);

        if (config('backpack.base.authentication_column') !== 'email') {

            $this->crud->addField([
                'name'  => config('backpack.base.authentication_column'),
                'type'  => 'text',
                'label' => config('backpack.base.authentication_column_name'),
            ])->afterField('name');
        }
    }
}


1		<?php
2
3		namespace Backpack\PermissionManager\app\Http\Controllers;
4
5		use Backpack\CRUD\app\Http\Controllers\CrudController;
6		use Backpack\PermissionManager\app\Http\Requests\UserStoreCrudRequest as StoreRequest;
7		use Backpack\PermissionManager\app\Http\Requests\UserUpdateCrudRequest as UpdateRequest;
8		use Illuminate\Support\Facades\Hash;
9
10		class UserCrudController extends CrudController
11		{
12		use \Backpack\CRUD\app\Http\Controllers\Operations\ListOperation;
13		use \Backpack\CRUD\app\Http\Controllers\Operations\CreateOperation { store as traitStore; }
14		use \Backpack\CRUD\app\Http\Controllers\Operations\UpdateOperation { update as traitUpdate; }
15		use \Backpack\CRUD\app\Http\Controllers\Operations\DeleteOperation;
16
17		public function setup()
18		{
19		$this->crud->setModel(config('backpack.permissionmanager.models.user'));
20		$this->crud->setEntityNameStrings(trans('backpack::permissionmanager.user'), trans('backpack::permissionmanager.users'));
21		$this->crud->setRoute(backpack_url('user'));
		0 ignored issues – show Bug introduced 2020-03-13 05:32 UTC by Report Bug Copy Issue Report It seems like `backpack_url('user')` targeting `backpack_url()` can also be of type `object<Illuminate\Contracts\Routing\UrlGenerator>`; however, `Backpack\CRUD\app\Librar...l\CrudPanel::setRoute()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
22		}
23
24		public function setupListOperation()
25		{
26		$this->crud->setColumns([
27		[
28		'name' => 'name',
29		'label' => trans('backpack::permissionmanager.name'),
30		'type' => 'text',
31		],
32		[
33		'name' => 'email',
34		'label' => trans('backpack::permissionmanager.email'),
35		'type' => 'email',
36		],
37		[ // n-n relationship (with pivot table)
38		'label' => trans('backpack::permissionmanager.roles'), // Table column heading
39		'type' => 'select_multiple',
40		'name' => 'roles', // the method that defines the relationship in your Model
41		'entity' => 'roles', // the method that defines the relationship in your Model
42		'attribute' => 'name', // foreign key attribute that is shown to user
43		'model' => config('permission.models.role'), // foreign key model
44		],
45		[ // n-n relationship (with pivot table)
46		'label' => trans('backpack::permissionmanager.extra_permissions'), // Table column heading
47		'type' => 'select_multiple',
48		'name' => 'permissions', // the method that defines the relationship in your Model
49		'entity' => 'permissions', // the method that defines the relationship in your Model
50		'attribute' => 'name', // foreign key attribute that is shown to user
51		'model' => config('permission.models.permission'), // foreign key model
52		],
53		]);
54
55	View Code Duplication	if (config('backpack.base.authentication_column') !== 'email') {
		0 ignored issues – show Duplication introduced 2020-05-17 06:47 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
56		$this->crud->addColumn([
57		'name' => config('backpack.base.authentication_column'),
58		'type' => 'text',
59		'label' => config('backpack.base.authentication_column_name'),
60		])->afterColumn('name');
61		}
62
63		// Role Filter
64		$this->crud->addFilter(
65		[
66		'name' => 'role',
67		'type' => 'dropdown',
68		'label' => trans('backpack::permissionmanager.role'),
69		],
70		config('permission.models.role')::all()->pluck('name', 'id')->toArray(),
71		function ($value) { // if the filter is active
72		$this->crud->addClause('whereHas', 'roles', function ($query) use ($value) {
73		$query->where('role_id', '=', $value);
74		});
75		}
76		);
77
78		// Extra Permission Filter
79		$this->crud->addFilter(
80		[
81		'name' => 'permissions',
82		'type' => 'select2',
83		'label' => trans('backpack::permissionmanager.extra_permissions'),
84		],
85		config('permission.models.permission')::all()->pluck('name', 'id')->toArray(),
86		function ($value) { // if the filter is active
87		$this->crud->addClause('whereHas', 'permissions', function ($query) use ($value) {
88		$query->where('permission_id', '=', $value);
89		});
90		}
91		);
92		}
93
94		public function setupCreateOperation()
95		{
96		$this->addUserFields();
97		$this->crud->setValidation(StoreRequest::class);
98		}
99
100		public function setupUpdateOperation()
101		{
102		$this->addUserFields();
103		$this->crud->setValidation(UpdateRequest::class);
104		}
105
106		/**
107		* Store a newly created resource in the database.
108		*
109		* @return \Illuminate\Http\RedirectResponse
110		*/
111	View Code Duplication	public function store()
		0 ignored issues – show Duplication introduced 2019-09-04 14:47 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...
112		{
113		$this->crud->setRequest($this->crud->validateRequest());
114		$this->crud->setRequest($this->handlePasswordInput($this->crud->getRequest()));
115		$this->crud->unsetValidation(); // validation has already been run
116
117		return $this->traitStore();
118		}
119
120		/**
121		* Update the specified resource in the database.
122		*
123		* @return \Illuminate\Http\RedirectResponse
		0 ignored issues – show Documentation introduced 2019-09-05 09:56 UTC by Report Bug Copy Issue Report Should the return type not be `\Backpack\CRUD\app\Http\...ers\Operations\Response`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
124		*/
125	View Code Duplication	public function update()
		0 ignored issues – show Duplication introduced 2019-09-04 14:47 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...
126		{
127		$this->crud->setRequest($this->crud->validateRequest());
128		$this->crud->setRequest($this->handlePasswordInput($this->crud->getRequest()));
129		$this->crud->unsetValidation(); // validation has already been run
130
131		return $this->traitUpdate();
132		}
133
134		/**
135		* Handle password input fields.
136		*/
137		protected function handlePasswordInput($request)
		0 ignored issues – show Documentation introduced 2019-09-04 14:47 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
138		{
139		// Remove fields not present on the user.
140		$request->request->remove('password_confirmation');
141		$request->request->remove('roles_show');
142		$request->request->remove('permissions_show');
143
144		// Encrypt password if specified.
145		if ($request->input('password')) {
146		$request->request->set('password', Hash::make($request->input('password')));
147		} else {
148		$request->request->remove('password');
149		}
150
151		return $request;
152		}
153
154		protected function addUserFields()
155		{
156		$this->crud->addFields([
157		[
158		'name' => 'name',
159		'label' => trans('backpack::permissionmanager.name'),
160		'type' => 'text',
161		],
162		[
163		'name' => 'email',
164		'label' => trans('backpack::permissionmanager.email'),
165		'type' => 'email',
166		],
167		[
168		'name' => 'password',
169		'label' => trans('backpack::permissionmanager.password'),
170		'type' => 'password',
171		],
172		[
173		'name' => 'password_confirmation',
174		'label' => trans('backpack::permissionmanager.password_confirmation'),
175		'type' => 'password',
176		],
177		[
178		// two interconnected entities
179		'label' => trans('backpack::permissionmanager.user_role_permission'),
180		'field_unique_name' => 'user_role_permission',
181		'type' => 'checklist_dependency',
182		'name' => ['roles', 'permissions'],
183		'subfields' => [
184		'primary' => [
185		'label' => trans('backpack::permissionmanager.roles'),
186		'name' => 'roles', // the method that defines the relationship in your Model
187		'entity' => 'roles', // the method that defines the relationship in your Model
188		'entity_secondary' => 'permissions', // the method that defines the relationship in your Model
189		'attribute' => 'name', // foreign key attribute that is shown to user
190		'model' => config('permission.models.role'), // foreign key model
191		'pivot' => true, // on create&update, do you need to add/delete pivot table entries?]
192		'number_columns' => 3, //can be 1,2,3,4,6
193		],
194		'secondary' => [
195		'label' => ucfirst(trans('backpack::permissionmanager.permission_singular')),
196		'name' => 'permissions', // the method that defines the relationship in your Model
197		'entity' => 'permissions', // the method that defines the relationship in your Model
198		'entity_primary' => 'roles', // the method that defines the relationship in your Model
199		'attribute' => 'name', // foreign key attribute that is shown to user
200		'model' => config('permission.models.permission'), // foreign key model
201		'pivot' => true, // on create&update, do you need to add/delete pivot table entries?]
202		'number_columns' => 3, //can be 1,2,3,4,6
203		],
204		],
205		],
206		]);
207
208	View Code Duplication	if (config('backpack.base.authentication_column') !== 'email') {
		0 ignored issues – show Duplication introduced 2020-05-17 06:47 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
209		$this->crud->addField([
210		'name' => config('backpack.base.authentication_column'),
211		'type' => 'text',
212		'label' => config('backpack.base.authentication_column_name'),
213		])->afterField('name');
214		}
215		}
216		}
217

Laravel-Backpack / PermissionManager

Scrutinizer GitHub App not installed

Pull Request — master (#236)

UserCrudController::addUserFields() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like