Backpack\PageManager\app\Http\Controllers\Admin\PageCrudController

Complexity

Total Complexity

14

Size/Duplication

Total Lines	204
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	3
Bugs	1	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	7	1
A	store()	0	7	1
A	edit()	0	14	2
A	update()	0	7	1
B	addDefaultPageFields()	0	36	1
A	useTemplate()	0	14	3
A	getTemplates()	0	13	2
A	getTemplatesArray()	0	10	2
A	setup()	0	53	1

<?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\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;

    public function setup($template_name = false)

The parameter $template_name is not used and could be removed.

The parameter $template_name is not named in camelCase.

    {
        parent::__construct();

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().

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

        /*
        |--------------------------------------------------------------------------
        | 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'));

        /*
        |--------------------------------------------------------------------------
        | 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');
    }

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

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

$template is of type boolean, but the function expects a false|string.

        $this->useTemplate($template);

$template is of type boolean, but the function expects a false|string.

        return parent::create();
    }

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

The parameter $request is not used and could be removed.

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

It seems like \Request::input('template') targeting Illuminate\Http\Concerns\InteractsWithInput::input() can also be of type array; however, Backpack\PageManager\app\Http\Controllers\Admin\PageCrudController::addDefaultPageFields() does only seem to accept false|string, maybe add an additional type check?

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

It seems like \Request::input('template') targeting Illuminate\Http\Concerns\InteractsWithInput::input() can also be of type array; however, Backpack\PageManager\app\Http\Controllers\Admin\PageCrudController::useTemplate() does only seem to accept false|string, maybe add an additional type check?

        return parent::storeCrud();

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().

    }

    // 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) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

            $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)

The parameter $request is not used and could be removed.

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

It seems like \Request::input('template') targeting Illuminate\Http\Concerns\InteractsWithInput::input() can also be of type array; however, Backpack\PageManager\app\Http\Controllers\Admin\PageCrudController::addDefaultPageFields() does only seem to accept false|string, maybe add an additional type check?

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

It seems like \Request::input('template') targeting Illuminate\Http\Concerns\InteractsWithInput::input() can also be of type array; however, Backpack\PageManager\app\Http\Controllers\Admin\PageCrudController::useTemplate() does only seem to accept false|string, maybe add an additional type check?

        return parent::updateCrud();

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().

    }

    // -----------------------------------------------
    // 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.

Should the type for parameter $template not be false|string?

     */
    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'

50% of this comment could be valid code. Did you maybe forget this after debugging?

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

50% of this comment could be valid code. Did you maybe forget this after debugging?

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

50% of this comment could be valid code. Did you maybe forget this after debugging?

                            ]);
    }

    /**
     * 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.

Should the type for parameter $template_name not be false|string?

     */
    public function useTemplate($template_name = false)

The parameter $template_name is not named in camelCase.

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

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

It seems like you are loosely comparing $template_name of type false|string against false; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

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

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

    /**
     * Get all defined templates.
     */
    public function getTemplates($template_name = false)

The parameter $template_name is not used and could be removed.

The parameter $template_name is not named in camelCase.

    {
        $templates_array = [];

$templates_array is not used, you could remove the assignment.

        $templates_trait = new \ReflectionClass('App\PageTemplates');
        $templates = $templates_trait->getMethods(\ReflectionMethod::IS_PRIVATE);

        if (! count($templates)) {
            abort(503, trans('backpack::pagemanager.template_not_found'));
        }

        return $templates;
    }

    /**
     * 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);

$templates_array was never initialized. Although not strictly required by PHP, it is generally a good practice to add $templates_array = array(); before regardless.

        }

        return $templates_array;

The variable $templates_array does not seem to be defined for all execution paths leading up to this point.

    }
}