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

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

152 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 IncomeBreakdown extends Endpoint
12	{
13
14	protected $payments;
15
16	public function __construct()
17	{
18	$this->endpoint = 'income-breakdown';
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 > 365):
31	$data = $this->get_data($start, $end, 'P1M');
32	break;
33	case ($diff->days > 60):
34	$data = $this->get_data($start, $end, 'P1W');
35	break;
36	case ($diff->days > 5):
37	$data = $this->get_data($start, $end, 'P1D');
38	break;
39	case ($diff->days >= 0):
40	$data = $this->get_data($start, $end, 'PT1H');
41	break;
42	}
43
44	return $data;
45	}
46
47	public function get_data($start, $end, $intervalStr)
48	{
49	$data = [];
50
51	$interval = new \DateInterval($intervalStr);
52
53	$periodStart = clone $start;
54	$periodEnd = clone $start;
55
56	// Subtract interval to set up period start
57	date_sub($periodStart, $interval);
58
59	while ($periodStart < $end) {
60	$values = $this->get_values($periodStart->format('Y-m-d H:i:s'), $periodEnd->format('Y-m-d H:i:s'));
61
62	$incomeForPeriod = $values['income'];
63	$donorsForPeriod = $values['donors'];
64	$refundsForPeriod = $values['refunds'];
65	$netForPeriod = $values['net'];
66
67	switch ($intervalStr) {
68	case 'P1M':
69	$periodLabel = $periodEnd->format('F Y');
70	break;
71	case 'P1D':
72	$periodLabel = $periodStart->format('F j, Y');
73	break;
74	case 'PT1H':
75	$periodLabel = $periodEnd->format('l ga');
76	break;
77	default:
78	$periodLabel = $periodEnd->format('F j, Y');
79	}
80
81	$data[] = [
82	__('Date', 'give') => $periodLabel,
83	__('Donors', 'give') => $donorsForPeriod,
84	__('Donations', 'give') => $incomeForPeriod,
85	__('Refunds', 'give') => $refundsForPeriod,
86	__('Net', 'give') => $netForPeriod,
87	];
88
89	// Add interval to set up next period
90	date_add($periodStart, $interval);
91	date_add($periodEnd, $interval);
92	}
93
94	return $data;
95	}
96
97	public function get_values($startStr, $endStr)
98	{
99	$paymentObjects = $this->getPayments($startStr, $endStr);
100
101	$income = 0;
102	$refundTotal = 0;
103	$refunds = 0;
104	$donors = [];
105
106	foreach ($paymentObjects as $paymentObject) {
107	if ($paymentObject->date > $startStr && $paymentObject->date <= $endStr) {
108	switch ($paymentObject->status) {
109	case 'give_subscription':
110	case 'publish':
111	{
112	$income += $paymentObject->total;
113	$donors[] = $paymentObject->donor_id;
114	break;
115	}
116	case 'refunded':
117	{
118	$refunds += 1;
119	$income += $paymentObject->total;
120	$refundTotal += $paymentObject->total;
121	break;
122	}
123	}
124	}
125	}
126
127	$unique = array_unique($donors);
128
129	return [
130	'income' => give_currency_filter(
131	give_format_amount($income),
132	[
133	'currency_code' => $this->currency,
134	'decode_currency' => true,
135	'sanitize' => false,
136	]
137	),
138	'donors' => count($unique),
139	'refunds' => $refunds,
140	'net' => give_currency_filter(
141	give_format_amount($income - $refundTotal),
142	[
143	'currency_code' => $this->currency,
144	'decode_currency' => true,
145	'sanitize' => false,
146	]
147	),
148	];
149	}
150
151	}
152