SkillCrudController::setupListOperation() - Code Metrics - Inspection of "1.0.17 (#2441)" - GCTC-NTGC/TalentCloud - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 6ceee8...d4902a )

by Tristan

created 2020-01-02 20:36 UTC

SkillCrudController::setupListOperation() B

↳ Parent: SkillCrudController

Complexity

Conditions	3
Paths	2

Size

Total Lines	105
Code Lines	68

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	18
CRAP Score	3.054

Importance

Changes	4
Bugs	0	Features	0

Metric	Value
eloc	68
c	4
b	0
f	0
dl	0
loc	105
ccs	18
cts	22
cp	0.8182
rs	8.6981
cc	3
nc	2
nop	0
crap	3.054

How to fix Long Method

<?php

namespace App\Http\Controllers\Admin;

// Validation.
use App\Http\Requests\SkillCrudRequest as StoreRequest;
use App\Http\Requests\SkillCrudRequest as UpdateRequest;
use App\Models\Classification;
use App\Models\Lookup\SkillType;
use Backpack\CRUD\app\Http\Controllers\CrudController;
use Illuminate\Support\Facades\App;

class SkillCrudController extends CrudController
{
    use \Backpack\CRUD\app\Http\Controllers\Operations\ListOperation;

    use \Backpack\CRUD\app\Http\Controllers\Operations\CreateOperation;

    use \Backpack\CRUD\app\Http\Controllers\Operations\UpdateOperation;


    /**
     * Prepare the admin interface by setting the associated
     * model, setting the route, and adding custom columns/fields.
     *
     * @return void
     */
    public function setup() : void
    {
        // Eloquent model to associate with this collection
        // of views and controller actions.
        $this->crud->setModel('App\Models\Skill');
        // Custom backpack route.
        $this->crud->setRoute('admin/skill');
        // Custom strings to display within the backpack UI,
        // things like Create Skill, Delete Skills, etc.
        $this->crud->setEntityNameStrings('skill', 'skills');

        $this->crud->operation(['create', 'update'], function () {
            // Add custom fields to the create/update views.
            $this->crud->addField([
                'name' => 'name',
                'type' => 'text',
                'label' => 'Name',
            ]);

            $this->crud->addField([
                'name' => 'description',
                'type' => 'textarea',
                'label' => 'Description',
                'limit' => 70,
            ]);

            $this->crud->addField([
                'name' => 'skill_type_id',
                'label' => 'Type',
                'type' => 'select_from_array',
                'options' => SkillType::all()->pluck('name', 'id')->toArray(),
                'allow_null' => false,
            ]);

            $this->crud->addField([
                'name' => 'classifications',
                'type' => 'select2_multiple',
                'label' => 'Classifications (select all that apply)',
                'entity' => 'skills',
                'attribute' => 'key',
                'model' => 'App\Models\Classification',
                'pivot' => true,
            ]);

            $this->crud->addField([
                'name' => 'is_culture_skill',
                'label' => 'This is a culture skill',
                'type' => 'checkbox'
            ]);

            $this->crud->addField([
                'name' => 'is_future_skill',
                'label' => 'This is a future skill',
                'type' => 'checkbox'
            ]);
        });
    }

