SubscriptionViewModel.php
126 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Subscriptions\ViewModels; |
| 4 | |
| 5 | use Give\API\REST\V3\Routes\Donors\ValueObjects\DonorAnonymousMode; |
| 6 | use Give\Framework\PaymentGateways\Contracts\Subscription\SubscriptionTransactionsSynchronizable; |
| 7 | use Give\Framework\PaymentGateways\PaymentGatewayRegister; |
| 8 | use Give\Subscriptions\Models\Subscription; |
| 9 | |
| 10 | /** |
| 11 | * @since 4.8.0 |
| 12 | */ |
| 13 | class SubscriptionViewModel |
| 14 | { |
| 15 | private Subscription $subscription; |
| 16 | |
| 17 | private DonorAnonymousMode $anonymousMode; |
| 18 | |
| 19 | private bool $includeSensitiveData = false; |
| 20 | |
| 21 | /** |
| 22 | * @since 4.8.0 |
| 23 | */ |
| 24 | public function __construct(Subscription $subscription) |
| 25 | { |
| 26 | $this->subscription = $subscription; |
| 27 | } |
| 28 | |
| 29 | /** |
| 30 | * @since 4.8.0 |
| 31 | */ |
| 32 | public function includeSensitiveData(bool $includeSensitiveData = true): SubscriptionViewModel |
| 33 | { |
| 34 | $this->includeSensitiveData = $includeSensitiveData; |
| 35 | |
| 36 | return $this; |
| 37 | } |
| 38 | |
| 39 | /** |
| 40 | * @since 4.8.0 |
| 41 | */ |
| 42 | public function anonymousMode(DonorAnonymousMode $mode): SubscriptionViewModel |
| 43 | { |
| 44 | $this->anonymousMode = $mode; |
| 45 | |
| 46 | return $this; |
| 47 | } |
| 48 | |
| 49 | /** |
| 50 | * @since 4.10.0 added campaignId |
| 51 | * @since 4.8.0 |
| 52 | */ |
| 53 | public function exports(): array |
| 54 | { |
| 55 | $donor = $this->subscription->donor; |
| 56 | |
| 57 | $data = array_merge( |
| 58 | $this->subscription->toArray(), |
| 59 | [ |
| 60 | 'firstName' => $donor ? $donor->firstName : '', |
| 61 | 'lastName' => $donor ? $donor->lastName : '', |
| 62 | 'gateway' => $this->getGatewayDetails(), |
| 63 | 'projectedAnnualRevenue' => $this->subscription->projectedAnnualRevenue(), |
| 64 | 'campaignId' => $this->subscription->campaign ? $this->subscription->campaign->id : null, |
| 65 | ] |
| 66 | ); |
| 67 | |
| 68 | if (!$this->includeSensitiveData) { |
| 69 | $sensitiveDataExcluded = [ |
| 70 | 'transactionId', |
| 71 | 'gatewaySubscriptionId', |
| 72 | ]; |
| 73 | |
| 74 | foreach ($sensitiveDataExcluded as $propertyName) { |
| 75 | switch ($propertyName) { |
| 76 | default: |
| 77 | $data[$propertyName] = ''; |
| 78 | break; |
| 79 | } |
| 80 | } |
| 81 | } |
| 82 | |
| 83 | if (isset($this->anonymousMode) && $this->anonymousMode->isRedacted() && $this->subscription->donor->isAnonymous()) { |
| 84 | $anonymousDataRedacted = [ |
| 85 | 'donorId', |
| 86 | 'firstName', |
| 87 | 'lastName', |
| 88 | ]; |
| 89 | |
| 90 | foreach ($anonymousDataRedacted as $propertyName) { |
| 91 | switch ($propertyName) { |
| 92 | case 'donorId': |
| 93 | $data[$propertyName] = 0; |
| 94 | break; |
| 95 | default: |
| 96 | $data[$propertyName] = __('anonymous', 'give'); |
| 97 | break; |
| 98 | } |
| 99 | } |
| 100 | } |
| 101 | |
| 102 | return $data; |
| 103 | } |
| 104 | |
| 105 | /** |
| 106 | * @since 4.10.0 Return null if subscription URL is not available |
| 107 | * @since 4.8.0 |
| 108 | */ |
| 109 | private function getGatewayDetails(): ?array |
| 110 | { |
| 111 | if (empty($this->subscription->gatewayId) || !give(PaymentGatewayRegister::class)->hasPaymentGateway($this->subscription->gatewayId)) { |
| 112 | return null; |
| 113 | } |
| 114 | |
| 115 | $subscriptionUrl = $this->subscription->gateway()->gatewayDashboardSubscriptionUrl($this->subscription); |
| 116 | |
| 117 | return array_merge( |
| 118 | $this->subscription->gateway()->toArray(), |
| 119 | [ |
| 120 | 'subscriptionUrl' => $subscriptionUrl ?: null, |
| 121 | 'canSync' => $this->subscription->gateway()->subscriptionModule instanceof SubscriptionTransactionsSynchronizable |
| 122 | ] |
| 123 | ); |
| 124 | } |
| 125 | } |
| 126 |