AjaxTable::searchableColumns() - Code Metrics - Inspection of "New column and field types for managing permission..." - Laravel-Backpack/CRUD - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#943)

by Pascal

created 2017-09-08 11:08 UTC

AjaxTable::searchableColumns() A

↳ Parent: AjaxTable

Complexity

Conditions	1
Paths	1

Size

Total Lines	22
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	1
eloc	11
c	2
b	0
f	0
nc	1
nop	0
dl	0
loc	22
rs	9.2

<?php

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

use Illuminate\Support\Collection;

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

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

$x = new MyClass();
$x->foo = true;

        // create an array with the names of the searchable columns
        $columns = $this->searchableColumns()->toArray();

        // structure the response in a DataTable-friendly way
        $dataTable = new \LiveControl\EloquentDataTable\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);

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

    /**
     * Gets the searchable columns.
     *
     * @return Collection
     */
    protected function searchableColumns()
    {
        // create an array with the names of the searchable columns
        $columns = collect($this->crud->columns)
            // Excludes fields that are not searchable
            ->reject(function ($column, $key) {

                return array_get($column, 'searchable', true) === false;
            })
            // Excludes fields on a relation
            ->reject(function ($column, $key) {

                return array_key_exists('entity', $column);
            })
            // Excludes field types with no column
            ->reject(function ($column, $key) {

                return in_array(array_get($column, 'type'), ['select_multiple', 'model_function', 'model_function_attribute']);

            })
            ->pluck('name')
            // add the primary key, otherwise the buttons won't work
            ->merge($this->crud->model->getKeyName());

        return $columns;
    }
}


1			<?php
2
3			namespace Backpack\CRUD\app\Http\Controllers\CrudFeatures;
4
5			use Illuminate\Support\Collection;
6
7			trait AjaxTable
8			{
9			/**
10			* Respond with the JSON of one or more rows, depending on the POST parameters.
11			* @return JSON Array of cells in HTML form.
			0 ignored issues – show Documentation introduced 2016-07-30 15:19 UTC by Report Bug Copy Issue Report Should the return type not be `array`? Also, consider making the array more specific, something like `array<String>`, or `String[]`. 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. If the return type contains the type array, this check recommends the use of a more specific type like `String[]` or `array<String>`. Loading history...
12			*/
13			public function search()
14			{
15			$this->crud->hasAccessOrFail('list');
			0 ignored issues – show Bug introduced 2017-04-18 10:54 UTC by Report Bug Copy Issue Report The property `crud` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
16
17			// create an array with the names of the searchable columns
18			$columns = $this->searchableColumns()->toArray();
19
20			// structure the response in a DataTable-friendly way
21			$dataTable = new \LiveControl\EloquentDataTable\DataTable($this->crud->query, $columns);
22
23			// make the datatable use the column types instead of just echoing the text
24			$dataTable->setFormatRowFunction(function ($entry) {
25			// get the actual HTML for each row's cell
26			$row_items = $this->crud->getRowViews($entry, $this->crud);
27
28			// add the buttons as the last column
29			if ($this->crud->buttons->where('stack', 'line')->count()) {
30			$row_items[] = \View::make('crud::inc.button_stack', ['stack' => 'line'])
31			->with('crud', $this->crud)
32			->with('entry', $entry)
33			->render();
34			}
35
36			// add the details_row buttons as the first column
37			if ($this->crud->details_row) {
38			array_unshift($row_items, \View::make('crud::columns.details_row_button')
39			->with('crud', $this->crud)
40			->with('entry', $entry)
41			->render());
42			}
43
44			return $row_items;
45			});
46
47			return $dataTable->make();
48			}
49
50			/**
51			* Gets the searchable columns.
52			*
53			* @return Collection
54			*/
55			protected function searchableColumns()
56			{
57			// create an array with the names of the searchable columns
58			$columns = collect($this->crud->columns)
59			// Excludes fields that are not searchable
60			->reject(function ($column, $key) {
			0 ignored issues – show Unused Code introduced 2016-09-26 11:32 UTC by Report Bug Copy Issue Report The parameter `$key` 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...
61			return array_get($column, 'searchable', true) === false;
62			})
63			// Excludes fields on a relation
64			->reject(function ($column, $key) {
			0 ignored issues – show Unused Code introduced 2016-09-26 10:52 UTC by Report Bug Copy Issue Report The parameter `$key` 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...
65			return array_key_exists('entity', $column);
66			})
67			// Excludes field types with no column
68			->reject(function ($column, $key) {
			0 ignored issues – show Unused Code introduced 2017-04-18 10:54 UTC by Report Bug Copy Issue Report The parameter `$key` 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...
69			return in_array(array_get($column, 'type'), ['select_multiple', 'model_function', 'model_function_attribute']);
			0 ignored issues – show Coding Style introduced 2017-09-08 10:28 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 127 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
70			})
71			->pluck('name')
72			// add the primary key, otherwise the buttons won't work
73			->merge($this->crud->model->getKeyName());
74
75			return $columns;
76			}
77			}
78

Laravel-Backpack / CRUD

Scrutinizer GitHub App not installed

Pull Request — master (#943)

AjaxTable::searchableColumns() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like