Banners
2 years ago
DataTransferObjects
4 years ago
Exceptions
3 years ago
Migrations
2 years ago
Models
2 years ago
PayPalCheckoutSdk
2 years ago
Repositories
2 years ago
Webhooks
2 years ago
AccountAdminNotices.php
4 years ago
AdminSettingFields.php
2 years ago
AdvancedCardFields.php
4 years ago
AjaxRequestHandler.php
2 years ago
DonationDetailsPage.php
4 years ago
DonationFormPaymentMethod.php
2 years ago
PayPalClient.php
2 years ago
PayPalCommerce.php
2 years ago
RefreshToken.php
2 years ago
RefundPaymentHandler.php
4 years ago
ScriptLoader.php
2 years ago
Utils.php
2 years ago
onBoardingRedirectHandler.php
2 years ago
PayPalCommerce.php
256 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\PaymentGateways\PayPalCommerce; |
| 4 | |
| 5 | use Give\Donations\Models\Donation; |
| 6 | use Give\Framework\Exceptions\Primitives\Exception; |
| 7 | use Give\Framework\PaymentGateways\Commands\GatewayCommand; |
| 8 | use Give\Framework\PaymentGateways\Commands\PaymentComplete; |
| 9 | use Give\Framework\PaymentGateways\PaymentGateway; |
| 10 | use Give\PaymentGateways\PayPalCommerce\Models\MerchantDetail; |
| 11 | use Give\PaymentGateways\PayPalCommerce\Models\PayPalOrder; |
| 12 | |
| 13 | /** |
| 14 | * Class PayPalCommerce |
| 15 | * |
| 16 | * Boots the PayPalCommerce gateway and provides its basic registration properties |
| 17 | * |
| 18 | * @since 2.9.0 |
| 19 | */ |
| 20 | class PayPalCommerce extends PaymentGateway |
| 21 | { |
| 22 | /** |
| 23 | * @deprecated |
| 24 | * |
| 25 | * Use getId or id function to access payment gateway id. |
| 26 | * |
| 27 | */ |
| 28 | const GATEWAY_ID = 'paypal-commerce'; |
| 29 | |
| 30 | /** |
| 31 | * @since 2.19.0 |
| 32 | */ |
| 33 | public function getLegacyFormFieldMarkup(int $formId, array $args): string |
| 34 | { |
| 35 | return give(AdvancedCardFields::class)->addCreditCardForm($formId); |
| 36 | } |
| 37 | |
| 38 | /** |
| 39 | * @since 2.19.0 |
| 40 | * |
| 41 | * @return string |
| 42 | */ |
| 43 | public static function id(): string |
| 44 | { |
| 45 | return 'paypal-commerce'; |
| 46 | } |
| 47 | |
| 48 | /** |
| 49 | * @since 2.19.0 |
| 50 | * |
| 51 | * @return string |
| 52 | */ |
| 53 | public function getId(): string |
| 54 | { |
| 55 | return self::id(); |
| 56 | } |
| 57 | |
| 58 | /** |
| 59 | * @since 2.19.0 |
| 60 | * |
| 61 | * @return string |
| 62 | */ |
| 63 | public function getName(): string |
| 64 | { |
| 65 | return esc_html__('PayPal Donations', 'give'); |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * @since 2.19.0 |
| 70 | * |
| 71 | * @return string |
| 72 | */ |
| 73 | public function getPaymentMethodLabel(): string |
| 74 | { |
| 75 | return esc_html__('Credit Card', 'give'); |
| 76 | } |
| 77 | |
| 78 | /** |
| 79 | * @inerhitDoc |
| 80 | * @since 2.19.0 |
| 81 | * |
| 82 | * @param array{paypalOrder: PayPalOrder} $gatewayData |
| 83 | */ |
| 84 | public function createPayment(Donation $donation, $gatewayData): GatewayCommand |
| 85 | { |
| 86 | /** @var PayPalOrder $paypalOrder */ |
| 87 | $paypalOrder = $gatewayData['paypalOrder']; |
| 88 | |
| 89 | $command = PaymentComplete::make($paypalOrder->payment->id) |
| 90 | ->setPaymentNotes( |
| 91 | sprintf( |
| 92 | __('Transaction Successful. PayPal Transaction ID: %1$s PayPal Order ID: %2$s', 'give'), |
| 93 | $paypalOrder->payment->id, |
| 94 | $paypalOrder->id |
| 95 | ) |
| 96 | ); |
| 97 | |
| 98 | give()->payment_meta->update_meta( |
| 99 | $donation->id, |
| 100 | '_give_order_id', |
| 101 | $paypalOrder->id |
| 102 | ); |
| 103 | |
| 104 | return $command; |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * @since 3.0.0 Conditionally add "Transaction Type" setting. |
| 109 | * @since 2.33.0 Register new payment field type setting. |
| 110 | * @since 2.27.3 Enable Venmo payment method by default. |
| 111 | * @since 2.16.2 Add setting "Transaction type". |
| 112 | */ |
| 113 | public function getOptions() |
| 114 | { |
| 115 | /* @var MerchantDetail $merchantDetails */ |
| 116 | $merchantDetails = give(MerchantDetail::class); |
| 117 | |
| 118 | $settings = [ |
| 119 | [ |
| 120 | 'type' => 'title', |
| 121 | 'id' => 'give_gateway_settings_1', |
| 122 | 'table_html' => false, |
| 123 | ], |
| 124 | [ |
| 125 | 'id' => 'paypal_commerce_introduction', |
| 126 | 'type' => 'paypal_commerce_introduction', |
| 127 | ], |
| 128 | [ |
| 129 | 'type' => 'sectionend', |
| 130 | 'id' => 'give_gateway_settings_1', |
| 131 | 'table_html' => false, |
| 132 | ], |
| 133 | [ |
| 134 | 'type' => 'title', |
| 135 | 'id' => 'give_gateway_settings_2', |
| 136 | ], |
| 137 | [ |
| 138 | 'name' => esc_html__('Account Country', 'give'), |
| 139 | 'id' => 'paypal_commerce_account_country', |
| 140 | 'type' => 'paypal_commerce_account_country', |
| 141 | ], |
| 142 | [ |
| 143 | 'name' => esc_html__('Connect With Paypal', 'give'), |
| 144 | 'id' => 'paypal_commerce_account_manger', |
| 145 | 'type' => 'paypal_commerce_account_manger', |
| 146 | ], |
| 147 | [ |
| 148 | 'name' => esc_html__('Accept Venmo', 'give'), |
| 149 | 'id' => 'paypal_commerce_accept_venmo', |
| 150 | 'type' => 'radio_inline', |
| 151 | 'desc' => esc_html__( |
| 152 | 'Displays a button allowing Donors to pay with Venmo (US-only). Donations still come into your PayPal account and are subject to normal PayPal transaction fees.', |
| 153 | 'give' |
| 154 | ), |
| 155 | 'default' => 'enabled', |
| 156 | 'options' => [ |
| 157 | 'enabled' => esc_html__('Enabled', 'give'), |
| 158 | 'disabled' => esc_html__('Disabled', 'give'), |
| 159 | ], |
| 160 | ], |
| 161 | [ |
| 162 | 'name' => esc_html__('Payment Field Type', 'give'), |
| 163 | 'desc' => sprintf( |
| 164 | esc_html__( |
| 165 | '"Auto" provides the most payment options to the donor as possible, based on your account. "Smart Buttons Only" shows only the payment buttons. There is no "Hosted Only" option at this time due to limitations with PayPal\'s hosted fields. Not sure what this means? %1$sRead here%2$s.', |
| 166 | 'give' |
| 167 | ), |
| 168 | '<a href="https://docs.givewp.com/paypal-settings" target="_blank">', |
| 169 | '</a>' |
| 170 | ), |
| 171 | 'id' => 'paypal_payment_field_type', |
| 172 | 'type' => 'radio_inline', |
| 173 | 'options' => [ |
| 174 | 'auto' => esc_html__('Auto', 'give'), |
| 175 | 'smart-buttons' => esc_html__('Smart Buttons Only', 'give'), |
| 176 | ], |
| 177 | 'default' => 'auto', |
| 178 | ], |
| 179 | [ |
| 180 | 'name' => esc_html__('PayPal Donations Gateway Settings Docs Link', 'give'), |
| 181 | 'id' => 'paypal_commerce_gateway_settings_docs_link', |
| 182 | 'url' => esc_url('http://docs.givewp.com/paypal-donations'), |
| 183 | 'title' => esc_html__('PayPal Donations Gateway Settings', 'give'), |
| 184 | 'type' => 'give_docs_link', |
| 185 | ], |
| 186 | [ |
| 187 | 'type' => 'sectionend', |
| 188 | 'id' => 'give_gateway_settings_2', |
| 189 | ], |
| 190 | ]; |
| 191 | |
| 192 | if (Utils::isDonationTransactionTypeSupported($merchantDetails->accountCountry ?: '')) { |
| 193 | $settings = give_settings_array_insert( |
| 194 | $settings, |
| 195 | 'paypal_commerce_accept_venmo', |
| 196 | [ |
| 197 | [ |
| 198 | 'name' => esc_html__('Transaction Type', 'give'), |
| 199 | 'desc' => esc_html__( |
| 200 | 'Nonprofits must verify their status to withdraw donations they receive via PayPal. PayPal users that are not verified nonprofits must demonstrate how their donations will be used, once they raise more than $10,000. By default, GiveWP transactions are sent to PayPal as donations. You may change the transaction type using this option if you feel you may not meet PayPal\'s donation requirements.', |
| 201 | 'give' |
| 202 | ), |
| 203 | 'id' => 'paypal_commerce_transaction_type', |
| 204 | 'type' => 'radio_inline', |
| 205 | 'options' => [ |
| 206 | 'donation' => esc_html__('Donation', 'give'), |
| 207 | 'standard' => esc_html__('Standard Transaction', 'give'), |
| 208 | ], |
| 209 | 'default' => 'donation', |
| 210 | ] |
| 211 | ] |
| 212 | ); |
| 213 | } |
| 214 | |
| 215 | if ($merchantDetails->accountIsReady) { |
| 216 | $settings = give_settings_array_insert( |
| 217 | $settings, |
| 218 | 'paypal_commerce_gateway_settings_docs_link', |
| 219 | [ |
| 220 | [ |
| 221 | 'name' => esc_html__('Collect Billing Details', 'give'), |
| 222 | 'id' => 'paypal_commerce_collect_billing_details', |
| 223 | 'type' => 'radio_inline', |
| 224 | 'desc' => esc_html__( |
| 225 | 'If enabled, required billing address fields are added to PayPal Donations Donation forms. These fields are required to process the transaction when enabled. Billing address details are added to both the donation and donor record in GiveWP.', |
| 226 | 'give' |
| 227 | ), |
| 228 | 'default' => 'disabled', |
| 229 | 'options' => [ |
| 230 | 'enabled' => esc_html__('Enabled', 'give'), |
| 231 | 'disabled' => esc_html__('Disabled', 'give'), |
| 232 | ], |
| 233 | ], |
| 234 | ] |
| 235 | ); |
| 236 | } |
| 237 | |
| 238 | /** |
| 239 | * filter the settings |
| 240 | * |
| 241 | * @since 2.9.6 |
| 242 | */ |
| 243 | return apply_filters('give_get_settings_paypal_commerce', $settings); |
| 244 | } |
| 245 | |
| 246 | /** |
| 247 | * @since 2.20.0 |
| 248 | * @inerhitDoc |
| 249 | * @throws Exception |
| 250 | */ |
| 251 | public function refundDonation(Donation $donation) |
| 252 | { |
| 253 | throw new Exception('Method has not been implemented yet. Please use the legacy method in the meantime.'); |
| 254 | } |
| 255 | } |
| 256 |