CampaignPageRepository.php
1 year ago
CampaignRepository.php
1 year ago
CampaignsDataRepository.php
1 year ago
CampaignsDataRepository.php
192 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Campaigns\Repositories; |
| 4 | |
| 5 | use Give\Campaigns\CampaignsDataQuery; |
| 6 | use Give\Campaigns\Models\Campaign; |
| 7 | use Give\Campaigns\ValueObjects\CampaignGoalType; |
| 8 | |
| 9 | /** |
| 10 | * Used to optimize the campaigns list table performance and to avoid n+1 problems. |
| 11 | * Instead of doing expensive queries in multiple columns in each row, this class loads everything upfront for multiple campaigns. |
| 12 | * |
| 13 | * @since 4.0.0 |
| 14 | */ |
| 15 | class CampaignsDataRepository |
| 16 | { |
| 17 | /** |
| 18 | * @var array |
| 19 | */ |
| 20 | private $amounts; |
| 21 | /** |
| 22 | * @var array |
| 23 | */ |
| 24 | private $subscriptionAmounts = []; |
| 25 | /** |
| 26 | * @var array |
| 27 | */ |
| 28 | private $donationsCount; |
| 29 | /** |
| 30 | * @var array |
| 31 | */ |
| 32 | private $subscriptionDonationsCount = []; |
| 33 | /** |
| 34 | * @var array |
| 35 | */ |
| 36 | private $donorsCount; |
| 37 | /** |
| 38 | * @var array |
| 39 | */ |
| 40 | private $subscriptionDonorsCount = []; |
| 41 | |
| 42 | /** |
| 43 | * @param int[] $ids |
| 44 | * |
| 45 | * @return CampaignsDataRepository |
| 46 | */ |
| 47 | public static function campaigns(array $ids): CampaignsDataRepository |
| 48 | { |
| 49 | $self = new self(); |
| 50 | |
| 51 | $donations = CampaignsDataQuery::donations($ids); |
| 52 | |
| 53 | $self->amounts = $donations->collectIntendedAmounts(); |
| 54 | $self->donationsCount = $donations->collectDonations(); |
| 55 | $self->donorsCount = $donations->collectDonors(); |
| 56 | |
| 57 | // Set subscriptions data |
| 58 | if (defined('GIVE_RECURRING_VERSION')) { |
| 59 | $subscriptions = CampaignsDataQuery::subscriptions($ids); |
| 60 | |
| 61 | $self->subscriptionAmounts = $subscriptions->collectInitialAmounts(); |
| 62 | $self->subscriptionDonationsCount = $subscriptions->collectDonations(); |
| 63 | $self->subscriptionDonorsCount = $subscriptions->collectDonors(); |
| 64 | } |
| 65 | |
| 66 | return $self; |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * @since 4.0.0 |
| 71 | * |
| 72 | * Get revenue for campaign |
| 73 | * |
| 74 | * @param Campaign $campaign |
| 75 | * |
| 76 | * @return int |
| 77 | */ |
| 78 | public function getRevenue(Campaign $campaign): int |
| 79 | { |
| 80 | $data = $campaign->goalType->isSubscriptions() |
| 81 | ? $this->subscriptionAmounts |
| 82 | : $this->amounts; |
| 83 | |
| 84 | foreach ($data as $row) { |
| 85 | if (isset($row['campaign_id']) && $row['campaign_id'] == $campaign->id) { |
| 86 | return (int)$row['sum']; |
| 87 | } |
| 88 | } |
| 89 | |
| 90 | return 0; |
| 91 | } |
| 92 | |
| 93 | /** |
| 94 | * @since 4.0.0 |
| 95 | * |
| 96 | * Get donations count for campaign |
| 97 | * |
| 98 | * @param Campaign $campaign |
| 99 | * |
| 100 | * @return int |
| 101 | */ |
| 102 | public function getDonationsCount(Campaign $campaign): int |
| 103 | { |
| 104 | $data = $campaign->goalType->isSubscriptions() |
| 105 | ? $this->subscriptionDonationsCount |
| 106 | : $this->donationsCount; |
| 107 | |
| 108 | foreach ($data as $row) { |
| 109 | if (isset($row['campaign_id']) && $row['campaign_id'] == $campaign->id) { |
| 110 | return (int)$row['count']; |
| 111 | } |
| 112 | } |
| 113 | |
| 114 | return 0; |
| 115 | } |
| 116 | |
| 117 | /** |
| 118 | * @since 4.0.0 |
| 119 | * |
| 120 | * Get donors count for campaign |
| 121 | * |
| 122 | * @param Campaign $campaign |
| 123 | * |
| 124 | * @return int |
| 125 | */ |
| 126 | public function getDonorsCount(Campaign $campaign): int |
| 127 | { |
| 128 | $data = $campaign->goalType->isSubscriptions() |
| 129 | ? $this->subscriptionDonorsCount |
| 130 | : $this->donorsCount; |
| 131 | |
| 132 | foreach ($data as $row) { |
| 133 | if (isset($row['campaign_id']) && $row['campaign_id'] == $campaign->id) { |
| 134 | return (int)$row['count']; |
| 135 | } |
| 136 | } |
| 137 | |
| 138 | return 0; |
| 139 | } |
| 140 | |
| 141 | |
| 142 | /** |
| 143 | * @since 4.0.0 |
| 144 | * |
| 145 | * Get goal data for campaign |
| 146 | * |
| 147 | * @param Campaign $campaign |
| 148 | * |
| 149 | * @return array{actual: int, goal: int, actualFormatted: string, goalFormatted:string, percentage:float} |
| 150 | */ |
| 151 | public function getGoalData(Campaign $campaign): array |
| 152 | { |
| 153 | $actual = $this->getActualGoal($campaign); |
| 154 | $percentage = $campaign->goal |
| 155 | ? $actual / $campaign->goal |
| 156 | : 0; |
| 157 | |
| 158 | return [ |
| 159 | 'actual' => $actual, |
| 160 | 'goal' => $campaign->goal, |
| 161 | 'actualFormatted' => $campaign->goalType == CampaignGoalType::AMOUNT |
| 162 | ? give_currency_filter(give_format_amount($actual)) |
| 163 | : $actual, |
| 164 | 'goalFormatted' => $campaign->goalType == CampaignGoalType::AMOUNT |
| 165 | ? give_currency_filter(give_format_amount($campaign->goal)) |
| 166 | : $campaign->goal, |
| 167 | 'percentage' => round($percentage * 100, 2), |
| 168 | ]; |
| 169 | } |
| 170 | |
| 171 | /** |
| 172 | * @since 4.0.0 |
| 173 | * |
| 174 | * @param Campaign $campaign |
| 175 | * |
| 176 | * @return int |
| 177 | */ |
| 178 | private function getActualGoal(Campaign $campaign): int |
| 179 | { |
| 180 | switch ($campaign->goalType->getValue()) { |
| 181 | case CampaignGoalType::DONATIONS(): |
| 182 | case CampaignGoalType::SUBSCRIPTIONS(): |
| 183 | return $this->getDonationsCount($campaign); |
| 184 | case CampaignGoalType::DONORS(): |
| 185 | case CampaignGoalType::DONORS_FROM_SUBSCRIPTIONS(): |
| 186 | return $this->getDonorsCount($campaign); |
| 187 | default: |
| 188 | return $this->getRevenue($campaign); |
| 189 | } |
| 190 | } |
| 191 | } |
| 192 |