Passed
Push — master ( 8e8ce5...b0770b )
by Brian
04:08
created

prepare_submission_data_for_saving()   B

Complexity

Conditions 10
Paths 28

Size

Total Lines 51
Code Lines 22

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 10
eloc 22
c 0
b 0
f 0
nc 28
nop 0
dl 0
loc 51
rs 7.6666

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
/**
3
 * Contains the Main Checkout Class.
4
 *
5
 */
6
7
defined( 'ABSPATH' ) || exit;
8
9
/**
10
 * Main Checkout Class.
11
 *
12
 */
13
class GetPaid_Checkout {
14
15
	/**
16
	 * @var GetPaid_Payment_Form_Submission
17
	 */
18
	protected $payment_form_submission;
19
20
	/**
21
	 * Class constructor.
22
	 * 
23
	 * @param GetPaid_Payment_Form_Submission $submission
24
	 */
25
	public function __construct( $submission ) {
26
		$this->payment_form_submission = $submission;
27
	}
28
29
	/**
30
	 * Processes the checkout.
31
	 *
32
	 */
33
	public function process_checkout() {
34
35
		// Validate the submission.
36
		$this->validate_submission();
37
38
		// Prepare the invoice.
39
		$items      = $this->get_submission_items();
40
		$invoice    = $this->get_submission_invoice();
41
		$invoice    = $this->process_submission_invoice( $invoice, $items );
42
		$prepared   = $this->prepare_submission_data_for_saving();
43
44
		$this->prepare_billing_info( $invoice );
45
46
		$shipping   = $this->prepare_shipping_info( $invoice );
47
48
		// Save the invoice.
49
		$invoice->set_is_viewed( true );
50
		$invoice->recalculate_total();
51
        $invoice->save();
52
53
		do_action( 'getpaid_checkout_invoice_updated', $invoice );
54
55
		// Send to the gateway.
56
		$this->post_process_submission( $invoice, $prepared, $shipping );
57
	}
58
59
	/**
60
	 * Validates the submission.
61
	 *
62
	 */
63
	protected function validate_submission() {
64
65
		$submission = $this->payment_form_submission;
66
		$data       = $submission->get_data();
67
68
		// Do we have an error?
69
        if ( ! empty( $submission->last_error ) ) {
70
			wp_send_json_error( $submission->last_error );
71
        }
72
73
		// We need a billing email.
74
        if ( ! $submission->has_billing_email() ) {
75
            wp_send_json_error( __( 'Provide a valid billing email.', 'invoicing' ) );
76
		}
77
78
		// Non-recurring gateways should not be allowed to process recurring invoices.
79
		if ( $submission->should_collect_payment_details() && $submission->has_recurring && ! wpinv_gateway_support_subscription( $data['wpi-gateway'] ) ) {
80
			wp_send_json_error( __( 'The selected payment gateway does not support subscription payments.', 'invoicing' ) );
81
		}
82
83
		// Ensure the gateway is active.
84
		if ( $submission->should_collect_payment_details() && ! wpinv_is_gateway_active( $data['wpi-gateway'] ) ) {
85
			wpinv_set_error( 'invalid_gateway', __( 'The selected payment gateway is not active', 'invoicing' ) );
86
		}
87
88
		// Clear any existing errors.
89
		wpinv_clear_errors();
90
91
		// Allow themes and plugins to hook to errors
92
		do_action( 'getpaid_checkout_error_checks', $submission );
93
94
		// Do we have any errors?
95
        if ( wpinv_get_errors() ) {
96
            wp_send_json_error( getpaid_get_errors_html() );
97
		}
98
99
	}
100
101
	/**
102
	 * Retrieves submission items.
103
	 *
104
	 * @return GetPaid_Form_Item[]
105
	 */
106
	protected function get_submission_items() {
107
108
		$items = $this->payment_form_submission->get_items();
109
110
        // Ensure that we have items.
111
        if ( empty( $items ) && ! $this->payment_form_submission->has_fees() ) {
112
            wp_send_json_error( __( 'Please provide at least one item or amount.', 'invoicing' ) );
113
		}
114
115
		return $items;
116
	}
117
118
	/**
119
	 * Retrieves submission invoice.
120
	 *
121
	 * @return WPInv_Invoice
122
	 */
123
	protected function get_submission_invoice() {
124
		$submission = $this->payment_form_submission;
125
126
		if ( ! $submission->has_invoice() ) {
127
			$invoice = new WPInv_Invoice();
128
			$invoice->set_created_via( 'payment_form' );
129
			return $invoice;
130
        }
131
132
		$invoice = $submission->get_invoice();
133
134
		// Make sure that it is neither paid or refunded.
135
		if ( $invoice->is_paid() || $invoice->is_refunded() ) {
136
			wp_send_json_error( __( 'This invoice has already been paid for.', 'invoicing' ) );
137
		}
138
139
		return $invoice;
140
	}
141
142
	/**
143
	 * Processes the submission invoice.
144
	 *
145
	 * @param WPInv_Invoice $invoice
146
	 * @param GetPaid_Form_Item[] $items
147
	 * @return WPInv_Invoice
148
	 */
149
	protected function process_submission_invoice( $invoice, $items ) {
150
151
		$submission = $this->payment_form_submission;
152
		$data       = $submission->get_data();
153
154
		// Set-up the invoice details.
155
		$invoice->set_email( sanitize_email( $submission->get_billing_email() ) );
156
		$invoice->set_user_id( $this->get_submission_customer() );
157
		$invoice->set_payment_form( absint( $submission->get_payment_form()->get_id() ) );
158
        $invoice->set_items( $items );
159
        $invoice->set_fees( $submission->get_fees() );
160
        $invoice->set_taxes( $submission->get_taxes() );
161
		$invoice->set_discounts( $submission->get_discounts() );
162
		$invoice->set_gateway( $data['wpi-gateway'] );
163
164
		$address_confirmed = $submission->get_field( 'confirm-address' );
0 ignored issues
show
Bug introduced by
Are you sure the assignment to $address_confirmed is correct as $submission->get_field('confirm-address') targeting GetPaid_Payment_Form_Submission::get_field() seems to always return null.

This check looks for function or method calls that always return null and whose return value is assigned to a variable.

class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

The method getObject() can return nothing but null, so it makes no sense to assign that value to a variable.

The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes.

Loading history...
165
		$invoice->set_address_confirmed( ! empty( $address_confirmed ) );
166
167
		if ( $submission->has_discount_code() ) {
168
            $invoice->set_discount_code( $submission->get_discount_code() );
169
		}
170
171
		getpaid_maybe_add_default_address( $invoice );
172
		return $invoice;
173
	}
174
175
	/**
176
	 * Retrieves the submission's customer.
177
	 *
178
	 * @return int The customer id.
179
	 */
180
	protected function get_submission_customer() {
181
		$submission = $this->payment_form_submission;
182
183
		// If this is an existing invoice...
184
		if ( $submission->has_invoice() ) {
185
			return $submission->get_invoice()->get_user_id();
186
		}
187
188
		// (Maybe) create the user.
189
        $user = get_current_user_id();
190
191
        if ( empty( $user ) ) {
192
            $user = get_user_by( 'email', $submission->get_billing_email() );
193
        }
194
195
        if ( empty( $user ) ) {
196
            $user = wpinv_create_user( $submission->get_billing_email() );
197
198
			// (Maybe) send new user notification.
199
			$should_send_notification = wpinv_get_option( 'disable_new_user_emails' );
200
			if ( ! empty( $user ) && is_numeric( $user ) && apply_filters( 'getpaid_send_new_user_notification', empty( $should_send_notification ), $user ) ) {
201
				wp_send_new_user_notifications( $user, 'user' );
202
			}
203
204
        }
205
206
        if ( is_wp_error( $user ) ) {
207
            wp_send_json_error( $user->get_error_message() );
208
        }
209
210
        if ( is_numeric( $user ) ) {
211
            return $user;
212
		}
213
214
		return $user->ID;
215
216
	}
217
218
	/**
219
     * Prepares submission data for saving to the database.
220
     *
221
	 * @return array
222
     */
223
    public function prepare_submission_data_for_saving() {
224
225
		$submission = $this->payment_form_submission;
226
227
		// Prepared submission details.
228
        $prepared = array(
229
			'all'  => array(),
230
			'meta' => array(),
231
		);
232
233
        // Raw submission details.
234
		$data     = $submission->get_data();
235
236
		// Loop through the submitted details.
237
        foreach ( $submission->get_payment_form()->get_elements() as $field ) {
238
239
			// Skip premade fields.
240
            if ( ! empty( $field['premade'] ) || $field['type'] == 'address' ) {
241
                continue;
242
            }
243
244
            // If it is required and not set, abort.
245
            if ( ! $submission->is_required_field_set( $field ) ) {
246
                wp_send_json_error( __( 'Please fill all required fields.', 'invoicing' ) );
247
            }
248
249
            // Handle misc fields.
250
            if ( isset( $data[ $field['id'] ] ) ) {
251
252
				if ( $field['type'] == 'checkbox' ) {
253
					$value = isset( $data[ $field['id'] ] ) ? __( 'Yes', 'invoicing' ) : __( 'No', 'invoicing' );
254
				} else {
255
					$value = wp_kses_post( $data[ $field['id'] ] );
256
				}
257
258
                $label = $field['id'];
259
260
                if ( isset( $field['label'] ) ) {
261
                    $label = $field['label'];
262
                }
263
264
				if ( ! empty( $field['add_meta'] ) ) {
265
					$prepared['meta'][ wpinv_clean( $label ) ] = $value;
266
				}
267
				$prepared['all'][ wpinv_clean( $label ) ] = $value;
268
269
            }
270
271
		}
272
273
		return $prepared;
274
275
	}
276
277
	/**
278
     * Retrieves address details.
279
     *
280
	 * @return array
281
	 * @param WPInv_Invoice $invoice
282
	 * @param string $type
283
     */
284
    public function prepare_address_details( $invoice, $type = 'billing' ) {
285
286
		$data     = $this->payment_form_submission->get_data();
287
		$type     = sanitize_key( $type );
288
		$address  = array();
289
		$prepared = array();
290
291
		if ( ! empty( $data[ $type ] ) ) {
292
			$address = $data[ $type ];
293
		}
294
295
		// Clean address details.
296
		foreach ( $address as $key => $value ) {
297
			$key             = sanitize_key( $key );
298
			$key             = str_replace( 'wpinv_', '', $key );
299
			$value           = wpinv_clean( $value );
300
			$prepared[ $key] = apply_filters( "getpaid_checkout_{$type}_address_$key", $value, $this->payment_form_submission, $invoice );
301
		}
302
303
		// Filter address details.
304
		$prepared = apply_filters( "getpaid_checkout_{$type}_address", $prepared, $this->payment_form_submission, $invoice );
305
306
		// Remove non-whitelisted values.
307
		return array_filter( $prepared, 'getpaid_is_address_field_whitelisted', ARRAY_FILTER_USE_KEY );
308
309
	}
310
311
	/**
312
     * Prepares the billing details.
313
     *
314
	 * @return array
315
	 * @param WPInv_Invoice $invoice
316
     */
317
    protected function prepare_billing_info( &$invoice ) {
318
319
		$billing_address = $this->prepare_address_details( $invoice, 'billing' );
320
321
		// Update the invoice with the billing details.
322
		$invoice->set_props( $billing_address );
323
324
	}
325
326
	/**
327
     * Prepares the shipping details.
328
     *
329
	 * @return array
330
	 * @param WPInv_Invoice $invoice
331
     */
332
    protected function prepare_shipping_info( $invoice ) {
333
334
		$data = $this->payment_form_submission->get_data();
335
336
		if ( empty( $data['same-shipping-address'] ) ) {
337
			return $this->prepare_address_details( $invoice, 'shipping' );
338
		}
339
340
		return $this->prepare_address_details( $invoice, 'billing' );
341
342
	}
343
344
	/**
345
	 * Confirms the submission is valid and send users to the gateway.
346
	 *
347
	 * @param WPInv_Invoice $invoice
348
	 * @param array $prepared_payment_form_data
349
	 * @param array $shipping
350
	 */
351
	protected function post_process_submission( $invoice, $prepared_payment_form_data, $shipping ) {
352
353
		// Ensure the invoice exists.
354
        if ( ! $invoice->exists() ) {
355
            wp_send_json_error( __( 'An error occured while saving your invoice. Please try again.', 'invoicing' ) );
356
        }
357
358
		// Save payment form data.
359
		$prepared_payment_form_data = apply_filters( 'getpaid_prepared_payment_form_data', $prepared_payment_form_data, $invoice );
360
        delete_post_meta( $invoice->get_id(), 'payment_form_data' );
361
		delete_post_meta( $invoice->get_id(), 'additional_meta_data' );
362
		if ( ! empty( $prepared_payment_form_data ) ) {
363
364
			if ( ! empty( $prepared_payment_form_data['all'] ) ) {
365
				update_post_meta( $invoice->get_id(), 'payment_form_data', $prepared_payment_form_data['all'] );
366
			}
367
368
			if ( ! empty( $prepared_payment_form_data['meta'] ) ) {
369
				update_post_meta( $invoice->get_id(), 'additional_meta_data', $prepared_payment_form_data['meta'] );
370
			}
371
372
		}
373
374
		// Save payment form data.
375
        if ( ! empty( $shipping ) ) {
376
            update_post_meta( $invoice->get_id(), 'shipping_address', $shipping );
377
		}
378
379
		// Backwards compatibility.
380
        add_filter( 'wp_redirect', array( $this, 'send_redirect_response' ) );
381
382
		$this->process_payment( $invoice );
383
384
        // If we are here, there was an error.
385
		wpinv_send_back_to_checkout( $invoice );
386
387
	}
388
389
	/**
390
	 * Processes the actual payment.
391
	 *
392
	 * @param WPInv_Invoice $invoice
393
	 */
394
	protected function process_payment( $invoice ) {
395
396
		// Clear any checkout errors.
397
		wpinv_clear_errors();
398
399
		// No need to send free invoices to the gateway.
400
		if ( $invoice->is_free() ) {
401
			$this->process_free_payment( $invoice );
402
		}
403
404
		$submission = $this->payment_form_submission;
405
406
		// Fires before sending to the gateway.
407
		do_action( 'getpaid_checkout_before_gateway', $invoice, $submission );
408
409
		// Allow the sumission data to be modified before it is sent to the gateway.
410
		$submission_data    = $submission->get_data();
411
		$submission_gateway = apply_filters( 'getpaid_gateway_submission_gateway', $invoice->get_gateway(), $submission, $invoice );
412
		$submission_data    = apply_filters( 'getpaid_gateway_submission_data', $submission_data, $submission, $invoice );
413
414
		// Validate the currency.
415
		if ( ! apply_filters( "getpaid_gateway_{$submission_gateway}_is_valid_for_currency", true, $invoice->get_currency() ) ) {
416
			wpinv_set_error( 'invalid_currency', __( 'The chosen payment gateway does not support this currency', 'invoicing' ) );
417
		}
418
419
		// Check to see if we have any errors.
420
		if ( wpinv_get_errors() ) {
421
			wpinv_send_back_to_checkout( $invoice );
422
		}
423
424
		// Send info to the gateway for payment processing
425
		do_action( "getpaid_gateway_$submission_gateway", $invoice, $submission_data, $submission );
426
427
		// Backwards compatibility.
428
		wpinv_send_to_gateway( $submission_gateway, $invoice );
0 ignored issues
show
Deprecated Code introduced by
The function wpinv_send_to_gateway() has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

428
		/** @scrutinizer ignore-deprecated */ wpinv_send_to_gateway( $submission_gateway, $invoice );
Loading history...
429
430
	}
431
432
	/**
433
	 * Marks the invoice as paid in case the checkout is free.
434
	 *
435
	 * @param WPInv_Invoice $invoice
436
	 */
437
	protected function process_free_payment( $invoice ) {
438
439
		$invoice->set_gateway( 'none' );
440
		$invoice->add_note( __( "This is a free invoice and won't be sent to the payment gateway", 'invoicing' ), false, false, true );
441
		$invoice->mark_paid();
442
		wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
443
444
	}
445
446
	/**
447
     * Sends a redrect response to payment details.
448
     *
449
     */
450
    public function send_redirect_response( $url ) {
451
        $url = urlencode( $url );
452
        wp_send_json_success( $url );
453
    }
454
455
}
456