PageCrudController::setup() - Code Metrics - Inspection of "Unique pages" - Laravel-Backpack/PageManager - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#61)

by Cristian

created 2018-01-20 12:27 UTC

PageCrudController::setup() A

↳ Parent: PageCrudController

Complexity

Conditions	1
Paths	1

Size

Total Lines	58
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	58
rs	9.639
cc	1
eloc	21
nc	1
nop	1

How to fix Long Method

<?php

namespace Backpack\PageManager\app\Http\Controllers\Admin;

use App\PageTemplates;
// VALIDATION: change the requests to match your own file names if you need form validation
use Backpack\PageManager\app\TraitReflections;
use Backpack\CRUD\app\Http\Controllers\CrudController;
use Backpack\PageManager\app\Http\Requests\PageRequest as StoreRequest;
use Backpack\PageManager\app\Http\Requests\PageRequest as UpdateRequest;

class PageCrudController extends CrudController
{
    use PageTemplates;
    use TraitReflections;

    public function setup($template_name = false)

    {
        parent::__construct();
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

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

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

        $modelClass = config('backpack.pagemanager.page_model_class', 'Backpack\PageManager\app\Models\Page');

        $this->checkForTemplatesAndUniquePagesNotDistinct();

        /*
        |--------------------------------------------------------------------------
        | BASIC CRUD INFORMATION
        |--------------------------------------------------------------------------
        */
        $this->crud->setModel($modelClass);
        $this->crud->setRoute(config('backpack.base.route_prefix').'/page');
        $this->crud->setEntityNameStrings(trans('backpack::pagemanager.page'), trans('backpack::pagemanager.pages'));

        $template_names = $this->getTemplateNames();
        $this->crud->addClause('whereIn', 'template', $template_names);

        /*
        |--------------------------------------------------------------------------
        | COLUMNS
        |--------------------------------------------------------------------------
        */

        $this->crud->addColumn([
                                'name' => 'name',
                                'label' => trans('backpack::pagemanager.name'),
                                ]);
        $this->crud->addColumn([
                                'name' => 'template',
                                'label' => trans('backpack::pagemanager.template'),
                                'type' => 'model_function',
                                'function_name' => 'getTemplateName',
                                ]);
        $this->crud->addColumn([
                                'name' => 'slug',
                                'label' => trans('backpack::pagemanager.slug'),
                                ]);

        /*
        |--------------------------------------------------------------------------
        | FIELDS
        |--------------------------------------------------------------------------
        */

        // In PageManager,
        // - default fields, that all templates are using, are set using $this->addDefaultPageFields();
        // - template-specific fields are set per-template, in the PageTemplates trait;

        /*
        |--------------------------------------------------------------------------
        | BUTTONS
        |--------------------------------------------------------------------------
        */
        $this->crud->addButtonFromModelFunction('line', 'open', 'getOpenButton', 'beginning');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    // -----------------------------------------------
    // Overwrites of CrudController
    // -----------------------------------------------

    // Overwrites the CrudController create() method to add template usage.
    public function create($template = false)
    {
        $this->addDefaultPageFields($template);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->useTemplate($template);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return parent::create();
    }

    // Overwrites the CrudController store() method to add template usage.
    public function store(StoreRequest $request)

    {
        $this->addDefaultPageFields(\Request::input('template'));

        $this->useTemplate(\Request::input('template'));


        return parent::storeCrud();
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

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

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    // Overwrites the CrudController edit() method to add template usage.
    public function edit($id, $template = false)
    {
        // if the template in the GET parameter is missing, figure it out from the db
        if ($template == false) {

            $model = $this->crud->model;
            $this->data['entry'] = $model::findOrFail($id);
            $template = $this->data['entry']->template;
        }

        $this->addDefaultPageFields($template);
        $this->useTemplate($template);

        return parent::edit($id);
    }

    // Overwrites the CrudController update() method to add template usage.
    public function update(UpdateRequest $request)

    {
        $this->addDefaultPageFields(\Request::input('template'));

        $this->useTemplate(\Request::input('template'));


        return parent::updateCrud();
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

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

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    // -----------------------------------------------
    // Methods that are particular to the PageManager.
    // -----------------------------------------------

    /**
     * Populate the create/update forms with basic fields, that all pages need.
     *
     * @param string $template The name of the template that should be used in the current form.

     */
    public function addDefaultPageFields($template = false)
    {
        $this->crud->addField([
                                'name' => 'template',
                                'label' => trans('backpack::pagemanager.template'),
                                'type' => 'select_page_template',
                                'options' => $this->getTemplatesArray(),
                                'value' => $template,
                                'allows_null' => false,
                                'wrapperAttributes' => [
                                    'class' => 'form-group col-md-6',
                                ],
                            ]);
        $this->crud->addField([
                                'name' => 'name',
                                'label' => trans('backpack::pagemanager.page_name'),
                                'type' => 'text',
                                'wrapperAttributes' => [
                                    'class' => 'form-group col-md-6',
                                ],
                                // 'disabled' => 'disabled'

                            ]);
        $this->crud->addField([
                                'name' => 'title',
                                'label' => trans('backpack::pagemanager.page_title'),
                                'type' => 'text',
                                // 'disabled' => 'disabled'

                            ]);
        $this->crud->addField([
                                'name' => 'slug',
                                'label' => trans('backpack::pagemanager.page_slug'),
                                'type' => 'text',
                                'hint' => trans('backpack::pagemanager.page_slug_hint'),
                                // 'disabled' => 'disabled'

                            ]);
    }

    /**
     * Add the fields defined for a specific template.
     *
     * @param  string $template_name The name of the template that should be used in the current form.

     */
    public function useTemplate($template_name = false)

    {
        $templates = $this->getTemplates();

        // set the default template
        if ($template_name == false) {

            $template_name = $templates[0]->name;
        }

        // actually use the template
        if ($template_name) {
            $this->{$template_name}();
        }
    }

    /**
     * Get all defined template as an array.
     *
     * Used to populate the template dropdown in the create/update forms.
     */
    public function getTemplatesArray()
    {
        $templates = $this->getTemplates();

        foreach ($templates as $template) {
            $templates_array[$template->name] = $this->crud->makeLabel($template->name);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        }

        return $templates_array;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
    }
}


Scrutinizer GitHub App not installed

Pull Request — master (#61)

PageCrudController::setup() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

1			<?php
2
3			namespace Backpack\PageManager\app\Http\Controllers\Admin;
4
5			use App\PageTemplates;
6			// VALIDATION: change the requests to match your own file names if you need form validation
7			use Backpack\PageManager\app\TraitReflections;
8			use Backpack\CRUD\app\Http\Controllers\CrudController;
9			use Backpack\PageManager\app\Http\Requests\PageRequest as StoreRequest;
10			use Backpack\PageManager\app\Http\Requests\PageRequest as UpdateRequest;
11
12			class PageCrudController extends CrudController
13			{
14			use PageTemplates;
15			use TraitReflections;
16
17			public function setup($template_name = false)
			0 ignored issues – show Unused Code introduced 2017-08-04 18:34 UTC by Report Bug Copy Issue Report The parameter `$template_name` 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... Coding Style Naming introduced 2017-08-04 18:34 UTC by Report Bug Copy Issue Report The parameter $template_name is not named in camelCase. This check marks parameter names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
18			{
19			parent::__construct();
			0 ignored issues – show Comprehensibility Bug introduced 2017-11-02 08:21 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`__construct()` instead of `setup()`). Are you sure this is correct? If so, you might want to change this to `$this->__construct()`. 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...
20
21			$modelClass = config('backpack.pagemanager.page_model_class', 'Backpack\PageManager\app\Models\Page');
22
23			$this->checkForTemplatesAndUniquePagesNotDistinct();
24
25			/*
26			\|--------------------------------------------------------------------------
27			\| BASIC CRUD INFORMATION
28			\|--------------------------------------------------------------------------
29			*/
30			$this->crud->setModel($modelClass);
31			$this->crud->setRoute(config('backpack.base.route_prefix').'/page');
32			$this->crud->setEntityNameStrings(trans('backpack::pagemanager.page'), trans('backpack::pagemanager.pages'));
33
34			$template_names = $this->getTemplateNames();
35			$this->crud->addClause('whereIn', 'template', $template_names);
36
37			/*
38			\|--------------------------------------------------------------------------

Laravel-Backpack / PageManager

Scrutinizer GitHub App not installed

Pull Request — master (#61)

PageCrudController::setup() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like