give / src / API / REST / V3 / Routes / Campaigns / CampaignRevenueController.php

CampaignRevenueController.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.8.1, at src/API/REST/V3/Routes/Campaigns/CampaignRevenueController.php

257 lines 7.7 KB

Raw Download Zip

1	<?php
2
3	namespace Give\API\REST\V3\Routes\Campaigns;
4
5	use DateInterval;
6	use DatePeriod;
7	use DateTime;
8	use DateTimeInterface;
9	use Exception;
10	use Give\API\REST\V3\Routes\Campaigns\ValueObjects\CampaignRoute;
11	use Give\Campaigns\CampaignDonationQuery;
12	use Give\Campaigns\Models\Campaign;
13	use Give\Framework\Permissions\Facades\UserPermissions;
14	use WP_Error;
15	use WP_REST_Controller;
16	use WP_REST_Response;
17	use WP_REST_Server;
18
19	/**
20	* @since 4.13.1
21	*/
22	class CampaignRevenueController extends WP_REST_Controller
23	{
24	/**
25	* @var string
26	*/
27	protected $namespace;
28
29	/**
30	* @since 4.13.1
31	*/
32	public function __construct()
33	{
34	$this->namespace = CampaignRoute::NAMESPACE;
35	}
36
37	/**
38	* @since 4.14.0 updated permission logic with UserPermissions facade
39	* @since 4.13.1
40	*/
41	public function register_routes()
42	{
43	register_rest_route(
44	$this->namespace,
45	'/' . CampaignRoute::CAMPAIGN . '/revenue',
46	[
47	[
48	'methods' => WP_REST_Server::READABLE,
49	'callback' => [$this, 'get_items'],
50	'permission_callback' => function () {
51	return UserPermissions::campaigns()->canView();
52	},
53	'args' => [
54	'id' => [
55	'type' => 'integer',
56	'required' => true,
57	'sanitize_callback' => 'absint',
58	],
59	],
60	],
61	'schema' => [$this, 'get_public_item_schema'],
62	]
63	);
64	}
65
66	/**
67	* @since 4.13.1
68	* @throws Exception
69	*/
70	public function get_items($request): WP_REST_Response
71	{
72	$campaign = Campaign::find((int)$request->get_param('id'));
73
74	if (!$campaign) {
75	$response = new WP_Error('campaign_not_found', __('Campaign not found', 'give'), ['status' => 404]);
76
77	return rest_ensure_response($response);
78	}
79
80	$query = new CampaignDonationQuery($campaign);
81
82	$oldestRevenueDate = $query->getOldestDonationDate();
83
84	if (!$oldestRevenueDate) {
85	$items = new WP_REST_Response([]);
86
87	return rest_ensure_response($items);
88	}
89
90	$firstResultDate = new DateTime($oldestRevenueDate, wp_timezone());
91
92	// the query start date is the earliest of the first result date and the campaign start date
93	$queryStartDate = ($firstResultDate < $campaign->startDate) ? $firstResultDate : $campaign->startDate;
94	$queryEndDate = $campaign->endDate ?: current_datetime();
95
96	$groupBy = $this->getGroupByFromDateRange($queryStartDate, $queryEndDate);
97
98	$results = $query->getDonationsByDate($groupBy);
99
100	if (empty($results)) {
101	$items = new WP_REST_Response([]);
102
103	return rest_ensure_response($items);
104	}
105
106	// Map the results by date
107	$resultMap = $this->mapResultsByDate($results, $groupBy);
108
109	// Get all dates between the start and end date based on the group by
110	$endTimestamp = strtotime($queryEndDate->format('Y-m-d H:i:s') . ' +1 day');
111	$queryEndDatePlusOne = new DateTime(date('Y-m-d H:i:s', $endTimestamp), wp_timezone());
112	$dates = $this->getDatesFromRange($queryStartDate, $queryEndDatePlusOne, $groupBy);
113
114	// Merge the results with the dates to ensure that all dates are included
115	$data = $this->mergeResultsWithDates($dates, $resultMap);
116
117	$items = new WP_REST_Response($data);
118
119	return rest_ensure_response($items);
120	}
121
122	/**
123	* @since 4.13.1
124	*/
125	public function getDatesFromRange(DateTimeInterface $startDate, DateTimeInterface $endDate, string $groupBy): array
126	{
127	$startDateInterval = $startDate->diff($endDate);
128
129	// If the date range is less than 7 days, pad the start date to include the last 7 days
130	// This is to ensure that the chart always shows at least 7 days of data
131	$start = new DateTime($startDate->format('Y-m-d H:i:s'), wp_timezone());
132	if ($startDateInterval->days < 7) {
133	$defaultDays = 7 - $startDateInterval->days;
134	$start = new DateTime(date('Y-m-d H:i:s', strtotime($start->format('Y-m-d H:i:s') . " -$defaultDays days")), wp_timezone());
135	}
136
137	$differenceInMonths = ($startDateInterval->y * 12) + $startDateInterval->m;
138
139	$intervalTime = 'days';
140	if ($startDateInterval->y >= 5) {
141	// If the date range is more than 5 years, group by year
142	$intervalTime = 'years';
143	} elseif ($differenceInMonths >= 6) {
144	// If the date range is more than 6 months, group by month
145	$intervalTime = 'months';
146	}
147
148	$interval = DateInterval::createFromDateString("1 $intervalTime");
149	$dateRange = new DatePeriod($start, $interval, $endDate);
150
151	$dates = [];
152	foreach ($dateRange as $date) {
153	$dateFormatted = $this->getFormattedDateFromGroupBy($groupBy, $date);
154
155	$dates[] = $dateFormatted;
156	}
157
158	return $dates;
159	}
160
161	/**
162	* @since 4.13.1
163	*/
164	public function getGroupByFromDateRange(DateTimeInterface $startDate, DateTimeInterface $endDate): string
165	{
166	$startDateInterval = $startDate->diff($endDate);
167	$differenceInMonths = ($startDateInterval->y * 12) + $startDateInterval->m;
168
169	// If the date range is more than 1 year, group by month
170	if ($startDateInterval->y >= 5) {
171	return 'YEAR';
172	}
173
174	if ($differenceInMonths >= 6) {
175	// If the date range is more than 90 days, group by week
176	return 'MONTH';
177	}
178
179	return 'DAY';
180	}
181
182	/**
183	* @since 4.13.1
184	*/
185	public function getFormattedDateFromGroupBy(string $groupBy, DateTimeInterface $date): string
186	{
187	if ($groupBy === 'MONTH') {
188	return $date->format('Y-m');
189	}
190
191	if ($groupBy === 'YEAR') {
192	return $date->format('Y');
193	}
194
195	return $date->format('Y-m-d');
196	}
197
198	/**
199	* @since 4.13.1
200	*/
201	public function mergeResultsWithDates(array $dates, array $resultMap): array
202	{
203	$data = [];
204	// Fill in the data with the results
205	foreach ($dates as $date) {
206	$data[] = [
207	'date' => $date,
208	'amount' => $resultMap[$date] ?? 0
209	];
210	}
211
212	return $data;
213	}
214
215	/**
216	* @since 4.13.1
217	*/
218	public function mapResultsByDate(array $results, string $groupBy): array
219	{
220	$resultMap = [];
221	foreach ($results as $result) {
222	$date = $this->getFormattedDateFromGroupBy($groupBy, date_create($result->date_created));
223
224	$resultMap[$date] = (float)$result->amount;
225	}
226
227	return $resultMap;
228	}
229
230	/**
231	* @since 4.13.1
232	*/
233	public function get_item_schema(): array
234	{
235	return [
236	'title' => 'campaign-revenue',
237	'description' => esc_html__('Provides daily revenue data for a specific campaign.', 'give'),
238	'type' => 'array',
239	'readonly' => true,
240	'items' => [
241	'type' => 'object',
242	'properties' => [
243	'date' => [
244	'type' => 'string',
245	'format' => 'date',
246	'description' => esc_html__('The date for the revenue entry (YYYY-MM-DD).', 'give'),
247	],
248	'amount' => [
249	'type' => ['integer', 'number'],
250	'description' => esc_html__('The amount of revenue received on the given date.', 'give'),
251	],
252	]
253	]
254	];
255	}
256	}
257