Column::displayUsing() - Code Metrics - Inspection of "[refactor]" - z-song/laravel-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 959f3b...22ac2d )

by Song

created 2018-09-27 13:32 UTC

Column::displayUsing() A

↳ Parent: Column

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	6
Ratio	46.15 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	2
dl	6
loc	13
rs	9.8333
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;
    }

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

        return $this;
    }

    /**
     * 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		* Mark this column as sortable.
281		*
282		* @return Column
283		*/
284		public function sortable()
285		{
286		$this->sortable = true;
287
288		return $this;
289		}
290
291		/**
292		* Add a display callback.
293		*
294		* @param Closure $callback
295		*
296		* @return $this
297		*/
298		public function display(Closure $callback)
299		{
300		$this->displayCallbacks[] = $callback;
301
302		return $this;
303		}
304
305		/**
306		* Display using display abstract.
307		*
308		* @param string $abstract
309		* @param array $arguments
310		* @return Column
311		*/
312		public function displayUsing($abstract, $arguments =[])
313		{
314		$grid = $this->grid;
315
316		$column = $this;
317
318	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...
319		/** @var AbstractDisplayer $displayer */
320		$displayer = new $abstract($value, $grid, $column, $this);
321
322		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...
323		});
324		}
325
326		/**
327		* Display column using array value map.
328		*
329		* @param array $values
330		* @param null $default
331		*
332		* @return $this
333		*/
334	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...
335		{
336		return $this->display(function ($value) use ($values, $default) {
337		if (is_null($value)) {
338		return $default;
339		}
340
341		return array_get($values, $value, $default);
342		});
343		}
344
345		/**
346		* Render this column with the given view.
347		*
348		* @param string $view
349		*
350		* @return $this
351		*/
352		public function view($view)
353		{
354		return $this->display(function ($value) use ($view) {
355		$model = $this;
356
357		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...
358		});
359		}
360
361		/**
362		* If has display callbacks.
363		*
364		* @return bool
365		*/
366		protected function hasDisplayCallbacks()
367		{
368		return !empty($this->displayCallbacks);
369		}
370
371		/**
372		* Call all of the "display" callbacks column.
373		*
374		* @param mixed $value
375		* @param int $key
376		*
377		* @return mixed
378		*/
379		protected function callDisplayCallbacks($value, $key)
380		{
381		foreach ($this->displayCallbacks as $callback) {
382		$previous = $value;
383
384		$callback = $this->bindOriginalRowModel($callback, $key);
385		$value = call_user_func_array($callback, [$value, $this]);
386
387		if (($value instanceof static) &&
388		($last = array_pop($this->displayCallbacks))
389		) {
390		$last = $this->bindOriginalRowModel($last, $key);
391		$value = call_user_func($last, $previous);
392		}
393		}
394
395		return $value;
396		}
397
398		/**
399		* Set original grid data to column.
400		*
401		* @param Closure $callback
402		* @param int $key
403		*
404		* @return Closure
405		*/
406		protected function bindOriginalRowModel(Closure $callback, $key)
407		{
408		$rowModel = static::$originalGridModels[$key];
409
410		return $callback->bindTo($rowModel);
411		}
412
413		/**
414		* Fill all data to every column.
415		*
416		* @param array $data
417		*
418		* @return mixed
419		*/
420		public function fill(array $data)
421		{
422		foreach ($data as $key => &$row) {
423		$this->original = $value = array_get($row, $this->name);
424
425		$value = $this->htmlEntityEncode($value);
426
427		array_set($row, $this->name, $value);
428
429		if ($this->isDefinedColumn()) {
430		$this->useDefinedColumn();
431		}
432
433		if ($this->hasDisplayCallbacks()) {
434		$value = $this->callDisplayCallbacks($this->original, $key);
435		array_set($row, $this->name, $value);
436		}
437		}
438
439		return $data;
440		}
441
442		/**
443		* If current column is a defined column.
444		*
445		* @return bool
446		*/
447		protected function isDefinedColumn()
448		{
449		return array_key_exists($this->name, static::$defined);
450		}
451
452		/**
453		* Use a defined column.
454		*
455		* @throws \Exception
456		*/
457		protected function useDefinedColumn()
458		{
459		// clear all display callbacks.
460		$this->displayCallbacks = [];
461
462		$class = static::$defined[$this->name];
463
464		if ($class instanceof Closure) {
465		$this->display($class);
466
467		return;
468		}
469
470		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...
471		throw new \Exception("Invalid column definition [$class]");
472		}
473
474		$grid = $this->grid;
475		$column = $this;
476
477		$this->display(function ($value) use ($grid, $column, $class) {
478		/** @var AbstractDisplayer $definition */
479		$definition = new $class($value, $grid, $column, $this);
480
481		return $definition->display();
482		});
483		}
484
485		/**
486		* Convert characters to HTML entities recursively.
487		*
488		* @param array\|string $item
489		*
490		* @return mixed
491		*/
492		protected function htmlEntityEncode($item)
493		{
494		if (is_array($item)) {
495		array_walk_recursive($item, function (&$value) {
496		$value = htmlentities($value);
497		});
498		} else {
499		$item = htmlentities($item);
500		}
501
502		return $item;
503		}
504
505		/**
506		* Create the column sorter.
507		*
508		* @return string
509		*/
510		public function sorter()
511		{
512		if (!$this->sortable) {
513		return '';
514		}
515
516		$icon = 'fa-sort';
517		$type = 'desc';
518
519		if ($this->isSorted()) {
520		$type = $this->sort['type'] == 'desc' ? 'asc' : 'desc';
521		$icon .= "-amount-{$this->sort['type']}";
522		}
523
524		$query = app('request')->all();
525		$query = array_merge($query, [$this->grid->model()->getSortName() => ['column' => $this->name, 'type' => $type]]);
526
527		$url = url()->current().'?'.http_build_query($query);
528
529		return "<a class=\"fa fa-fw $icon\" href=\"$url\"></a>";
530		}
531
532		/**
533		* Determine if this column is currently sorted.
534		*
535		* @return bool
536		*/
537		protected function isSorted()
538		{
539		$this->sort = app('request')->get($this->grid->model()->getSortName());
540
541		if (empty($this->sort)) {
542		return false;
543		}
544
545		return isset($this->sort['column']) && $this->sort['column'] == $this->name;
546		}
547
548		/**
549		* Find a displayer to display column.
550		*
551		* @param string $abstract
552		* @param array $arguments
553		*
554		* @return Column
555		*/
556		protected function resolveDisplayer($abstract, $arguments)
557		{
558		if (array_key_exists($abstract, static::$displayers)) {
559		return $this->callBuiltinDisplayer(static::$displayers[$abstract], $arguments);
560		}
561
562		return $this->callSupportDisplayer($abstract, $arguments);
563		}
564
565		/**
566		* Call Illuminate/Support displayer.
567		*
568		* @param string $abstract
569		* @param array $arguments
570		*
571		* @return Column
572		*/
573		protected function callSupportDisplayer($abstract, $arguments)
574		{
575		return $this->display(function ($value) use ($abstract, $arguments) {
576		if (is_array($value) \|\| $value instanceof Arrayable) {
577		return call_user_func_array([collect($value), $abstract], $arguments);
578		}
579
580		if (is_string($value)) {
581		return call_user_func_array([Str::class, $abstract], array_merge([$value], $arguments));
582		}
583
584		return $value;
585		});
586		}
587
588		/**
589		* Call Builtin displayer.
590		*
591		* @param string $abstract
592		* @param array $arguments
593		*
594		* @return Column
595		*/
596		protected function callBuiltinDisplayer($abstract, $arguments)
597		{
598		if ($abstract instanceof Closure) {
599		return $this->display(function ($value) use ($abstract, $arguments) {
600		return $abstract->call($this, ...array_merge([$value], $arguments));
601		});
602		}
603
604		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...
605		$grid = $this->grid;
606		$column = $this;
607
608	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...
609		/** @var AbstractDisplayer $displayer */
610		$displayer = new $abstract($value, $grid, $column, $this);
611
612		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...
613		});
614		}
615
616		return $this;
617		}
618
619		/**
620		* Passes through all unknown calls to builtin displayer or supported displayer.
621		*
622		* Allow fluent calls on the Column object.
623		*
624		* @param string $method
625		* @param array $arguments
626		*
627		* @return $this
628		*/
629		public function __call($method, $arguments)
630		{
631		if ($this->isRelation() && !$this->relationColumn) {
632		$this->name = "{$this->relation}.$method";
633		$this->label = isset($arguments[0]) ? $arguments[0] : ucfirst($method);
634
635		$this->relationColumn = $method;
636
637		return $this;
638		}
639
640		return $this->resolveDisplayer($method, $arguments);
641		}
642		}
643

z-song / laravel-admin

Push — master ( 959f3b...22ac2d )

Column::displayUsing() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like