Skip to content
Navigation Menu
{{ message }}
forked from code16/sharp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSharpEntityList.php
More file actions
343 lines (282 loc) · 8.16 KB
/
Copy pathSharpEntityList.php
File metadata and controls
343 lines (282 loc) · 8.16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
<?php
namespace Code16\Sharp\EntityList;
use Code16\Sharp\EntityList\Commands\ReorderHandler;
use Code16\Sharp\EntityList\Containers\EntityListDataContainer;
use Code16\Sharp\EntityList\Layout\EntityListLayoutColumn;
use Code16\Sharp\EntityList\Traits\HandleCommands;
use Code16\Sharp\EntityList\Traits\HandleEntityState;
use Code16\Sharp\Utils\Filters\HandleFilters;
use Code16\Sharp\Utils\Transformers\WithCustomTransformers;
use Illuminate\Pagination\LengthAwarePaginator;
use Illuminate\Support\Collection;
abstract class SharpEntityList
{
use HandleFilters, HandleEntityState, HandleCommands, WithCustomTransformers;
/** @var array */
protected $containers = [];
/** @var array */
protected $columns = [];
/** @var bool */
protected $listBuilt = false;
/** @var bool */
protected $layoutBuilt = false;
/** @var string */
protected $instanceIdAttribute = "id";
/** @var string */
protected $multiformAttribute = null;
/** @var array */
protected $multiformEntityKeys = [];
/** @var string */
protected $displayMode = "list";
/** @var bool */
protected $searchable = false;
/** @var bool */
protected $paginated = false;
/** @var ReorderHandler */
protected $reorderHandler = null;
/** @var string */
protected $defaultSort;
/** @var string */
protected $defaultSortDir;
/**
* Get the SharpListDataContainer array representation.
*
* @return array
*/
function dataContainers(): array
{
$this->checkListIsBuilt();
return collect($this->containers)->map(function(EntityListDataContainer $container) {
return $container->toArray();
})->keyBy("key")->all();
}
/**
* Return the list fields layout.
*
* @return array
*/
function listLayout(): array
{
if(!$this->layoutBuilt) {
$this->buildListLayout();
$this->layoutBuilt = true;
}
return collect($this->columns)->map(function(EntityListLayoutColumn $column) {
return $column->toArray();
})->all();
}
/**
* Return data, as an array.
*
* @param array|Collection|null $items
* @return array
*/
function data($items = null): array
{
$this->putRetainedFilterValuesInSession();
$items = $items ?: $this->getListData(
EntityListQueryParams::create()
->setDefaultSort($this->defaultSort, $this->defaultSortDir)
->fillWithRequest()
->setDefaultFilters($this->getFilterDefaultValues())
);
if($items instanceof LengthAwarePaginator) {
$page = $items->currentPage();
$totalCount = $items->total();
$pageSize = $items->perPage();
$items = $items->items();
}
$this->addInstanceCommandsAuthorizationsToConfigForItems($items);
$keys = $this->getDataKeys();
return [
"items" =>
collect($items)
->map(function($row) use($keys) {
// Filter model attributes on actual form fields
return collect($row)->only(
array_merge(
$this->entityStateAttribute ? [$this->entityStateAttribute] : [],
$this->multiformAttribute ? [$this->multiformAttribute] : [],
[$this->instanceIdAttribute],
$keys
)
)->all();
})->all()
] + (isset($page) ? compact('page', 'totalCount', 'pageSize') : []);
}
/**
* Return the data config values.
*
* @return array
*/
function listConfig(): array
{
$config = [
"instanceIdAttribute" => $this->instanceIdAttribute,
"multiformAttribute" => $this->multiformAttribute,
"displayMode" => $this->displayMode,
"searchable" => $this->searchable,
"paginated" => $this->paginated,
"reorderable" => !is_null($this->reorderHandler),
"defaultSort" => $this->defaultSort,
"defaultSortDir" => $this->defaultSortDir,
];
$this->appendFiltersToConfig($config);
$this->appendEntityStateToConfig($config);
$this->appendCommandsToConfig($config);
return $config;
}
/**
* @param string $instanceIdAttribute
* @return $this
*/
public function setInstanceIdAttribute(string $instanceIdAttribute)
{
$this->instanceIdAttribute = $instanceIdAttribute;
return $this;
}
/**
* @param string $displayMode
* @return $this
*/
public function setDisplayMode(string $displayMode)
{
$this->displayMode = $displayMode;
return $this;
}
/**
* @param string|ReorderHandler $reorderHandler
* @return $this
*/
public function setReorderable($reorderHandler)
{
$this->reorderHandler = $reorderHandler instanceof ReorderHandler
? $reorderHandler
: app($reorderHandler);
return $this;
}
public function setNotReorderable()
{
$this->reorderHandler = null;
}
/**
* @param bool $searchable
* @return $this
*/
public function setSearchable(bool $searchable = true)
{
$this->searchable = $searchable;
return $this;
}
/**
* @param string $sortBy
* @param string $sortDir
* @return $this
*/
public function setDefaultSort(string $sortBy, string $sortDir = "asc")
{
$this->defaultSort = $sortBy;
$this->defaultSortDir = $sortDir;
return $this;
}
/**
* @param bool $paginated
* @return $this
*/
public function setPaginated(bool $paginated = true)
{
$this->paginated = $paginated;
return $this;
}
/**
* @param string $attribute
* @return $this
*/
protected function setMultiformAttribute(string $attribute)
{
$this->multiformAttribute = $attribute;
return $this;
}
/**
* @return ReorderHandler
*/
public function reorderHandler()
{
return $this->reorderHandler;
}
/**
* Add a data container.
*
* @param EntityListDataContainer $container
* @return $this
*/
protected function addDataContainer(EntityListDataContainer $container)
{
$this->containers[] = $container;
$this->listBuilt = false;
return $this;
}
/**
* @param string $label
* @param int $size
* @param null $sizeXS
* @return $this
*/
protected function addColumn(string $label, int $size, $sizeXS = null)
{
$this->layoutBuilt = false;
$this->columns[] = new EntityListLayoutColumn($label, $size, $sizeXS);
return $this;
}
/**
* @param string $label
* @param int $size
* @return $this
*/
protected function addColumnLarge(string $label, int $size)
{
$this->layoutBuilt = false;
$column = new EntityListLayoutColumn($label, $size);
$column->setLargeOnly(true);
$this->columns[] = $column;
return $this;
}
private function checkListIsBuilt()
{
if (!$this->listBuilt) {
$this->buildListDataContainers();
$this->listBuilt = true;
}
}
protected function getDataKeys()
{
return collect($this->dataContainers())
->pluck("key")
->all();
}
/**
* Retrieve all rows data as array.
*
* @param EntityListQueryParams $params
* @return array
*/
abstract function getListData(EntityListQueryParams $params);
/**
* Build list containers using ->addDataContainer()
*
* @return void
*/
abstract function buildListDataContainers();
/**
* Build list layout using ->addColumn()
*
* @return void
*/
abstract function buildListLayout();
/**
* Build list config
*
* @return void
*/
abstract function buildListConfig();
}
You can’t perform that action at this time.