    public function setupListOperation()
    {
        // Workaround for how the unique_translation validation
        // works in App\Http\Requests\SkillCrudRequest.
        $locale = 'en';
        if (null !== $this->request->input('locale')) {
            $locale = $this->request->input('locale');
        }
        App::setLocale($locale);

        // Remove delete button.
        $this->crud->removeButton('delete');

        // Add custom columns to the Skill index view.
        $this->crud->addColumn([
            'name' => 'id',
            'type' => 'text',
            'label' => 'ID',
            'orderable' => true
        ]);

        $this->crud->addColumn([
            'name' => 'name',
            'type' => 'text',
            'label' => 'Name',
            'searchLogic' => function ($query, $column, $searchTerm) use ($locale) : void {
                $query->orWhere('name->' . $locale, 'like', "%$searchTerm%");
            },
            'orderLogic' => function ($query, $column, $columnDirection) use ($locale) {
                return $query->orderBy('name->' . $locale, $columnDirection)->select('*');
            }
        ]);

        $this->crud->addColumn([
            'name' => 'description',
            'type' => 'text',
            'label' => 'Description',
            'searchLogic' => function ($query, $column, $searchTerm) use ($locale) : void {
                $query->orWhere('description->' . $locale, 'like', "%$searchTerm%");
            },
            'orderable' => false,
        ]);

        $this->crud->addColumn([
            'name' => 'skill_type.name',
            'key' => 'skill_type_name',
            'type' => 'text',
            'label' => 'Type',
            'orderable' => true,
            'orderLogic' => function ($query, $column, $columnDirection) use ($locale) {

                return $query->orderBy('skill_type_id', $columnDirection)->select('*');
            }
        ]);

        $this->crud->addColumn([
            'label' => 'Classifications',
            'type' => 'select_multiple',
            'name' => 'classifications',
            'entity' => 'classifications',
            'attribute' => 'key',
            'model' => 'App\Models\Skill',
        ]);

        $this->crud->addColumn([
            'name' => 'is_culture_skill',
            'label' => 'Culture',
            'type' => 'boolean',
            'orderable' => true,
        ]);

        $this->crud->addColumn([
            'name' => 'is_future_skill',
            'label' => 'Future',
            'type' => 'boolean',
            'orderable' => true,
        ]);

        // Add select2_multiple filter for classifications.
        $this->crud->addFilter([
            'name' => 'classifications',
            'key' => 'classifications_filter',
            'type' => 'select2_multiple',
            'label' => 'Filter by classification'
        ], function () {
            // The options that show up in the select2.
            return Classification::all()->pluck('key', 'id')->toArray();
        }, function ($values) {
            // If the filter is active.
            foreach (json_decode($values) as $key => $value) {
                $this->crud->query = $this->crud->query->whereHas('classifications', function ($query) use ($value) {
                    $query->where('id', $value);
                });
            }
        });

        // Add filter for skills without classifications.
        $this->crud->addFilter(
            [
                'type' => 'simple',
                'name' => 'noClassification',
                'label'=> 'No classification'
            ],
            false,
            function () {
                $this->crud->query = $this->crud->query->doesntHave('classifications');
            }
        );
    }

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

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


1		<?php
2
3		namespace App\Http\Controllers\Admin;
4
5		// Validation.
6		use App\Http\Requests\SkillCrudRequest as StoreRequest;
7		use App\Http\Requests\SkillCrudRequest as UpdateRequest;
8		use App\Models\Classification;
9		use App\Models\Lookup\SkillType;
10		use Backpack\CRUD\app\Http\Controllers\CrudController;
11		use Illuminate\Support\Facades\App;
12
13		class SkillCrudController extends CrudController
14		{
15		use \Backpack\CRUD\app\Http\Controllers\Operations\ListOperation;
		0 ignored issues – show introduced 2019-09-27 18:14 UTC by Report Bug Copy Issue Report The trait `Backpack\CRUD\app\Http\C...perations\ListOperation` requires some properties which are not provided by `App\Http\Controllers\Admin\SkillCrudController`: `$model`, `$entity_name_plural` Loading history...
16		use \Backpack\CRUD\app\Http\Controllers\Operations\CreateOperation;
		0 ignored issues – show Bug introduced 2019-09-27 18:14 UTC by Report Bug Copy Issue Report The trait `Backpack\CRUD\app\Http\C...rations\CreateOperation` requires the property `$entity_name` which is not provided by `App\Http\Controllers\Admin\SkillCrudController`. Loading history...
17		use \Backpack\CRUD\app\Http\Controllers\Operations\UpdateOperation;
		0 ignored issues – show introduced 2019-09-27 18:14 UTC by Report Bug Copy Issue Report The trait `Backpack\CRUD\app\Http\C...rations\UpdateOperation` requires some properties which are not provided by `App\Http\Controllers\Admin\SkillCrudController`: `$model`, `$entity_name` Loading history...
18
19		/**
20	1	* Prepare the admin interface by setting the associated
21		* model, setting the route, and adding custom columns/fields.
22		*
23		* @return void
24	1	*/
25	1	public function setup() : void
26		{
27		// Eloquent model to associate with this collection
28	1	// of views and controller actions.
29		$this->crud->setModel('App\Models\Skill');
30		// Custom backpack route.
31		$this->crud->setRoute('admin/skill');
32	1	// Custom strings to display within the backpack UI,
33		// things like Create Skill, Delete Skills, etc.
34	1	$this->crud->setEntityNameStrings('skill', 'skills');
35
36		$this->crud->operation(['create', 'update'], function () {
37	1	// Add custom fields to the create/update views.
38		$this->crud->addField([
39		'name' => 'name',
40	1	'type' => 'text',
41	1	'label' => 'Name',
42	1	]);
43	1
44		$this->crud->addField([
45		'name' => 'description',
46	1	'type' => 'textarea',
47		'label' => 'Description',
48		'limit' => 70,
49	1	]);
50
51		$this->crud->addField([
52	1	'name' => 'skill_type_id',
53	1	'label' => 'Type',
54	1	'type' => 'select_from_array',
55	1	'options' => SkillType::all()->pluck('name', 'id')->toArray(),
56		'allow_null' => false,
57		]);
58	1
59		$this->crud->addField([
60		'name' => 'classifications',
61		'type' => 'select2_multiple',
62	1	'label' => 'Classifications (select all that apply)',
63	1	'entity' => 'skills',
64	1	'attribute' => 'key',
65	1	'model' => 'App\Models\Classification',
66		'pivot' => true,
67		]);
68
69	1	$this->crud->addField([
70		'name' => 'is_culture_skill',
71		'label' => 'This is a culture skill',
72	1	'type' => 'checkbox'
73	1	]);
74
75		$this->crud->addField([
76		'name' => 'is_future_skill',
77		'label' => 'This is a future skill',
78		'type' => 'checkbox'
79		]);
80		});
81	1	}
82	1
83		public function setupListOperation()
84		{
85		// Workaround for how the unique_translation validation
86		// works in App\Http\Requests\SkillCrudRequest.
87		$locale = 'en';
88	1	if (null !== $this->request->input('locale')) {
89	1	$locale = $this->request->input('locale');
90		}
91		App::setLocale($locale);
92
93		// Remove delete button.
94		$this->crud->removeButton('delete');
95
96	1	// Add custom columns to the Skill index view.
97	1	$this->crud->addColumn([
98		'name' => 'id',
99		'type' => 'text',
100		'label' => 'ID',
101		'orderable' => true
102	1	]);
103	1
104		$this->crud->addColumn([
105		'name' => 'name',
106		'type' => 'text',
107		'label' => 'Name',
108	1	'searchLogic' => function ($query, $column, $searchTerm) use ($locale) : void {
109	1	$query->orWhere('name->' . $locale, 'like', "%$searchTerm%");
110	1	},
111	1	'orderLogic' => function ($query, $column, $columnDirection) use ($locale) {
112	1	return $query->orderBy('name->' . $locale, $columnDirection)->select('*');
113		}
114		]);
115
116	1	$this->crud->addColumn([
117	1	'name' => 'description',
118		'type' => 'text',
119		'label' => 'Description',
120		'searchLogic' => function ($query, $column, $searchTerm) use ($locale) : void {
121		$query->orWhere('description->' . $locale, 'like', "%$searchTerm%");
122		},
123		'orderable' => false,
124		]);
125
126	1	$this->crud->addColumn([
127	1	'name' => 'skill_type.name',
128		'key' => 'skill_type_name',
129		'type' => 'text',
130		'label' => 'Type',
131		'orderable' => true,
132	1	'orderLogic' => function ($query, $column, $columnDirection) use ($locale) {
		0 ignored issues – show Unused Code introduced 2019-02-12 18:41 UTC by Report Bug Copy Issue Report The import `$locale` is not used and could be removed. This check looks for imports that have been defined, but are not used in the scope. Loading history...
133	1	return $query->orderBy('skill_type_id', $columnDirection)->select('*');
134		}
135		]);
136
137	1	$this->crud->addColumn([
138		'label' => 'Classifications',
139		'type' => 'select_multiple',
140		'name' => 'classifications',
141		'entity' => 'classifications',
142		'attribute' => 'key',
143		'model' => 'App\Models\Skill',
144		]);
145
146		$this->crud->addColumn([
147		'name' => 'is_culture_skill',
148		'label' => 'Culture',
149		'type' => 'boolean',
150		'orderable' => true,
151		]);
152
153		$this->crud->addColumn([
154		'name' => 'is_future_skill',
155		'label' => 'Future',
156		'type' => 'boolean',
157		'orderable' => true,
158		]);
159
160		// Add select2_multiple filter for classifications.
161		$this->crud->addFilter([
162		'name' => 'classifications',
163		'key' => 'classifications_filter',
164		'type' => 'select2_multiple',
165		'label' => 'Filter by classification'
166		], function () {
167		// The options that show up in the select2.
168		return Classification::all()->pluck('key', 'id')->toArray();
169		}, function ($values) {
170		// If the filter is active.
171		foreach (json_decode($values) as $key => $value) {
172		$this->crud->query = $this->crud->query->whereHas('classifications', function ($query) use ($value) {
173		$query->where('id', $value);
174		});
175		}
176		});
177
178		// Add filter for skills without classifications.
179		$this->crud->addFilter(
180		[
181		'type' => 'simple',
182		'name' => 'noClassification',
183		'label'=> 'No classification'
184		],
185		false,
186		function () {
187		$this->crud->query = $this->crud->query->doesntHave('classifications');
188		}
189		);
190		}
191
192		public function setupCreateOperation()
193		{
194		$this->crud->setValidation(StoreRequest::class);
195		}
196
197		public function setupUpdateOperation()
198		{
199		$this->crud->setValidation(UpdateRequest::class);
200		}
201		}
202

GCTC-NTGC / TalentCloud

Push — master ( 6ceee8...d4902a )

SkillCrudController::setupListOperation() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like