resources
1 year ago
PayPalCommerceGateway.php
11 months ago
payPalCommerceGateway.tsx
1 year ago
types.ts
11 months ago
PayPalCommerceGateway.php
148 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\PaymentGateways\Gateways\PayPalCommerce; |
| 4 | |
| 5 | use Exception; |
| 6 | use Give\DonationForms\Actions\GenerateDonationFormValidationRouteUrl; |
| 7 | use Give\Framework\Support\Scripts\Concerns\HasScriptAssetFile; |
| 8 | use Give\Helpers\Form\Utils; |
| 9 | use Give\Helpers\Language; |
| 10 | use Give\PaymentGateways\PayPalCommerce\Models\MerchantDetail; |
| 11 | use Give\PaymentGateways\PayPalCommerce\PayPalCommerce; |
| 12 | use Give\PaymentGateways\PayPalCommerce\Repositories\MerchantDetails; |
| 13 | |
| 14 | /** |
| 15 | * An extension of the PayPalCommerce gateway in GiveWP that supports the NextGenPaymentGatewayInterface. |
| 16 | */ |
| 17 | class PayPalCommerceGateway extends PayPalCommerce |
| 18 | { |
| 19 | use HasScriptAssetFile; |
| 20 | |
| 21 | /** |
| 22 | * This function uses to render the credit card form for v2 donation forms. |
| 23 | * |
| 24 | * @since 3.0.0 |
| 25 | * |
| 26 | * @param int $formId |
| 27 | * @param array $args |
| 28 | * |
| 29 | * @return string |
| 30 | */ |
| 31 | public function getLegacyFormFieldMarkup(int $formId, array $args): string |
| 32 | { |
| 33 | return parent::getLegacyFormFieldMarkup($formId, $args); |
| 34 | } |
| 35 | |
| 36 | /** |
| 37 | * @since 3.1.0 set translations for script |
| 38 | * @since 3.0.0 |
| 39 | */ |
| 40 | public function enqueueScript(int $formId) |
| 41 | { |
| 42 | $assets = $this->getScriptAsset(GIVE_PLUGIN_DIR . 'build/payPalCommerceGateway.asset.php'); |
| 43 | $handle = $this::id(); |
| 44 | |
| 45 | wp_enqueue_script( |
| 46 | $handle, |
| 47 | GIVE_PLUGIN_URL . 'build/payPalCommerceGateway.js', |
| 48 | $assets['dependencies'], |
| 49 | $assets['version'], |
| 50 | true |
| 51 | ); |
| 52 | |
| 53 | Language::setScriptTranslations($handle); |
| 54 | } |
| 55 | |
| 56 | /** |
| 57 | * @since 3.19.1 Add validate URL |
| 58 | * |
| 59 | * @throws Exception |
| 60 | */ |
| 61 | public function formSettings(int $formId): array |
| 62 | { |
| 63 | return [ |
| 64 | 'ajaxUrl' => admin_url('admin-ajax.php'), |
| 65 | 'donationFormId' => $formId, |
| 66 | 'donationFormNonce' => wp_create_nonce("give_donation_form_nonce_{$formId}"), |
| 67 | 'sdkOptions' => $this->getPayPalSDKOptions($formId), |
| 68 | 'validateUrl' => (new GenerateDonationFormValidationRouteUrl())(), |
| 69 | ]; |
| 70 | } |
| 71 | |
| 72 | /** |
| 73 | * List of PayPal query parameters: https://developer.paypal.com/docs/checkout/reference/customize-sdk/#query-parameters |
| 74 | * |
| 75 | * @since 4.6.0 Removed data-client-token from the SDK options for v3 forms. For v2 forms, we still need to pass the client token only when hosted fields are enabled. |
| 76 | * @since 4.5.0 Add support for disabling credit card funding via Smart Buttons Only. |
| 77 | * @since 3.0.0 |
| 78 | * @throws Exception |
| 79 | */ |
| 80 | private function getPayPalSDKOptions(int $formId): array |
| 81 | { |
| 82 | /* @var MerchantDetail $merchantDetailModel */ |
| 83 | $merchantDetailModel = give(MerchantDetail::class); |
| 84 | |
| 85 | /* @var MerchantDetails $merchantDetailRepository */ |
| 86 | $merchantDetailRepository = give(MerchantDetails::class); |
| 87 | |
| 88 | // Add hosted fields if payment field type is auto and connect account type supports custom payments. |
| 89 | $paymentFieldType = give_get_option('paypal_payment_field_type', 'auto'); |
| 90 | $acceptCreditCard = give_is_setting_enabled(give_get_option('paypal_commerce_accept_credit_card', 'enabled')); |
| 91 | |
| 92 | $paymentComponents[] = 'buttons'; |
| 93 | |
| 94 | $formIsV3 = Utils::isV3Form($formId); |
| 95 | $venmoEnabled = give_is_setting_enabled(give_get_option('paypal_commerce_accept_venmo', 'disabled')); |
| 96 | $fieldsEnabled = 'auto' === $paymentFieldType && $merchantDetailModel->supportsCustomPayments; |
| 97 | |
| 98 | $disableFunding = ['credit']; |
| 99 | if (!$acceptCreditCard && !$fieldsEnabled) { |
| 100 | $disableFunding[] = 'card'; |
| 101 | } |
| 102 | |
| 103 | $data = [ |
| 104 | 'intent' => 'capture', |
| 105 | 'vault' => 'false', |
| 106 | 'currency' => give_get_currency($formId), |
| 107 | ]; |
| 108 | |
| 109 | if ($formIsV3) { |
| 110 | if ($fieldsEnabled) { |
| 111 | $paymentComponents[] = 'card-fields'; |
| 112 | } |
| 113 | |
| 114 | $data = array_merge($data, [ |
| 115 | 'dataNamespace' => 'givewp/paypal-commerce', |
| 116 | 'clientId' => $merchantDetailModel->clientId, |
| 117 | 'disableFunding' => $disableFunding, |
| 118 | 'dataPartnerAttributionId' => give('PAYPAL_COMMERCE_ATTRIBUTION_ID'), |
| 119 | 'components' => implode(',', $paymentComponents), |
| 120 | ]); |
| 121 | |
| 122 | if ($venmoEnabled){ |
| 123 | $data['enableFunding'] = 'venmo'; |
| 124 | } |
| 125 | } else { |
| 126 | if ($fieldsEnabled) { |
| 127 | $paymentComponents[] = 'hosted-fields'; |
| 128 | $data['data-client-token'] = $merchantDetailRepository->getClientToken(); |
| 129 | } |
| 130 | |
| 131 | $data = array_merge($data, [ |
| 132 | // data-namespace is required for multiple PayPal SDKs to load in harmony. |
| 133 | 'data-namespace' => 'givewp/paypal-commerce', |
| 134 | 'client-id' => $merchantDetailModel->clientId, |
| 135 | 'disable-funding' => $disableFunding, |
| 136 | 'data-partner-attribution-id' => give('PAYPAL_COMMERCE_ATTRIBUTION_ID'), |
| 137 | 'components' => implode(',', $paymentComponents), |
| 138 | ]); |
| 139 | |
| 140 | if ($venmoEnabled){ |
| 141 | $data['enable-funding'] = 'venmo'; |
| 142 | } |
| 143 | } |
| 144 | |
| 145 | return $data; |
| 146 | } |
| 147 | } |
| 148 |