TestOffsiteGateway.php
167 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\PaymentGateways\Gateways\TestOffsiteGateway; |
| 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\PaymentRefunded; |
| 11 | use Give\Framework\PaymentGateways\Commands\RedirectOffsite; |
| 12 | use Give\Framework\PaymentGateways\PaymentGateway; |
| 13 | use Give\Framework\Support\Facades\Scripts\ScriptAsset; |
| 14 | use Give\Helpers\Form\Utils as FormUtils; |
| 15 | use Give\PaymentGateways\Gateways\TestGateway\Views\LegacyFormFieldMarkup; |
| 16 | |
| 17 | /** |
| 18 | * Class TestGatewayOffsite |
| 19 | * @since 2.18.0 |
| 20 | */ |
| 21 | class TestOffsiteGateway extends PaymentGateway |
| 22 | { |
| 23 | /** |
| 24 | * @inheritDoc |
| 25 | */ |
| 26 | public $secureRouteMethods = [ |
| 27 | 'securelyReturnFromOffsiteRedirect' |
| 28 | ]; |
| 29 | |
| 30 | /** |
| 31 | * @inheritDoc |
| 32 | */ |
| 33 | public static function id(): string |
| 34 | { |
| 35 | return 'test-offsite-gateway'; |
| 36 | } |
| 37 | |
| 38 | /** |
| 39 | * @inheritDoc |
| 40 | */ |
| 41 | public function getId(): string |
| 42 | { |
| 43 | return self::id(); |
| 44 | } |
| 45 | |
| 46 | /** |
| 47 | * @inheritDoc |
| 48 | */ |
| 49 | public function getName(): string |
| 50 | { |
| 51 | return __('Test Gateway (Offsite)', 'give'); |
| 52 | } |
| 53 | |
| 54 | /** |
| 55 | * @since 3.0.0 |
| 56 | */ |
| 57 | public function formSettings(int $formId): array |
| 58 | { |
| 59 | return [ |
| 60 | 'message' => __( |
| 61 | 'There are no fields for this gateway and you will not be charged. This payment option is only for you to test the donation experience.', |
| 62 | 'give' |
| 63 | ) |
| 64 | ]; |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * @inheritDoc |
| 69 | */ |
| 70 | public function getPaymentMethodLabel(): string |
| 71 | { |
| 72 | return __('Test Gateway (Offsite)', 'give'); |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * @since 2.30.0 |
| 77 | */ |
| 78 | public function enqueueScript(int $formId) |
| 79 | { |
| 80 | $scriptAsset = ScriptAsset::get(GIVE_PLUGIN_DIR . 'build/testOffsiteGateway.asset.php'); |
| 81 | |
| 82 | wp_enqueue_script( |
| 83 | $this::id(), |
| 84 | GIVE_PLUGIN_URL . 'build/testOffsiteGateway.js', |
| 85 | $scriptAsset['dependencies'], |
| 86 | $scriptAsset['version'], |
| 87 | true |
| 88 | ); |
| 89 | } |
| 90 | |
| 91 | /** |
| 92 | * @since 2.18.0 |
| 93 | */ |
| 94 | public function getLegacyFormFieldMarkup(int $formId, array $args): string |
| 95 | { |
| 96 | if (FormUtils::isLegacyForm($formId)) { |
| 97 | return false; |
| 98 | } |
| 99 | |
| 100 | /** @var LegacyFormFieldMarkup $legacyFormFieldMarkup */ |
| 101 | $legacyFormFieldMarkup = give(LegacyFormFieldMarkup::class); |
| 102 | |
| 103 | return $legacyFormFieldMarkup(); |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * @inheritDoc |
| 108 | */ |
| 109 | public function createPayment(Donation $donation, $gatewayData) |
| 110 | { |
| 111 | $redirectUrl = $this->generateSecureGatewayRouteUrl( |
| 112 | 'securelyReturnFromOffsiteRedirect', |
| 113 | $donation->id, |
| 114 | [ |
| 115 | 'givewp-donation-id' => $donation->id, |
| 116 | 'givewp-return-url' => $gatewayData['successUrl'] |
| 117 | ] |
| 118 | ); |
| 119 | |
| 120 | return new RedirectOffsite($redirectUrl); |
| 121 | } |
| 122 | |
| 123 | /** |
| 124 | * @since 2.29.0 Return PaymentRefunded instead of a bool value |
| 125 | * @since 2.20.0 |
| 126 | * @inerhitDoc |
| 127 | */ |
| 128 | public function refundDonation(Donation $donation): PaymentRefunded |
| 129 | { |
| 130 | return new PaymentRefunded(); |
| 131 | } |
| 132 | |
| 133 | /** |
| 134 | * An example of using a secureRouteMethod for extending the Gateway API to handle a redirect. |
| 135 | * |
| 136 | * @since 3.0.0 |
| 137 | * |
| 138 | * @throws Exception |
| 139 | */ |
| 140 | protected function securelyReturnFromOffsiteRedirect(array $queryParams): RedirectResponse |
| 141 | { |
| 142 | /** @var Donation $donation */ |
| 143 | $donation = Donation::find($queryParams['givewp-donation-id']); |
| 144 | $this->updateDonation($donation); |
| 145 | |
| 146 | return new RedirectResponse($queryParams['givewp-return-url']); |
| 147 | } |
| 148 | |
| 149 | /** |
| 150 | * @param Donation $donation |
| 151 | * |
| 152 | * @return void |
| 153 | * @throws Exception |
| 154 | */ |
| 155 | private function updateDonation(Donation $donation) |
| 156 | { |
| 157 | $donation->status = DonationStatus::COMPLETE(); |
| 158 | $donation->gatewayTransactionId = "test-gateway-transaction-id"; |
| 159 | $donation->save(); |
| 160 | |
| 161 | DonationNote::create([ |
| 162 | 'donationId' => $donation->id, |
| 163 | 'content' => 'Donation Completed from Test Gateway Offsite.' |
| 164 | ]); |
| 165 | } |
| 166 | } |
| 167 |