Column::sort() - Code Metrics - Inspection of "add sort function in Grid/Column" - z-song/laravel-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2820)

unknown

created 2018-12-04 05:50 UTC

Column::sort() A

↳ Parent: Column

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	6
rs	10
c	0
b	0
f	0

<?php

namespace Encore\Admin\Grid;

use Closure;
use Encore\Admin\Grid;
use Encore\Admin\Grid\Displayers\AbstractDisplayer;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Database\Eloquent\Model;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Illuminate\Support\Collection;
use Illuminate\Support\Str;

class Column
{
    /**
     * @var Grid
     */
    protected $grid;

    /**
     * Name of column.
     *
     * @var string
     */
    protected $name;

    /**
     * Label of column.
     *
     * @var string
     */
    protected $label;

    /**
     * Original value of column.
     *
     * @var mixed
     */
    protected $original;

    /**
     * Is column sortable.
     *
     * @var bool
     */
    protected $sortable = false;

    /**
     * Sort arguments.
     *
     * @var array
     */
    protected $sort;

    /**
     * Attributes of column.
     *
     * @var array
     */
    protected $attributes = [];

    /**
     * Relation name.
     *
     * @var bool
     */
    protected $relation = false;

    /**
     * Relation column.
     *
     * @var string
     */
    protected $relationColumn;

    /**
     * Original grid data.
     *
     * @var Collection
     */
    protected static $originalGridModels;

    /**
     * @var []Closure
     */
    protected $displayCallbacks = [];

    /**
     * Displayers for grid column.
     *
     * @var array
     */
    public static $displayers = [];

    /**
     * Defined columns.
     *
     * @var array
     */
    public static $defined = [];

    /**
     * @var array
     */
    protected static $htmlAttributes = [];

    /**
     * @var Model
     */
    protected static $model;

    const SELECT_COLUMN_NAME = '__row_selector__';

    /**
     * @param string $name
     * @param string $label
     */
    public function __construct($name, $label)
    {
        $this->name = $name;

        $this->label = $this->formatLabel($label);
    }

    /**
     * Extend column displayer.
     *
     * @param $name
     * @param $displayer
     */
    public static function extend($name, $displayer)
    {
        static::$displayers[$name] = $displayer;
    }

    /**
     * Define a column globally.
     *
     * @param string $name
     * @param mixed  $definition
     */
    public static function define($name, $definition)
    {
        static::$defined[$name] = $definition;
    }

    /**
     * Set grid instance for column.
     *
     * @param Grid $grid
     */
    public function setGrid(Grid $grid)
    {
        $this->grid = $grid;

        $this->setModel($grid->model()->eloquent());
    }

    /**
     * Set model for column.
     *
     * @param $model
     */
    public function setModel($model)
    {
        if (is_null(static::$model) && ($model instanceof Model)) {
            static::$model = $model->newInstance();
        }
    }

    /**
     * Set original data for column.
     *
     * @param Collection $collection
     */
    public static function setOriginalGridModels(Collection $collection)
    {
        static::$originalGridModels = $collection;
    }

    /**
     * Set column attributes.
     *
     * @param array $attributes
     *
     * @return $this
     */
    public function setAttributes($attributes = [])
    {
        static::$htmlAttributes[$this->name] = $attributes;

        return $this;
    }

    /**
     * Get column attributes.
     *
     * @param string $name
     *
     * @return mixed
     */
    public static function getAttributes($name)
    {
        return array_get(static::$htmlAttributes, $name, '');
    }

    /**
     * Set style of this column.
     *
     * @param string $style
     *
     * @return Column
     */
    public function style($style)
    {
        return $this->setAttributes(compact('style'));
    }

    /**
     * Get name of this column.
     *
     * @return mixed
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Format label.
     *
     * @param $label
     *
     * @return mixed
     */
    protected function formatLabel($label)
    {
        $label = $label ?: ucfirst($this->name);

        return str_replace(['.', '_'], ' ', $label);
    }

    /**
     * Get label of the column.
     *
     * @return mixed
     */
    public function getLabel()
    {
        return $this->label;
    }

