DocumentCrudController::setup() - Code Metrics - Inspection of "Update changelog" - webfactor/laravel-backpack-documents - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4dc9cd...0d595f )

by Oliver

created 2018-02-07 17:38 UTC

DocumentCrudController::setup() B

↳ Parent: DocumentCrudController

Complexity

Conditions	2
Paths	1

Size

Total Lines	81
Code Lines	31

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	81
ccs	0
cts	30
cp	0
rs	8.8076
cc	2
eloc	31
nc	1
nop	0
crap	6

How to fix Long Method

<?php

namespace Webfactor\Laravel\Backpack\Documents\Controllers;

use Backpack\CRUD\app\Http\Controllers\CrudController;
use Webfactor\Laravel\Backpack\Documents\Requests\DocumentRequest as StoreRequest;
use Webfactor\Laravel\Backpack\Documents\Requests\DocumentRequest as UpdateRequest;

class DocumentCrudController extends CrudController
{
    public function setup()
    {
        /*
        |--------------------------------------------------------------------------
        | BASIC CRUD INFORMATION
        |--------------------------------------------------------------------------
        */
        $this->crud->setModel(config('webfactor.documents.model_class'));
        $this->crud->setRoute(config('webfactor.documents.backend.route_prefix').'/'.config('webfactor.documents.backend.route'));

        $this->crud->setEntityNameStrings(trans('webfactor::documents.entity_name_singular'),
            trans('webfactor::documents.entity_name_plural'));

        /*
        |--------------------------------------------------------------------------
        | BASIC CRUD INFORMATION
        |--------------------------------------------------------------------------
        */

        // ------ CRUD FIELDS

        $this->crud->addField([
            'name'  => 'type',
            'label' => 'Dokumentenart',
            'type'  => 'select_from_array',
            'options' => $this->getTypeOptions(),
            'allows_null' => false,
            'allows_multiple' => false
        ]);

        $this->crud->addField([
            'name' => 'title',
            'label' => trans('webfactor::documents.title')
        ]);
        
        $this->crud->addField([
            'name' => 'body',
            'label' => trans('webfactor::documents.body'),
            'type' => $this->bodyFieldType()
        ]);

        // ------ CRUD COLUMNS

        $this->crud->addColumns([
            [
                'name'  => 'translated_type',
                'label' => trans('webfactor::documents.type'),
            ],
            [
                'name'  => 'title',
                'label' => trans('webfactor::documents.title')
            ],
            [
                'name'  => 'body',
                'label' => trans('webfactor::documents.body')
            ]
        ]);

        // ------ CRUD BUTTONS

        // ------ CRUD ACCESS

        collect(config('webfactor.documents.access', []))->each(function ($enabled, $key) {
            if ($enabled) {
                $this->crud->allowAccess($key);
            } else {
                $this->crud->denyAccess($key);
            }
        });

        // ------ CRUD REORDER

        // ------ CRUD DETAILS ROW

        // ------ REVISIONS

        // ------ AJAX TABLE VIEW

        // ------ DATATABLE EXPORT BUTTONS

        // ------ ADVANCED QUERIES
    }

    public function getTypeOptions()
    {
        $types = collect(config('webfactor.documents.types'));

        return $types->mapWithKeys(function ($type) {
            return [$type => trans('webfactor::documents.types.'.$type)];
        });
    }

    public function bodyFieldType()
    {
        $types = [
            'plaintext' => 'textarea',
            'html' => 'summernote',
            'md' => 'simplemde'
        ];

        return $types[config('webfactor.documents.body_type', 'plaintext')];
    }

    public function store(StoreRequest $request)
    {
        // your additional operations before save here
        $redirect_location = parent::storeCrud($request);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
        // your additional operations after save here
        // use $this->data['entry'] or $this->crud->entry

        return $redirect_location;
    }

    public function update(UpdateRequest $request)
    {
        // your additional operations before save here
        $redirect_location = parent::updateCrud($request);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
        // your additional operations after save here
        // use $this->data['entry'] or $this->crud->entry

        return $redirect_location;
    }
}


