give / src / Campaigns / ListTable / Routes / GetCampaignsListTable.php

GetCampaignsListTable.php in GiveWP – Donation Plugin and Fundraising Platform 4.17.0, at src/Campaigns/ListTable/Routes/GetCampaignsListTable.php

247 lines 7.2 KB

Raw Download Zip

1	<?php
2
3	namespace Give\Campaigns\ListTable\Routes;
4
5	use Give\API\REST\V3\Routes\Campaigns\ValueObjects\CampaignRoute;
6	use Give\API\RestRoute;
7	use Give\Campaigns\ListTable\CampaignsListTable;
8	use Give\Campaigns\ListTable\Columns\RevenueColumn;
9	use Give\Campaigns\Models\Campaign;
10	use Give\Campaigns\Repositories\CampaignRepository;
11	use Give\Campaigns\Repositories\CampaignsDataRepository;
12	use Give\Framework\Permissions\Facades\UserPermissions;
13	use Give\Framework\QueryBuilder\QueryBuilder;
14	use WP_Error;
15	use WP_REST_Request;
16	use WP_REST_Response;
17	use WP_REST_Server;
18
19	/**
20	* @since 4.0.0
21	*/
22	class GetCampaignsListTable implements RestRoute
23	{
24	/**
25	* @var string
26	*/
27	protected $endpoint = 'campaigns/list-table';
28
29	/**
30	* @var WP_REST_Request
31	*/
32	protected $request;
33
34	/**
35	* @var CampaignsListTable
36	*/
37	protected $listTable;
38
39	/**
40	* @since 4.0.0
41	*/
42	public function registerRoute(): void
43	{
44	register_rest_route(
45	CampaignRoute::NAMESPACE,
46	$this->endpoint,
47	[
48	[
49	'methods' => WP_REST_Server::READABLE,
50	'callback' => [$this, 'handleRequest'],
51	'permission_callback' => [$this, 'permissionsCheck'],
52	],
53	'args' => [
54	'page' => [
55	'type' => 'integer',
56	'default' => 1,
57	'minimum' => 1,
58	],
59	'perPage' => [
60	'type' => 'integer',
61	'default' => 30,
62	'minimum' => 1,
63	],
64	'search' => [
65	'type' => 'string',
66	'required' => false,
67	'sanitize_callback' => 'sanitize_text_field',
68	],
69	'status' => [
70	'type' => 'string',
71	'required' => false,
72	'sanitize_callback' => 'sanitize_text_field',
73	],
74	'sortColumn' => [
75	'type' => 'string',
76	'default' => 'id',
77	'sanitize_callback' => 'sanitize_text_field',
78	],
79	'sortDirection' => [
80	'type' => 'string',
81	'default' => 'asc',
82	'enum' => ['asc', 'desc'],
83	],
84	'locale' => [
85	'type' => 'string',
86	'required' => false,
87	'default' => get_locale(),
88	],
89	],
90	]
91	);
92	}
93
94	/**
95	* @since 4.12.0 add support for sorting by revenue column
96	* @since 4.0.0
97	*/
98	public function handleRequest(WP_REST_Request $request): WP_REST_Response
99	{
100	$this->request = $request;
101	$this->listTable = give(CampaignsListTable::class);
102	$sortColumns = $this->listTable->getSortColumnById($request->get_param('sortColumn') ?: 'id');
103	$sortDirection = $request->get_param('sortDirection') ?: 'desc';
104
105	$campaignsCount = $this->getTotalCampaignsCount();
106
107	if ($campaignsCount === 0) {
108	return new WP_REST_Response(
109	[
110	'items' => [],
111	'totalItems' => 0,
112	'totalPages' => 0,
113	]
114	);
115	}
116
117	$campaigns = $this->getCampaigns();
118	$pageCount = (int)ceil($campaignsCount / $request->get_param('perPage'));
119
120	$ids = array_map(function (Campaign $campaign) {
121	return $campaign->id;
122	}, $campaigns);
123
124	$campaignsData = CampaignsDataRepository::campaigns($ids);
125
126	// Sort by revenue column
127	if (in_array(RevenueColumn::getId(), $sortColumns)) {
128	usort($campaigns, function(Campaign $a, Campaign $b) use ($campaignsData, $sortDirection) {
129	return $sortDirection === 'asc'
130	? $campaignsData->getRevenue($a) <=> $campaignsData->getRevenue($b)
131	: $campaignsData->getRevenue($b) <=> $campaignsData->getRevenue($a);
132	});
133	}
134
135	$this->listTable
136	->setData($campaignsData)
137	->items($campaigns, $this->request->get_param('locale') ?? '');
138
139	$items = $this->listTable->getItems();
140
141	foreach ($items as $i => $item) {
142	$items[$i]['titleRaw'] = $campaigns[$i]->title;
143	}
144
145	return new WP_REST_Response(
146	[
147	'items' => $items,
148	'totalItems' => $campaignsCount,
149	'totalPages' => $pageCount,
150	]
151	);
152	}
153
154	/**
155	* @since 4.12.0 remove revenue column from sort
156	* @since 4.0.0
157	*/
158	public function getCampaigns(): array
159	{
160	$page = $this->request->get_param('page');
161	$perPage = $this->request->get_param('perPage');
162	$sortColumns = $this->listTable->getSortColumnById($this->request->get_param('sortColumn') ?: 'id');
163	$sortDirection = $this->request->get_param('sortDirection') ?: 'desc';
164
165	$query = give(CampaignRepository::class)->prepareQuery();
166	$query = $this->getWhereConditions($query);
167
168	foreach ($sortColumns as $sortColumn) {
169	if (RevenueColumn::getId() === $sortColumn) {
170	continue;
171	}
172
173	$query->orderBy($sortColumn, $sortDirection);
174	}
175
176	$query->limit($perPage)
177	->offset(($page - 1) * $perPage);
178
179	$campaigns = $query->getAll();
180
181	if ( ! $campaigns) {
182	return [];
183	}
184
185	return $campaigns;
186	}
187
188	/**
189	* @since 4.0.0
190	*/
191	public function getTotalCampaignsCount(): int
192	{
193	$query = Campaign::query();
194	$query = $this->getWhereConditions($query);
195
196	return $query->count();
197	}
198
199	/**
200	* @since 4.0.0
201	*/
202	private function getWhereConditions(QueryBuilder $query): QueryBuilder
203	{
204	$search = $this->request->get_param('search');
205	$status = $this->request->get_param('status');
206
207	if ($search) {
208	if (ctype_digit($search)) {
209	$query->where('id', $search);
210	} else {
211	$query->whereLike('campaign_title', $search);
212	$query->orWhereLike('short_desc', $search);
213	}
214	}
215
216	if ($status === 'any') {
217	$query->where('status', 'archived', '!=');
218	} elseif ($status === 'inactive') {
219	$query->where('status', 'archived');
220	} elseif ($status) {
221	$query->where('status', $status);
222	}
223
224	return $query;
225	}
226
227	/**
228	* @since 4.14.0 update permission capability to use facade
229	* @since 4.3.1 update permissions
230	* @since 4.0.0
231	*
232	* @return bool\|WP_Error
233	*/
234	public function permissionsCheck()
235	{
236	if (UserPermissions::campaigns()->canView()) {
237	return true;
238	}
239
240	return new WP_Error(
241	'rest_forbidden',
242	__("You don't have permission to view Campaigns", 'give'),
243	['status' => is_user_logged_in() ? 403 : 401]
244	);
245	}
246	}
247