|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
namespace Psi\Component\Grid; |
|
6
|
|
|
|
|
7
|
|
|
use Psi\Component\Grid\Grid; |
|
8
|
|
|
|
|
9
|
|
|
final class GridContext |
|
10
|
|
|
{ |
|
11
|
|
|
/** |
|
12
|
|
|
* @var array |
|
13
|
|
|
*/ |
|
14
|
|
|
private $options; |
|
15
|
|
|
|
|
16
|
|
|
/** |
|
17
|
|
|
* @var string |
|
18
|
|
|
*/ |
|
19
|
|
|
private $classFqn; |
|
20
|
|
|
|
|
21
|
|
|
public function __construct(string $classFqn, array $options) |
|
22
|
|
|
{ |
|
23
|
|
|
$this->classFqn = $classFqn; |
|
24
|
|
|
$defaults = [ |
|
25
|
|
|
'page_size' => 50, |
|
26
|
|
|
'page' => 1, |
|
27
|
|
|
'groups' => [ Grid::DEFAULT_GROUP ], |
|
28
|
|
|
'orderings' => [], |
|
29
|
|
|
'filter' => [], |
|
30
|
|
|
'variant' => Grid::DEFAULT_VARIANT, |
|
31
|
|
|
]; |
|
32
|
|
|
|
|
33
|
|
|
// check for invalid keys |
|
34
|
|
View Code Duplication |
if ($diff = array_diff(array_keys($options), array_keys($defaults))) { |
|
|
|
|
|
|
35
|
|
|
throw new \InvalidArgumentException(sprintf( |
|
36
|
|
|
'Invalid grid context options "%s". Valid options: "%s"', |
|
37
|
|
|
implode('", "', $diff), implode('", "', array_keys($defaults)) |
|
38
|
|
|
)); |
|
39
|
|
|
} |
|
40
|
|
|
|
|
41
|
|
|
// set defaults |
|
42
|
|
|
$options = array_merge($defaults, $options); |
|
43
|
|
|
|
|
44
|
|
|
// normalize the orderings |
|
45
|
|
|
$options['orderings'] = array_map(function ($order) { |
|
46
|
|
|
$order = strtolower($order); |
|
47
|
|
|
|
|
48
|
|
|
if (false === in_array($order, ['asc', 'desc'])) { |
|
49
|
|
|
throw new \InvalidArgumentException(sprintf( |
|
50
|
|
|
'Order must be either "asc" or "desc" got "%s"', |
|
51
|
|
|
$order |
|
52
|
|
|
)); |
|
53
|
|
|
} |
|
54
|
|
|
|
|
55
|
|
|
return $order; |
|
56
|
|
|
}, $options['orderings']); |
|
57
|
|
|
|
|
58
|
|
|
// cast integer values where applicable |
|
59
|
|
|
foreach (['page', 'page_size'] as $key) { |
|
60
|
|
|
$options[$key] = $options[$key] !== null ? (int) $options[$key] : null; |
|
61
|
|
|
} |
|
62
|
|
|
|
|
63
|
|
|
// ensure current page is > 0 |
|
64
|
|
|
if ($options['page'] < 1) { |
|
65
|
|
|
$options['page'] = 1; |
|
66
|
|
|
} |
|
67
|
|
|
|
|
68
|
|
|
$this->options = $options; |
|
69
|
|
|
} |
|
70
|
|
|
|
|
71
|
|
|
public function getCurrentPage(): int |
|
72
|
|
|
{ |
|
73
|
|
|
return $this->options['page']; |
|
74
|
|
|
} |
|
75
|
|
|
|
|
76
|
|
|
public function isPaginated(): bool |
|
77
|
|
|
{ |
|
78
|
|
|
return null !== $this->options['page_size']; |
|
79
|
|
|
} |
|
80
|
|
|
|
|
81
|
|
|
public function getPageSize(): int |
|
82
|
|
|
{ |
|
83
|
|
|
return $this->options['page_size']; |
|
84
|
|
|
} |
|
85
|
|
|
|
|
86
|
|
|
public function getPageOffset(): int |
|
87
|
|
|
{ |
|
88
|
|
|
return $this->isPaginated() ? ($this->getCurrentPage() - 1) * $this->getPageSize() : 0; |
|
89
|
|
|
} |
|
90
|
|
|
|
|
91
|
|
|
public function getOrderings(): array |
|
92
|
|
|
{ |
|
93
|
|
|
return $this->options['orderings']; |
|
94
|
|
|
} |
|
95
|
|
|
|
|
96
|
|
|
public function getVariant() |
|
97
|
|
|
{ |
|
98
|
|
|
return $this->options['variant']; |
|
99
|
|
|
} |
|
100
|
|
|
|
|
101
|
|
|
public function getFilter() |
|
102
|
|
|
{ |
|
103
|
|
|
return $this->options['filter']; |
|
104
|
|
|
} |
|
105
|
|
|
|
|
106
|
|
|
public function getUrlParameters(): array |
|
107
|
|
|
{ |
|
108
|
|
|
return $this->options; |
|
109
|
|
|
} |
|
110
|
|
|
|
|
111
|
|
|
public function getClassFqn(): string |
|
112
|
|
|
{ |
|
113
|
|
|
return $this->classFqn; |
|
114
|
|
|
} |
|
115
|
|
|
|
|
116
|
|
|
public function getGroups(): array |
|
117
|
|
|
{ |
|
118
|
|
|
return $this->options['groups']; |
|
119
|
|
|
} |
|
120
|
|
|
} |
|
121
|
|
|
|
psiphp /
grid
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.