Backpack\CRUD\app\Http\Controllers\CrudController

Complexity

Total Complexity

27

Size/Duplication

Total Lines	345
Duplicated Lines	15.36 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes	2
Bugs	1	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	index()	0	16	2
A	create()	12	12	1
B	storeCrud()	0	31	5
A	edit()	15	15	1
B	updateCrud()	0	25	4
A	show()	12	12	1
A	listRevisions()	14	14	1
A	restoreRevision()	0	23	2
A	destroy()	0	6	1
A	reorder()	0	16	2
A	saveReorder()	0	14	2
A	showDetailsRow()	0	10	1
B	search()	0	37	3

<?php

namespace Backpack\CRUD\app\Http\Controllers;

use Backpack\CRUD\app\Http\Requests\CrudRequest as StoreRequest;
use Backpack\CRUD\app\Http\Requests\CrudRequest as UpdateRequest;
use Backpack\CRUD\CrudPanel;
use Illuminate\Foundation\Bus\DispatchesJobs;
use Illuminate\Foundation\Validation\ValidatesRequests;
// VALIDATION: change the requests to match your own file names if you need form validation
use Illuminate\Routing\Controller as BaseController;
use Illuminate\Support\Facades\Form as Form;
use LiveControl\EloquentDataTable\DataTable;

class CrudController extends BaseController
{
    use DispatchesJobs, ValidatesRequests;

    public $data = [];
    public $crud;

    public function __construct()
    {
        $this->crud = new CrudPanel();
    }

    /**
     * Display all rows in the database for this entity.
     *
     * @return Response

Should the return type not be \Illuminate\View\View|\Illuminate\Contracts\View\Factory?

     */
    public function index()
    {
        $this->crud->hasAccessOrFail('list');

        $this->data['crud'] = $this->crud;
        $this->data['title'] = ucfirst($this->crud->entity_name_plural);

        // get all entries if AJAX is not enabled
        if (! $this->data['crud']->ajaxTable()) {
            $this->data['entries'] = $this->data['crud']->getEntries();
        }

        // load the view from /resources/views/vendor/backpack/crud/ if it exists, otherwise load the one in the package
        // $this->crud->getListView() returns 'list' by default, or 'list_ajax' if ajax was enabled

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

        return view('crud::list', $this->data);
    }

    /**
     * Show the form for creating inserting a new row.
     *
     * @return Response

Should the return type not be \Illuminate\View\View|\Illuminate\Contracts\View\Factory?

     */
    public function create()

This method seems to be duplicated in your project.

