give / src / Donations / DataTransferObjects / DonationQueryData.php

DonationQueryData.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.8.1, at src/Donations/DataTransferObjects/DonationQueryData.php

223 lines 7.1 KB

Raw Download Zip

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 string
54	*/
55	public $phone;
56	/**
57	* @var int
58	*/
59	public $id;
60	/**
61	* @var DonationStatus
62	*/
63	public $status;
64	/**
65	* @var int
66	*/
67	public $subscriptionId;
68	/**
69	* @var DateTime
70	*/
71	public $updatedAt;
72	/**
73	* @var DateTime
74	*/
75	public $createdAt;
76	/**
77	* @var string
78	*/
79	public $gatewayId;
80	/**
81	* @var DonationMode
82	*/
83	public $mode;
84	/**
85	* @var DonationType
86	*/
87	public $type;
88	/**
89	* @var int
90	*/
91	public $formId;
92	/**
93	* @var BillingAddress
94	*/
95	public $billingAddress;
96	/**
97	* @var string
98	*/
99	public $formTitle;
100	/**
101	* @var string
102	*/
103	public $purchaseKey;
104	/**
105	* @var string
106	*/
107	public $donorIp;
108	/**
109	* @var bool
110	*/
111	public $anonymous;
112	/**
113	* @var int
114	*/
115	public $levelId;
116	/**
117	* @var string
118	*/
119	public $gatewayTransactionId;
120	/**
121	* @var string\|null
122	*/
123	public $company;
124	/**
125	* @var string\|null
126	*/
127	public $comment;
128	/**
129	* @var string\|null
130	*/
131	public $honorific;
132	/**
133	* @var int
134	*/
135	public $campaignId;
136
137	/**
138	* Convert data from object to Donation
139	*
140	* @since 4.13.0 prevent fatal error when status is not valid
141	* @since 4.0.0 Added campaignId property
142	* @since 3.9.0 Add support for "phone" property
143	* @since 3.2.0 add fallback for donation mode
144	* @since 2.23.0 remove parentId property
145	* @since 2.22.0 add support for company field
146	* @since 2.20.0 update for new amount property, fee amount recovered, and exchange rate
147	* @since 2.19.6
148	*
149	* @param object $donationQueryObject
150	*
151	* @return self
152	*/
153	public static function fromObject($donationQueryObject): self
154	{
155	$self = new static();
156
157	$currency = $donationQueryObject->{DonationMetaKeys::CURRENCY()->getKeyAsCamelCase()};
158	$feeAmountRecovered = $donationQueryObject->{DonationMetaKeys::FEE_AMOUNT_RECOVERED()->getKeyAsCamelCase()};
159	$donationMode = $donationQueryObject->{DonationMetaKeys::MODE()->getKeyAsCamelCase()};
160
161	$self->id = (int)$donationQueryObject->id;
162	$self->formId = (int)$donationQueryObject->{DonationMetaKeys::FORM_ID()->getKeyAsCamelCase()};
163	$self->formTitle = $donationQueryObject->{DonationMetaKeys::FORM_TITLE()->getKeyAsCamelCase()};
164	$self->amount = Money::fromDecimal(
165	$donationQueryObject->{DonationMetaKeys::AMOUNT()->getKeyAsCamelCase()},
166	$currency
167	);
168	$self->feeAmountRecovered = $feeAmountRecovered ? Money::fromDecimal($feeAmountRecovered, $currency) : null;
169	$self->exchangeRate = $donationQueryObject->{DonationMetaKeys::EXCHANGE_RATE()->getKeyAsCamelCase()};
170	$self->donorId = (int)$donationQueryObject->{DonationMetaKeys::DONOR_ID()->getKeyAsCamelCase()};
171	$self->honorific = $donationQueryObject->{DonationMetaKeys::HONORIFIC()->getKeyAsCamelCase()};
172	$self->firstName = $donationQueryObject->{DonationMetaKeys::FIRST_NAME()->getKeyAsCamelCase()};
173	$self->lastName = $donationQueryObject->{DonationMetaKeys::LAST_NAME()->getKeyAsCamelCase()};
174	$self->email = $donationQueryObject->{DonationMetaKeys::EMAIL()->getKeyAsCamelCase()};
175	$self->phone = $donationQueryObject->{DonationMetaKeys::PHONE()->getKeyAsCamelCase()};
176	$self->gatewayId = $donationQueryObject->{DonationMetaKeys::GATEWAY()->getKeyAsCamelCase()};
177	$self->createdAt = Temporal::toDateTime($donationQueryObject->createdAt);
178	$self->updatedAt = Temporal::toDateTime($donationQueryObject->updatedAt);
179	$self->status = new DonationStatus(DonationStatus::isValid($donationQueryObject->status) ? $donationQueryObject->status : DonationStatus::PENDING);
180	$self->subscriptionId = (int)$donationQueryObject->{DonationMetaKeys::SUBSCRIPTION_ID()->getKeyAsCamelCase()};
181	$self->mode = DonationMode::isValid($donationMode) ? new DonationMode($donationMode) : DonationMode::LIVE();
182	$self->billingAddress = BillingAddress::fromArray([
183	'country' => $donationQueryObject->{DonationMetaKeys::BILLING_COUNTRY()->getKeyAsCamelCase()},
184	'city' => $donationQueryObject->{DonationMetaKeys::BILLING_CITY()->getKeyAsCamelCase()},
185	'state' => $donationQueryObject->{DonationMetaKeys::BILLING_STATE()->getKeyAsCamelCase()},
186	'zip' => $donationQueryObject->{DonationMetaKeys::BILLING_ZIP()->getKeyAsCamelCase()},
187	'address1' => $donationQueryObject->{DonationMetaKeys::BILLING_ADDRESS1()->getKeyAsCamelCase()},
188	'address2' => $donationQueryObject->{DonationMetaKeys::BILLING_ADDRESS2()->getKeyAsCamelCase()},
189	]);
190	$self->purchaseKey = $donationQueryObject->{DonationMetaKeys::PURCHASE_KEY()->getKeyAsCamelCase()};
191	$self->donorIp = $donationQueryObject->{DonationMetaKeys::DONOR_IP()->getKeyAsCamelCase()};
192	$self->anonymous = (bool)$donationQueryObject->{DonationMetaKeys::ANONYMOUS()->getKeyAsCamelCase()};
193	$self->levelId = (string)$donationQueryObject->{DonationMetaKeys::LEVEL_ID()->getKeyAsCamelCase()};
194	$self->gatewayTransactionId = $donationQueryObject->{DonationMetaKeys::GATEWAY_TRANSACTION_ID()
195	->getKeyAsCamelCase()};
196	$self->company = $donationQueryObject->{DonationMetaKeys::COMPANY()
197	->getKeyAsCamelCase()};
198	$self->comment = $donationQueryObject->{DonationMetaKeys::COMMENT()
199	->getKeyAsCamelCase()};
200	$self->campaignId = (int)$donationQueryObject->{DonationMetaKeys::CAMPAIGN_ID()->getKeyAsCamelCase()};
201
202	if (!empty($donationQueryObject->{DonationMetaKeys::SUBSCRIPTION_INITIAL_DONATION()->getKeyAsCamelCase()})) {
203	$self->type = DonationType::SUBSCRIPTION();
204	} elseif ($self->subscriptionId) {
205	$self->type = DonationType::RENEWAL();
206	} else {
207	$self->type = DonationType::SINGLE();
208	}
209
210	return $self;
211	}
212
213	/**
214	* Convert DTO to Donation
215	*/
216	public function toDonation(): Donation
217	{
218	$attributes = get_object_vars($this);
219
220	return new Donation($attributes);
221	}
222	}
223