give / src / API / Endpoints / Reports / AverageDonation.php

AverageDonation.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.9, at src/API/Endpoints/Reports/AverageDonation.php

223 lines 6.9 KB

Raw Download Zip

1	<?php
2
3	/**
4	* Income over time endpoint
5	*
6	* @package Give
7	*/
8
9	namespace Give\API\Endpoints\Reports;
10
11	use WP_REST_Request;
12
13	class AverageDonation extends Endpoint
14	{
15
16	protected $payments;
17
18	public function __construct()
19	{
20	$this->endpoint = 'average-donation';
21	}
22
23	/**
24	* Handle rest request.
25	*
26	* @since 2.6.0
27	*
28	* @param WP_REST_Request $request
29	*
30	* @return array
31	*/
32	public function getReport($request)
33	{
34	$start = date_create($request->get_param('start'));
35	$end = date_create($request->get_param('end'));
36	$diff = date_diff($start, $end);
37
38	$data = [];
39
40	switch (true) {
41	case ($diff->days > 12):
42	$interval = round($diff->days / 12);
43	$data = $this->get_data($start, $end, 'P' . $interval . 'D');
44	break;
45	case ($diff->days > 5):
46	$data = $this->get_data($start, $end, 'P1D');
47	break;
48	case ($diff->days > 4):
49	$data = $this->get_data($start, $end, 'PT12H');
50	break;
51	case ($diff->days > 2):
52	$data = $this->get_data($start, $end, 'PT3H');
53	break;
54	case ($diff->days >= 0):
55	$data = $this->get_data($start, $end, 'PT1H');
56	break;
57	}
58
59	return $data;
60	}
61
62	public function get_data($start, $end, $intervalStr)
63	{
64	$tooltips = [];
65	$income = [];
66
67	$interval = new \DateInterval($intervalStr);
68
69	$periodStart = clone $start;
70	$periodEnd = clone $start;
71
72	// Subtract interval to set up period start
73	date_sub($periodStart, $interval);
74
75	while ($periodStart < $end) {
76	$avgIncomeForPeriod = $this->get_average_income(
77	$periodStart->format('Y-m-d H:i:s'),
78	$periodEnd->format('Y-m-d H:i:s')
79	);
80	$time = $periodEnd->format('Y-m-d H:i:s');
81
82	switch ($intervalStr) {
83	case 'P1D':
84	$periodLabel = $periodStart->format('l');
85	break;
86	case 'PT12H':
87	case 'PT3H':
88	case 'PT1H':
89	$periodLabel = $periodStart->format('D ga') . ' - ' . $periodEnd->format('D ga');
90	break;
91	default:
92	$periodLabel = $periodStart->format('M j, Y') . ' - ' . $periodEnd->format('M j, Y');
93	}
94
95	$income[] = [
96	'x' => $time,
97	'y' => $avgIncomeForPeriod,
98	];
99
100	$tooltips[] = [
101	'title' => give_currency_filter(
102	give_format_amount($avgIncomeForPeriod),
103	[
104	'currency_code' => $this->currency,
105	'decode_currency' => true,
106	'sanitize' => false,
107	]
108	),
109	'body' => __('Avg Revenue', 'give'),
110	'footer' => $periodLabel,
111	];
112
113	// Add interval to set up next period
114	date_add($periodStart, $interval);
115	date_add($periodEnd, $interval);
116	}
117
118	if ($intervalStr === 'P1D') {
119	$income = array_slice($income, 1);
120	$tooltips = array_slice($tooltips, 1);
121	}
122
123	$totalAvgIncomeForPeriod = $this->get_average_income(
124	$start->format('Y-m-d H:i:s'),
125	$end->format('Y-m-d H:i:s')
126	);
127	$trend = $this->get_trend($start, $end, $income);
128
129	$diff = date_diff($start, $end);
130	$info = $diff->days > 1 ? __('VS previous', 'give') . ' ' . $diff->days . ' ' . __('days', 'give') : __(
131	'VS previous day',
132	'give'
133	);
134
135	// Create data object to be returned, with 'highlights' object containing total and average figures to display
136	$data = [
137	'datasets' => [
138	[
139	'data' => $income,
140	'tooltips' => $tooltips,
141	'trend' => $trend,
142	'info' => $info,
143	'highlight' => give_currency_filter(
144	give_format_amount($totalAvgIncomeForPeriod),
145	[
146	'currency_code' => $this->currency,
147	'decode_currency' => true,
148	'sanitize' => false,
149	]
150	),
151	],
152	],
153	];
154
155	return $data;
156	}
157
158	public function get_trend($start, $end, $income)
159	{
160	$interval = $start->diff($end);
161
162	$prevStart = clone $start;
163	$prevStart = date_sub($prevStart, $interval);
164
165	$prevEnd = clone $start;
166
167	$prevAverage = $this->get_average_income($prevStart->format('Y-m-d H:i:s'), $prevEnd->format('Y-m-d H:i:s'));
168	$currentAverage = $this->get_average_income($start->format('Y-m-d H:i:s'), $end->format('Y-m-d H:i:s'));
169
170	// Set default trend to 0
171	$trend = 0;
172
173	// Check that prev value and current value are > 0 (can't divide by 0)
174	if ($prevAverage > 0 && $currentAverage > 0) {
175	// Check if it is a percent decreate, or increase
176	if ($prevAverage > $currentAverage) {
177	// Calculate a percent decrease
178	$trend = ((($prevAverage - $currentAverage) / $prevAverage) * 100) * -1;
179	} elseif ($currentAverage > $prevAverage) {
180	// Calculate a percent increase
181	$trend = (($currentAverage - $prevAverage) / $prevAverage) * 100;
182	}
183	}
184
185	return $trend;
186	}
187
188	/**
189	* Calculate average income for a period
190	*
191	* Based on provided start and end strings, return the calculated income,
192	* rounded to the appropriate decimal place for the currently queried currency
193	*
194	* @since 2.6.0
195	**@param string $endStr Period end string
196	*
197	* @param string $startStr Period start string
198	*
199	* @return float Average income float (rounded to the decimal place of currently queried currency)
200	*/
201	public function get_average_income($startStr, $endStr)
202	{
203	$paymentObjects = $this->getPayments($startStr, $endStr);
204
205	$earnings = 0;
206	$paymentCount = 0;
207
208	foreach ($paymentObjects as $paymentObject) {
209	if ($paymentObject->date >= $startStr && $paymentObject->date < $endStr) {
210	if ($paymentObject->status == 'publish' \|\| $paymentObject->status == 'give_subscription') {
211	$earnings += $paymentObject->total;
212	$paymentCount += 1;
213	}
214	}
215	}
216
217	$averageIncome = $paymentCount > 0 ? $earnings / $paymentCount : 0;
218
219	// Return rounded average (avoid displaying figures with many decimal places)
220	return round($averageIncome, give_get_price_decimals($this->currency));
221	}
222	}
223