    /**
     * Set relation.
     *
     * @param string $relation
     * @param string $relationColumn
     *
     * @return $this
     */
    public function setRelation($relation, $relationColumn = null)
    {
        $this->relation = $relation;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        $this->relationColumn = $relationColumn;

        return $this;
    }

    /**
     * If this column is relation column.
     *
     * @return bool
     */
    protected function isRelation()
    {
        return (bool) $this->relation;
    }

    /**
     * Set sort value.
     *
     * @param bool $sort
     * @return Column
     */
    public function sort($sort)
    {
        $this->sortable = $sort;

        return $this;
    }

    /**
     * Mark this column as sortable.
     *
     * @return Column
     */
    public function sortable()
    {
        return $this->sort(true);
    }

    /**
     * Add a display callback.
     *
     * @param Closure $callback
     *
     * @return $this
     */
    public function display(Closure $callback)
    {
        $this->displayCallbacks[] = $callback;

        return $this;
    }

    /**
     * Display using display abstract.
     *
     * @param string $abstract
     * @param array  $arguments
     *
     * @return Column
     */
    public function displayUsing($abstract, $arguments = [])
    {
        $grid = $this->grid;

        $column = $this;

        return $this->display(function ($value) use ($grid, $column, $abstract, $arguments) {

            /** @var AbstractDisplayer $displayer */
            $displayer = new $abstract($value, $grid, $column, $this);

            return $displayer->display(...$arguments);

        });
    }

    /**
     * Display column using array value map.
     *
     * @param array $values
     * @param null  $default
     *
     * @return $this
     */
    public function using(array $values, $default = null)

    {
        return $this->display(function ($value) use ($values, $default) {
            if (is_null($value)) {
                return $default;
            }

            return array_get($values, $value, $default);
        });
    }

