| 1 |
<?php |
| 2 |
|
| 3 |
/** |
| 4 |
* Refunds over time endpoint |
| 5 |
* |
| 6 |
* @package Give |
| 7 |
*/ |
| 8 |
|
| 9 |
namespace Give\API\Endpoints\Reports; |
| 10 |
|
| 11 |
class TotalRefunds extends Endpoint |
| 12 |
{ |
| 13 |
|
| 14 |
protected $payments; |
| 15 |
|
| 16 |
public function __construct() |
| 17 |
{ |
| 18 |
$this->endpoint = 'total-refunds'; |
| 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 |
$data = []; |
| 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 |
$refunds = []; |
| 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 |
$refundsForPeriod = $this->get_refunds( |
| 66 |
$periodStart->format('Y-m-d H:i:s'), |
| 67 |
$periodEnd->format('Y-m-d H:i:s') |
| 68 |
); |
| 69 |
$time = $periodEnd->format('Y-m-d H:i:s'); |
| 70 |
|
| 71 |
switch ($intervalStr) { |
| 72 |
case 'P1D': |
| 73 |
$time = $periodStart->format('Y-m-d'); |
| 74 |
$periodLabel = $periodStart->format('l'); |
| 75 |
break; |
| 76 |
case 'PT12H': |
| 77 |
case 'PT3H': |
| 78 |
case 'PT1H': |
| 79 |
$periodLabel = $periodStart->format('D ga') . ' - ' . $periodEnd->format('D ga'); |
| 80 |
break; |
| 81 |
default: |
| 82 |
$periodLabel = $periodStart->format('M j, Y') . ' - ' . $periodEnd->format('M j, Y'); |
| 83 |
} |
| 84 |
|
| 85 |
$refunds[] = [ |
| 86 |
'x' => $time, |
| 87 |
'y' => $refundsForPeriod, |
| 88 |
]; |
| 89 |
|
| 90 |
$tooltips[] = [ |
| 91 |
'title' => sprintf(_n('%d Donor', '%d Donors', $refundsForPeriod, 'give'), $refundsForPeriod), |
| 92 |
'body' => __('Total Refunds', 'give'), |
| 93 |
'footer' => $periodLabel, |
| 94 |
]; |
| 95 |
|
| 96 |
// Add interval to set up next period |
| 97 |
date_add($periodStart, $interval); |
| 98 |
date_add($periodEnd, $interval); |
| 99 |
} |
| 100 |
|
| 101 |
if ($intervalStr === 'P1D') { |
| 102 |
$refunds = array_slice($refunds, 1); |
| 103 |
$tooltips = array_slice($tooltips, 1); |
| 104 |
} |
| 105 |
|
| 106 |
$totalRefundsForPeriod = $this->get_refunds($start->format('Y-m-d H:i:s'), $end->format('Y-m-d H:i:s')); |
| 107 |
$trend = $this->get_trend($start, $end, $refunds); |
| 108 |
|
| 109 |
$diff = date_diff($start, $end); |
| 110 |
$info = $diff->days > 1 ? __('VS previous', 'give') . ' ' . $diff->days . ' ' . __('days', 'give') : __( |
| 111 |
'VS previous day', |
| 112 |
'give' |
| 113 |
); |
| 114 |
|
| 115 |
// Create data object to be returned, with 'highlights' object containing total and average figures to display |
| 116 |
$data = [ |
| 117 |
'datasets' => [ |
| 118 |
[ |
| 119 |
'data' => $refunds, |
| 120 |
'tooltips' => $tooltips, |
| 121 |
'trend' => $trend, |
| 122 |
'info' => $info, |
| 123 |
'highlight' => $totalRefundsForPeriod, |
| 124 |
], |
| 125 |
], |
| 126 |
]; |
| 127 |
|
| 128 |
return $data; |
| 129 |
} |
| 130 |
|
| 131 |
public function get_trend($start, $end, $refunds) |
| 132 |
{ |
| 133 |
$interval = $start->diff($end); |
| 134 |
|
| 135 |
$prevStart = clone $start; |
| 136 |
$prevStart = date_sub($prevStart, $interval); |
| 137 |
|
| 138 |
$prevEnd = clone $start; |
| 139 |
|
| 140 |
$prevRefunds = $this->get_refunds($prevStart->format('Y-m-d H:i:s'), $prevEnd->format('Y-m-d H:i:s')); |
| 141 |
$currentRefunds = $this->get_refunds($start->format('Y-m-d H:i:s'), $end->format('Y-m-d H:i:s')); |
| 142 |
|
| 143 |
// Set default trend to 0 |
| 144 |
$trend = 0; |
| 145 |
|
| 146 |
// Check that prev value and current value are > 0 (can't divide by 0) |
| 147 |
if ($prevRefunds > 0 && $currentRefunds > 0) { |
| 148 |
// Check if it is a percent decrease, or increase |
| 149 |
if ($prevRefunds > $currentRefunds) { |
| 150 |
// Calculate a percent decrease |
| 151 |
$trend = ((($prevRefunds - $currentRefunds) / $prevRefunds) * 100) * -1; |
| 152 |
} elseif ($currentRefunds > $prevRefunds) { |
| 153 |
// Calculate a percent increase |
| 154 |
$trend = (($currentRefunds - $prevRefunds) / $prevRefunds) * 100; |
| 155 |
} |
| 156 |
} |
| 157 |
|
| 158 |
return $trend; |
| 159 |
} |
| 160 |
|
| 161 |
public function get_refunds($startStr, $endStr) |
| 162 |
{ |
| 163 |
$paymentObjects = $this->getPayments($startStr, $endStr); |
| 164 |
|
| 165 |
$refunds = 0; |
| 166 |
foreach ($paymentObjects as $paymentObject) { |
| 167 |
if ($paymentObject->status == 'refunded' && $paymentObject->date >= $startStr && $paymentObject->date < $endStr) { |
| 168 |
$refunds += 1; |
| 169 |
} |
| 170 |
} |
| 171 |
|
| 172 |
return $refunds; |
| 173 |
} |
| 174 |
|
| 175 |
} |
| 176 |
|
