TestGateway.php
167 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\PaymentGateways\Gateways\TestGateway; |
| 4 | |
| 5 | use Exception; |
| 6 | use Give\Donations\Models\Donation; |
| 7 | use Give\Framework\PaymentGateways\Commands\GatewayCommand; |
| 8 | use Give\Framework\PaymentGateways\Commands\PaymentComplete; |
| 9 | use Give\Framework\PaymentGateways\Commands\PaymentRefunded; |
| 10 | use Give\Framework\PaymentGateways\Contracts\WebhookNotificationsListener; |
| 11 | use Give\Framework\PaymentGateways\Log\PaymentGatewayLog; |
| 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\Helpers\Language; |
| 16 | use Give\PaymentGateways\Gateways\TestGateway\Views\LegacyFormFieldMarkup; |
| 17 | |
| 18 | /** |
| 19 | * A gateway for testing the donation process. No actual payment is processed and only form validation is performed. |
| 20 | * |
| 21 | * @since 4.5.0 Implements the WebhookNotificationsListener interface |
| 22 | * @since 3.0.0 change to Test Donations and manual id to replace legacy gateway |
| 23 | * @since 2.18.0 |
| 24 | */ |
| 25 | class TestGateway extends PaymentGateway implements WebhookNotificationsListener |
| 26 | { |
| 27 | /** |
| 28 | * @inheritDoc |
| 29 | */ |
| 30 | public static function id(): string |
| 31 | { |
| 32 | return 'manual'; |
| 33 | } |
| 34 | |
| 35 | /** |
| 36 | * @inheritDoc |
| 37 | */ |
| 38 | public function getId(): string |
| 39 | { |
| 40 | return self::id(); |
| 41 | } |
| 42 | |
| 43 | /** |
| 44 | * @inheritDoc |
| 45 | */ |
| 46 | public function getName(): string |
| 47 | { |
| 48 | return __('Test Donation', 'give'); |
| 49 | } |
| 50 | |
| 51 | /** |
| 52 | * @since 2.32.0 updated to enqueue script |
| 53 | * @since 2.30.0 |
| 54 | */ |
| 55 | public function enqueueScript(int $formId) |
| 56 | { |
| 57 | $scriptAsset = ScriptAsset::get(GIVE_PLUGIN_DIR . 'build/testGateway.asset.php'); |
| 58 | |
| 59 | wp_enqueue_script( |
| 60 | $this::id(), |
| 61 | GIVE_PLUGIN_URL . 'build/testGateway.js', |
| 62 | $scriptAsset['dependencies'], |
| 63 | $scriptAsset['version'], |
| 64 | true |
| 65 | ); |
| 66 | |
| 67 | Language::setScriptTranslations($this::id()); |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * @inheritDoc |
| 72 | */ |
| 73 | public function getPaymentMethodLabel(): string |
| 74 | { |
| 75 | return __('Test Donation', 'give'); |
| 76 | } |
| 77 | |
| 78 | /** |
| 79 | * @since 2.18.0 |
| 80 | */ |
| 81 | public function getLegacyFormFieldMarkup(int $formId, array $args): string |
| 82 | { |
| 83 | if (FormUtils::isLegacyForm($formId)) { |
| 84 | return ''; |
| 85 | } |
| 86 | |
| 87 | /** @var LegacyFormFieldMarkup $legacyFormFieldMarkup */ |
| 88 | $legacyFormFieldMarkup = give(LegacyFormFieldMarkup::class); |
| 89 | |
| 90 | return $legacyFormFieldMarkup(); |
| 91 | } |
| 92 | |
| 93 | /** |
| 94 | * @inheritDoc |
| 95 | */ |
| 96 | public function createPayment(Donation $donation, $gatewayData): GatewayCommand |
| 97 | { |
| 98 | $intent = $gatewayData['testGatewayIntent'] ?? 'test-gateway-intent'; |
| 99 | |
| 100 | return new PaymentComplete("test-gateway-transaction-id-{$intent}-$donation->id"); |
| 101 | } |
| 102 | |
| 103 | /** |
| 104 | * @since 2.29.0 Return PaymentRefunded instead of a bool value |
| 105 | * @since 2.20.0 |
| 106 | * @inerhitDoc |
| 107 | */ |
| 108 | public function refundDonation(Donation $donation): PaymentRefunded |
| 109 | { |
| 110 | return new PaymentRefunded(); |
| 111 | } |
| 112 | |
| 113 | /** |
| 114 | * This method implementation is a sample that demonstrates how we can handle webhook notifications |
| 115 | * |
| 116 | * @since 4.5.0 |
| 117 | */ |
| 118 | public function webhookNotificationsListener() |
| 119 | { |
| 120 | try { |
| 121 | $webhookNotification = give_clean($_REQUEST); |
| 122 | |
| 123 | /** |
| 124 | * Allow developers to handle the webhook notification. |
| 125 | * |
| 126 | * @since 4.5.0 |
| 127 | * |
| 128 | * @param array $webhookNotification |
| 129 | */ |
| 130 | do_action('givewp_' . $this::id() . '_webhook_notification_handler', $webhookNotification); |
| 131 | |
| 132 | // We will handle recurring donations in a separate submodule. |
| 133 | if (isset($webhookNotification['gatewayRecurringPayment']) && $webhookNotification['gatewayRecurringPayment']) { |
| 134 | return; |
| 135 | } |
| 136 | |
| 137 | if ( ! isset($webhookNotification['gatewayPaymentStatus']) && ! isset($webhookNotification['gatewayPaymentId'])) { |
| 138 | return; |
| 139 | } |
| 140 | |
| 141 | switch (strtolower($webhookNotification['gatewayPaymentStatus'])) { |
| 142 | case 'complete': |
| 143 | $this->webhook->events->paymentCompleted($webhookNotification['gatewayPaymentId']); |
| 144 | break; |
| 145 | case 'failed': |
| 146 | $this->webhook->events->paymentFailed($webhookNotification['gatewayPaymentId']); |
| 147 | break; |
| 148 | case 'cancelled': |
| 149 | $this->webhook->events->paymentCancelled($webhookNotification['gatewayPaymentId']); |
| 150 | break; |
| 151 | case 'refunded': |
| 152 | $this->webhook->events->paymentRefunded($webhookNotification['gatewayPaymentId']); |
| 153 | break; |
| 154 | default: |
| 155 | break; |
| 156 | } |
| 157 | } catch (Exception $e) { |
| 158 | esc_html_e('Webhook Notification failed.', 'give'); |
| 159 | PaymentGatewayLog::error( |
| 160 | 'Webhook Notification failed. Error: ' . $e->getMessage() |
| 161 | ); |
| 162 | } |
| 163 | |
| 164 | exit(); |
| 165 | } |
| 166 | } |
| 167 |