    /**
     * Render this column with the given view.
     *
     * @param string $view
     *
     * @return $this
     */
    public function view($view)
    {
        return $this->display(function ($value) use ($view) {
            $model = $this;

            return view($view, compact('model', 'value'))->render();
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.
}
        });
    }

    /**
     * If has display callbacks.
     *
     * @return bool
     */
    protected function hasDisplayCallbacks()
    {
        return !empty($this->displayCallbacks);
    }

    /**
     * Call all of the "display" callbacks column.
     *
     * @param mixed $value
     * @param int   $key
     *
     * @return mixed
     */
    protected function callDisplayCallbacks($value, $key)
    {
        foreach ($this->displayCallbacks as $callback) {
            $previous = $value;

            $callback = $this->bindOriginalRowModel($callback, $key);
            $value = call_user_func_array($callback, [$value, $this]);

            if (($value instanceof static) &&
                ($last = array_pop($this->displayCallbacks))
            ) {
                $last = $this->bindOriginalRowModel($last, $key);
                $value = call_user_func($last, $previous);
            }
        }

        return $value;
    }

    /**
     * Set original grid data to column.
     *
     * @param Closure $callback
     * @param int     $key
     *
     * @return Closure
     */
    protected function bindOriginalRowModel(Closure $callback, $key)
    {
        $rowModel = static::$originalGridModels[$key];

        return $callback->bindTo($rowModel);
    }

    /**
     * Fill all data to every column.
     *
     * @param array $data
     *
     * @return mixed
     */
    public function fill(array $data)
    {
        foreach ($data as $key => &$row) {
            $this->original = $value = array_get($row, $this->name);

            $value = $this->htmlEntityEncode($value);

            array_set($row, $this->name, $value);

            if ($this->isDefinedColumn()) {
                $this->useDefinedColumn();
            }

            if ($this->hasDisplayCallbacks()) {
                $value = $this->callDisplayCallbacks($this->original, $key);
                array_set($row, $this->name, $value);
            }
        }

        return $data;
    }

    /**
     * If current column is a defined column.
     *
     * @return bool
     */
    protected function isDefinedColumn()
    {
        return array_key_exists($this->name, static::$defined);
    }

    /**
     * Use a defined column.
     *
     * @throws \Exception
     */
    protected function useDefinedColumn()
    {
        // clear all display callbacks.
        $this->displayCallbacks = [];

        $class = static::$defined[$this->name];

        if ($class instanceof Closure) {
            $this->display($class);

            return;
        }

        if (!class_exists($class) || !is_subclass_of($class, AbstractDisplayer::class)) {

            throw new \Exception("Invalid column definition [$class]");
        }

        $grid = $this->grid;
        $column = $this;

        $this->display(function ($value) use ($grid, $column, $class) {
            /** @var AbstractDisplayer $definition */
            $definition = new $class($value, $grid, $column, $this);

            return $definition->display();
        });
    }

    /**
     * Convert characters to HTML entities recursively.
     *
     * @param array|string $item
     *
     * @return mixed
     */
    protected function htmlEntityEncode($item)
    {
        if (is_array($item)) {
            array_walk_recursive($item, function (&$value) {
                $value = htmlentities($value);
            });
        } else {
            $item = htmlentities($item);
        }

        return $item;
    }

    /**
     * Create the column sorter.
     *
     * @return string
     */
    public function sorter()
    {
        if (!$this->sortable) {
            return '';
        }

        $icon = 'fa-sort';
        $type = 'desc';

        if ($this->isSorted()) {
            $type = $this->sort['type'] == 'desc' ? 'asc' : 'desc';
            $icon .= "-amount-{$this->sort['type']}";
        }

        $query = app('request')->all();
        $query = array_merge($query, [$this->grid->model()->getSortName() => ['column' => $this->name, 'type' => $type]]);

        $url = url()->current().'?'.http_build_query($query);

        return "<a class=\"fa fa-fw $icon\" href=\"$url\"></a>";
    }

    /**
     * Determine if this column is currently sorted.
     *
     * @return bool
     */
    protected function isSorted()
    {
        $this->sort = app('request')->get($this->grid->model()->getSortName());

        if (empty($this->sort)) {
            return false;
        }

        return isset($this->sort['column']) && $this->sort['column'] == $this->name;
    }

    /**
     * Find a displayer to display column.
     *
     * @param string $abstract
     * @param array  $arguments
     *
     * @return Column
     */
    protected function resolveDisplayer($abstract, $arguments)
    {
        if (array_key_exists($abstract, static::$displayers)) {
            return $this->callBuiltinDisplayer(static::$displayers[$abstract], $arguments);
        }

        return $this->callSupportDisplayer($abstract, $arguments);
    }

    /**
     * Call Illuminate/Support displayer.
     *
     * @param string $abstract
     * @param array  $arguments
     *
     * @return Column
     */
    protected function callSupportDisplayer($abstract, $arguments)
    {
        return $this->display(function ($value) use ($abstract, $arguments) {
            if (is_array($value) || $value instanceof Arrayable) {
                return call_user_func_array([collect($value), $abstract], $arguments);
            }

            if (is_string($value)) {
                return call_user_func_array([Str::class, $abstract], array_merge([$value], $arguments));
            }

            return $value;
        });
    }

    /**
     * Call Builtin displayer.
     *
     * @param string $abstract
     * @param array  $arguments
     *
     * @return Column
     */
    protected function callBuiltinDisplayer($abstract, $arguments)
    {
        if ($abstract instanceof Closure) {
            return $this->display(function ($value) use ($abstract, $arguments) {
                return $abstract->call($this, ...array_merge([$value], $arguments));
            });
        }

        if (class_exists($abstract) && is_subclass_of($abstract, AbstractDisplayer::class)) {

            $grid = $this->grid;
            $column = $this;

            return $this->display(function ($value) use ($abstract, $grid, $column, $arguments) {

                /** @var AbstractDisplayer $displayer */
                $displayer = new $abstract($value, $grid, $column, $this);

                return $displayer->display(...$arguments);

            });
        }

        return $this;
    }

    /**
     * Passes through all unknown calls to builtin displayer or supported displayer.
     *
     * Allow fluent calls on the Column object.
     *
     * @param string $method
     * @param array  $arguments
     *
     * @return $this
     */
    public function __call($method, $arguments)
    {
        if ($this->isRelation() && !$this->relationColumn) {
            $this->name = "{$this->relation}.$method";
            $this->label = isset($arguments[0]) ? $arguments[0] : ucfirst($method);

            $this->relationColumn = $method;

            return $this;
        }

        return $this->resolveDisplayer($method, $arguments);
    }
}


