CampaignGoalData.php
139 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Campaigns\DataTransferObjects; |
| 4 | |
| 5 | use Give\Campaigns\CampaignDonationQuery; |
| 6 | use Give\Campaigns\CampaignSubscriptionQuery; |
| 7 | use Give\Campaigns\Models\Campaign; |
| 8 | use Give\Campaigns\ValueObjects\CampaignGoalType; |
| 9 | use Give\Framework\Support\Contracts\Arrayable; |
| 10 | |
| 11 | /** |
| 12 | * @since 4.0.0 |
| 13 | */ |
| 14 | class CampaignGoalData implements Arrayable |
| 15 | { |
| 16 | /** |
| 17 | * @var Campaign |
| 18 | */ |
| 19 | private $campaign; |
| 20 | |
| 21 | /** |
| 22 | * @var int |
| 23 | */ |
| 24 | public $actual; |
| 25 | |
| 26 | /** |
| 27 | * @var int |
| 28 | */ |
| 29 | public $percentage; |
| 30 | |
| 31 | /** |
| 32 | * @var int |
| 33 | */ |
| 34 | public $goal; |
| 35 | |
| 36 | /** |
| 37 | * @var int|string |
| 38 | */ |
| 39 | public $goalFormatted; |
| 40 | |
| 41 | /** |
| 42 | * @var int|string |
| 43 | */ |
| 44 | public $actualFormatted; |
| 45 | |
| 46 | /** |
| 47 | * @since 4.0.0 |
| 48 | */ |
| 49 | public function __construct(Campaign $campaign) |
| 50 | { |
| 51 | $this->campaign = $campaign; |
| 52 | $this->actual = $this->getActual(); |
| 53 | $this->actualFormatted = $this->getActualFormatted(); |
| 54 | $this->percentage = $this->getPercentage(); |
| 55 | $this->goal = $campaign->goal; |
| 56 | $this->goalFormatted = $this->getGoalFormatted(); |
| 57 | } |
| 58 | |
| 59 | /** |
| 60 | * @since 4.0.0 |
| 61 | */ |
| 62 | private function getActual(): int |
| 63 | { |
| 64 | $query = $this->campaign->goalType->isOneOf( |
| 65 | CampaignGoalType::SUBSCRIPTIONS(), |
| 66 | CampaignGoalType::AMOUNT_FROM_SUBSCRIPTIONS(), |
| 67 | CampaignGoalType::DONORS_FROM_SUBSCRIPTIONS() |
| 68 | ) |
| 69 | ? new CampaignSubscriptionQuery($this->campaign) |
| 70 | : new CampaignDonationQuery($this->campaign); |
| 71 | |
| 72 | switch ($this->campaign->goalType->getValue()) { |
| 73 | case CampaignGoalType::DONATIONS(): |
| 74 | case CampaignGoalType::SUBSCRIPTIONS(): |
| 75 | return $query->countDonations(); |
| 76 | |
| 77 | case CampaignGoalType::DONORS(): |
| 78 | case CampaignGoalType::DONORS_FROM_SUBSCRIPTIONS(): |
| 79 | return $query->countDonors(); |
| 80 | |
| 81 | case CampaignGoalType::AMOUNT_FROM_SUBSCRIPTIONS(): |
| 82 | return $query->sumInitialAmount(); |
| 83 | |
| 84 | case CampaignGoalType::AMOUNT(): |
| 85 | default: |
| 86 | return $query->sumIntendedAmount(); |
| 87 | } |
| 88 | } |
| 89 | |
| 90 | /** |
| 91 | * @since 4.0.0 |
| 92 | */ |
| 93 | private function getPercentage(): float |
| 94 | { |
| 95 | $percentage = $this->campaign->goal |
| 96 | ? $this->actual / $this->campaign->goal |
| 97 | : 0; |
| 98 | return round($percentage * 100, 2); |
| 99 | } |
| 100 | |
| 101 | /** |
| 102 | * @since 4.0.0 |
| 103 | */ |
| 104 | private function getActualFormatted(): string |
| 105 | { |
| 106 | if ($this->campaign->goalType->isAmount()) { |
| 107 | return give_currency_filter(give_format_amount($this->actual)); |
| 108 | } |
| 109 | |
| 110 | return $this->actual; |
| 111 | } |
| 112 | |
| 113 | /** |
| 114 | * @since 4.0.0 |
| 115 | */ |
| 116 | private function getGoalFormatted(): string |
| 117 | { |
| 118 | if ($this->campaign->goalType->isAmount()) { |
| 119 | return give_currency_filter(give_format_amount($this->goal)); |
| 120 | } |
| 121 | |
| 122 | return $this->goal; |
| 123 | } |
| 124 | |
| 125 | /** |
| 126 | * @since 4.0.0 |
| 127 | */ |
| 128 | public function toArray(): array |
| 129 | { |
| 130 | return [ |
| 131 | 'actual' => $this->actual, |
| 132 | 'actualFormatted' => $this->actualFormatted, |
| 133 | 'percentage' => $this->percentage, |
| 134 | 'goal' => $this->goal, |
| 135 | 'goalFormatted' => $this->goalFormatted, |
| 136 | ]; |
| 137 | } |
| 138 | } |
| 139 |