give
/
src
/
Framework
/
PaymentGateways
/
Webhooks
/
EventHandlers
/
Actions
/
UpdateSubscriptionStatus.php
GetEventHandlerClassByDonationStatus.php
1 year ago
GetEventHandlerClassBySubscriptionStatus.php
1 year ago
UpdateDonationStatus.php
2 years ago
UpdateSubscriptionStatus.php
3 weeks ago
UpdateSubscriptionStatus.php
92 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Framework\PaymentGateways\Webhooks\EventHandlers\Actions; |
| 4 | |
| 5 | use Exception; |
| 6 | use Give\Framework\PaymentGateways\Log\PaymentGatewayLog; |
| 7 | use Give\Subscriptions\Models\Subscription; |
| 8 | use Give\Subscriptions\Models\SubscriptionNote; |
| 9 | use Give\Subscriptions\ValueObjects\SubscriptionStatus; |
| 10 | |
| 11 | /** |
| 12 | * @since 3.6.0 |
| 13 | */ |
| 14 | class UpdateSubscriptionStatus |
| 15 | { |
| 16 | /** |
| 17 | * @since 4.16.0 Add note to subscription |
| 18 | * @since 3.6.0 |
| 19 | * |
| 20 | * @throws Exception |
| 21 | */ |
| 22 | public function __invoke( |
| 23 | Subscription $subscription, |
| 24 | SubscriptionStatus $status, |
| 25 | string $message = '' |
| 26 | ) { |
| 27 | $subscription->status = $status; |
| 28 | $subscription->save(); |
| 29 | |
| 30 | if (empty($message)) { |
| 31 | $message = $this->getMessageFromStatus($status); |
| 32 | } |
| 33 | |
| 34 | SubscriptionNote::create([ |
| 35 | 'subscriptionId' => $subscription->id, |
| 36 | 'content' => $message . ' ' . sprintf( |
| 37 | __('%s subscription ID: %s', 'give'), |
| 38 | $subscription->initialDonation()->gateway()->getName(), |
| 39 | $subscription->gatewaySubscriptionId |
| 40 | ), |
| 41 | ]); |
| 42 | |
| 43 | PaymentGatewayLog::info( |
| 44 | $message . ' ' . sprintf('Subscription ID: %s.', $subscription->id), |
| 45 | [ |
| 46 | 'Payment Gateway' => $subscription->gatewayId, |
| 47 | 'Gateway Subscription Id' => $subscription->gatewaySubscriptionId, |
| 48 | 'Subscription ID' => $subscription->id, |
| 49 | ] |
| 50 | ); |
| 51 | } |
| 52 | |
| 53 | |
| 54 | /** |
| 55 | * @since 4.5.0 Add support for PAUSED and PENDING statuses |
| 56 | * @since 3.6.0 |
| 57 | */ |
| 58 | protected function getMessageFromStatus(SubscriptionStatus $status): string |
| 59 | { |
| 60 | $message = ''; |
| 61 | |
| 62 | switch (true): |
| 63 | case ($status->isCompleted()): |
| 64 | $message = __('Subscription Completed.', 'give'); |
| 65 | break; |
| 66 | case ($status->isExpired()): |
| 67 | $message = __('Subscription Expired.', 'give'); |
| 68 | break; |
| 69 | case ($status->isActive()): |
| 70 | $message = __('Subscription Active.', 'give'); |
| 71 | break; |
| 72 | case ($status->isCancelled()): |
| 73 | $message = __('Subscription Cancelled.', 'give'); |
| 74 | break; |
| 75 | case ($status->isFailing()): |
| 76 | $message = __('Subscription Failing.', 'give'); |
| 77 | break; |
| 78 | case ($status->isPaused()): |
| 79 | $message = __('Subscription Paused.', 'give'); |
| 80 | break; |
| 81 | case ($status->isPending()): |
| 82 | $message = __('Subscription Pending.', 'give'); |
| 83 | break; |
| 84 | case ($status->isSuspended()): |
| 85 | $message = __('Subscription Suspended.', 'give'); |
| 86 | break; |
| 87 | endswitch; |
| 88 | |
| 89 | return $message; |
| 90 | } |
| 91 | } |
| 92 |