CrudController::index() - Code Metrics - Inspection of "[WIP] CRUD 3.3 Upgrade" - Laravel-Backpack/CRUD - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1022)

by Cristian

created 2017-09-28 07:19 UTC

CrudController::index() A

↳ Parent: CrudController

Complexity

Conditions	2
Paths	2

Size

Total Lines	15
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	7
nc	2
nop	0
dl	0
loc	15
rs	9.4285
c	0
b	0
f	0

<?php

namespace Backpack\CRUD\app\Http\Controllers;

use Backpack\CRUD\CrudPanel;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Form as Form;
use Illuminate\Foundation\Bus\DispatchesJobs;
use Illuminate\Routing\Controller as BaseController;
use Illuminate\Foundation\Validation\ValidatesRequests;
use Backpack\CRUD\app\Http\Controllers\CrudFeatures\Reorder;
use Backpack\CRUD\app\Http\Controllers\CrudFeatures\AjaxTable;
// CRUD Traits for non-core features
use Backpack\CRUD\app\Http\Controllers\CrudFeatures\Revisions;
use Backpack\CRUD\app\Http\Controllers\CrudFeatures\SaveActions;
use Backpack\CRUD\app\Http\Requests\CrudRequest as StoreRequest;
use Backpack\CRUD\app\Http\Requests\CrudRequest as UpdateRequest;
use Backpack\CRUD\app\Http\Controllers\CrudFeatures\ShowDetailsRow;

class CrudController extends BaseController
{
    use DispatchesJobs, ValidatesRequests;
    use AjaxTable, Reorder, Revisions, ShowDetailsRow, SaveActions;

    public $data = [];
    public $crud;
    public $request;

    public function __construct()
    {
        if (! $this->crud) {
            $this->crud = app()->make(CrudPanel::class);

            // call the setup function inside this closure to also have the request there
            // this way, developers can use things stored in session (auth variables, etc)
            $this->middleware(function ($request, $next) {
                $this->request = $request;
                $this->crud->request = $request;
                $this->setup();

                return $next($request);
            });
        }
    }

    /**
     * Allow developers to set their configuration options for a CrudPanel.
     */
    public function setup()
    {
    }

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

     */
    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
        return view($this->crud->getListView(), $this->data);
    }

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

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

        // prepare the fields you need to show
        $this->data['crud'] = $this->crud;
        $this->data['saveAction'] = $this->getSaveAction();
        $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($this->crud->getCreateView(), $this->data);
    }

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

     *
     * @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) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (empty($value) && $value !== '0') {
                $request->request->set($key, null);
            }
        }

        // insert item in the db
        $item = $this->crud->create($request->except(['save_action', '_token', '_method']));
        $this->data['entry'] = $this->crud->entry = $item;

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

        // save the redirect choice for next time
        $this->setSaveAction();

        return $this->performSaveAction($item->getKey());
    }

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

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

        // get the info for that entry
        $this->data['entry'] = $this->crud->getEntry($id);
        $this->data['crud'] = $this->crud;
        $this->data['saveAction'] = $this->getSaveAction();
        $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($this->crud->getEditView(), $this->data);
    }

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

     *
     * @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) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (empty($value) && $value !== '0') {
                $request->request->set($key, null);
            }
        }

        // update the row in the db
        $item = $this->crud->update($request->get($this->crud->model->getKeyName()),
                            $request->except('save_action', '_token', '_method'));
        $this->data['entry'] = $this->crud->entry = $item;

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

        // save the redirect choice for next time
        $this->setSaveAction();

        return $this->performSaveAction($item->getKey());
    }

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

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

        // set columns from db
        $this->crud->setFromDb();

        // cycle through columns
        foreach ($this->crud->columns as $key => $column) {
            // remove any autoset relationship columns
            if (array_key_exists('model', $column) && array_key_exists('autoset', $column) && $column['autoset']) {
                $this->crud->removeColumn($column['name']);
            }
        }

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

        // remove preview button from stack:line
        $this->crud->removeButton('preview');
        $this->crud->removeButton('delete');

        // load the view from /resources/views/vendor/backpack/crud/ if it exists, otherwise load the one in the package
        return view($this->crud->getShowView(), $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);
    }
}


