TestGatewayOffsite.php
197 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\PaymentGateways\Gateways\TestGateway; |
| 4 | |
| 5 | use Give\Donations\Models\Donation; |
| 6 | use Give\Donations\Models\DonationNote; |
| 7 | use Give\Donations\ValueObjects\DonationStatus; |
| 8 | use Give\Framework\Exceptions\Primitives\Exception; |
| 9 | use Give\Framework\Http\Response\Types\RedirectResponse; |
| 10 | use Give\Framework\PaymentGateways\Commands\GatewayCommand; |
| 11 | use Give\Framework\PaymentGateways\Commands\PaymentRefunded; |
| 12 | use Give\Framework\PaymentGateways\Commands\RedirectOffsite; |
| 13 | use Give\Framework\PaymentGateways\PaymentGateway; |
| 14 | use Give\Helpers\Form\Utils as FormUtils; |
| 15 | use Give\PaymentGateways\Gateways\TestGateway\Views\LegacyFormFieldMarkup; |
| 16 | use Give\Subscriptions\Models\Subscription; |
| 17 | use Give\Subscriptions\ValueObjects\SubscriptionStatus; |
| 18 | |
| 19 | /** |
| 20 | * Class TestGatewayOffsite |
| 21 | * @since 2.18.0 |
| 22 | */ |
| 23 | class TestGatewayOffsite extends PaymentGateway |
| 24 | { |
| 25 | /** |
| 26 | * @inheritDoc |
| 27 | */ |
| 28 | public $secureRouteMethods = [ |
| 29 | 'securelyReturnFromOffsiteRedirect' |
| 30 | ]; |
| 31 | |
| 32 | /** |
| 33 | * @since 2.30.0 |
| 34 | */ |
| 35 | public function enqueueScript(int $formId) |
| 36 | { |
| 37 | // This is temporary action to enqueue gateway scripts in the GiveWP 3.0 feature plugin. |
| 38 | // Eventually, these scripts will be moved to the GiveWP core plugin. |
| 39 | // TODO: enqueue scripts for 3.0 when feature plugin is merged into GiveWP |
| 40 | do_action('givewp_donation_form_enqueue_test_gateway_offsite_scripts'); |
| 41 | } |
| 42 | |
| 43 | /** |
| 44 | * @inheritDoc |
| 45 | */ |
| 46 | public static function id(): string |
| 47 | { |
| 48 | return 'test-gateway-offsite'; |
| 49 | } |
| 50 | |
| 51 | /** |
| 52 | * @inheritDoc |
| 53 | */ |
| 54 | public function getId(): string |
| 55 | { |
| 56 | return self::id(); |
| 57 | } |
| 58 | |
| 59 | /** |
| 60 | * @inheritDoc |
| 61 | */ |
| 62 | public function getName(): string |
| 63 | { |
| 64 | return __('Test Gateway (Offsite)', 'give'); |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * @inheritDoc |
| 69 | */ |
| 70 | public function getPaymentMethodLabel(): string |
| 71 | { |
| 72 | return __('Test Gateway (Offsite)', 'give'); |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * @since 2.18.0 |
| 77 | */ |
| 78 | public function getLegacyFormFieldMarkup(int $formId, array $args): string |
| 79 | { |
| 80 | if (FormUtils::isLegacyForm($formId)) { |
| 81 | return false; |
| 82 | } |
| 83 | |
| 84 | /** @var LegacyFormFieldMarkup $legacyFormFieldMarkup */ |
| 85 | $legacyFormFieldMarkup = give(LegacyFormFieldMarkup::class); |
| 86 | |
| 87 | return $legacyFormFieldMarkup(); |
| 88 | } |
| 89 | |
| 90 | /** |
| 91 | * @inheritDoc |
| 92 | */ |
| 93 | public function createPayment(Donation $donation, $gatewayData) |
| 94 | { |
| 95 | $redirectUrl = $this->generateSecureGatewayRouteUrl( |
| 96 | 'securelyReturnFromOffsiteRedirect', |
| 97 | $donation->id, |
| 98 | [ |
| 99 | 'givewp-donation-id' => $donation->id, |
| 100 | 'givewp-return-url' => $gatewayData['successUrl'] |
| 101 | ] |
| 102 | ); |
| 103 | |
| 104 | return new RedirectOffsite($redirectUrl); |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * @inheritDoc |
| 109 | */ |
| 110 | public function createSubscription( |
| 111 | Donation $donation, |
| 112 | Subscription $subscription, |
| 113 | $gatewayData |
| 114 | ): GatewayCommand { |
| 115 | $redirectUrl = $this->generateSecureGatewayRouteUrl( |
| 116 | 'securelyReturnFromOffsiteRedirect', |
| 117 | $donation->id, |
| 118 | [ |
| 119 | 'givewp-donation-id' => $donation->id, |
| 120 | 'give-subscription-id' => $subscription->id, |
| 121 | 'givewp-return-url' => $gatewayData['successUrl'] |
| 122 | ] |
| 123 | ); |
| 124 | |
| 125 | return new RedirectOffsite($redirectUrl); |
| 126 | } |
| 127 | |
| 128 | /** |
| 129 | * An example of using a secureRouteMethod for extending the Gateway API to handle a redirect. |
| 130 | * |
| 131 | * @since 2.30.0 update with new gatewayData params |
| 132 | * @since 2.21.0 update to use Donation model |
| 133 | * @since 2.19.0 |
| 134 | * |
| 135 | * @param array $queryParams |
| 136 | * |
| 137 | * @return RedirectResponse |
| 138 | * @throws Exception |
| 139 | * @throws \Exception |
| 140 | */ |
| 141 | protected function securelyReturnFromOffsiteRedirect(array $queryParams): RedirectResponse |
| 142 | { |
| 143 | /** @var Donation $donation */ |
| 144 | $donation = Donation::find($queryParams['givewp-donation-id']); |
| 145 | $this->updateDonation($donation); |
| 146 | |
| 147 | if ($donation->type->isSubscription()) { |
| 148 | /** @var Subscription $subscription */ |
| 149 | $subscription = Subscription::find($queryParams['givewp-subscription-id']); |
| 150 | $this->updateSubscription($subscription); |
| 151 | } |
| 152 | |
| 153 | return new RedirectResponse($queryParams['givewp-return-url']); |
| 154 | } |
| 155 | |
| 156 | /** |
| 157 | * @since 2.29.0 Return PaymentRefunded instead of a bool value |
| 158 | * @since 2.20.0 |
| 159 | * @inerhitDoc |
| 160 | */ |
| 161 | public function refundDonation(Donation $donation): PaymentRefunded |
| 162 | { |
| 163 | return new PaymentRefunded(); |
| 164 | } |
| 165 | |
| 166 | /** |
| 167 | * @param Donation $donation |
| 168 | * |
| 169 | * @return void |
| 170 | * @throws Exception |
| 171 | */ |
| 172 | private function updateDonation(Donation $donation) |
| 173 | { |
| 174 | $donation->status = DonationStatus::COMPLETE(); |
| 175 | $donation->gatewayTransactionId = "test-gateway-transaction-id"; |
| 176 | $donation->save(); |
| 177 | |
| 178 | DonationNote::create([ |
| 179 | 'donationId' => $donation->id, |
| 180 | 'content' => 'Donation Completed from Test Gateway Offsite.' |
| 181 | ]); |
| 182 | } |
| 183 | |
| 184 | /** |
| 185 | * @since 2.23.0 |
| 186 | * |
| 187 | * @return void |
| 188 | * @throws \Exception |
| 189 | */ |
| 190 | private function updateSubscription(Subscription $subscription) |
| 191 | { |
| 192 | $subscription->status = SubscriptionStatus::ACTIVE(); |
| 193 | $subscription->transactionId = "test-gateway-transaction-id"; |
| 194 | $subscription->save(); |
| 195 | } |
| 196 | } |
| 197 |