Search - Code Metrics - Inspection of "[EH] add possibility to use custom columns" - Laravel-Backpack/CRUD - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1388)

by Thomas

created 2018-05-16 08:38 UTC

Search A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	202
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	0

Test Coverage

Coverage

6.49%

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
c	2
b	0
f	1
dl	0
loc	202
ccs	5
cts	77
cp	0.0649
rs	9.8
wmc	31
lcom	3
cbo	0

9 Methods

Rating	Name	Size	Complexity
A	applySearchTerm()	12	3
C	applySearchLogicForColumn()	38	11
A	enableAjaxTable()	4	1
A	ajaxTable()	4	1
B	getRowViews()	26	4
A	getCellView()	4	1
A	renderCellView()	12	2
A	getEntriesAsJsonForDatatables()	15	3
B	getCellViewName()	20	5

<?php

namespace Backpack\CRUD\PanelTraits;

trait Search
{
    /*
    |--------------------------------------------------------------------------
    |                                   SEARCH
    |--------------------------------------------------------------------------
    */

    public $ajax_table = true;

    /**
     * Add conditions to the CRUD query for a particular search term.
     *
     * @param  [string] $searchTerm Whatever string the user types in the search bar.

     */
    public function applySearchTerm($searchTerm)

    {
        return $this->query->where(function ($query) use ($searchTerm) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            foreach ($this->getColumns() as $column) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                if (! isset($column['type'])) {
                    abort(400, 'Missing column type when trying to apply search term.');
                }

                $this->applySearchLogicForColumn($query, $column, $searchTerm);
            }
        });
    }

    /**
     * Apply the search logic for each CRUD column.
     */
    public function applySearchLogicForColumn($query, $column, $searchTerm)

    {
        // if there's a particular search logic defined, apply that one
        if (isset($column['searchLogic'])) {
            $searchLogic = $column['searchLogic'];

            if (is_callable($searchLogic)) {
                return $searchLogic($query, $column, $searchTerm);
            }

            if ($searchLogic == false) {
                return;
            }
        }

        // sensible fallback search logic, if none was explicitly given
        if ($column['tableColumn']) {
            switch ($column['type']) {
                case 'email':
                case 'date':
                case 'datetime':
                case 'text':
                    $query->orWhere($column['name'], 'like', '%'.$searchTerm.'%');
                    break;

                case 'select':
                case 'select_multiple':
                    $query->orWhereHas($column['entity'], function ($q) use ($column, $searchTerm) {
                        $q->where($column['attribute'], 'like', '%'.$searchTerm.'%');
                    });
                    break;

                default:
                    return;
                    break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            }
        }
    }

    /**
     * Tell the list view to use AJAX for loading multiple rows.
     *
     * @deprecated 3.3.0 All tables are AjaxTables starting with 3.3.0.
     */
    public function enableAjaxTable()
    {
        $this->ajax_table = true;
    }

    /**
     * Check if ajax is enabled for the table view.
     *
     * @deprecated 3.3.0 Since all tables use ajax, this will soon be removed.
     * @return bool
     */
    public function ajaxTable()
    {
        return $this->ajax_table;
    }

    /**
     * Get the HTML of the cells in a table row, for a certain DB entry.
     * @param  Entity $entry A db entry of the current entity;
     * @return array         Array of HTML cell contents.
     */
    public function getRowViews($entry)
    {
        $row_items = [];
        foreach ($this->columns as $key => $column) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $row_items[] = $this->getCellView($column, $entry);
        }

        // add the buttons as the last column
        if ($this->buttons->where('stack', 'line')->count()) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $row_items[] = \View::make('crud::inc.button_stack', ['stack' => 'line'])
                                ->with('crud', $this)
                                ->with('entry', $entry)
                                ->render();
        }

        // add the details_row button to the first column
        if ($this->details_row) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $details_row_button = \View::make('crud::columns.details_row_button')
                                           ->with('crud', $this)
                                           ->with('entry', $entry)
                                           ->render();
            $row_items[0] = $details_row_button.$row_items[0];
        }

        return $row_items;
    }

    /**
     * Get the HTML of a cell, using the column types.
     * @param  array $column
     * @param  Entity $entry A db entry of the current entity;
     * @return HTML
     */
    public function getCellView($column, $entry)
    {
        return $this->renderCellView($this->getCellViewName($column), $column, $entry);
    }

    /**
     * Get the name of the view to load for the cell
     * @param $column
     * @return string
     */
    private function getCellViewName($column)
    {
        // return custom column from view attribute
        if (isset($column['view_namespace']) && isset($column['type'])) {
            return $column['view_namespace'] . '.' . $column['type'];
        }

        if (isset($column['type'])) {
            // if the column has been overwritten return that one
            if (view()->exists('vendor.backpack.crud.columns.' . $column['type'])) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                return 'vendor.backpack.crud.columns.' . $column['type'];
            }

            // return the column from the package
            return 'crud::columns.' . $column['type'];
        }

        // fallback to text column
        return 'crud::columns.text';
    }

    /**
     * Render the given view
     * @param $view
     * @param $column
     * @param $entry
     * @return mixed
     */
    private function renderCellView($view, $column, $entry)
    {
        if (!view()->exists($view)) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            $view = 'crud::columns.text'; // fallback to text column
        }

        return \View::make($view)
            ->with('crud', $this)
            ->with('column', $column)
            ->with('entry', $entry)
            ->render();
    }

    /**
     * Created the array to be fed to the data table.
     *
     * @param $entries Eloquent results.
     * @return array
     */
    public function getEntriesAsJsonForDatatables($entries, $totalRows, $filteredRows)
    {
        $rows = [];

        foreach ($entries as $row) {
            $rows[] = $this->getRowViews($row);
        }

        return [
            'draw'            => (isset($this->request['draw']) ? (int) $this->request['draw'] : 0),
class MyClass { }

$x = new MyClass();
$x->foo = true;
            'recordsTotal'    => $totalRows,
            'recordsFiltered' => $filteredRows,
            'data'            => $rows,
        ];
    }
}