1		<?php
2
3		namespace Backpack\CRUD\app\Http\Controllers;
4
5		use Backpack\CRUD\CrudPanel;
6		use Illuminate\Http\Request;
7		use Illuminate\Support\Facades\Form as Form;
8		use Illuminate\Foundation\Bus\DispatchesJobs;
9		use Illuminate\Routing\Controller as BaseController;
10		use Illuminate\Foundation\Validation\ValidatesRequests;
11		use Backpack\CRUD\app\Http\Controllers\CrudFeatures\Reorder;
12		use Backpack\CRUD\app\Http\Controllers\CrudFeatures\AjaxTable;
13		// CRUD Traits for non-core features
14		use Backpack\CRUD\app\Http\Controllers\CrudFeatures\Revisions;
15		use Backpack\CRUD\app\Http\Controllers\CrudFeatures\SaveActions;
16		use Backpack\CRUD\app\Http\Requests\CrudRequest as StoreRequest;
17		use Backpack\CRUD\app\Http\Requests\CrudRequest as UpdateRequest;
18		use Backpack\CRUD\app\Http\Controllers\CrudFeatures\ShowDetailsRow;
19
20		class CrudController extends BaseController
21		{
22		use DispatchesJobs, ValidatesRequests;
23		use AjaxTable, Reorder, Revisions, ShowDetailsRow, SaveActions;
24
25		public $data = [];
26		public $crud;
27		public $request;
28
29		public function __construct()
30		{
31		if (! $this->crud) {
32		$this->crud = app()->make(CrudPanel::class);
33
34		// call the setup function inside this closure to also have the request there
35		// this way, developers can use things stored in session (auth variables, etc)
36		$this->middleware(function ($request, $next) {
37		$this->request = $request;
38		$this->crud->request = $request;
39		$this->setup();
40
41		return $next($request);
42		});
43		}
44		}
45
46		/**
47		* Allow developers to set their configuration options for a CrudPanel.
48		*/
49		public function setup()
50		{
51		}
52
53		/**
54		* Display all rows in the database for this entity.
55		*
56		* @return Response
		0 ignored issues – show Documentation introduced 2016-07-22 16:53 UTC by Report Bug Copy Issue Report Should the return type not be `\Illuminate\View\View\|\I...\Contracts\View\Factory`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
57		*/
58		public function index()
59		{
60		$this->crud->hasAccessOrFail('list');
61
62		$this->data['crud'] = $this->crud;
63		$this->data['title'] = ucfirst($this->crud->entity_name_plural);
64
65		// get all entries if AJAX is not enabled
66		if (! $this->data['crud']->ajaxTable()) {
67		$this->data['entries'] = $this->data['crud']->getEntries();
68		}
69
70		// load the view from /resources/views/vendor/backpack/crud/ if it exists, otherwise load the one in the package
71		return view($this->crud->getListView(), $this->data);
72		}
73
74		/**
75		* Show the form for creating inserting a new row.
76		*
77		* @return Response
		0 ignored issues – show Documentation introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report Should the return type not be `\Illuminate\View\View\|\I...\Contracts\View\Factory`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
78		*/
79		public function create()
80		{
81		$this->crud->hasAccessOrFail('create');
82
83		// prepare the fields you need to show
84		$this->data['crud'] = $this->crud;
85		$this->data['saveAction'] = $this->getSaveAction();
86		$this->data['fields'] = $this->crud->getCreateFields();
87		$this->data['title'] = trans('backpack::crud.add').' '.$this->crud->entity_name;
88
89		// load the view from /resources/views/vendor/backpack/crud/ if it exists, otherwise load the one in the package
90		return view($this->crud->getCreateView(), $this->data);
91		}
92
93		/**
94		* Store a newly created resource in the database.
95		*
96		* @param StoreRequest $request - type injection used for validation using Requests
		0 ignored issues – show Documentation introduced 2016-05-20 15:02 UTC by Report Bug Copy Issue Report Should the type for parameter `$request` not be `null\|StoreRequest`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
97		*
98		* @return \Illuminate\Http\RedirectResponse
99		*/
100		public function storeCrud(StoreRequest $request = null)
101		{
102		$this->crud->hasAccessOrFail('create');
103
104		// fallback to global request instance
105		if (is_null($request)) {
106		$request = \Request::instance();
107		}
108
109		// replace empty values with NULL, so that it will work with MySQL strict mode on
110	View Code Duplication	foreach ($request->input() as $key => $value) {
		0 ignored issues – show Bug introduced 2016-11-11 10:29 UTC by Report Bug Copy Issue Report The expression `$request->input()` of type `string\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history... Duplication introduced 2016-11-11 10:29 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
111		if (empty($value) && $value !== '0') {
112		$request->request->set($key, null);
113		}
114		}
115
116		// insert item in the db
117		$item = $this->crud->create($request->except(['save_action', '_token', '_method']));
118		$this->data['entry'] = $this->crud->entry = $item;
119
120		// show a success message
121		\Alert::success(trans('backpack::crud.insert_success'))->flash();
122
123		// save the redirect choice for next time
124		$this->setSaveAction();
125
126		return $this->performSaveAction($item->getKey());
127		}
128
129		/**
130		* Show the form for editing the specified resource.
131		*
132		* @param int $id
133		*
134		* @return Response
		0 ignored issues – show Documentation introduced 2017-08-03 17:04 UTC by Report Bug Copy Issue Report Should the return type not be `\Illuminate\View\View\|\I...\Contracts\View\Factory`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
135		*/
136		public function edit($id)
137		{
138		$this->crud->hasAccessOrFail('update');
139
140		// get the info for that entry
141		$this->data['entry'] = $this->crud->getEntry($id);
142		$this->data['crud'] = $this->crud;
143		$this->data['saveAction'] = $this->getSaveAction();
144		$this->data['fields'] = $this->crud->getUpdateFields($id);
145		$this->data['title'] = trans('backpack::crud.edit').' '.$this->crud->entity_name;
146
147		$this->data['id'] = $id;
148
149		// load the view from /resources/views/vendor/backpack/crud/ if it exists, otherwise load the one in the package
150		return view($this->crud->getEditView(), $this->data);
151		}
152
153		/**
154		* Update the specified resource in the database.
155		*
156		* @param UpdateRequest $request - type injection used for validation using Requests
		0 ignored issues – show Documentation introduced 2016-05-20 15:02 UTC by Report Bug Copy Issue Report Should the type for parameter `$request` not be `null\|StoreRequest`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
157		*
158		* @return \Illuminate\Http\RedirectResponse
159		*/
160		public function updateCrud(UpdateRequest $request = null)
161		{
162		$this->crud->hasAccessOrFail('update');
163
164		// fallback to global request instance
165		if (is_null($request)) {
166		$request = \Request::instance();
167		}
168
169		// replace empty values with NULL, so that it will work with MySQL strict mode on
170	View Code Duplication	foreach ($request->input() as $key => $value) {
		0 ignored issues – show Bug introduced 2016-09-12 08:57 UTC by Report Bug Copy Issue Report The expression `$request->input()` of type `string\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history... Duplication introduced 2016-09-19 16:42 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
171		if (empty($value) && $value !== '0') {
172		$request->request->set($key, null);
173		}
174		}
175
176		// update the row in the db
177		$item = $this->crud->update($request->get($this->crud->model->getKeyName()),
178		$request->except('save_action', '_token', '_method'));
179		$this->data['entry'] = $this->crud->entry = $item;
180
181		// show a success message
182		\Alert::success(trans('backpack::crud.update_success'))->flash();
183
184		// save the redirect choice for next time
185		$this->setSaveAction();
186
187		return $this->performSaveAction($item->getKey());
188		}
189
190		/**
191		* Display the specified resource.
192		*
193		* @param int $id
194		*
195		* @return Response
		0 ignored issues – show Documentation introduced 2017-08-03 17:04 UTC by Report Bug Copy Issue Report Should the return type not be `\Illuminate\View\View\|\I...\Contracts\View\Factory`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
196		*/
197		public function show($id)
198		{
199		$this->crud->hasAccessOrFail('show');
200
201		// set columns from db
202		$this->crud->setFromDb();
203
204		// cycle through columns
205		foreach ($this->crud->columns as $key => $column) {
206		// remove any autoset relationship columns
207		if (array_key_exists('model', $column) && array_key_exists('autoset', $column) && $column['autoset']) {
208		$this->crud->removeColumn($column['name']);
209		}
210		}
211
212		// get the info for that entry
213		$this->data['entry'] = $this->crud->getEntry($id);
214		$this->data['crud'] = $this->crud;
215		$this->data['title'] = trans('backpack::crud.preview').' '.$this->crud->entity_name;
216
217		// remove preview button from stack:line
218		$this->crud->removeButton('preview');
219		$this->crud->removeButton('delete');
220
221		// load the view from /resources/views/vendor/backpack/crud/ if it exists, otherwise load the one in the package
222		return view($this->crud->getShowView(), $this->data);
223		}
224
225		/**
226		* Remove the specified resource from storage.
227		*
228		* @param int $id
229		*
230		* @return string
231		*/
232		public function destroy($id)
233		{
234		$this->crud->hasAccessOrFail('delete');
235
236		return $this->crud->delete($id);
237		}
238		}
239

Laravel-Backpack / CRUD

Scrutinizer GitHub App not installed

Pull Request — master (#1022)

CrudController::index() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like