Completed
Push — master ( cae265...e87c3d )
by Song
02:23
created

Column::sorter()   A

Complexity

Conditions 4
Paths 4

Size

Total Lines 21

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 4
nc 4
nop 0
dl 0
loc 21
rs 9.584
c 0
b 0
f 0
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 by
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 by
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 column using array value map.
307
     *
308
     * @param array $values
309
     * @param null  $default
310
     *
311
     * @return $this
312
     */
313 View Code Duplication
    public function using(array $values, $default = null)
0 ignored issues
show
Duplication introduced by
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...
314
    {
315
        return $this->display(function ($value) use ($values, $default) {
316
            if (is_null($value)) {
317
                return $default;
318
            }
319
320
            return array_get($values, $value, $default);
321
        });
322
    }
323
324
    /**
325
     * Render this column with the given view.
326
     *
327
     * @param string $view
328
     *
329
     * @return $this
330
     */
331
    public function view($view)
332
    {
333
        return $this->display(function ($value) use ($view) {
334
            $model = $this;
335
336
            return view($view, compact('model', 'value'))->render();
0 ignored issues
show
Bug introduced by
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

  1. Add an additional type-check:

    /**
     * @param A|B $x
     */
    function someFunction($x)
    {
        $x->foo();
    
        if ($x instanceof B) {
            $x->bar();
        }
    }
    
  2. Only allow a single type to be passed if the variable comes from a parameter:

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