    {
        $this->crud->hasAccessOrFail('create');

        // prepare the fields you need to show
        $this->data['crud'] = $this->crud;
        $this->data['fields'] = $this->crud->getCreateFields();
        $this->data['title'] = trans('backpack::crud.add').' '.$this->crud->entity_name;

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

    /**
     * Store a newly created resource in the database.
     *
     * @param StoreRequest $request - type injection used for validation using Requests

Should the type for parameter $request not be null|StoreRequest?

     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function storeCrud(StoreRequest $request = null)
    {
        $this->crud->hasAccessOrFail('create');

        // fallback to global request instance
        if (is_null($request)) {
            $request = \Request::instance();
        }

        // replace empty values with NULL, so that it will work with MySQL strict mode on
        foreach ($request->input() as $key => $value) {

The expression $request->input() of type string|array is not guaranteed to be traversable. How about adding an additional type check?

            if (empty($value)) {
                $request->request->set($key, null);
            }
        }

        // insert item in the db
        $item = $this->crud->create($request->except(['redirect_after_save', 'password']));

        // show a success message
        \Alert::success(trans('backpack::crud.insert_success'))->flash();

        // redirect the user where he chose to be redirected
        switch ($request->input('redirect_after_save')) {
            case 'current_item_edit':
                return \Redirect::to($this->crud->route.'/'.$item->getKey().'/edit');

            default:
                return \Redirect::to($request->input('redirect_after_save'));

It seems like $request->input('redirect_after_save') targeting Illuminate\Http\Request::input() can also be of type array; however, Illuminate\Routing\Redirector::to() does only seem to accept string, maybe add an additional type check?

        }
    }

    /**
     * Show the form for editing the specified resource.
     *
     * @param int $id
     *
     * @return Response

Should the return type not be \Illuminate\View\View|\Illuminate\Contracts\View\Factory?

     */
    public function edit($id)

This method seems to be duplicated in your project.

    {
        $this->crud->hasAccessOrFail('update');

        // get the info for that entry
        $this->data['entry'] = $this->crud->getEntry($id);
        $this->data['crud'] = $this->crud;
        $this->data['fields'] = $this->crud->getUpdateFields($id);
        $this->data['title'] = trans('backpack::crud.edit').' '.$this->crud->entity_name;

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

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

    /**
     * Update the specified resource in the database.
     *
     * @param UpdateRequest $request - type injection used for validation using Requests

Should the type for parameter $request not be null|StoreRequest?

     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function updateCrud(UpdateRequest $request = null)
    {
        $this->crud->hasAccessOrFail('update');

        // fallback to global request instance
        if (is_null($request)) {
            $request = \Request::instance();
        }

        // replace empty values with NULL, so that it will work with MySQL strict mode on
        foreach ($request->input() as $key => $value) {

The expression $request->input() of type string|array is not guaranteed to be traversable. How about adding an additional type check?

            if (empty($value)) {
                $request->request->set($key, null);
            }
        }

        // update the row in the db
        $this->crud->update($request->get($this->crud->model->getKeyName()),

The method getKeyName cannot be called on $this->crud->model (of type string).

                            $request->except('redirect_after_save'));

        // show a success message
        \Alert::success(trans('backpack::crud.update_success'))->flash();

        return \Redirect::to($this->crud->route);
    }

    /**
     * Display the specified resource.
     *
     * @param int $id
     *
     * @return Response

Should the return type not be \Illuminate\View\View|\Illuminate\Contracts\View\Factory?

     */
    public function show($id)

This method seems to be duplicated in your project.

    {
        $this->crud->hasAccessOrFail('show');

        // get the info for that entry
        $this->data['entry'] = $this->crud->getEntry($id);
        $this->data['crud'] = $this->crud;
        $this->data['title'] = trans('backpack::crud.preview').' '.$this->crud->entity_name;

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

    /**
     * Display the revisions for specified resource.
     *
     * @param int $id
     *
     * @return Response

Should the return type not be \Illuminate\View\View|\Illuminate\Contracts\View\Factory?

     */
    public function listRevisions($id)

This method seems to be duplicated in your project.

    {
        $this->crud->hasAccessOrFail('revisions');

        // get the info for that entry
        $this->data['entry'] = $this->crud->getEntry($id);
        $this->data['crud'] = $this->crud;
        $this->data['title'] = trans('backpack::crud.revisions').' '.$this->crud->entity_name;
        $this->data['id'] = $id;
        $this->data['revisions'] = $this->crud->listRevisions($id);

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

    /**
     * Restore a specific revision for the specified resource.
     *
     * Used via AJAX in the revisions view
     *
     * @param int $id
     *
     * @return JSON Response containing the new revision that was created from the update
     * @return HTTP 500 if the request did not contain the revision ID

Should the return type not be null|\Illuminate\View\View|\Illuminate\Contracts\View\Factory?

     */
    public function restoreRevision($id)
    {

        $this->crud->hasAccessOrFail('revisions');

        // @TODO: Currently the route already contains the revision ID, so passing it as a POST param
        // is somewhat superfluous.. however if we are POSTing, it makes sense to actually have data to post.
        // Perhaps the route shoud be better named to reflect this (e.g. just /model/{id}/revisions) (??)
        $revisionId = \Request::input('revision_id', false);

false is of type boolean, but the function expects a string|array|null.

        if(!$revisionId) {
            abort(500, 'Can\'t restore revision without revision_id');
        } else {
            $this->crud->restoreRevision($id, $revisionId); // do the update

            $this->data['entry'] = $this->crud->getEntry($id);
            $this->data['crud'] = $this->crud;
            $this->data['revisions'] = $this->crud->listRevisions($id); // Reload revisions as they have changed

            // Rebuild the revision timeline HTML and return it to the AJAX call
            // @TODO: Return only the latest revision to save bandwidth - 15/9/16 @se1exin
            return view('crud::inc.revision_timeline', $this->data);
        }
    }

    /**
     * Remove the specified resource from storage.
     *
     * @param int $id
     *
     * @return string
     */
    public function destroy($id)
    {
        $this->crud->hasAccessOrFail('delete');

        return $this->crud->delete($id);
    }

    /**
     *  Reorder the items in the database using the Nested Set pattern.
     *
     *	Database columns needed: id, parent_id, lft, rgt, depth, name/title
     *
     *  @return Response

Should the return type not be \Illuminate\View\View|\Illuminate\Contracts\View\Factory?

     */
    public function reorder()
    {
        $this->crud->hasAccessOrFail('reorder');

        if (! $this->crud->isReorderEnabled()) {
            abort(403, 'Reorder is disabled.');
        }

        // get all results for that entity
        $this->data['entries'] = $this->crud->getEntries();
        $this->data['crud'] = $this->crud;
        $this->data['title'] = trans('backpack::crud.reorder').' '.$this->crud->entity_name;

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

    /**
     * Save the new order, using the Nested Set pattern.
     *
     * Database columns needed: id, parent_id, lft, rgt, depth, name/title
     *
     * @return
     */
    public function saveReorder()
    {
        $this->crud->hasAccessOrFail('reorder');

        $all_entries = \Request::input('tree');

        if (count($all_entries)) {
            $count = $this->crud->updateTreeOrder($all_entries);
        } else {
            return false;
        }

        return 'success for '.$count.' items';
    }

    /**
     * Used with AJAX in the list view (datatables) to show extra information about that row that didn't fit in the table.

This line exceeds maximum limit of 120 characters; contains 122 characters

     * It defaults to showing some dummy text.
     *
     * It's enabled by:
     * - setting: $crud->details_row = true;
     * - adding the details route for the entity; ex: Route::get('page/{id}/details', 'PageCrudController@showDetailsRow');

This line exceeds maximum limit of 120 characters; contains 123 characters

     * - adding a view with the following name to change what the row actually contains: app/resources/views/vendor/backpack/crud/details_row.blade.php

This line exceeds maximum limit of 120 characters; contains 151 characters

     */
    public function showDetailsRow($id)
    {
        $this->crud->hasAccessOrFail('details_row');

        $this->data['entry'] = $this->crud->getEntry($id);
        $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('crud::details_row', $this->data);
    }

    /**
     * Respond with the JSON of one or more rows, depending on the POST parameters.
     * @return JSON Array of cells in HTML form.

Should the return type not be array? Also, consider making the array more specific, something like array<String>, or String[].

     */
    public function search()
    {
        $this->crud->hasAccessOrFail('list');

        // add the primary key, even though you don't show it,
        // otherwise the buttons won't work
        $columns = collect($this->crud->columns)->pluck('name')->merge($this->crud->model->getKeyName())->toArray();

The method getKeyName cannot be called on $this->crud->model (of type string).

        // structure the response in a DataTable-friendly way
        $dataTable = new DataTable($this->crud->query, $columns);

        // make the datatable use the column types instead of just echoing the text
        $dataTable->setFormatRowFunction(function ($entry) {
            // get the actual HTML for each row's cell
            $row_items = $this->crud->getRowViews($entry, $this->crud);

The call to CrudPanel::getRowViews() has too many arguments starting with $this->crud.

            // add the buttons as the last column
            if ($this->crud->buttons->where('stack', 'line')->count()) {
                $row_items[] = \View::make('crud::inc.button_stack', ['stack' => 'line'])
                                ->with('crud', $this->crud)
                                ->with('entry', $entry)
                                ->render();
            }

            // add the details_row buttons as the first column
            if ($this->crud->details_row) {
                array_unshift($row_items, \View::make('crud::columns.details_row_button')
                                ->with('crud', $this->crud)
                                ->with('entry', $entry)
                                ->render());
            }

            return $row_items;
        });

        return $dataTable->make();
    }
}