1		<?php
2
3		namespace Encore\Admin\Grid;
4
5		use Closure;
6		use Encore\Admin\Grid;
7		use Encore\Admin\Grid\Displayers\AbstractDisplayer;
8		use Illuminate\Contracts\Support\Arrayable;
9		use Illuminate\Database\Eloquent\Model;
		0 ignored issues – show Bug introduced 2017-09-01 02:27 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Encore\Admin\Grid\Model`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
10		use Illuminate\Support\Collection;
11		use Illuminate\Support\Str;
12
13		class Column
14		{
15		/**
16		* @var Grid
17		*/
18		protected $grid;
19
20		/**
21		* Name of column.
22		*
23		* @var string
24		*/
25		protected $name;
26
27		/**
28		* Label of column.
29		*
30		* @var string
31		*/
32		protected $label;
33
34		/**
35		* Original value of column.
36		*
37		* @var mixed
38		*/
39		protected $original;
40
41		/**
42		* Is column sortable.
43		*
44		* @var bool
45		*/
46		protected $sortable = false;
47
48		/**
49		* Sort arguments.
50		*
51		* @var array
52		*/
53		protected $sort;
54
55		/**
56		* Attributes of column.
57		*
58		* @var array
59		*/
60		protected $attributes = [];
61
62		/**
63		* Relation name.
64		*
65		* @var bool
66		*/
67		protected $relation = false;
68
69		/**
70		* Relation column.
71		*
72		* @var string
73		*/
74		protected $relationColumn;
75
76		/**
77		* Original grid data.
78		*
79		* @var Collection
80		*/
81		protected static $originalGridModels;
82
83		/**
84		* @var []Closure
85		*/
86		protected $displayCallbacks = [];
87
88		/**
89		* Displayers for grid column.
90		*
91		* @var array
92		*/
93		public static $displayers = [];
94
95		/**
96		* Defined columns.
97		*
98		* @var array
99		*/
100		public static $defined = [];
101
102		/**
103		* @var array
104		*/
105		protected static $htmlAttributes = [];
106
107		/**
108		* @var Model
109		*/
110		protected static $model;
111
112		const SELECT_COLUMN_NAME = '__row_selector__';
113
114		/**
115		* @param string $name
116		* @param string $label
117		*/
118		public function __construct($name, $label)
119		{
120		$this->name = $name;
121
122		$this->label = $this->formatLabel($label);
123		}
124
125		/**
126		* Extend column displayer.
127		*
128		* @param $name
129		* @param $displayer
130		*/
131		public static function extend($name, $displayer)
132		{
133		static::$displayers[$name] = $displayer;
134		}
135
136		/**
137		* Define a column globally.
138		*
139		* @param string $name
140		* @param mixed $definition
141		*/
142		public static function define($name, $definition)
143		{
144		static::$defined[$name] = $definition;
145		}
146
147		/**
148		* Set grid instance for column.
149		*
150		* @param Grid $grid
151		*/
152		public function setGrid(Grid $grid)
153		{
154		$this->grid = $grid;
155
156		$this->setModel($grid->model()->eloquent());
157		}
158
159		/**
160		* Set model for column.
161		*
162		* @param $model
163		*/
164		public function setModel($model)
165		{
166		if (is_null(static::$model) && ($model instanceof Model)) {
167		static::$model = $model->newInstance();
168		}
169		}
170
171		/**
172		* Set original data for column.
173		*
174		* @param Collection $collection
175		*/
176		public static function setOriginalGridModels(Collection $collection)
177		{
178		static::$originalGridModels = $collection;
179		}
180
181		/**
182		* Set column attributes.
183		*
184		* @param array $attributes
185		*
186		* @return $this
187		*/
188		public function setAttributes($attributes = [])
189		{
190		static::$htmlAttributes[$this->name] = $attributes;
191
192		return $this;
193		}
194
195		/**
196		* Get column attributes.
197		*
198		* @param string $name
199		*
200		* @return mixed
201		*/
202		public static function getAttributes($name)
203		{
204		return array_get(static::$htmlAttributes, $name, '');
205		}
206
207		/**
208		* Set style of this column.
209		*
210		* @param string $style
211		*
212		* @return Column
213		*/
214		public function style($style)
215		{
216		return $this->setAttributes(compact('style'));
217		}
218
219		/**
220		* Get name of this column.
221		*
222		* @return mixed
223		*/
224		public function getName()
225		{
226		return $this->name;
227		}
228
229		/**
230		* Format label.
231		*
232		* @param $label
233		*
234		* @return mixed
235		*/
236		protected function formatLabel($label)
237		{
238		$label = $label ?: ucfirst($this->name);
239
240		return str_replace(['.', '_'], ' ', $label);
241		}
242
243		/**
244		* Get label of the column.
245		*
246		* @return mixed
247		*/
248		public function getLabel()
249		{
250		return $this->label;
251		}
252
253		/**
254		* Set relation.
255		*
256		* @param string $relation
257		* @param string $relationColumn
258		*
259		* @return $this
260		*/
261		public function setRelation($relation, $relationColumn = null)
262		{
263		$this->relation = $relation;
		0 ignored issues – show Documentation Bug introduced 2017-09-01 02:27 UTC by Report Bug Copy Issue Report The property `$relation` was declared of type `boolean`, but `$relation` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
264		$this->relationColumn = $relationColumn;
265
266		return $this;
267		}
268
269		/**
270		* If this column is relation column.
271		*
272		* @return bool
273		*/
274		protected function isRelation()
275		{
276		return (bool) $this->relation;
277		}
278
279		/**
280		* Set sort value.
281		*
282		* @param bool $sort
283		* @return Column
284		*/
285		public function sort($sort)
286		{
287		$this->sortable = $sort;
288
289		return $this;
290		}
291
292		/**
293		* Mark this column as sortable.
294		*
295		* @return Column
296		*/
297		public function sortable()
298		{
299		return $this->sort(true);
300		}
301
302		/**
303		* Add a display callback.
304		*
305		* @param Closure $callback
306		*
307		* @return $this
308		*/
309		public function display(Closure $callback)
310		{
311		$this->displayCallbacks[] = $callback;
312
313		return $this;
314		}
315
316		/**
317		* Display using display abstract.
318		*
319		* @param string $abstract
320		* @param array $arguments
321		*
322		* @return Column
323		*/
324		public function displayUsing($abstract, $arguments = [])
325		{
326		$grid = $this->grid;
327
328		$column = $this;
329
330	View Code Duplication	return $this->display(function ($value) use ($grid, $column, $abstract, $arguments) {
		0 ignored issues – show Duplication introduced 2018-09-27 13:35 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...
331		/** @var AbstractDisplayer $displayer */
332		$displayer = new $abstract($value, $grid, $column, $this);
333
334		return $displayer->display(...$arguments);
		0 ignored issues – show Unused Code introduced 2018-09-09 16:40 UTC by Report Bug Copy Issue Report The call to `AbstractDisplayer::display()` has too many arguments starting with `$arguments`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
335		});
336		}
337
338		/**
339		* Display column using array value map.
340		*
341		* @param array $values
342		* @param null $default
343		*
344		* @return $this
345		*/
346	View Code Duplication	public function using(array $values, $default = null)
		0 ignored issues – show Duplication introduced 2018-08-02 14:43 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
347		{
348		return $this->display(function ($value) use ($values, $default) {
349		if (is_null($value)) {
350		return $default;
351		}
352
353		return array_get($values, $value, $default);
354		});
355		}
356
357		/**
358		* Render this column with the given view.
359		*
360		* @param string $view
361		*
362		* @return $this
363		*/
364		public function view($view)
365		{
366		return $this->display(function ($value) use ($view) {
367		$model = $this;
368
369		return view($view, compact('model', 'value'))->render();
		0 ignored issues – show Bug introduced 2018-08-27 16:40 UTC by Report Bug Copy Issue Report The method `render` does only exist in `Illuminate\View\View`, but not in `Illuminate\Contracts\View\Factory`. 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...
370		});
371		}
372
373		/**
374		* If has display callbacks.
375		*
376		* @return bool
377		*/
378		protected function hasDisplayCallbacks()
379		{
380		return !empty($this->displayCallbacks);
381		}
382
383		/**
384		* Call all of the "display" callbacks column.
385		*
386		* @param mixed $value
387		* @param int $key
388		*
389		* @return mixed
390		*/
391		protected function callDisplayCallbacks($value, $key)
392		{
393		foreach ($this->displayCallbacks as $callback) {
394		$previous = $value;
395
396		$callback = $this->bindOriginalRowModel($callback, $key);
397		$value = call_user_func_array($callback, [$value, $this]);
398
399		if (($value instanceof static) &&
400		($last = array_pop($this->displayCallbacks))
401		) {
402		$last = $this->bindOriginalRowModel($last, $key);
403		$value = call_user_func($last, $previous);
404		}
405		}
406
407		return $value;
408		}
409
410		/**
411		* Set original grid data to column.
412		*
413		* @param Closure $callback
414		* @param int $key
415		*
416		* @return Closure
417		*/
418		protected function bindOriginalRowModel(Closure $callback, $key)
419		{
420		$rowModel = static::$originalGridModels[$key];
421
422		return $callback->bindTo($rowModel);
423		}
424
425		/**
426		* Fill all data to every column.
427		*
428		* @param array $data
429		*
430		* @return mixed
431		*/
432		public function fill(array $data)
433		{
434		foreach ($data as $key => &$row) {
435		$this->original = $value = array_get($row, $this->name);
436
437		$value = $this->htmlEntityEncode($value);
438
439		array_set($row, $this->name, $value);
440
441		if ($this->isDefinedColumn()) {
442		$this->useDefinedColumn();
443		}
444
445		if ($this->hasDisplayCallbacks()) {
446		$value = $this->callDisplayCallbacks($this->original, $key);
447		array_set($row, $this->name, $value);
448		}
449		}
450
451		return $data;
452		}
453
454		/**
455		* If current column is a defined column.
456		*
457		* @return bool
458		*/
459		protected function isDefinedColumn()
460		{
461		return array_key_exists($this->name, static::$defined);
462		}
463
464		/**
465		* Use a defined column.
466		*
467		* @throws \Exception
468		*/
469		protected function useDefinedColumn()
470		{
471		// clear all display callbacks.
472		$this->displayCallbacks = [];
473
474		$class = static::$defined[$this->name];
475
476		if ($class instanceof Closure) {
477		$this->display($class);
478
479		return;
480		}
481
482		if (!class_exists($class) \|\| !is_subclass_of($class, AbstractDisplayer::class)) {
		0 ignored issues – show Bug introduced 2017-09-01 02:27 UTC by Report Bug Copy Issue Report Due to PHP Bug #53727, `is_subclass_of` might return inconsistent results on some PHP versions if `\Encore\Admin\Grid\Displ...bstractDisplayer::class` can be an interface. If so, you could instead use `ReflectionClass::implementsInterface`. Loading history...
483		throw new \Exception("Invalid column definition [$class]");
484		}
485
486		$grid = $this->grid;
487		$column = $this;
488
489		$this->display(function ($value) use ($grid, $column, $class) {
490		/** @var AbstractDisplayer $definition */
491		$definition = new $class($value, $grid, $column, $this);
492
493		return $definition->display();
494		});
495		}
496
497		/**
498		* Convert characters to HTML entities recursively.
499		*
500		* @param array\|string $item
501		*
502		* @return mixed
503		*/
504		protected function htmlEntityEncode($item)
505		{
506		if (is_array($item)) {
507		array_walk_recursive($item, function (&$value) {
508		$value = htmlentities($value);
509		});
510		} else {
511		$item = htmlentities($item);
512		}
513
514		return $item;
515		}
516
517		/**
518		* Create the column sorter.
519		*
520		* @return string
521		*/
522		public function sorter()
523		{
524		if (!$this->sortable) {
525		return '';
526		}
527
528		$icon = 'fa-sort';
529		$type = 'desc';
530
531		if ($this->isSorted()) {
532		$type = $this->sort['type'] == 'desc' ? 'asc' : 'desc';
533		$icon .= "-amount-{$this->sort['type']}";
534		}
535
536		$query = app('request')->all();
537		$query = array_merge($query, [$this->grid->model()->getSortName() => ['column' => $this->name, 'type' => $type]]);
538
539		$url = url()->current().'?'.http_build_query($query);
540
541		return "<a class=\"fa fa-fw $icon\" href=\"$url\"></a>";
542		}
543
544		/**
545		* Determine if this column is currently sorted.
546		*
547		* @return bool
548		*/
549		protected function isSorted()
550		{
551		$this->sort = app('request')->get($this->grid->model()->getSortName());
552
553		if (empty($this->sort)) {
554		return false;
555		}
556
557		return isset($this->sort['column']) && $this->sort['column'] == $this->name;
558		}
559
560		/**
561		* Find a displayer to display column.
562		*
563		* @param string $abstract
564		* @param array $arguments
565		*
566		* @return Column
567		*/
568		protected function resolveDisplayer($abstract, $arguments)
569		{
570		if (array_key_exists($abstract, static::$displayers)) {
571		return $this->callBuiltinDisplayer(static::$displayers[$abstract], $arguments);
572		}
573
574		return $this->callSupportDisplayer($abstract, $arguments);
575		}
576
577		/**
578		* Call Illuminate/Support displayer.
579		*
580		* @param string $abstract
581		* @param array $arguments
582		*
583		* @return Column
584		*/
585		protected function callSupportDisplayer($abstract, $arguments)
586		{
587		return $this->display(function ($value) use ($abstract, $arguments) {
588		if (is_array($value) \|\| $value instanceof Arrayable) {
589		return call_user_func_array([collect($value), $abstract], $arguments);
590		}
591
592		if (is_string($value)) {
593		return call_user_func_array([Str::class, $abstract], array_merge([$value], $arguments));
594		}
595
596		return $value;
597		});
598		}
599
600		/**
601		* Call Builtin displayer.
602		*
603		* @param string $abstract
604		* @param array $arguments
605		*
606		* @return Column
607		*/
608		protected function callBuiltinDisplayer($abstract, $arguments)
609		{
610		if ($abstract instanceof Closure) {
611		return $this->display(function ($value) use ($abstract, $arguments) {
612		return $abstract->call($this, ...array_merge([$value], $arguments));
613		});
614		}
615
616		if (class_exists($abstract) && is_subclass_of($abstract, AbstractDisplayer::class)) {
		0 ignored issues – show Bug introduced 2017-09-01 02:27 UTC by Report Bug Copy Issue Report Due to PHP Bug #53727, `is_subclass_of` might return inconsistent results on some PHP versions if `\Encore\Admin\Grid\Displ...bstractDisplayer::class` can be an interface. If so, you could instead use `ReflectionClass::implementsInterface`. Loading history...
617		$grid = $this->grid;
618		$column = $this;
619
620	View Code Duplication	return $this->display(function ($value) use ($abstract, $grid, $column, $arguments) {
		0 ignored issues – show Duplication introduced 2018-09-27 13:35 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...
621		/** @var AbstractDisplayer $displayer */
622		$displayer = new $abstract($value, $grid, $column, $this);
623
624		return $displayer->display(...$arguments);
		0 ignored issues – show Unused Code introduced 2018-09-27 13:35 UTC by Report Bug Copy Issue Report The call to `AbstractDisplayer::display()` has too many arguments starting with `$arguments`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
625		});
626		}
627
628		return $this;
629		}
630
631		/**
632		* Passes through all unknown calls to builtin displayer or supported displayer.
633		*
634		* Allow fluent calls on the Column object.
635		*
636		* @param string $method
637		* @param array $arguments
638		*
639		* @return $this
640		*/
641		public function __call($method, $arguments)
642		{
643		if ($this->isRelation() && !$this->relationColumn) {
644		$this->name = "{$this->relation}.$method";
645		$this->label = isset($arguments[0]) ? $arguments[0] : ucfirst($method);
646
647		$this->relationColumn = $method;
648
649		return $this;
650		}
651
652		return $this->resolveDisplayer($method, $arguments);
653		}
654		}
655

z-song / laravel-admin

Pull Request — master (#2820)

Column::sort() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like