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