Backpack\CRUD\app\Http\Controllers\Operations\ListOperation

Complexity

Total Complexity

18

Size/Duplication

Total Lines	150
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setupListDefaults()	0	7	1
A	applyCachedDatatableSetup()	0	3	1
A	setupListRoutes()	0	19	3
A	index()	0	10	1
A	showDetailsRow()	0	12	1
B	search()	0	53	11

<?php

namespace Backpack\CRUD\app\Http\Controllers\Operations;

use Backpack\CRUD\app\Library\CrudPanel\Hooks\Facades\LifecycleHook;
use Illuminate\Support\Facades\Route;
use Backpack\CRUD\app\Library\Support\DatatableCache;

trait ListOperation
{
    /**
     * Define which routes are needed for this operation.
     *
     * @param  string  $segment  Name of the current entity (singular). Used as first URL segment.
     * @param  string  $routeName  Prefix of the route name.
     * @param  string  $controller  Name of the current CrudController.
     */
    protected function setupListRoutes($segment, $routeName, $controller)
    {
        Route::get($segment.'/', [
            'as' => $routeName.'.index',
            'uses' => $controller.'@index',
            'operation' => 'list',
        ]);

        Route::post($segment.'/search', [
            'as' => $routeName.'.search',
            'uses' => $controller.'@search',
            'operation' => 'list',
        ]);

        if (! isset($this->setupDetailsRowRoute) || $this->setupDetailsRowRoute === true) {
            Route::get($segment.'/{id}/details', [
                'as' => $routeName.'.showDetailsRow',
                'uses' => $controller.'@showDetailsRow',
                'operation' => 'list',
            ]);
        }
    }

    /**
     * Add the default settings, buttons, etc that this operation needs.
     */
    protected function setupListDefaults()
    {
        $this->crud->allowAccess('list');

        LifecycleHook::hookInto('list:before_setup', function () {

The method hookInto() does not exist on Backpack\CRUD\app\Library\CrudPanel\Hooks\Facades\LifecycleHook. Since you implemented __callStatic, consider adding a @method annotation.

            $this->crud->loadDefaultOperationSettingsFromConfig();
            $this->crud->setOperationSetting('datatablesUrl', $this->crud->getRoute());
        });
    }

    /**
     * Display all rows in the database for this entity.
     *
     * @return \Illuminate\Contracts\View\View
     */
    public function index()
    {
        $this->crud->hasAccessOrFail('list');

        $this->data['crud'] = $this->crud;

The property data does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->data['title'] = $this->crud->getTitle() ?? mb_ucfirst($this->crud->entity_name_plural);
        $this->data['controller'] = get_class($this);

        // load the view from /resources/views/vendor/backpack/crud/ if it exists, otherwise load the one in the package
        return view($this->crud->getListView(), $this->data);
    }

    /**
     * The search function that is called by the data table.
     *
     * @return array JSON Array of cells in HTML form.
     */
    public function search()
    {
        $this->crud->hasAccessOrFail('list');

        // If there's a config closure in the cache for this CRUD, run that configuration closure.
        // This is done in order to allow the developer to configure the datatable component.
        $this->applyCachedDatatableSetup();

        $this->crud->applyUnappliedFilters();

        $start = (int) request()->input('start');
        $length = (int) request()->input('length');
        $search = request()->input('search');

        // check if length is allowed by developer
        if ($length && ! in_array($length, $this->crud->getPageLengthMenu()[0])) {
            return response()->json([

The expression return response()->json(array('error' => 'Unknown page length.'), 400) returns the type Illuminate\Http\JsonResponse which is incompatible with the documented return type array.

                'error' => 'Unknown page length.',
            ], 400);
        }

        // if a search term was present
        if ($search && $search['value'] ?? false) {
            // filter the results accordingly
            $this->crud->applySearchTerm($search['value']);
        }
        // start the results according to the datatables pagination
        if ($start) {
            $this->crud->skip($start);
        }
        // limit the number of results according to the datatables pagination
        if ($length) {
            $this->crud->take($length);
        }
        // overwrite any order set in the setup() method with the datatables order
        $this->crud->applyDatatableOrder();

        $entries = $this->crud->getEntries();
        $requestTotalEntryCount = request()->get('totalEntryCount') ? (int) request()->get('totalEntryCount') : null;
        // if show entry count is disabled we use the "simplePagination" technique to move between pages.
        if ($this->crud->getOperationSetting('showEntryCount')) {
            $totalEntryCount = (int) ($requestTotalEntryCount ?: $this->crud->getTotalQueryCount());
            $filteredEntryCount = $this->crud->getFilteredQueryCount() ?? $totalEntryCount;
        } else {
            $totalEntryCount = $length;
            $entryCount = $entries->count();
            $filteredEntryCount = $entryCount < $length ? $entryCount : $length + $start + 1;
        }

        // store the totalEntryCount in CrudPanel so that multiple blade files can access it
        $this->crud->setOperationSetting('totalEntryCount', $totalEntryCount);

        return $this->crud->getEntriesAsJsonForDatatables($entries, $totalEntryCount, $filteredEntryCount, $start);
    }

    /**
     * Apply the cached datatable setup configuration directly using DatatableCache.
     * 
     * @return bool Whether the cached setup was successfully applied
     */
    protected function applyCachedDatatableSetup()
    {
        return DatatableCache::instance()->applyFromRequest($this->crud);
    }

    /**
     * Used with AJAX in the list view (datatables) to show extra information about that row that didn't fit in the table.
     * It defaults to showing some dummy text.
     *
     * @return \Illuminate\Contracts\View\View
     */
    public function showDetailsRow($id)
    {
        $this->crud->hasAccessOrFail('list');

        // get entry ID from Request (makes sure its the last ID for nested resources)
        $id = $this->crud->getCurrentEntryId() ?? $id;

        $this->data['entry'] = $this->crud->getEntry($id);

The property data does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->data['crud'] = $this->crud;

        // load the view from /resources/views/vendor/backpack/crud/ if it exists, otherwise load the one in the package
        return view($this->crud->getDetailsRowView(), $this->data);
    }
}