DonationResponseData.php
148 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Donations\DataTransferObjects; |
| 4 | |
| 5 | use DateTime; |
| 6 | use Give\Donations\ValueObjects\DonationMetaKeys; |
| 7 | use Give\Donations\ValueObjects\DonationMode; |
| 8 | use Give\Donations\ValueObjects\DonationStatus; |
| 9 | use Give\Framework\Support\Contracts\Arrayable; |
| 10 | use Give\Helpers\Date; |
| 11 | |
| 12 | /** |
| 13 | * Class DonationResponseData |
| 14 | * |
| 15 | * @since 2.20.0 |
| 16 | */ |
| 17 | class DonationResponseData implements Arrayable |
| 18 | { |
| 19 | /** |
| 20 | * @var int |
| 21 | */ |
| 22 | public $amount; |
| 23 | /** |
| 24 | * @var int |
| 25 | */ |
| 26 | public $donorId; |
| 27 | /** |
| 28 | * @var string |
| 29 | */ |
| 30 | public $donorName; |
| 31 | /** |
| 32 | * @var string |
| 33 | */ |
| 34 | public $email; |
| 35 | /** |
| 36 | * @var int |
| 37 | */ |
| 38 | public $id; |
| 39 | /** |
| 40 | * @var DonationStatus |
| 41 | */ |
| 42 | public $status; |
| 43 | /** |
| 44 | * @var DateTime |
| 45 | */ |
| 46 | public $createdAt; |
| 47 | /** |
| 48 | * @var string |
| 49 | */ |
| 50 | public $gateway; |
| 51 | /** |
| 52 | * @var integer |
| 53 | */ |
| 54 | public $formId; |
| 55 | /** |
| 56 | * @var string |
| 57 | */ |
| 58 | public $formTitle; |
| 59 | /** |
| 60 | * @var DonationMode |
| 61 | */ |
| 62 | public $paymentMode; |
| 63 | /** |
| 64 | * @var bool |
| 65 | */ |
| 66 | public $anonymous; |
| 67 | /** |
| 68 | * @var string |
| 69 | */ |
| 70 | public $donationType; |
| 71 | /** |
| 72 | * @var string |
| 73 | */ |
| 74 | public $name; |
| 75 | |
| 76 | /** |
| 77 | * Convert data from object to Donation |
| 78 | * |
| 79 | * @param object $donation |
| 80 | * |
| 81 | * @since 2.21.0 use meta keys as camelcase |
| 82 | * @since 2.20.0 |
| 83 | */ |
| 84 | public static function fromObject($donation): DonationResponseData |
| 85 | { |
| 86 | $self = new static(); |
| 87 | |
| 88 | $self->id = (int)$donation->id; |
| 89 | $self->formId = (int)$donation->{DonationMetaKeys::FORM_ID()->getKeyAsCamelCase()}; |
| 90 | $self->formTitle = $donation->{DonationMetaKeys::FORM_TITLE()->getKeyAsCamelCase()}; |
| 91 | $self->amount = html_entity_decode( |
| 92 | give_currency_filter(give_format_amount($donation->{DonationMetaKeys::AMOUNT()->getKeyAsCamelCase()})) |
| 93 | ); |
| 94 | $self->donorId = (int)$donation->{DonationMetaKeys::DONOR_ID()->getKeyAsCamelCase()}; |
| 95 | $self->name = $donation->{DonationMetaKeys::FIRST_NAME()->getKeyAsCamelCase( |
| 96 | )} . ' ' . $donation->{DonationMetaKeys::LAST_NAME()->getKeyAsCamelCase()}; |
| 97 | $self->email = $donation->{DonationMetaKeys::EMAIL()->getKeyAsCamelCase()}; |
| 98 | $self->gateway = give_get_gateway_admin_label($donation->{DonationMetaKeys::GATEWAY()->getKeyAsCamelCase()}); |
| 99 | $self->createdAt = Date::getDateTime($donation->createdAt); |
| 100 | $self->status = new DonationStatus($donation->status); |
| 101 | $self->paymentMode = $donation->{DonationMetaKeys::MODE()->getKeyAsCamelCase()}; |
| 102 | $self->anonymous = (bool)$donation->{DonationMetaKeys::ANONYMOUS()->getKeyAsCamelCase()}; |
| 103 | $self->donationType = self::getDonationType($donation); |
| 104 | |
| 105 | return $self; |
| 106 | } |
| 107 | |
| 108 | /** |
| 109 | * Convert DTO to array |
| 110 | * |
| 111 | * @since 2.20.0 |
| 112 | */ |
| 113 | public function toArray(): array |
| 114 | { |
| 115 | return get_object_vars($this); |
| 116 | } |
| 117 | |
| 118 | /** |
| 119 | * Get donation type to display on front-end |
| 120 | * |
| 121 | * @since 2.21.0 refactor conditional for subscription renewals |
| 122 | * @since 2.20.0 |
| 123 | * @param object $donation |
| 124 | */ |
| 125 | private static function getDonationType($donation): string |
| 126 | { |
| 127 | /** |
| 128 | * Initial donations will have a special meta key |
| 129 | */ |
| 130 | if ($donation->{DonationMetaKeys::SUBSCRIPTION_INITIAL_DONATION()->getKeyAsCamelCase()}) { |
| 131 | return 'subscription'; |
| 132 | } |
| 133 | |
| 134 | $hasRenewalStatus = $donation->status === DonationStatus::RENEWAL; |
| 135 | $hasSubscriptionId = !empty($donation->{DonationMetaKeys::SUBSCRIPTION_ID()->getKeyAsCamelCase()}); |
| 136 | $hasRenewalMetaKey = !empty($donation->{DonationMetaKeys::IS_RECURRING()->getKeyAsCamelCase()}); |
| 137 | |
| 138 | /** |
| 139 | * Renewals are determined by a few different ways through GiveWP versions |
| 140 | */ |
| 141 | if ($hasRenewalStatus || $hasSubscriptionId || $hasRenewalMetaKey) { |
| 142 | return 'renewal'; |
| 143 | } |
| 144 | |
| 145 | return 'single'; |
| 146 | } |
| 147 | } |
| 148 |