give / src / API / REST / V3 / Routes / Donations / ViewModels / DonationViewModel.php

DonationViewModel.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.8.1, at src/API/REST/V3/Routes/Donations/ViewModels/DonationViewModel.php

238 lines 6.7 KB

Raw Download Zip

1	<?php
2
3	namespace Give\API\REST\V3\Routes\Donations\ViewModels;
4
5	use Give\API\REST\V3\Routes\Donations\ValueObjects\DonationAnonymousMode;
6	use Give\DonationForms\Models\DonationForm;
7	use Give\DonationForms\Repositories\DonationFormRepository;
8	use Give\Donations\Models\Donation;
9	use Give\EventTickets\Repositories\EventTicketRepository;
10	use Give\Framework\FieldsAPI\Field;
11	use Give\Framework\FieldsAPI\Types;
12	use Give\Framework\PaymentGateways\PaymentGatewayRegister;
13	use Give\Framework\Support\Facades\Str;
14
15	/**
16	* @since 4.6.0
17	*/
18	class DonationViewModel
19	{
20	private Donation $donation;
21	private DonationAnonymousMode $anonymousMode;
22	private bool $includeSensitiveData = false;
23
24	/**
25	* @since 4.6.0
26	*/
27	public function __construct(Donation $donation)
28	{
29	$this->donation = $donation;
30	}
31
32	/**
33	* @since 4.6.0
34	*/
35	public function includeSensitiveData(bool $includeSensitiveData = true): DonationViewModel
36	{
37	$this->includeSensitiveData = $includeSensitiveData;
38
39	return $this;
40	}
41
42	/**
43	* @since 4.6.0
44	*/
45	public function anonymousMode(DonationAnonymousMode $mode): DonationViewModel
46	{
47	$this->anonymousMode = $mode;
48
49	return $this;
50	}
51
52	/**
53	* @since 4.14.0 Add gatewayTransactionId to the sensitive data excluded list, lastName should return only the first letter when sensitive data is not included
54	* @since 4.6.0
55	*/
56	public function exports(): array
57	{
58	$data = array_merge(
59	$this->donation->toArray(),
60	[
61	'customFields' => $this->getCustomFields(),
62	'eventTicketsAmount' => $this->donation->eventTicketsAmount(),
63	'eventTickets' => $this->getEventTickets(),
64	'gateway' => $this->getGatewayDetails(),
65	]
66	);
67
68	if (!$this->includeSensitiveData) {
69	$sensitiveDataExcluded = [
70	'donorIp',
71	'email',
72	'phone',
73	'billingAddress',
74	'purchaseKey',
75	'customFields',
76	'gatewayTransactionId',
77	'lastName',
78	];
79
80	foreach ($sensitiveDataExcluded as $propertyName) {
81	switch ($propertyName) {
82	case 'lastName':
83	$data[$propertyName] = Str::substr($data[$propertyName], 0, 1);
84	break;
85	case 'billingAddress':
86	$data[$propertyName] = null;
87	break;
88	case 'customFields':
89	$data[$propertyName] = [];
90	break;
91	default:
92	$data[$propertyName] = '';
93	break;
94	}
95	}
96	}
97
98	if (isset($this->anonymousMode) && $this->anonymousMode->isRedacted() && $this->donation->anonymous) {
99	$anonymousDataRedacted = [
100	'donorId',
101	'honorific',
102	'firstName',
103	'lastName',
104	'company',
105	'customFields'
106	];
107
108	foreach ($anonymousDataRedacted as $propertyName) {
109	switch ($propertyName) {
110	case 'donorId':
111	$data[$propertyName] = 0;
112	break;
113	case 'customFields':
114	$data[$propertyName] = [];
115	break;
116	default:
117	$data[$propertyName] = __('anonymous', 'give');
118	break;
119	}
120	}
121	}
122
123	return $data;
124	}
125
126	/**
127	* Get custom fields for the donation
128	*
129	* @since 4.6.0
130	*/
131	private function getCustomFields(): array
132	{
133	$customFields = [];
134
135	// get custom fields from v3 forms
136	$v3Form = $this->getDonationForm();
137
138	if ($v3Form) {
139	$displayedFields = $this->getDisplayedDonationMetaFieldsForForm($v3Form);
140
141	foreach ($displayedFields as $field) {
142	$value = $this->getFieldValue($field);
143
144	if (empty($value)) {
145	continue;
146	}
147
148	$customFields[] = [
149	'label' => method_exists($field, 'getLabel') ? $field->getLabel() : $field->getName(),
150	'value' => $value,
151	];
152	}
153	}
154
155	return apply_filters('givewp_donation_details_custom_fields', $customFields, $this->donation->id);
156	}
157
158	/**
159	* Get donation form for the donation
160	*
161	* @since 4.6.0
162	*/
163	private function getDonationForm(): ?DonationForm
164	{
165	$formId = $this->donation->formId;
166
167	if (!$formId \|\| give(DonationFormRepository::class)->isLegacyForm($formId)) {
168	return null;
169	}
170
171	return DonationForm::find($formId);
172	}
173
174	/**
175	* Get displayed donation meta fields for a form
176	*
177	* @since 4.6.0
178	*/
179	private function getDisplayedDonationMetaFieldsForForm(DonationForm $form): array
180	{
181	return array_filter($form->schema()->getFields(), static function (Field $field): bool {
182	return $field->shouldShowInAdmin() && !$field->shouldStoreAsDonorMeta();
183	});
184	}
185
186	/**
187	* Get field value for a custom field
188	*
189	* @since 4.6.0
190	*/
191	private function getFieldValue(Field $field): string
192	{
193	$metaValue = give()->payment_meta->get_meta($this->donation->id, $field->getName(), true);
194
195	if (empty($metaValue)) {
196	return '';
197	}
198
199	if ($field->getType() === Types::FILE) {
200	$attachmentLink = wp_get_attachment_link($metaValue);
201	return $attachmentLink ?: '';
202	}
203
204	return (string) $metaValue;
205	}
206
207	/**
208	* @since 4.6.0
209	*/
210	private function getEventTickets(): array
211	{
212	return give(EventTicketRepository::class)->getEventTicketDetails($this->donation);
213	}
214
215	/**
216	* @since 4.14.0 Return gateway details without transactionUrl when sensitive data is not included
217	* @since 4.8.0 Return empty array if gateway is not registered
218	* @since 4.6.0
219	*/
220	private function getGatewayDetails(): array
221	{
222	if (!give(PaymentGatewayRegister::class)->hasPaymentGateway($this->donation->gatewayId)) {
223	return [];
224	}
225
226	if (!$this->includeSensitiveData) {
227	return $this->donation->gateway()->toArray();
228	}
229
230	return array_merge(
231	$this->donation->gateway()->toArray(),
232	[
233	'transactionUrl' => $this->donation->gateway()->getTransactionUrl($this->donation),
234	]
235	);
236	}
237	}
238