FormEntry.php — GiveWP – Donation Plugin and Fundraising Platform 3.21.0

give / src / Session / SessionDonation / SessionObjects / FormEntry.php

give / src / Session / SessionDonation / SessionObjects Last commit date

Donation.php 1 year ago FormEntry.php 1 year ago

FormEntry.php

228 lines

1	<?php
2
3	namespace Give\Session\SessionDonation\SessionObjects;
4
5	use Give\Framework\Exceptions\Primitives\InvalidArgumentException;
6	use Give\Helpers\ArrayDataSet;
7	use Give\Session\Objects;
8	use Give\ValueObjects\CardInfo;
9	use Give\ValueObjects\DonorInfo;
10
11	/**
12	* Class FormEntry
13	*
14	* This class use to represent donation form entries as object.
15	*
16	* @package Give\Session\SessionDonation\SessionObjects
17	*/
18	class FormEntry implements Objects
19	{
20	/**
21	* Form Id.
22	*
23	* @var string
24	*/
25	public $formId;
26
27	/**
28	* Form Title.
29	*
30	* @var string
31	*/
32	public $formTitle;
33
34	/**
35	* Page url on which donation page exist.
36	*
37	* @var string
38	*/
39	public $currentUrl;
40
41	/**
42	* Donation level id.
43	*
44	* @var string
45	*/
46	public $priceId;
47
48	/**
49	* Donation amount
50	*
51	* @var string
52	*/
53	public $totalAmount;
54
55	/**
56	* First name
57	*
58	* @var string
59	*/
60	public $firstName;
61
62	/**
63	* Last name.
64	*
65	* @var string
66	*/
67	public $lastName;
68
69	/**
70	* Company name.
71	*
72	* @var string
73	*/
74	public $companyName;
75
76	/**
77	* Donor email
78	*
79	* @var string
80	*/
81	public $donorEmail;
82
83	/**
84	* WP user id.
85	*
86	* @var string
87	*/
88	public $wpUserId;
89
90	/**
91	* Payment gateway.
92	*
93	* @var string
94	*/
95	public $paymentGateway;
96
97	/**
98	* Donation-related session objects.
99	*
100	* @since 3.18.0
101	* @var FormEntry
102	*/
103	public $formEntry;
104
105	/**
106	* Donor information.
107	*
108	* @since 3.18.0
109	* @var DonorInfo
110	*/
111	public $donorInfo;
112
113	/**
114	* Card information.
115	*
116	* @since 3.18.0
117	* @var CardInfo
118	*/
119	public $cardInfo;
120
121	/**
122	* Honeypot value to detect spam submissions.
123	*
124	* @var string\|null
125	*/
126	public $honeypot;
127
128	/**
129	* Form ID prefix.
130	*
131	* @var string\|null
132	*/
133	public $formIdPrefix;
134
135	/**
136	* Form URL.
137	*
138	* @var string\|null
139	*/
140	public $formUrl;
141
142	/**
143	* Minimum donation amount.
144	*
145	* @var float\|null
146	*/
147	public $formMinimum;
148
149	/**
150	* Maximum donation amount.
151	*
152	* @var float\|null
153	*/
154	public $formMaximum;
155
156	/**
157	* Form hash.
158	*
159	* @var string\|null
160	*/
161	public $formHash;
162
163	/**
164	* Payment mode.
165	*
166	* @var string\|null
167	*/
168	public $paymentMode;
169
170	/**
171	* Stripe Payment Method.
172	*
173	* @var string\|null
174	*/
175	public $stripePaymentMethod;
176	/*
177
178	/**
179	* Constant Contact signup status.
180	*
181	* @var bool\|null
182	*/
183	public $constantContactSignup;
184
185	/**
186	* Action property.
187	*
188	* @var string\|null
189	*/
190	public $action;
191
192	/**
193	* Take array and return object.
194	*
195	* @param $array
196	*
197	* @return FormEntry
198	*/
199	public static function fromArray($array)
200	{
201	$renameTo = [
202	'amount' => 'totalAmount',
203	'first' => 'firstName',
204	'last' => 'lastName',
205	'email' => 'donorEmail',
206	'userId' => 'wpUserId',
207	'gateway' => 'paymentGateway',
208	];
209
210	$array = ArrayDataSet::renameKeys($array, $renameTo);
211	$expectedKeys = ['formId', 'totalAmount', 'firstName', 'email', 'gateway'];
212
213	if ( ! ArrayDataSet::hasRequiredKeys($array, $expectedKeys)) {
214	throw new InvalidArgumentException(
215	'Invalid FormEntries object, must have the exact following keys: ' . implode(', ', $expectedKeys)
216	);
217	}
218
219	$formEntries = new self();
220
221	foreach ($array as $key => $value) {
222	$formEntries->{$key} = $value;
223	}
224
225	return $formEntries;
226	}
227	}
228