give / src / Framework / ListTable / ListTable.php

ListTable.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.8.1, at src/Framework/ListTable/ListTable.php

202 lines 4.3 KB

Raw Download Zip

1	<?php
2
3	declare(strict_types=1);
4
5	namespace Give\Framework\ListTable;
6
7	use Exception;
8	use Give\Framework\ListTable\Concerns\Columns;
9	use Give\Framework\ListTable\Exceptions\ColumnIdCollisionException;
10	use Give\Framework\Models\Model;
11	use Give\Framework\Support\Contracts\Arrayable;
12	use Give\Log\Log;
13
14	/**
15	* @since 2.24.0
16	*/
17	abstract class ListTable implements Arrayable
18	{
19	use Columns;
20
21	/**
22	* @var array
23	*/
24	private $items = [];
25
26	/**
27	* @since 4.0.0
28	* @var array\|object
29	*/
30	private $data = [];
31
32	/**
33	* @since 2.24.0
34	*
35	* @throws ColumnIdCollisionException
36	*/
37	public function __construct()
38	{
39	$this->addColumns(...$this->getDefaultColumns());
40	}
41
42	/**
43	* Get table ID
44	*
45	* @since 2.24.0
46	*/
47	abstract public function id(): string;
48
49	/**
50	* Define table columns
51	*
52	* @since 2.24.0
53	*
54	* @return ModelColumn[]
55	*/
56	abstract protected function getDefaultColumns(): array;
57
58	/**
59	* Define default visible table columns
60	*
61	* @since 2.24.0
62	*
63	* @return string[]
64	*/
65	abstract protected function getDefaultVisibleColumns(): array;
66
67	/**
68	* Get table definitions
69	*
70	* @since 2.24.0
71	*
72	* @return array
73	*/
74	public function toArray(): array
75	{
76	return [
77	'id' => $this->id(),
78	'columns' => $this->getColumnsArray(),
79	];
80	}
81
82	/**
83	* Set table items
84	*
85	* @since 2.24.0
86	*
87	* @param array $items
88	* @param string $locale
89	*
90	* @return void
91	*/
92	public function items(array $items, string $locale = '')
93	{
94	$data = [];
95
96	$columns = $this->getColumns();
97
98	foreach ($items as $model) {
99	$row = [];
100
101	foreach ($columns as $column) {
102	if ($column->isUsingListTableData()) {
103	$column->setListTableData($this->getData());
104	}
105	$row[$column::getId()] = $this->safelyGetCellValue($column, $model, $locale);;
106	}
107
108	$data[] = $row;
109	}
110
111	$this->items = $data;
112	}
113
114	/**
115	* @since 2.24.0
116	*
117	* @return array
118	*/
119	public function getItems(): array
120	{
121	return $this->items;
122	}
123
124	/**
125	* @since 4.0.0
126	*
127	* @param array\|object $data
128	*
129	* @return ListTable
130	*/
131	public function setData($data): ListTable
132	{
133	$this->data = $data;
134
135	return $this;
136	}
137
138	/**
139	* @since 4.0.0
140	*
141	* @return array\|object
142	*/
143	public function getData()
144	{
145	return $this->data;
146	}
147
148	/**
149	* Safely retrieves the cell value for a column. If an exception is thrown, it will be logged and the cell value
150	* will be a human-readable error message. This is to prevent fatal errors from breaking the entire table.
151	*
152	* @since 2.24.1
153	*
154	* @return mixed
155	*/
156	private function safelyGetCellValue(ModelColumn $column, Model $model, string $locale)
157	{
158	try {
159	/**
160	* @since 3.16.0
161	*/
162	do_action("givewp_list_table_cell_value_{$column::getId()}_before", $column, $model, $locale);
163
164	/**
165	* @since 3.16.0
166	*/
167	$cellValue = apply_filters(
168	"givewp_list_table_cell_value_{$column::getId()}",
169	$column->getCellValue($model, $locale),
170	$column,
171	$model,
172	$locale
173	);
174	} catch (Exception $exception) {
175	Log::error(
176	sprintf(
177	'Error while rendering column "%s" for table "%s".',
178	$column::getId(),
179	$this->id()
180	),
181	[
182	'column' => $column::getId(),
183	'table' => $this->id(),
184	'model' => $model->toArray(),
185	'exception' => $exception->getMessage(),
186	]
187	);
188
189	$cellValue = sprintf(
190	__(
191	'Something went wrong, more in detail in <a href="%s">logs</a>',
192	'give'
193	),
194	admin_url('edit.php?post_type=give_forms&page=give-tools&tab=logs')
195	);
196	}
197
198	return $cellValue;
199	}
200	}
201
202