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

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

150 lines 4.3 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	class Income extends Endpoint
12	{
13
14	protected $payments;
15
16	public function __construct()
17	{
18	$this->endpoint = 'income';
19	}
20
21	public function getReport($request)
22	{
23	$start = date_create($request->get_param('start'));
24	$end = date_create($request->get_param('end'));
25	$diff = date_diff($start, $end);
26
27	$dataset = [];
28
29	switch (true) {
30	case ($diff->days > 12):
31	$interval = round($diff->days / 12);
32	$data = $this->get_data($start, $end, 'P' . $interval . 'D');
33	break;
34	case ($diff->days > 5):
35	$data = $this->get_data($start, $end, 'P1D');
36	break;
37	case ($diff->days > 4):
38	$data = $this->get_data($start, $end, 'PT12H');
39	break;
40	case ($diff->days > 2):
41	$data = $this->get_data($start, $end, 'PT3H');
42	break;
43	case ($diff->days >= 0):
44	$data = $this->get_data($start, $end, 'PT1H');
45	break;
46	}
47
48	return $data;
49	}
50
51	public function get_data($start, $end, $intervalStr)
52	{
53	$tooltips = [];
54	$income = [];
55
56	$interval = new \DateInterval($intervalStr);
57
58	$periodStart = clone $start;
59	$periodEnd = clone $start;
60
61	// Subtract interval to set up period start
62	date_sub($periodStart, $interval);
63
64	while ($periodStart < $end) {
65	$values = $this->get_values($periodStart->format('Y-m-d H:i:s'), $periodEnd->format('Y-m-d H:i:s'));
66	$incomeForPeriod = $values['earnings'];
67	$donorsForPeriod = $values['donor_count'];
68	$time = $periodEnd->format('Y-m-d H:i:s');
69
70	switch ($intervalStr) {
71	case 'P1D':
72	$time = $periodStart->format('Y-m-d');
73	$periodLabel = $periodStart->format('l');
74	break;
75	case 'PT12H':
76	case 'PT3H':
77	case 'PT1H':
78	$periodLabel = $periodStart->format('D ga') . ' - ' . $periodEnd->format('D ga');
79	break;
80	default:
81	$periodLabel = $periodStart->format('M j, Y') . ' - ' . $periodEnd->format('M j, Y');
82	}
83
84	$income[] = [
85	'x' => $time,
86	'y' => $incomeForPeriod,
87	];
88
89	$tooltips[] = [
90	'title' => give_currency_filter(
91	give_format_amount($incomeForPeriod),
92	[
93	'currency_code' => $this->currency,
94	'decode_currency' => true,
95	'sanitize' => false,
96	]
97	),
98	'body' => $donorsForPeriod . ' ' . __('Donors', 'give'),
99	'footer' => $periodLabel,
100	];
101
102	// Add interval to set up next period
103	date_add($periodStart, $interval);
104	date_add($periodEnd, $interval);
105	}
106
107	if ($intervalStr === 'P1D') {
108	$income = array_slice($income, 1);
109	$tooltips = array_slice($tooltips, 1);
110	}
111
112	// Create data object to be returned, with 'highlights' object containing total and average figures to display
113	$data = [
114	'datasets' => [
115	[
116	'data' => $income,
117	'tooltips' => $tooltips,
118	],
119	],
120	];
121
122	return $data;
123	}
124
125	public function get_values($startStr, $endStr)
126	{
127	$paymentObjects = $this->getPayments($startStr, $endStr);
128
129	$earnings = 0;
130	$donors = [];
131
132	foreach ($paymentObjects as $paymentObject) {
133	if ($paymentObject->date >= $startStr && $paymentObject->date < $endStr) {
134	if ($paymentObject->status == 'publish' \|\| $paymentObject->status == 'give_subscription') {
135	$earnings += $paymentObject->total;
136	$donors[] = $paymentObject->donor_id;
137	}
138	}
139	}
140
141	$unique = array_unique($donors);
142
143	return [
144	'earnings' => $earnings,
145	'donor_count' => count($unique),
146	];
147	}
148
149	}
150