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