GetCampaignsListTable.php — GiveWP – Donation Plugin and Fundraising Platform 4.0.0

give / src / Campaigns / Routes / GetCampaignsListTable.php

give / src / Campaigns / Routes Last commit date

DeleteCampaignListTable.php 1 year ago GetCampaignComments.php 1 year ago GetCampaignRevenue.php 1 year ago GetCampaignStatistics.php 1 year ago GetCampaignsListTable.php 1 year ago RegisterCampaignRoutes.php 1 year ago

GetCampaignsListTable.php

218 lines

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