ListTable.php
111 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Framework\ListTable; |
| 4 | |
| 5 | use Give\Framework\ListTable\Concerns\Columns; |
| 6 | use Give\Framework\ListTable\Exceptions\ColumnIdCollisionException; |
| 7 | use Give\Framework\Support\Contracts\Arrayable; |
| 8 | |
| 9 | /** |
| 10 | * @since 2.24.0 |
| 11 | */ |
| 12 | abstract class ListTable implements Arrayable |
| 13 | { |
| 14 | use Columns; |
| 15 | |
| 16 | /** |
| 17 | * @var array |
| 18 | */ |
| 19 | private $items = []; |
| 20 | |
| 21 | /** |
| 22 | * @since 2.24.0 |
| 23 | * |
| 24 | * @throws ColumnIdCollisionException |
| 25 | */ |
| 26 | public function __construct() |
| 27 | { |
| 28 | $this->addColumns(...$this->getDefaultColumns()); |
| 29 | } |
| 30 | |
| 31 | /** |
| 32 | * Get table ID |
| 33 | * |
| 34 | * @since 2.24.0 |
| 35 | */ |
| 36 | abstract public function id(): string; |
| 37 | |
| 38 | /** |
| 39 | * Define table columns |
| 40 | * |
| 41 | * @since 2.24.0 |
| 42 | * |
| 43 | * @return ModelColumn[] |
| 44 | */ |
| 45 | abstract protected function getDefaultColumns(): array; |
| 46 | |
| 47 | /** |
| 48 | * Define default visible table columns |
| 49 | * |
| 50 | * @since 2.24.0 |
| 51 | * |
| 52 | * @return string[] |
| 53 | */ |
| 54 | abstract protected function getDefaultVisibleColumns(): array; |
| 55 | |
| 56 | /** |
| 57 | * Get table definitions |
| 58 | * |
| 59 | * @since 2.24.0 |
| 60 | * |
| 61 | * @return array |
| 62 | */ |
| 63 | public function toArray(): array |
| 64 | { |
| 65 | return [ |
| 66 | 'id' => $this->id(), |
| 67 | 'columns' => $this->getColumnsArray() |
| 68 | ]; |
| 69 | } |
| 70 | |
| 71 | /** |
| 72 | * Set table items |
| 73 | * |
| 74 | * @since 2.24.0 |
| 75 | * |
| 76 | * @param array $items |
| 77 | * @param string $locale |
| 78 | * |
| 79 | * @return void |
| 80 | */ |
| 81 | public function items(array $items, string $locale = '') |
| 82 | { |
| 83 | $data = []; |
| 84 | |
| 85 | $columns = $this->getColumns(); |
| 86 | |
| 87 | foreach ($items as $model) { |
| 88 | $row = []; |
| 89 | |
| 90 | foreach ($columns as $column) { |
| 91 | $row[$column::getId()] = $column->getCellValue($model, $locale); |
| 92 | } |
| 93 | |
| 94 | $data[] = $row; |
| 95 | } |
| 96 | |
| 97 | $this->items = $data; |
| 98 | } |
| 99 | |
| 100 | /** |
| 101 | * @since 2.24.0 |
| 102 | * |
| 103 | * @return array |
| 104 | */ |
| 105 | public function getItems(): array |
| 106 | { |
| 107 | return $this->items; |
| 108 | } |
| 109 | } |
| 110 | |
| 111 |