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