Scrutinizer GitHub App not installed

Pull Request — master (#1388)

Search A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

9 Methods

Available Fixes

Available Fixes

1		<?php
2
3		namespace Backpack\CRUD\PanelTraits;
4
5		trait Search
6		{
7		/*
8		\|--------------------------------------------------------------------------
9		\| SEARCH
10		\|--------------------------------------------------------------------------
11		*/
12
13		public $ajax_table = true;
14
15		/**
16		* Add conditions to the CRUD query for a particular search term.
17		*
18		* @param [string] $searchTerm Whatever string the user types in the search bar.
		0 ignored issues – show Documentation introduced 2017-11-06 12:02 UTC by Report Bug Copy Issue Report The doc-type `[string]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
19		*/
20		public function applySearchTerm($searchTerm)
		0 ignored issues – show Documentation introduced 2017-11-06 12:02 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
21		{
22		return $this->query->where(function ($query) use ($searchTerm) {
		0 ignored issues – show Bug introduced 2017-11-06 12:02 UTC by Report Bug Copy Issue Report The property `query` 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...
23		foreach ($this->getColumns() as $column) {
		0 ignored issues – show Bug introduced 2017-11-06 12:02 UTC by Report Bug Copy Issue Report It seems like `getColumns()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
24		if (! isset($column['type'])) {
25		abort(400, 'Missing column type when trying to apply search term.');
26		}
27
28		$this->applySearchLogicForColumn($query, $column, $searchTerm);
29		}
30		});
31		}
32
33		/**
34		* Apply the search logic for each CRUD column.
35		*/
36		public function applySearchLogicForColumn($query, $column, $searchTerm)
		0 ignored issues – show Documentation introduced 2017-11-06 12:02 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
37		{
38		// if there's a particular search logic defined, apply that one
39		if (isset($column['searchLogic'])) {
40		$searchLogic = $column['searchLogic'];
41
42		if (is_callable($searchLogic)) {
43		return $searchLogic($query, $column, $searchTerm);
44		}
45
46		if ($searchLogic == false) {
47		return;
48		}
49		}
50
51		// sensible fallback search logic, if none was explicitly given
52		if ($column['tableColumn']) {
53		switch ($column['type']) {
54		case 'email':
55		case 'date':
56		case 'datetime':
57		case 'text':
58		$query->orWhere($column['name'], 'like', '%'.$searchTerm.'%');
59		break;
60
61		case 'select':
62		case 'select_multiple':
63		$query->orWhereHas($column['entity'], function ($q) use ($column, $searchTerm) {
64		$q->where($column['attribute'], 'like', '%'.$searchTerm.'%');
65		});
66		break;
67
68		default:
69		return;
70		break;
		0 ignored issues – show Unused Code introduced 2017-11-06 12:02 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
71		}
72		}
73		}
74
75		/**
76		* Tell the list view to use AJAX for loading multiple rows.
77		*
78		* @deprecated 3.3.0 All tables are AjaxTables starting with 3.3.0.
79		*/
80	1	public function enableAjaxTable()
81		{
82	1	$this->ajax_table = true;
83	1	}
84
85		/**
86		* Check if ajax is enabled for the table view.
87		*
88		* @deprecated 3.3.0 Since all tables use ajax, this will soon be removed.
89		* @return bool
90		*/
91	2	public function ajaxTable()
92		{
93	2	return $this->ajax_table;
94		}
95
96		/**
97		* Get the HTML of the cells in a table row, for a certain DB entry.
98		* @param Entity $entry A db entry of the current entity;
99		* @return array Array of HTML cell contents.
100		*/
101		public function getRowViews($entry)
102		{
103		$row_items = [];
104		foreach ($this->columns as $key => $column) {
		0 ignored issues – show Bug introduced 2016-07-30 15:19 UTC by Report Bug Copy Issue Report The property `columns` 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...
105		$row_items[] = $this->getCellView($column, $entry);
106		}
107
108		// add the buttons as the last column
109		if ($this->buttons->where('stack', 'line')->count()) {
		0 ignored issues – show Bug introduced 2017-11-06 12:02 UTC by Report Bug Copy Issue Report The property `buttons` 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...
110		$row_items[] = \View::make('crud::inc.button_stack', ['stack' => 'line'])
111		->with('crud', $this)
112		->with('entry', $entry)
113		->render();
114		}
115
116		// add the details_row button to the first column
117		if ($this->details_row) {
		0 ignored issues – show Bug introduced 2017-11-06 12:02 UTC by Report Bug Copy Issue Report The property `details_row` 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...
118		$details_row_button = \View::make('crud::columns.details_row_button')
119		->with('crud', $this)
120		->with('entry', $entry)
121		->render();
122		$row_items[0] = $details_row_button.$row_items[0];
123		}
124
125		return $row_items;
126		}
127
128		/**
129		* Get the HTML of a cell, using the column types.
130		* @param array $column
131		* @param Entity $entry A db entry of the current entity;
132		* @return HTML
133		*/
134		public function getCellView($column, $entry)
135		{
136		return $this->renderCellView($this->getCellViewName($column), $column, $entry);
137		}
138
139		/**
140		* Get the name of the view to load for the cell
141		* @param $column
142		* @return string
143		*/
144		private function getCellViewName($column)
145		{
146		// return custom column from view attribute
147		if (isset($column['view_namespace']) && isset($column['type'])) {
148		return $column['view_namespace'] . '.' . $column['type'];
149		}
150
151		if (isset($column['type'])) {
152		// if the column has been overwritten return that one
153		if (view()->exists('vendor.backpack.crud.columns.' . $column['type'])) {
		0 ignored issues – show Bug introduced 2018-03-07 10:47 UTC by Report Bug Copy Issue Report The method `exists` does only exist in `Illuminate\Contracts\View\Factory`, but not in `Illuminate\View\View`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
154		return 'vendor.backpack.crud.columns.' . $column['type'];
155		}
156
157		// return the column from the package
158		return 'crud::columns.' . $column['type'];
159		}
160
161		// fallback to text column
162		return 'crud::columns.text';
163		}
164
165		/**
166		* Render the given view
167		* @param $view
168		* @param $column
169		* @param $entry
170		* @return mixed
171		*/
172		private function renderCellView($view, $column, $entry)
173		{
174		if (!view()->exists($view)) {
		0 ignored issues – show Bug introduced 2018-05-09 14:32 UTC by Report Bug Copy Issue Report The method `exists` does only exist in `Illuminate\Contracts\View\Factory`, but not in `Illuminate\View\View`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
175		$view = 'crud::columns.text'; // fallback to text column
176		}
177
178		return \View::make($view)
179		->with('crud', $this)
180		->with('column', $column)
181		->with('entry', $entry)
182		->render();
183		}
184
185		/**
186		* Created the array to be fed to the data table.
187		*
188		* @param $entries Eloquent results.
189		* @return array
190		*/
191		public function getEntriesAsJsonForDatatables($entries, $totalRows, $filteredRows)
192		{
193		$rows = [];
194
195		foreach ($entries as $row) {
196		$rows[] = $this->getRowViews($row);
197		}
198
199		return [
200		'draw' => (isset($this->request['draw']) ? (int) $this->request['draw'] : 0),
		0 ignored issues – show Bug introduced 2017-11-06 12:02 UTC by Report Bug Copy Issue Report The property `request` 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...
201		'recordsTotal' => $totalRows,
202		'recordsFiltered' => $filteredRows,
203		'data' => $rows,
204		];
205		}
206		}
207

Laravel-Backpack / CRUD

Scrutinizer GitHub App not installed

Pull Request — master (#1388)

Search A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

9 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like