AuthenticationData.php
2 years ago
DonateControllerData.php
1 year ago
DonateFormRouteData.php
1 year ago
DonateRouteData.php
2 years ago
DonationConfirmationReceiptViewRouteData.php
1 year ago
DonationFormGoalData.php
1 year ago
DonationFormPreviewRouteData.php
1 year ago
DonationFormQueryData.php
2 years ago
DonationFormViewRouteData.php
1 year ago
LegacyPurchaseFormData.php
2 years ago
UserData.php
2 years ago
ValidationRouteData.php
1 year ago
DonationFormGoalData.php
135 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\DonationForms\DataTransferObjects; |
| 4 | |
| 5 | use Give\DonationForms\DonationQuery; |
| 6 | use Give\DonationForms\Properties\FormSettings; |
| 7 | use Give\DonationForms\SubscriptionQuery; |
| 8 | use Give\DonationForms\ValueObjects\GoalProgressType; |
| 9 | use Give\DonationForms\ValueObjects\GoalType; |
| 10 | use Give\Framework\Support\Contracts\Arrayable; |
| 11 | |
| 12 | /** |
| 13 | * @since 3.0.0 |
| 14 | */ |
| 15 | class DonationFormGoalData implements Arrayable |
| 16 | { |
| 17 | /** |
| 18 | * @var int |
| 19 | */ |
| 20 | public $formId; |
| 21 | /** |
| 22 | * @var array |
| 23 | */ |
| 24 | public $formSettings; |
| 25 | /** |
| 26 | * @var false |
| 27 | */ |
| 28 | public $isEnabled; |
| 29 | /** |
| 30 | * @var GoalType |
| 31 | */ |
| 32 | public $goalType; |
| 33 | /** |
| 34 | * @var int |
| 35 | */ |
| 36 | public $targetAmount; |
| 37 | /** |
| 38 | * @var GoalProgressType |
| 39 | */ |
| 40 | public $goalProgressType; |
| 41 | /** |
| 42 | * @var string|null |
| 43 | */ |
| 44 | public $goalStartDate; |
| 45 | /** |
| 46 | * @var string|null |
| 47 | */ |
| 48 | public $goalEndDate; |
| 49 | |
| 50 | /** |
| 51 | * @since 3.0.0 |
| 52 | */ |
| 53 | public function __construct(int $formId, FormSettings $formSettings) |
| 54 | { |
| 55 | $this->formId = $formId; |
| 56 | $this->formSettings = $formSettings; |
| 57 | $this->isEnabled = $formSettings->enableDonationGoal ?? false; |
| 58 | $this->goalType = $formSettings->goalType ?? GoalType::AMOUNT(); |
| 59 | $this->targetAmount = $this->formSettings->goalAmount ?? 0; |
| 60 | $this->goalProgressType = $this->formSettings->goalProgressType ?? GoalProgressType::ALL_TIME(); |
| 61 | $this->goalStartDate = $this->formSettings->goalStartDate ?? null; |
| 62 | $this->goalEndDate = $this->formSettings->goalEndDate ?? null; |
| 63 | } |
| 64 | |
| 65 | /** |
| 66 | * @since 3.0.0 |
| 67 | * |
| 68 | * @return int|float |
| 69 | */ |
| 70 | public function getCurrentAmount() |
| 71 | { |
| 72 | $query = $this->goalType->isOneOf(GoalType::SUBSCRIPTIONS(), GoalType::AMOUNT_FROM_SUBSCRIPTIONS(), GoalType::DONORS_FROM_SUBSCRIPTIONS()) |
| 73 | ? new SubscriptionQuery() |
| 74 | : new DonationQuery(); |
| 75 | |
| 76 | $query->form($this->formId); |
| 77 | |
| 78 | switch ($this->goalType): |
| 79 | case GoalType::DONORS(): |
| 80 | case GoalType::DONORS_FROM_SUBSCRIPTIONS(): |
| 81 | return $query->countDonors(); |
| 82 | case GoalType::DONATIONS(): |
| 83 | case GoalType::SUBSCRIPTIONS(): |
| 84 | return $query->count(); |
| 85 | case GoalType::AMOUNT_FROM_SUBSCRIPTIONS(): |
| 86 | return $query->sumInitialAmount(); |
| 87 | case GoalType::AMOUNT(): |
| 88 | default: |
| 89 | return $query->sumIntendedAmount(); |
| 90 | endswitch; |
| 91 | } |
| 92 | |
| 93 | /** |
| 94 | * @since 3.0.0 |
| 95 | */ |
| 96 | public function getLabel(): string |
| 97 | { |
| 98 | if ($this->goalType->isDonors() || $this->goalType->isDonorsFromSubscriptions()) { |
| 99 | return __('donors', 'give'); |
| 100 | } |
| 101 | |
| 102 | if ($this->goalType->isDonations()) { |
| 103 | return __('donations', 'give'); |
| 104 | } |
| 105 | |
| 106 | if ($this->goalType->isSubscriptions()) { |
| 107 | return __('recurring donations', 'give'); |
| 108 | } |
| 109 | |
| 110 | return __('amount', 'give'); |
| 111 | } |
| 112 | |
| 113 | /** |
| 114 | * @since 3.0.0 |
| 115 | */ |
| 116 | public function toArray(): array |
| 117 | { |
| 118 | $currentAmount = $this->getCurrentAmount(); |
| 119 | $progressPercentage = !$currentAmount || !$this->targetAmount ? 0 : ($currentAmount / $this->targetAmount) * 100; |
| 120 | $goalTypeIsAmount = $this->goalType->isOneOf(GoalType::AMOUNT(), GoalType::AMOUNT_FROM_SUBSCRIPTIONS()); |
| 121 | |
| 122 | return [ |
| 123 | 'type' => $this->goalType->getValue(), |
| 124 | 'typeIsCount' => !$goalTypeIsAmount, |
| 125 | 'typeIsMoney' => $goalTypeIsAmount, |
| 126 | 'enabled' => $this->isEnabled, |
| 127 | 'show' => $this->isEnabled, |
| 128 | 'currentAmount' => $currentAmount, |
| 129 | 'targetAmount' => $this->targetAmount, |
| 130 | 'label' => $this->getLabel(), |
| 131 | 'isAchieved' => $this->isEnabled && $this->formSettings->enableAutoClose && $progressPercentage >= 100 |
| 132 | ]; |
| 133 | } |
| 134 | } |
| 135 |