DonationQueryData.php
210 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Donations\DataTransferObjects; |
| 4 | |
| 5 | use DateTime; |
| 6 | use Give\Donations\Models\Donation; |
| 7 | use Give\Donations\Properties\BillingAddress; |
| 8 | use Give\Donations\ValueObjects\DonationMetaKeys; |
| 9 | use Give\Donations\ValueObjects\DonationMode; |
| 10 | use Give\Donations\ValueObjects\DonationStatus; |
| 11 | use Give\Donations\ValueObjects\DonationType; |
| 12 | use Give\Framework\Support\Facades\DateTime\Temporal; |
| 13 | use Give\Framework\Support\ValueObjects\Money; |
| 14 | |
| 15 | /** |
| 16 | * Class DonationData |
| 17 | * |
| 18 | * @since 3.2.0 added honorific property |
| 19 | * @since 2.23.0 remove parentId property |
| 20 | * @since 2.19.6 |
| 21 | */ |
| 22 | final class DonationQueryData |
| 23 | { |
| 24 | /** |
| 25 | * @var Money |
| 26 | */ |
| 27 | public $amount; |
| 28 | /** |
| 29 | * @var string |
| 30 | */ |
| 31 | public $exchangeRate; |
| 32 | /** |
| 33 | * @var Money |
| 34 | */ |
| 35 | public $feeAmountRecovered; |
| 36 | /** |
| 37 | * @var int |
| 38 | */ |
| 39 | public $donorId; |
| 40 | /** |
| 41 | * @var string |
| 42 | */ |
| 43 | public $firstName; |
| 44 | /** |
| 45 | * @var string |
| 46 | */ |
| 47 | public $lastName; |
| 48 | /** |
| 49 | * @var string |
| 50 | */ |
| 51 | public $email; |
| 52 | /** |
| 53 | * @var int |
| 54 | */ |
| 55 | public $id; |
| 56 | /** |
| 57 | * @var DonationStatus |
| 58 | */ |
| 59 | public $status; |
| 60 | /** |
| 61 | * @var int |
| 62 | */ |
| 63 | public $subscriptionId; |
| 64 | /** |
| 65 | * @var DateTime |
| 66 | */ |
| 67 | public $updatedAt; |
| 68 | /** |
| 69 | * @var DateTime |
| 70 | */ |
| 71 | public $createdAt; |
| 72 | /** |
| 73 | * @var string |
| 74 | */ |
| 75 | public $gatewayId; |
| 76 | /** |
| 77 | * @var DonationMode |
| 78 | */ |
| 79 | public $mode; |
| 80 | /** |
| 81 | * @var DonationType |
| 82 | */ |
| 83 | public $type; |
| 84 | /** |
| 85 | * @var int |
| 86 | */ |
| 87 | public $formId; |
| 88 | /** |
| 89 | * @var BillingAddress |
| 90 | */ |
| 91 | public $billingAddress; |
| 92 | /** |
| 93 | * @var string |
| 94 | */ |
| 95 | public $formTitle; |
| 96 | /** |
| 97 | * @var string |
| 98 | */ |
| 99 | public $purchaseKey; |
| 100 | /** |
| 101 | * @var string |
| 102 | */ |
| 103 | public $donorIp; |
| 104 | /** |
| 105 | * @var bool |
| 106 | */ |
| 107 | public $anonymous; |
| 108 | /** |
| 109 | * @var int |
| 110 | */ |
| 111 | public $levelId; |
| 112 | /** |
| 113 | * @var string |
| 114 | */ |
| 115 | public $gatewayTransactionId; |
| 116 | /** |
| 117 | * @var string|null |
| 118 | */ |
| 119 | public $company; |
| 120 | /** |
| 121 | * @var string|null |
| 122 | */ |
| 123 | public $comment; |
| 124 | /** |
| 125 | * @var string|null |
| 126 | */ |
| 127 | public $honorific; |
| 128 | |
| 129 | /** |
| 130 | * Convert data from object to Donation |
| 131 | * |
| 132 | * @since 3.2.0 add fallback for donation mode |
| 133 | * @since 2.23.0 remove parentId property |
| 134 | * @since 2.22.0 add support for company field |
| 135 | * @since 2.20.0 update for new amount property, fee amount recovered, and exchange rate |
| 136 | * @since 2.19.6 |
| 137 | * |
| 138 | * @param object $donationQueryObject |
| 139 | * |
| 140 | * @return self |
| 141 | */ |
| 142 | public static function fromObject($donationQueryObject): self |
| 143 | { |
| 144 | $self = new static(); |
| 145 | |
| 146 | $currency = $donationQueryObject->{DonationMetaKeys::CURRENCY()->getKeyAsCamelCase()}; |
| 147 | $feeAmountRecovered = $donationQueryObject->{DonationMetaKeys::FEE_AMOUNT_RECOVERED()->getKeyAsCamelCase()}; |
| 148 | $donationMode = $donationQueryObject->{DonationMetaKeys::MODE()->getKeyAsCamelCase()}; |
| 149 | |
| 150 | $self->id = (int)$donationQueryObject->id; |
| 151 | $self->formId = (int)$donationQueryObject->{DonationMetaKeys::FORM_ID()->getKeyAsCamelCase()}; |
| 152 | $self->formTitle = $donationQueryObject->{DonationMetaKeys::FORM_TITLE()->getKeyAsCamelCase()}; |
| 153 | $self->amount = Money::fromDecimal( |
| 154 | $donationQueryObject->{DonationMetaKeys::AMOUNT()->getKeyAsCamelCase()}, |
| 155 | $currency |
| 156 | ); |
| 157 | $self->feeAmountRecovered = $feeAmountRecovered ? Money::fromDecimal($feeAmountRecovered, $currency) : null; |
| 158 | $self->exchangeRate = $donationQueryObject->{DonationMetaKeys::EXCHANGE_RATE()->getKeyAsCamelCase()}; |
| 159 | $self->donorId = (int)$donationQueryObject->{DonationMetaKeys::DONOR_ID()->getKeyAsCamelCase()}; |
| 160 | $self->honorific = $donationQueryObject->{DonationMetaKeys::HONORIFIC()->getKeyAsCamelCase()}; |
| 161 | $self->firstName = $donationQueryObject->{DonationMetaKeys::FIRST_NAME()->getKeyAsCamelCase()}; |
| 162 | $self->lastName = $donationQueryObject->{DonationMetaKeys::LAST_NAME()->getKeyAsCamelCase()}; |
| 163 | $self->email = $donationQueryObject->{DonationMetaKeys::EMAIL()->getKeyAsCamelCase()}; |
| 164 | $self->gatewayId = $donationQueryObject->{DonationMetaKeys::GATEWAY()->getKeyAsCamelCase()}; |
| 165 | $self->createdAt = Temporal::toDateTime($donationQueryObject->createdAt); |
| 166 | $self->updatedAt = Temporal::toDateTime($donationQueryObject->updatedAt); |
| 167 | $self->status = new DonationStatus($donationQueryObject->status); |
| 168 | $self->subscriptionId = (int)$donationQueryObject->{DonationMetaKeys::SUBSCRIPTION_ID()->getKeyAsCamelCase()}; |
| 169 | $self->mode = DonationMode::isValid($donationMode) ? new DonationMode($donationMode) : DonationMode::LIVE(); |
| 170 | $self->billingAddress = BillingAddress::fromArray([ |
| 171 | 'country' => $donationQueryObject->{DonationMetaKeys::BILLING_COUNTRY()->getKeyAsCamelCase()}, |
| 172 | 'city' => $donationQueryObject->{DonationMetaKeys::BILLING_CITY()->getKeyAsCamelCase()}, |
| 173 | 'state' => $donationQueryObject->{DonationMetaKeys::BILLING_STATE()->getKeyAsCamelCase()}, |
| 174 | 'zip' => $donationQueryObject->{DonationMetaKeys::BILLING_ZIP()->getKeyAsCamelCase()}, |
| 175 | 'address1' => $donationQueryObject->{DonationMetaKeys::BILLING_ADDRESS1()->getKeyAsCamelCase()}, |
| 176 | 'address2' => $donationQueryObject->{DonationMetaKeys::BILLING_ADDRESS2()->getKeyAsCamelCase()}, |
| 177 | ]); |
| 178 | $self->purchaseKey = $donationQueryObject->{DonationMetaKeys::PURCHASE_KEY()->getKeyAsCamelCase()}; |
| 179 | $self->donorIp = $donationQueryObject->{DonationMetaKeys::DONOR_IP()->getKeyAsCamelCase()}; |
| 180 | $self->anonymous = (bool)$donationQueryObject->{DonationMetaKeys::ANONYMOUS()->getKeyAsCamelCase()}; |
| 181 | $self->levelId = (string)$donationQueryObject->{DonationMetaKeys::LEVEL_ID()->getKeyAsCamelCase()}; |
| 182 | $self->gatewayTransactionId = $donationQueryObject->{DonationMetaKeys::GATEWAY_TRANSACTION_ID() |
| 183 | ->getKeyAsCamelCase()}; |
| 184 | $self->company = $donationQueryObject->{DonationMetaKeys::COMPANY() |
| 185 | ->getKeyAsCamelCase()}; |
| 186 | $self->comment = $donationQueryObject->{DonationMetaKeys::COMMENT() |
| 187 | ->getKeyAsCamelCase()}; |
| 188 | |
| 189 | if (!empty($donationQueryObject->{DonationMetaKeys::SUBSCRIPTION_INITIAL_DONATION()->getKeyAsCamelCase()})) { |
| 190 | $self->type = DonationType::SUBSCRIPTION(); |
| 191 | } elseif ($self->subscriptionId) { |
| 192 | $self->type = DonationType::RENEWAL(); |
| 193 | } else { |
| 194 | $self->type = DonationType::SINGLE(); |
| 195 | } |
| 196 | |
| 197 | return $self; |
| 198 | } |
| 199 | |
| 200 | /** |
| 201 | * Convert DTO to Donation |
| 202 | */ |
| 203 | public function toDonation(): Donation |
| 204 | { |
| 205 | $attributes = get_object_vars($this); |
| 206 | |
| 207 | return new Donation($attributes); |
| 208 | } |
| 209 | } |
| 210 |