Total Complexity | 62 |
Total Lines | 692 |
Duplicated Lines | 0 % |
Changes | 7 | ||
Bugs | 0 | 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 | |||
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 | return array( |
||
187 | 'cmd' => '_cart', |
||
188 | 'business' => wpinv_get_option( 'paypal_email', false ), |
||
189 | 'no_shipping' => '1', |
||
190 | 'shipping' => '0', |
||
191 | 'no_note' => '1', |
||
192 | 'charset' => 'utf-8', |
||
193 | 'rm' => is_ssl() ? 2 : 1, |
||
194 | 'upload' => 1, |
||
195 | 'currency_code' => $invoice->get_currency(), // https://developer.paypal.com/docs/nvp-soap-api/currency-codes/#paypal |
||
196 | 'return' => esc_url_raw( $this->get_return_url( $invoice ) ), |
||
197 | 'cancel_return' => esc_url_raw( $invoice->get_checkout_payment_url() ), |
||
198 | 'notify_url' => getpaid_limit_length( $this->notify_url, 255 ), |
||
199 | 'invoice' => getpaid_limit_length( $invoice->get_number(), 127 ), |
||
200 | 'custom' => $invoice->get_id(), |
||
201 | 'first_name' => getpaid_limit_length( $invoice->get_first_name(), 32 ), |
||
202 | 'last_name' => getpaid_limit_length( $invoice->get_last_name(), 64 ), |
||
203 | 'country' => getpaid_limit_length( $invoice->get_country(), 2 ), |
||
204 | 'email' => getpaid_limit_length( $invoice->get_email(), 127 ), |
||
205 | 'cbt' => get_bloginfo( 'name' ) |
||
206 | ); |
||
207 | |||
208 | } |
||
209 | |||
210 | /** |
||
211 | * Get line item args for paypal request. |
||
212 | * |
||
213 | * @param WPInv_Invoice $invoice Invoice object. |
||
214 | * @param bool $force_one_line_item Create only one item for this invoice. |
||
215 | * @return array |
||
216 | */ |
||
217 | protected function get_line_item_args( $invoice, $force_one_line_item = false ) { |
||
218 | |||
219 | // Maybe send invoice as a single item. |
||
220 | if ( $force_one_line_item ) { |
||
221 | return $this->get_line_item_args_single_item( $invoice ); |
||
222 | } |
||
223 | |||
224 | // Send each line item individually. |
||
225 | $line_item_args = array(); |
||
226 | |||
227 | // Prepare line items. |
||
228 | $this->prepare_line_items( $invoice ); |
||
229 | |||
230 | // Add taxes to the cart |
||
231 | if ( wpinv_use_taxes() && $invoice->is_taxable() ) { |
||
232 | $line_item_args['tax_cart'] = wpinv_sanitize_amount( (float) $invoice->get_total_tax(), 2 ); |
||
233 | } |
||
234 | |||
235 | // Add discount. |
||
236 | if ( $invoice->get_total_discount() > 0 ) { |
||
237 | $line_item_args['discount_amount_cart'] = wpinv_sanitize_amount( (float) $invoice->get_total_discount(), 2 ); |
||
238 | } |
||
239 | |||
240 | return array_merge( $line_item_args, $this->get_line_items() ); |
||
241 | |||
242 | } |
||
243 | |||
244 | /** |
||
245 | * Get line item args for paypal request as a single line item. |
||
246 | * |
||
247 | * @param WPInv_Invoice $invoice Invoice object. |
||
248 | * @return array |
||
249 | */ |
||
250 | protected function get_line_item_args_single_item( $invoice ) { |
||
251 | $this->delete_line_items(); |
||
252 | |||
253 | $item_name = sprintf( __( 'Invoice #%s', 'invoicing' ), $invoice->get_number() ); |
||
254 | $this->add_line_item( $item_name, 1, wpinv_round_amount( (float) $invoice->get_total(), 2, true ), $invoice->get_id() ); |
||
255 | |||
256 | return $this->get_line_items(); |
||
257 | } |
||
258 | |||
259 | /** |
||
260 | * Return all line items. |
||
261 | */ |
||
262 | protected function get_line_items() { |
||
264 | } |
||
265 | |||
266 | /** |
||
267 | * Remove all line items. |
||
268 | */ |
||
269 | protected function delete_line_items() { |
||
270 | $this->line_items = array(); |
||
271 | } |
||
272 | |||
273 | /** |
||
274 | * Prepare line items to send to paypal. |
||
275 | * |
||
276 | * @param WPInv_Invoice $invoice Invoice object. |
||
277 | */ |
||
278 | protected function prepare_line_items( $invoice ) { |
||
279 | $this->delete_line_items(); |
||
280 | |||
281 | // Items. |
||
282 | foreach ( $invoice->get_items() as $item ) { |
||
283 | $amount = $item->get_price(); |
||
284 | $quantity = $invoice->get_template() == 'amount' ? 1 : $item->get_quantity(); |
||
285 | $this->add_line_item( $item->get_raw_name(), $quantity, $amount, $item->get_id() ); |
||
286 | } |
||
287 | |||
288 | // Fees. |
||
289 | foreach ( $invoice->get_fees() as $fee => $data ) { |
||
290 | $this->add_line_item( $fee, 1, wpinv_sanitize_amount( $data['initial_fee'] ) ); |
||
291 | } |
||
292 | |||
293 | } |
||
294 | |||
295 | /** |
||
296 | * Add PayPal Line Item. |
||
297 | * |
||
298 | * @param string $item_name Item name. |
||
299 | * @param float $quantity Item quantity. |
||
300 | * @param float $amount Amount. |
||
301 | * @param string $item_number Item number. |
||
302 | */ |
||
303 | protected function add_line_item( $item_name, $quantity = 1, $amount = 0.0, $item_number = '' ) { |
||
304 | $index = ( count( $this->line_items ) / 4 ) + 1; |
||
305 | |||
306 | $item = apply_filters( |
||
307 | 'getpaid_paypal_line_item', |
||
308 | array( |
||
309 | 'item_name' => html_entity_decode( getpaid_limit_length( $item_name ? wp_strip_all_tags( $item_name ) : __( 'Item', 'invoicing' ), 127 ), ENT_NOQUOTES, 'UTF-8' ), |
||
310 | 'quantity' => (float) $quantity, |
||
311 | 'amount' => wpinv_sanitize_amount( (float) $amount, 2 ), |
||
312 | 'item_number' => $item_number, |
||
313 | ), |
||
314 | $item_name, |
||
315 | $quantity, |
||
316 | $amount, |
||
317 | $item_number |
||
318 | ); |
||
319 | |||
320 | $this->line_items[ 'item_name_' . $index ] = getpaid_limit_length( $item['item_name'], 127 ); |
||
321 | $this->line_items[ 'quantity_' . $index ] = $item['quantity']; |
||
322 | |||
323 | // The price or amount of the product, service, or contribution, not including shipping, handling, or tax. |
||
324 | $this->line_items[ 'amount_' . $index ] = $item['amount'] * $item['quantity']; |
||
325 | $this->line_items[ 'item_number_' . $index ] = getpaid_limit_length( $item['item_number'], 127 ); |
||
326 | } |
||
327 | |||
328 | /** |
||
329 | * If the default request with line items is too long, generate a new one with only one line item. |
||
330 | * |
||
331 | * https://support.microsoft.com/en-us/help/208427/maximum-url-length-is-2-083-characters-in-internet-explorer. |
||
332 | * |
||
333 | * @param WPInv_Invoice $invoice Invoice to be sent to Paypal. |
||
334 | * @param array $paypal_args Arguments sent to Paypal in the request. |
||
335 | * @return array |
||
336 | */ |
||
337 | protected function fix_request_length( $invoice, $paypal_args ) { |
||
338 | $max_paypal_length = 2083; |
||
339 | $query_candidate = http_build_query( $paypal_args, '', '&' ); |
||
340 | |||
341 | if ( strlen( $this->endpoint . $query_candidate ) <= $max_paypal_length ) { |
||
342 | return $paypal_args; |
||
343 | } |
||
344 | |||
345 | return apply_filters( |
||
346 | 'getpaid_paypal_args', |
||
347 | array_merge( |
||
348 | $this->get_transaction_args( $invoice ), |
||
349 | $this->get_line_item_args( $invoice, true ) |
||
350 | ), |
||
351 | $invoice |
||
352 | ); |
||
353 | |||
354 | } |
||
355 | |||
356 | /** |
||
357 | * Processes recurring invoices. |
||
358 | * |
||
359 | * @param array $paypal_args PayPal args. |
||
360 | * @param WPInv_Invoice $invoice Invoice object. |
||
361 | */ |
||
362 | public function process_subscription( $paypal_args, $invoice ) { |
||
466 | ); |
||
467 | |||
468 | } |
||
469 | |||
470 | /** |
||
471 | * Processes ipns and marks payments as complete. |
||
472 | * |
||
473 | * @return void |
||
474 | */ |
||
475 | public function verify_ipn() { |
||
476 | new GetPaid_Paypal_Gateway_IPN_Handler( $this ); |
||
477 | } |
||
478 | |||
479 | /** |
||
480 | * Returns a sandbox notice. |
||
481 | */ |
||
482 | public function sandbox_notice() { |
||
488 | ); |
||
489 | |||
490 | } |
||
491 | |||
492 | /** |
||
493 | * Filters the gateway settings. |
||
494 | * |
||
495 | * @param array $admin_settings |
||
496 | */ |
||
497 | public function admin_settings( $admin_settings ) { |
||
498 | |||
499 | $currencies = sprintf( |
||
500 | __( 'Supported Currencies: %s', 'invoicing' ), |
||
501 | implode( ', ', $this->currencies ) |
||
502 | ); |
||
503 | |||
504 | $admin_settings['paypal_active']['desc'] .= " ($currencies)"; |
||
505 | $admin_settings['paypal_desc']['std'] = __( 'Pay via PayPal: you can pay with your credit card if you don\'t have a PayPal account.', 'invoicing' ); |
||
506 | |||
507 | // Access tokens. |
||
508 | $live_email = wpinv_get_option( 'paypal_email' ); |
||
509 | $sandbox_email = wpinv_get_option( 'paypal_sandbox_email' ); |
||
510 | |||
511 | $admin_settings['paypal_connect'] = array( |
||
512 | 'type' => 'raw_html', |
||
513 | 'id' => 'paypal_connect', |
||
514 | 'name' => __( 'Connect to PayPal', 'invoicing' ), |
||
515 | 'desc' => sprintf( |
||
516 | '<div class="wpinv-paypal-connect-live"><a class="button button-primary" href="%s">%s</a></div><div class="wpinv-paypal-connect-sandbox"><a class="button button-primary" href="%s">%s</a></div>%s', |
||
517 | esc_url( self::get_connect_url( false ) ), |
||
518 | __( 'Connect to PayPal', 'invoicing' ), |
||
519 | esc_url( self::get_connect_url( true ) ), |
||
520 | __( 'Connect to PayPal Sandox', 'invoicing' ), |
||
521 | $this->get_js() |
||
522 | ), |
||
523 | ); |
||
524 | |||
525 | $admin_settings['paypal_email'] = array( |
||
526 | 'type' => 'text', |
||
527 | 'class' => 'live-auth-data', |
||
528 | 'id' => 'paypal_email', |
||
529 | 'name' => __( 'Live Email Address', 'invoicing' ), |
||
530 | 'desc' => __( 'The email address of your PayPal account.', 'invoicing' ), |
||
531 | ); |
||
532 | |||
533 | $admin_settings['paypal_sandbox_email'] = array( |
||
534 | 'type' => 'text', |
||
535 | 'class' => 'sandbox-auth-data', |
||
536 | 'id' => 'paypal_sandbox_email', |
||
537 | 'name' => __( 'Sandbox Email Address', 'invoicing' ), |
||
538 | 'desc' => __( 'The email address of your sandbox PayPal account.', 'invoicing' ), |
||
539 | 'std' => wpinv_get_option( 'paypal_email', '' ), |
||
540 | ); |
||
541 | |||
542 | $admin_settings['paypal_ipn_url'] = array( |
||
543 | 'type' => 'ipn_url', |
||
544 | 'id' => 'paypal_ipn_url', |
||
545 | 'name' => __( 'IPN Url', 'invoicing' ), |
||
546 | 'std' => $this->notify_url, |
||
547 | '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>', |
||
548 | 'readonly' => true, |
||
549 | ); |
||
550 | |||
551 | return $admin_settings; |
||
552 | } |
||
553 | |||
554 | /** |
||
555 | * Retrieves the PayPal connect URL when using the setup wizzard. |
||
556 | * |
||
557 | * |
||
558 | * @param array $data |
||
559 | * @return string |
||
560 | */ |
||
561 | public static function maybe_get_connect_url( $url = '', $data ) { |
||
562 | return self::get_connect_url( false, urldecode( $data['redirect'] ) ); |
||
563 | } |
||
564 | |||
565 | /** |
||
566 | * Retrieves the PayPal connect URL. |
||
567 | * |
||
568 | * |
||
569 | * @param bool $is_sandbox |
||
570 | * @param string $redirect |
||
571 | * @return string |
||
572 | */ |
||
573 | public static function get_connect_url( $is_sandbox, $redirect = '' ) { |
||
594 | ); |
||
595 | |||
596 | } |
||
597 | |||
598 | /** |
||
599 | * Generates settings page js. |
||
600 | * |
||
601 | * @return void |
||
602 | */ |
||
603 | public static function get_js() { |
||
604 | ob_start(); |
||
605 | ?> |
||
606 | <script> |
||
607 | jQuery(document).ready(function() { |
||
608 | |||
609 | jQuery( '#wpinv-settings-paypal_sandbox' ).on ( 'change', function( e ) { |
||
610 | |||
611 | jQuery( '.wpinv-paypal-connect-live, .live-auth-data' ).toggle( ! this.checked ) |
||
612 | jQuery( '.wpinv-paypal-connect-sandbox, .sandbox-auth-data' ).toggle( this.checked ) |
||
613 | |||
614 | if ( this.checked ) { |
||
615 | |||
616 | if ( jQuery('#wpinv-settings-paypal_sandbox_email').val().length > 0 ) { |
||
617 | jQuery('.wpinv-paypal-connect-sandbox').closest('tr').hide() |
||
618 | } else { |
||
619 | jQuery('.wpinv-paypal-connect-sandbox').closest('tr').show() |
||
620 | } |
||
621 | } else { |
||
622 | if ( jQuery('#wpinv-settings-paypal_email').val().length > 0 ) { |
||
623 | jQuery('.wpinv-paypal-connect-live').closest('tr').hide() |
||
624 | } else { |
||
625 | jQuery('.wpinv-paypal-connect-live').closest('tr').show() |
||
626 | } |
||
627 | } |
||
628 | }) |
||
629 | |||
630 | // Set initial state. |
||
631 | jQuery( '#wpinv-settings-paypal_sandbox' ).trigger( 'change' ) |
||
632 | |||
633 | }); |
||
634 | </script> |
||
635 | <?php |
||
636 | return ob_get_clean(); |
||
637 | } |
||
638 | |||
639 | /** |
||
640 | * Connects to PayPal. |
||
641 | * |
||
642 | * @param array $data Connection data. |
||
643 | * @return void |
||
644 | */ |
||
645 | public function connect_paypal( $data ) { |
||
705 | } |
||
706 | |||
707 | } |
||
708 |
In general, usage of exit should be done with care and only when running in a scripting context like a CLI script.