give / src / API / REST / V3 / Routes / Donors / ViewModels / DonorViewModel.php

DonorViewModel.php in GiveWP – Donation Plugin and Fundraising Platform 4.18.0, at src/API/REST/V3/Routes/Donors/ViewModels/DonorViewModel.php

258 lines 7.2 KB

Raw Download Zip

1	<?php
2
3	namespace Give\API\REST\V3\Routes\Donors\ViewModels;
4
5	use Give\API\REST\V3\Routes\Donors\ValueObjects\DonorAnonymousMode;
6	use Give\DonationForms\Models\DonationForm;
7	use Give\DonationForms\Repositories\DonationFormRepository;
8	use Give\Donors\Models\Donor;
9	use Give\Framework\FieldsAPI\Field;
10	use Give\Framework\FieldsAPI\Types;
11	use Give\Framework\Support\Facades\Str;
12
13	/**
14	* @since 4.14.0 Move from Give\Donors\ViewModels to API REST V3 namespace
15	* @since 4.4.0
16	*/
17	class DonorViewModel
18	{
19	private Donor $donor;
20	private DonorAnonymousMode $anonymousMode;
21	private bool $includeSensitiveData = false;
22
23	/**
24	* @since 4.4.0
25	*/
26	public function __construct(Donor $donor)
27	{
28	$this->donor = $donor;
29	}
30
31	/**
32	* @since 4.4.0
33	*/
34	public function includeSensitiveData(bool $includeSensitiveData = true): DonorViewModel
35	{
36	$this->includeSensitiveData = $includeSensitiveData;
37
38	return $this;
39	}
40
41	/**
42	* @since 4.4.0
43	*/
44	public function anonymousMode(DonorAnonymousMode $mode): DonorViewModel
45	{
46	$this->anonymousMode = $mode;
47
48	return $this;
49	}
50
51	/**
52	* @since 4.14.0 name and lastName should return only the first letter of the last name when sensitive data is not included
53	* @since 4.4.0
54	*/
55	public function exports(): array
56	{
57	$data = array_merge(
58	$this->donor->toArray(),
59	[
60	'addresses' => array_map(function ($address) { return $address->toArray(); }, $this->donor->addresses),
61	'avatarUrl' => $this->getAvatarUrl(),
62	'wpUserPermalink' => $this->donor->userId ? get_edit_user_link($this->donor->userId) : null,
63	'customFields' => $this->getCustomFields(),
64	],
65	);
66
67	if (!$this->includeSensitiveData) {
68	$sensitiveDataExcluded = [
69	'userId',
70	'email',
71	'phone',
72	'additionalEmails',
73	'name',
74	'lastName',
75	'avatarUrl',
76	'company',
77	'addresses',
78	'wpUserPermalink',
79	'customFields',
80	];
81
82	foreach ($sensitiveDataExcluded as $propertyName) {
83	switch ($propertyName) {
84	case 'name':
85	$data[$propertyName] = $data['firstName'] . ' ' . Str::substr($data['lastName'], 0, 1);
86	break;
87	case 'lastName':
88	$data[$propertyName] = Str::substr($data[$propertyName], 0, 1);
89	break;
90	case 'additionalEmails':
91	case 'customFields':
92	$data[$propertyName] = [];
93	break;
94	default:
95	$data[$propertyName] = '';
96	break;
97	}
98	}
99	}
100
101	if (isset($this->anonymousMode) && $this->anonymousMode->isRedacted() && $this->donor->isAnonymous()) {
102	$anonymousDataRedacted = [
103	'id',
104	'name',
105	'firstName',
106	'lastName',
107	'prefix',
108	'avatarUrl',
109	'company',
110	'email',
111	'phone',
112	'additionalEmails',
113	'wpUserPermalink',
114	'customFields'
115	];
116
117	foreach ($anonymousDataRedacted as $propertyName) {
118	switch ($propertyName) {
119	case 'id':
120	$data[$propertyName] = 0;
121	break;
122	case 'wpUserPermalink':
123	case 'avatarUrl':
124	$data[$propertyName] = '';
125	break;
126	case 'additionalEmails':
127	case 'customFields':
128	$data[$propertyName] = [];
129	break;
130	default:
131	$data[$propertyName] = __('anonymous', 'give');
132	break;
133	}
134	}
135	}
136
137	return $data;
138	}
139
140	/**
141	* Get avatar URL from avatar ID with fallback to Gravatar
142	*
143	* @since 4.4.0
144	*/
145	private function getAvatarUrl(): ?string
146	{
147	$avatarId = $this->donor->avatarId;
148
149	if ($avatarId) {
150	return wp_get_attachment_image_url($avatarId, ['width' => '80', 'height' => '80']);
151	} else {
152	return give_validate_gravatar($this->donor->email) ? get_avatar_url($this->donor->email, ['size' => 80]) : null;
153	}
154	}
155
156	/**
157	* Get custom fields for the donor
158	*
159	* @since 4.4.0
160	*/
161	private function getCustomFields(): array
162	{
163	$forms = $this->getUniqueDonationFormsForDonor();
164
165	if (empty($forms)) {
166	return [];
167	}
168
169	$allFields = [];
170	foreach ($forms as $form) {
171	$allFields = array_merge($allFields, $this->getDisplayedDonorMetaFieldsForForm($form));
172	}
173
174	$customFields = [];
175	foreach ($allFields as $field) {
176	$value = $this->getFieldValue($field);
177
178	if (empty($value)) {
179	continue;
180	}
181
182	$customFields[] = [
183	'label' => method_exists($field, 'getLabel') ? $field->getLabel() : $field->getName(),
184	'value' => $value,
185	];
186	}
187
188	return $customFields;
189	}
190
191	/**
192	* Get unique donation forms for the donor
193	*
194	* @since 4.4.0
195	*/
196	private function getUniqueDonationFormsForDonor(): array
197	{
198	$donations = $this->donor->donations()->getAll();
199
200	if (empty($donations)) {
201	return [];
202	}
203
204	$uniqueFormIds = [];
205	foreach ($donations as $donation) {
206	$formId = $donation->formId;
207
208	// Skip legacy forms and avoid duplicates
209	if (!give(DonationFormRepository::class)->isLegacyForm($formId) && !in_array($formId, $uniqueFormIds, true)) {
210	$uniqueFormIds[] = $formId;
211	}
212	}
213
214	$forms = [];
215	foreach ($uniqueFormIds as $formId) {
216	$form = DonationForm::find($formId);
217	if ($form !== null) {
218	$forms[] = $form;
219	}
220	}
221
222	return $forms;
223	}
224
225	/**
226	* Get displayed donor meta fields for a form
227	*
228	* @since 4.4.0
229	*/
230	private function getDisplayedDonorMetaFieldsForForm(DonationForm $form): array
231	{
232	return array_filter($form->schema()->getFields(), static function (Field $field): bool {
233	return $field->shouldShowInAdmin() && $field->shouldStoreAsDonorMeta();
234	});
235	}
236
237	/**
238	* Get field value for a custom field
239	*
240	* @since 4.4.0
241	*/
242	private function getFieldValue(Field $field): string
243	{
244	$metaValue = give()->donor_meta->get_meta($this->donor->id, $field->getName(), true);
245
246	if (empty($metaValue)) {
247	return '';
248	}
249
250	if ($field->getType() === Types::FILE) {
251	$attachmentLink = wp_get_attachment_link($metaValue);
252	return $attachmentLink ?: '';
253	}
254
255	return (string) $metaValue;
256	}
257	}
258