1			<?php
2
3			namespace Webfactor\Laravel\Backpack\Documents\Controllers;
4
5			use Backpack\CRUD\app\Http\Controllers\CrudController;
6			use Webfactor\Laravel\Backpack\Documents\Requests\DocumentRequest as StoreRequest;
7			use Webfactor\Laravel\Backpack\Documents\Requests\DocumentRequest as UpdateRequest;
8
9			class DocumentCrudController extends CrudController
10			{
11			public function setup()
12			{
13			/*
14			\|--------------------------------------------------------------------------
15			\| BASIC CRUD INFORMATION
16			\|--------------------------------------------------------------------------
17			*/
18			$this->crud->setModel(config('webfactor.documents.model_class'));
19			$this->crud->setRoute(config('webfactor.documents.backend.route_prefix').'/'.config('webfactor.documents.backend.route'));
			0 ignored issues – show Coding Style introduced 2018-02-01 11:09 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 130 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
20			$this->crud->setEntityNameStrings(trans('webfactor::documents.entity_name_singular'),
21			trans('webfactor::documents.entity_name_plural'));
22
23			/*
24			\|--------------------------------------------------------------------------
25			\| BASIC CRUD INFORMATION
26			\|--------------------------------------------------------------------------
27			*/
28
29			// ------ CRUD FIELDS
30
31			$this->crud->addField([
32			'name' => 'type',
33			'label' => 'Dokumentenart',
34			'type' => 'select_from_array',
35			'options' => $this->getTypeOptions(),
36			'allows_null' => false,
37			'allows_multiple' => false
38			]);
39
40			$this->crud->addField([
41			'name' => 'title',
42			'label' => trans('webfactor::documents.title')
43			]);
44
45			$this->crud->addField([
46			'name' => 'body',
47			'label' => trans('webfactor::documents.body'),
48			'type' => $this->bodyFieldType()
49			]);
50
51			// ------ CRUD COLUMNS
52
53			$this->crud->addColumns([
54			[
55			'name' => 'translated_type',
56			'label' => trans('webfactor::documents.type'),
57			],
58			[
59			'name' => 'title',
60			'label' => trans('webfactor::documents.title')
61			],
62			[
63			'name' => 'body',
64			'label' => trans('webfactor::documents.body')
65			]
66			]);
67
68			// ------ CRUD BUTTONS
69
70			// ------ CRUD ACCESS
71
72			collect(config('webfactor.documents.access', []))->each(function ($enabled, $key) {
73			if ($enabled) {
74			$this->crud->allowAccess($key);
75			} else {
76			$this->crud->denyAccess($key);
77			}
78			});
79
80			// ------ CRUD REORDER
81
82			// ------ CRUD DETAILS ROW
83
84			// ------ REVISIONS
85
86			// ------ AJAX TABLE VIEW
87
88			// ------ DATATABLE EXPORT BUTTONS
89
90			// ------ ADVANCED QUERIES
91			}
92
93			public function getTypeOptions()
94			{
95			$types = collect(config('webfactor.documents.types'));
96
97			return $types->mapWithKeys(function ($type) {
98			return [$type => trans('webfactor::documents.types.'.$type)];
99			});
100			}
101
102			public function bodyFieldType()
103			{
104			$types = [
105			'plaintext' => 'textarea',
106			'html' => 'summernote',
107			'md' => 'simplemde'
108			];
109
110			return $types[config('webfactor.documents.body_type', 'plaintext')];
111			}
112
113			public function store(StoreRequest $request)
114			{
115			// your additional operations before save here
116			$redirect_location = parent::storeCrud($request);
			0 ignored issues – show Comprehensibility Bug introduced 2018-02-01 11:09 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`storeCrud()` instead of `store()`). Are you sure this is correct? If so, you might want to change this to `$this->storeCrud()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
117			// your additional operations after save here
118			// use $this->data['entry'] or $this->crud->entry
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-02-01 11:09 UTC by Report Bug Copy Issue Report `59%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
119			return $redirect_location;
120			}
121
122			public function update(UpdateRequest $request)
123			{
124			// your additional operations before save here
125			$redirect_location = parent::updateCrud($request);
			0 ignored issues – show Comprehensibility Bug introduced 2018-02-01 11:09 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`updateCrud()` instead of `update()`). Are you sure this is correct? If so, you might want to change this to `$this->updateCrud()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
126			// your additional operations after save here
127			// use $this->data['entry'] or $this->crud->entry
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-02-01 11:09 UTC by Report Bug Copy Issue Report `59%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
128			return $redirect_location;
129			}
130			}
131

webfactor / laravel-backpack-documents

Push — master ( 4dc9cd...0d595f )

DocumentCrudController::setup() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like