Search - Code Metrics - Inspection of "Add a view column type" - Laravel-Backpack/CRUD - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1269)

by Pascal

created 2018-03-07 10:39 UTC

Search A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	194
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	0

Test Coverage

Coverage

5.68%

Importance

Changes

Metric	Value
dl	0
loc	194
ccs	5
cts	88
cp	0.0568
rs	10
c	0
b	0
f	0
wmc	28
lcom	3
cbo	0

7 Methods

Rating	Name	Size	Complexity
A	applySearchTerm()	12	3
C	applySearchLogicForColumn()	38	11
A	enableAjaxTable()	4	1
A	ajaxTable()	4	1
B	getRowViews()	25	4
B	getCellView()	43	5
A	getEntriesAsJsonForDatatables()	15	3

<?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 buttons as the first column
        if ($this->details_row) {
class MyClass { }

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

        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)
    {
        // if column type not set, show as text
        if (! isset($column['type'])) {
            return \View::make('crud::columns.text')
                            ->with('crud', $this)
                            ->with('column', $column)
                            ->with('entry', $entry)
                            ->render();
        } else {
            // show the custom column view
            if ($column['type'] === 'view') {
                return \View::make(array_get($column, 'view'))
                    ->with('crud', $this)
                    ->with('column', $column)
                    ->with('entry', $entry)
                    ->render();
            }
            // if the column has been overwritten show that one
            elseif (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 \View::make('vendor.backpack.crud.columns.'.$column['type'])
                                ->with('crud', $this)
                                ->with('column', $column)
                                ->with('entry', $entry)
                                ->render();
            } else {
                // show the column from the package
                if (view()->exists('crud::columns.'.$column['type'])) {
                    return \View::make('crud::columns.'.$column['type'])
                                    ->with('crud', $this)
                                    ->with('column', $column)
                                    ->with('entry', $entry)
                                    ->render();
                } else {
                    return \View::make('crud::columns.text')
                                    ->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 (#1269)

Search A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

7 Methods

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 buttons as 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		array_unshift($row_items, \View::make('crud::columns.details_row_button')
119		->with('crud', $this)
120		->with('entry', $entry)
121		->render());
122		}
123
124		return $row_items;
125		}
126
127		/**
128		* Get the HTML of a cell, using the column types.
129		* @param array $column
130		* @param Entity $entry A db entry of the current entity;
131		* @return HTML
132		*/
133		public function getCellView($column, $entry)
134		{
135		// if column type not set, show as text
136		if (! isset($column['type'])) {
137		return \View::make('crud::columns.text')
138		->with('crud', $this)
139		->with('column', $column)
140		->with('entry', $entry)
141		->render();
142		} else {
143		// show the custom column view
144		if ($column['type'] === 'view') {
145		return \View::make(array_get($column, 'view'))
146		->with('crud', $this)
147		->with('column', $column)
148		->with('entry', $entry)
149		->render();
150		}
151		// if the column has been overwritten show that one
152		elseif (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...
153		return \View::make('vendor.backpack.crud.columns.'.$column['type'])
154		->with('crud', $this)
155		->with('column', $column)
156		->with('entry', $entry)
157		->render();
158		} else {
159		// show the column from the package
160		if (view()->exists('crud::columns.'.$column['type'])) {
161		return \View::make('crud::columns.'.$column['type'])
162		->with('crud', $this)
163		->with('column', $column)
164		->with('entry', $entry)
165		->render();
166		} else {
167		return \View::make('crud::columns.text')
168		->with('crud', $this)
169		->with('column', $column)
170		->with('entry', $entry)
171		->render();
172		}
173		}
174		}
175		}
176
177		/**
178		* Created the array to be fed to the data table.
179		*
180		* @param $entries Eloquent results.
181		* @return array
182		*/
183		public function getEntriesAsJsonForDatatables($entries, $totalRows, $filteredRows)
184		{
185		$rows = [];
186
187		foreach ($entries as $row) {
188		$rows[] = $this->getRowViews($row);
189		}
190
191		return [
192		'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...
193		'recordsTotal' => $totalRows,
194		'recordsFiltered' => $filteredRows,
195		'data' => $rows,
196		];
197		}
198		}
199

Laravel-Backpack / CRUD

Scrutinizer GitHub App not installed

Pull Request — master (#1269)

Search A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

7 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like