AyeCode /
invoicing
| Total Complexity | 65 |
| Total Lines | 694 |
| Duplicated Lines | 0 % |
| Changes | 7 | ||
| Bugs | 1 | Features | 2 |
Complex classes like GetPaid_Paypal_Gateway often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use GetPaid_Paypal_Gateway, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 13 | class GetPaid_Paypal_Gateway extends GetPaid_Payment_Gateway { |
||
| 14 | |||
| 15 | /** |
||
| 16 | * Payment method id. |
||
| 17 | * |
||
| 18 | * @var string |
||
| 19 | */ |
||
| 20 | public $id = 'paypal'; |
||
| 21 | |||
| 22 | /** |
||
| 23 | * An array of features that this gateway supports. |
||
| 24 | * |
||
| 25 | * @var array |
||
| 26 | */ |
||
| 27 | protected $supports = array( 'subscription', 'sandbox', 'single_subscription_group' ); |
||
| 28 | |||
| 29 | /** |
||
| 30 | * Payment method order. |
||
| 31 | * |
||
| 32 | * @var int |
||
| 33 | */ |
||
| 34 | public $order = 1; |
||
| 35 | |||
| 36 | /** |
||
| 37 | * Stores line items to send to PayPal. |
||
| 38 | * |
||
| 39 | * @var array |
||
| 40 | */ |
||
| 41 | protected $line_items = array(); |
||
| 42 | |||
| 43 | /** |
||
| 44 | * Endpoint for requests from PayPal. |
||
| 45 | * |
||
| 46 | * @var string |
||
| 47 | */ |
||
| 48 | protected $notify_url; |
||
| 49 | |||
| 50 | /** |
||
| 51 | * Endpoint for requests to PayPal. |
||
| 52 | * |
||
| 53 | * @var string |
||
| 54 | */ |
||
| 55 | protected $endpoint; |
||
| 56 | |||
| 57 | /** |
||
| 58 | * Currencies this gateway is allowed for. |
||
| 59 | * |
||
| 60 | * @var array |
||
| 61 | */ |
||
| 62 | public $currencies = array( 'AUD', 'BRL', 'CAD', 'MXN', 'NZD', 'HKD', 'SGD', 'USD', 'EUR', 'JPY', 'TRY', 'NOK', 'CZK', 'DKK', 'HUF', 'ILS', 'MYR', 'PHP', 'PLN', 'SEK', 'CHF', 'TWD', 'THB', 'GBP', 'RMB', 'RUB', 'INR' ); |
||
| 63 | |||
| 64 | /** |
||
| 65 | * URL to view a transaction. |
||
| 66 | * |
||
| 67 | * @var string |
||
| 68 | */ |
||
| 69 | public $view_transaction_url = 'https://www.{sandbox}paypal.com/activity/payment/%s'; |
||
| 70 | |||
| 71 | /** |
||
| 72 | * URL to view a subscription. |
||
| 73 | * |
||
| 74 | * @var string |
||
| 75 | */ |
||
| 76 | public $view_subscription_url = 'https://www.{sandbox}paypal.com/cgi-bin/webscr?cmd=_profile-recurring-payments&encrypted_profile_id=%s'; |
||
| 77 | |||
| 78 | /** |
||
| 79 | * Class constructor. |
||
| 80 | */ |
||
| 81 | public function __construct() { |
||
| 82 | |||
| 83 | $this->title = __( 'PayPal Standard', 'invoicing' ); |
||
| 84 | $this->method_title = __( 'PayPal Standard', 'invoicing' ); |
||
| 85 | $this->checkout_button_text = __( 'Proceed to PayPal', 'invoicing' ); |
||
| 86 | $this->notify_url = wpinv_get_ipn_url( $this->id ); |
||
| 87 | |||
| 88 | add_filter( 'getpaid_paypal_args', array( $this, 'process_subscription' ), 10, 2 ); |
||
| 89 | add_filter( 'getpaid_paypal_sandbox_notice', array( $this, 'sandbox_notice' ) ); |
||
| 90 | add_filter( 'getpaid_get_paypal_connect_url', array( $this, 'maybe_get_connect_url' ), 10, 2 ); |
||
| 91 | add_action( 'getpaid_authenticated_admin_action_connect_paypal', array( $this, 'connect_paypal' ) ); |
||
| 92 | add_action( 'wpinv_paypal_connect', array( $this, 'display_connect_buttons' ) ); |
||
| 93 | parent::__construct(); |
||
| 94 | } |
||
| 95 | |||
| 96 | /** |
||
| 97 | * Process Payment. |
||
| 98 | * |
||
| 99 | * |
||
| 100 | * @param WPInv_Invoice $invoice Invoice. |
||
| 101 | * @param array $submission_data Posted checkout fields. |
||
| 102 | * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
||
| 103 | * @return array |
||
| 104 | */ |
||
| 105 | public function process_payment( $invoice, $submission_data, $submission ) { |
||
| 106 | |||
| 107 | // Get redirect url. |
||
| 108 | $paypal_redirect = $this->get_request_url( $invoice ); |
||
| 109 | |||
| 110 | // Add a note about the request url. |
||
| 111 | $invoice->add_note( |
||
| 112 | sprintf( |
||
| 113 | __( 'Redirecting to PayPal: %s', 'invoicing' ), |
||
| 114 | esc_url( $paypal_redirect ) |
||
| 115 | ), |
||
| 116 | false, |
||
| 117 | false, |
||
| 118 | true |
||
| 119 | ); |
||
| 120 | |||
| 121 | // Redirect to PayPal |
||
| 122 | wp_redirect( $paypal_redirect ); |
||
| 123 | exit; |
||
|
|
|||
| 124 | |||
| 125 | } |
||
| 126 | |||
| 127 | /** |
||
| 128 | * Get the PayPal request URL for an invoice. |
||
| 129 | * |
||
| 130 | * @param WPInv_Invoice $invoice Invoice object. |
||
| 131 | * @return string |
||
| 132 | */ |
||
| 133 | public function get_request_url( $invoice ) { |
||
| 134 | |||
| 135 | // Endpoint for this request |
||
| 136 | $this->endpoint = $this->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr?test_ipn=1&' : 'https://www.paypal.com/cgi-bin/webscr?'; |
||
| 137 | |||
| 138 | // Retrieve paypal args. |
||
| 139 | $paypal_args = map_deep( $this->get_paypal_args( $invoice ), 'urlencode' ); |
||
| 140 | |||
| 141 | if ( $invoice->is_recurring() ) { |
||
| 142 | $paypal_args['bn'] = 'GetPaid_Subscribe_WPS_US'; |
||
| 143 | } else { |
||
| 144 | $paypal_args['bn'] = 'GetPaid_ShoppingCart_WPS_US'; |
||
| 145 | } |
||
| 146 | |||
| 147 | return add_query_arg( $paypal_args, $this->endpoint ); |
||
| 148 | |||
| 149 | } |
||
| 150 | |||
| 151 | /** |
||
| 152 | * Get PayPal Args for passing to PP. |
||
| 153 | * |
||
| 154 | * @param WPInv_Invoice $invoice Invoice object. |
||
| 155 | * @return array |
||
| 156 | */ |
||
| 157 | protected function get_paypal_args( $invoice ) { |
||
| 176 | } |
||
| 177 | |||
| 178 | /** |
||
| 179 | * Get transaction args for paypal request. |
||
| 180 | * |
||
| 181 | * @param WPInv_Invoice $invoice Invoice object. |
||
| 182 | * @return array |
||
| 183 | */ |
||
| 184 | protected function get_transaction_args( $invoice ) { |
||
| 185 | |||
| 186 | $email = $this->is_sandbox( $invoice ) ? wpinv_get_option( 'paypal_sandbox_email', wpinv_get_option( 'paypal_email', '' ) ) : wpinv_get_option( 'paypal_email', '' ); |
||
| 187 | return array( |
||
| 188 | 'cmd' => '_cart', |
||
| 189 | 'business' => $email, |
||
| 190 | 'no_shipping' => '1', |
||
| 191 | 'shipping' => '0', |
||
| 192 | 'no_note' => '1', |
||
| 193 | 'charset' => 'utf-8', |
||
| 194 | 'rm' => is_ssl() ? 2 : 1, |
||
| 195 | 'upload' => 1, |
||
| 196 | 'currency_code' => $invoice->get_currency(), // https://developer.paypal.com/docs/nvp-soap-api/currency-codes/#paypal |
||
| 197 | 'return' => esc_url_raw( $this->get_return_url( $invoice ) ), |
||
| 198 | 'cancel_return' => esc_url_raw( $invoice->get_checkout_payment_url() ), |
||
| 199 | 'notify_url' => getpaid_limit_length( $this->notify_url, 255 ), |
||
| 200 | 'invoice' => getpaid_limit_length( $invoice->get_number(), 127 ), |
||
| 201 | 'custom' => $invoice->get_id(), |
||
| 202 | 'first_name' => getpaid_limit_length( $invoice->get_first_name(), 32 ), |
||
| 203 | 'last_name' => getpaid_limit_length( $invoice->get_last_name(), 64 ), |
||
| 204 | 'country' => getpaid_limit_length( $invoice->get_country(), 2 ), |
||
| 205 | 'email' => getpaid_limit_length( $invoice->get_email(), 127 ), |
||
| 206 | 'cbt' => get_bloginfo( 'name' ), |
||
| 207 | ); |
||
| 208 | |||
| 209 | } |
||
| 210 | |||
| 211 | /** |
||
| 212 | * Get line item args for paypal request. |
||
| 213 | * |
||
| 214 | * @param WPInv_Invoice $invoice Invoice object. |
||
| 215 | * @param bool $force_one_line_item Create only one item for this invoice. |
||
| 216 | * @return array |
||
| 217 | */ |
||
| 218 | protected function get_line_item_args( $invoice, $force_one_line_item = false ) { |
||
| 219 | |||
| 220 | // Maybe send invoice as a single item. |
||
| 221 | if ( $force_one_line_item ) { |
||
| 222 | return $this->get_line_item_args_single_item( $invoice ); |
||
| 223 | } |
||
| 224 | |||
| 225 | // Send each line item individually. |
||
| 226 | $line_item_args = array(); |
||
| 227 | |||
| 228 | // Prepare line items. |
||
| 229 | $this->prepare_line_items( $invoice ); |
||
| 230 | |||
| 231 | // Add taxes to the cart |
||
| 232 | if ( wpinv_use_taxes() && $invoice->is_taxable() ) { |
||
| 233 | $line_item_args['tax_cart'] = wpinv_sanitize_amount( (float) $invoice->get_total_tax(), 2 ); |
||
| 234 | } |
||
| 235 | |||
| 236 | // Add discount. |
||
| 237 | if ( $invoice->get_total_discount() > 0 ) { |
||
| 238 | $line_item_args['discount_amount_cart'] = wpinv_sanitize_amount( (float) $invoice->get_total_discount(), 2 ); |
||
| 239 | } |
||
| 240 | |||
| 241 | return array_merge( $line_item_args, $this->get_line_items() ); |
||
| 242 | |||
| 243 | } |
||
| 244 | |||
| 245 | /** |
||
| 246 | * Get line item args for paypal request as a single line item. |
||
| 247 | * |
||
| 248 | * @param WPInv_Invoice $invoice Invoice object. |
||
| 249 | * @return array |
||
| 250 | */ |
||
| 251 | protected function get_line_item_args_single_item( $invoice ) { |
||
| 252 | $this->delete_line_items(); |
||
| 253 | |||
| 254 | $item_name = sprintf( __( 'Invoice #%s', 'invoicing' ), $invoice->get_number() ); |
||
| 255 | $this->add_line_item( $item_name, 1, wpinv_round_amount( (float) $invoice->get_total(), 2, true ), $invoice->get_id() ); |
||
| 256 | |||
| 257 | return $this->get_line_items(); |
||
| 258 | } |
||
| 259 | |||
| 260 | /** |
||
| 261 | * Return all line items. |
||
| 262 | */ |
||
| 263 | protected function get_line_items() { |
||
| 265 | } |
||
| 266 | |||
| 267 | /** |
||
| 268 | * Remove all line items. |
||
| 269 | */ |
||
| 270 | protected function delete_line_items() { |
||
| 271 | $this->line_items = array(); |
||
| 272 | } |
||
| 273 | |||
| 274 | /** |
||
| 275 | * Prepare line items to send to paypal. |
||
| 276 | * |
||
| 277 | * @param WPInv_Invoice $invoice Invoice object. |
||
| 278 | */ |
||
| 279 | protected function prepare_line_items( $invoice ) { |
||
| 280 | $this->delete_line_items(); |
||
| 281 | |||
| 282 | // Items. |
||
| 283 | foreach ( $invoice->get_items() as $item ) { |
||
| 284 | $amount = $item->get_price(); |
||
| 285 | $quantity = $invoice->get_template() == 'amount' ? 1 : $item->get_quantity(); |
||
| 286 | $this->add_line_item( $item->get_raw_name(), $quantity, $amount, $item->get_id() ); |
||
| 287 | } |
||
| 288 | |||
| 289 | // Fees. |
||
| 290 | foreach ( $invoice->get_fees() as $fee => $data ) { |
||
| 291 | $this->add_line_item( $fee, 1, wpinv_sanitize_amount( $data['initial_fee'] ) ); |
||
| 292 | } |
||
| 293 | |||
| 294 | } |
||
| 295 | |||
| 296 | /** |
||
| 297 | * Add PayPal Line Item. |
||
| 298 | * |
||
| 299 | * @param string $item_name Item name. |
||
| 300 | * @param float $quantity Item quantity. |
||
| 301 | * @param float $amount Amount. |
||
| 302 | * @param string $item_number Item number. |
||
| 303 | */ |
||
| 304 | protected function add_line_item( $item_name, $quantity = 1, $amount = 0.0, $item_number = '' ) { |
||
| 305 | $index = ( count( $this->line_items ) / 4 ) + 1; |
||
| 306 | |||
| 307 | $item = apply_filters( |
||
| 308 | 'getpaid_paypal_line_item', |
||
| 309 | array( |
||
| 310 | 'item_name' => html_entity_decode( getpaid_limit_length( $item_name ? wp_strip_all_tags( $item_name ) : __( 'Item', 'invoicing' ), 127 ), ENT_NOQUOTES, 'UTF-8' ), |
||
| 311 | 'quantity' => (float) $quantity, |
||
| 312 | 'amount' => wpinv_sanitize_amount( (float) $amount, 2 ), |
||
| 313 | 'item_number' => $item_number, |
||
| 314 | ), |
||
| 315 | $item_name, |
||
| 316 | $quantity, |
||
| 317 | $amount, |
||
| 318 | $item_number |
||
| 319 | ); |
||
| 320 | |||
| 321 | $this->line_items[ 'item_name_' . $index ] = getpaid_limit_length( $item['item_name'], 127 ); |
||
| 322 | $this->line_items[ 'quantity_' . $index ] = $item['quantity']; |
||
| 323 | |||
| 324 | // The price or amount of the product, service, or contribution, not including shipping, handling, or tax. |
||
| 325 | $this->line_items[ 'amount_' . $index ] = $item['amount'] * $item['quantity']; |
||
| 326 | $this->line_items[ 'item_number_' . $index ] = getpaid_limit_length( $item['item_number'], 127 ); |
||
| 327 | } |
||
| 328 | |||
| 329 | /** |
||
| 330 | * If the default request with line items is too long, generate a new one with only one line item. |
||
| 331 | * |
||
| 332 | * https://support.microsoft.com/en-us/help/208427/maximum-url-length-is-2-083-characters-in-internet-explorer. |
||
| 333 | * |
||
| 334 | * @param WPInv_Invoice $invoice Invoice to be sent to Paypal. |
||
| 335 | * @param array $paypal_args Arguments sent to Paypal in the request. |
||
| 336 | * @return array |
||
| 337 | */ |
||
| 338 | protected function fix_request_length( $invoice, $paypal_args ) { |
||
| 353 | ); |
||
| 354 | |||
| 355 | } |
||
| 356 | |||
| 357 | /** |
||
| 358 | * Processes recurring invoices. |
||
| 359 | * |
||
| 360 | * @param array $paypal_args PayPal args. |
||
| 361 | * @param WPInv_Invoice $invoice Invoice object. |
||
| 362 | */ |
||
| 363 | public function process_subscription( $paypal_args, $invoice ) { |
||
| 472 | ); |
||
| 473 | |||
| 474 | } |
||
| 475 | |||
| 476 | /** |
||
| 477 | * Processes ipns and marks payments as complete. |
||
| 478 | * |
||
| 479 | * @return void |
||
| 480 | */ |
||
| 481 | public function verify_ipn() { |
||
| 482 | new GetPaid_Paypal_Gateway_IPN_Handler( $this ); |
||
| 483 | } |
||
| 484 | |||
| 485 | /** |
||
| 486 | * Returns a sandbox notice. |
||
| 487 | */ |
||
| 488 | public function sandbox_notice() { |
||
| 494 | ); |
||
| 495 | |||
| 496 | } |
||
| 497 | |||
| 498 | /** |
||
| 499 | * Filters the gateway settings. |
||
| 500 | * |
||
| 501 | * @param array $admin_settings |
||
| 502 | */ |
||
| 503 | public function admin_settings( $admin_settings ) { |
||
| 504 | |||
| 505 | $currencies = sprintf( |
||
| 506 | __( 'Supported Currencies: %s', 'invoicing' ), |
||
| 507 | implode( ', ', $this->currencies ) |
||
| 508 | ); |
||
| 509 | |||
| 510 | $admin_settings['paypal_active']['desc'] .= " ($currencies)"; |
||
| 511 | $admin_settings['paypal_desc']['std'] = __( 'Pay via PayPal: you can pay with your credit card if you don\'t have a PayPal account.', 'invoicing' ); |
||
| 512 | |||
| 513 | // Access tokens. |
||
| 514 | $live_email = wpinv_get_option( 'paypal_email' ); |
||
| 515 | $sandbox_email = wpinv_get_option( 'paypal_sandbox_email' ); |
||
| 516 | |||
| 517 | $admin_settings['paypal_connect'] = array( |
||
| 518 | 'type' => 'hook', |
||
| 519 | 'id' => 'paypal_connect', |
||
| 520 | 'name' => __( 'Connect to PayPal', 'invoicing' ), |
||
| 521 | ); |
||
| 522 | |||
| 523 | $admin_settings['paypal_email'] = array( |
||
| 524 | 'type' => 'text', |
||
| 525 | 'class' => 'live-auth-data', |
||
| 526 | 'id' => 'paypal_email', |
||
| 527 | 'name' => __( 'Live Email Address', 'invoicing' ), |
||
| 528 | 'desc' => __( 'The email address of your PayPal account.', 'invoicing' ), |
||
| 529 | ); |
||
| 530 | |||
| 531 | $admin_settings['paypal_sandbox_email'] = array( |
||
| 532 | 'type' => 'text', |
||
| 533 | 'class' => 'sandbox-auth-data', |
||
| 534 | 'id' => 'paypal_sandbox_email', |
||
| 535 | 'name' => __( 'Sandbox Email Address', 'invoicing' ), |
||
| 536 | 'desc' => __( 'The email address of your sandbox PayPal account.', 'invoicing' ), |
||
| 537 | 'std' => wpinv_get_option( 'paypal_email', '' ), |
||
| 538 | ); |
||
| 539 | |||
| 540 | $admin_settings['paypal_ipn_url'] = array( |
||
| 541 | 'type' => 'ipn_url', |
||
| 542 | 'id' => 'paypal_ipn_url', |
||
| 543 | 'name' => __( 'IPN Url', 'invoicing' ), |
||
| 544 | 'std' => $this->notify_url, |
||
| 545 | 'desc' => __( "If you've not enabled IPNs in your paypal account, use the above URL to enable them.", 'invoicing' ) . ' <a href="https://developer.paypal.com/docs/api-basics/notifications/ipn/"><em>' . __( 'Learn more.', 'invoicing' ) . '</em></a>', |
||
| 546 | 'readonly' => true, |
||
| 547 | ); |
||
| 548 | |||
| 549 | return $admin_settings; |
||
| 550 | } |
||
| 551 | |||
| 552 | /** |
||
| 553 | * Retrieves the PayPal connect URL when using the setup wizzard. |
||
| 554 | * |
||
| 555 | * |
||
| 556 | * @param array $data |
||
| 557 | * @return string |
||
| 558 | */ |
||
| 559 | public static function maybe_get_connect_url( $url = '', $data = array() ) { |
||
| 560 | return self::get_connect_url( false, urldecode( $data['redirect'] ) ); |
||
| 561 | } |
||
| 562 | |||
| 563 | /** |
||
| 564 | * Retrieves the PayPal connect URL. |
||
| 565 | * |
||
| 566 | * |
||
| 567 | * @param bool $is_sandbox |
||
| 568 | * @param string $redirect |
||
| 569 | * @return string |
||
| 570 | */ |
||
| 571 | public static function get_connect_url( $is_sandbox, $redirect = '' ) { |
||
| 592 | ); |
||
| 593 | |||
| 594 | } |
||
| 595 | |||
| 596 | /** |
||
| 597 | * Generates settings page js. |
||
| 598 | * |
||
| 599 | * @return void |
||
| 600 | */ |
||
| 601 | public static function display_connect_buttons() { |
||
| 602 | |||
| 603 | ?> |
||
| 604 | <div class="wpinv-paypal-connect-live"> |
||
| 605 | <a class="button button-primary" href="<?php echo esc_url( self::get_connect_url( false ) ); ?>"><?php esc_html_e( 'Connect to PayPal', 'invoicing' ); ?></a> |
||
| 606 | </div> |
||
| 607 | <div class="wpinv-paypal-connect-sandbox"> |
||
| 608 | <a class="button button-primary" href="<?php echo esc_url( self::get_connect_url( true ) ); ?>"><?php esc_html_e( 'Connect to PayPal Sandbox', 'invoicing' ); ?></a> |
||
| 609 | </div> |
||
| 610 | |||
| 611 | <script> |
||
| 612 | jQuery(document).ready(function() { |
||
| 613 | |||
| 614 | jQuery( '#wpinv-settings-paypal_sandbox' ).on ( 'change', function( e ) { |
||
| 615 | |||
| 616 | jQuery( '.wpinv-paypal-connect-live, .live-auth-data' ).toggle( ! this.checked ) |
||
| 617 | jQuery( '.wpinv-paypal-connect-sandbox, .sandbox-auth-data' ).toggle( this.checked ) |
||
| 618 | |||
| 619 | if ( this.checked ) { |
||
| 620 | |||
| 621 | if ( jQuery('#wpinv-settings-paypal_sandbox_email').val().length > 0 ) { |
||
| 622 | jQuery('.wpinv-paypal-connect-sandbox').closest('tr').hide() |
||
| 623 | } else { |
||
| 624 | jQuery('.wpinv-paypal-connect-sandbox').closest('tr').show() |
||
| 625 | } |
||
| 626 | } else { |
||
| 627 | if ( jQuery('#wpinv-settings-paypal_email').val().length > 0 ) { |
||
| 628 | jQuery('.wpinv-paypal-connect-live').closest('tr').hide() |
||
| 629 | } else { |
||
| 630 | jQuery('.wpinv-paypal-connect-live').closest('tr').show() |
||
| 631 | } |
||
| 632 | } |
||
| 633 | }) |
||
| 634 | |||
| 635 | // Set initial state. |
||
| 636 | jQuery( '#wpinv-settings-paypal_sandbox' ).trigger( 'change' ) |
||
| 637 | |||
| 638 | }); |
||
| 639 | </script> |
||
| 640 | <?php |
||
| 641 | } |
||
| 642 | |||
| 643 | /** |
||
| 644 | * Connects to PayPal. |
||
| 645 | * |
||
| 646 | * @param array $data Connection data. |
||
| 647 | * @return void |
||
| 648 | */ |
||
| 649 | public function connect_paypal( $data ) { |
||
| 707 | } |
||
| 708 | |||
| 709 | } |
||
| 710 |
Loading history...
In general, usage of exit should be done with care and only when running in a scripting context like a CLI script.