Completed
Branch FET/gateways-sometimes-onsite-... (1290b9)
by
unknown
19:36 queued 17:16
created
reg_steps/payment_options/EE_SPCO_Reg_Step_Payment_Options.class.php 2 patches
Indentation   +2828 added lines, -2828 removed lines patch added patch discarded remove patch
@@ -19,2832 +19,2832 @@
 block discarded – undo
19 19
  */
20 20
 class EE_SPCO_Reg_Step_Payment_Options extends EE_SPCO_Reg_Step
21 21
 {
22
-    /**
23
-     * @var EE_Line_Item_Display $Line_Item_Display
24
-     */
25
-    protected $line_item_display;
26
-
27
-    /**
28
-     * @var boolean $handle_IPN_in_this_request
29
-     */
30
-    protected $handle_IPN_in_this_request = false;
31
-
32
-
33
-    /**
34
-     *    set_hooks - for hooking into EE Core, other modules, etc
35
-     *
36
-     * @access    public
37
-     * @return    void
38
-     */
39
-    public static function set_hooks()
40
-    {
41
-        add_filter(
42
-            'FHEE__SPCO__EE_Line_Item_Filter_Collection',
43
-            ['EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters']
44
-        );
45
-        add_action(
46
-            'wp_ajax_switch_spco_billing_form',
47
-            ['EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form']
48
-        );
49
-        add_action(
50
-            'wp_ajax_nopriv_switch_spco_billing_form',
51
-            ['EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form']
52
-        );
53
-        add_action('wp_ajax_save_payer_details', ['EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details']);
54
-        add_action(
55
-            'wp_ajax_nopriv_save_payer_details',
56
-            ['EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details']
57
-        );
58
-        add_action(
59
-            'wp_ajax_get_transaction_details_for_gateways',
60
-            ['EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details']
61
-        );
62
-        add_action(
63
-            'wp_ajax_nopriv_get_transaction_details_for_gateways',
64
-            ['EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details']
65
-        );
66
-        add_filter(
67
-            'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
68
-            ['EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'],
69
-            10,
70
-            1
71
-        );
72
-    }
73
-
74
-
75
-    /**
76
-     *    ajax switch_spco_billing_form
77
-     *
78
-     */
79
-    public static function switch_spco_billing_form()
80
-    {
81
-        EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
82
-    }
83
-
84
-
85
-    /**
86
-     *    ajax save_payer_details
87
-     *
88
-     */
89
-    public static function save_payer_details()
90
-    {
91
-        EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
92
-    }
93
-
94
-
95
-    /**
96
-     *    ajax get_transaction_details
97
-     *
98
-     */
99
-    public static function get_transaction_details()
100
-    {
101
-        EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
102
-    }
103
-
104
-
105
-    /**
106
-     * bypass_recaptcha_for_load_payment_method
107
-     *
108
-     * @access public
109
-     * @return array
110
-     * @throws InvalidArgumentException
111
-     * @throws InvalidDataTypeException
112
-     * @throws InvalidInterfaceException
113
-     */
114
-    public static function bypass_recaptcha_for_load_payment_method()
115
-    {
116
-        return [
117
-            'EESID'  => EE_Registry::instance()->SSN->id(),
118
-            'step'   => 'payment_options',
119
-            'action' => 'spco_billing_form',
120
-        ];
121
-    }
122
-
123
-
124
-    /**
125
-     *    class constructor
126
-     *
127
-     * @access    public
128
-     * @param EE_Checkout $checkout
129
-     */
130
-    public function __construct(EE_Checkout $checkout)
131
-    {
132
-        $this->request   = EED_Single_Page_Checkout::getRequest();
133
-        $this->_slug     = 'payment_options';
134
-        $this->_name     = esc_html__('Payment Options', 'event_espresso');
135
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . '/payment_options_main.template.php';
136
-        $this->checkout  = $checkout;
137
-        $this->_reset_success_message();
138
-        $this->set_instructions(
139
-            esc_html__(
140
-                'Please select a method of payment and provide any necessary billing information before proceeding.',
141
-                'event_espresso'
142
-            )
143
-        );
144
-    }
145
-
146
-
147
-    /**
148
-     * @return null
149
-     */
150
-    public function line_item_display()
151
-    {
152
-        return $this->line_item_display;
153
-    }
154
-
155
-
156
-    /**
157
-     * @param null $line_item_display
158
-     */
159
-    public function set_line_item_display($line_item_display)
160
-    {
161
-        $this->line_item_display = $line_item_display;
162
-    }
163
-
164
-
165
-    /**
166
-     * @return boolean
167
-     */
168
-    public function handle_IPN_in_this_request()
169
-    {
170
-        return $this->handle_IPN_in_this_request;
171
-    }
172
-
173
-
174
-    /**
175
-     * @param boolean $handle_IPN_in_this_request
176
-     */
177
-    public function set_handle_IPN_in_this_request($handle_IPN_in_this_request)
178
-    {
179
-        $this->handle_IPN_in_this_request = filter_var($handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN);
180
-    }
181
-
182
-
183
-    /**
184
-     * translate_js_strings
185
-     *
186
-     * @return void
187
-     */
188
-    public function translate_js_strings()
189
-    {
190
-        EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
191
-            'Please select a method of payment in order to continue.',
192
-            'event_espresso'
193
-        );
194
-        EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
195
-            'A valid method of payment could not be determined. Please refresh the page and try again.',
196
-            'event_espresso'
197
-        );
198
-        EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
199
-            'Forwarding to Secure Payment Provider.',
200
-            'event_espresso'
201
-        );
202
-    }
203
-
204
-
205
-    /**
206
-     * enqueue_styles_and_scripts
207
-     *
208
-     * @return void
209
-     * @throws EE_Error
210
-     * @throws InvalidArgumentException
211
-     * @throws InvalidDataTypeException
212
-     * @throws InvalidInterfaceException
213
-     * @throws ReflectionException
214
-     */
215
-    public function enqueue_styles_and_scripts()
216
-    {
217
-        $transaction = $this->checkout->transaction;
218
-        // if the transaction isn't set or nothing is owed on it, don't enqueue any JS
219
-        if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
220
-            return;
221
-        }
222
-        foreach (
223
-            EEM_Payment_Method::instance()->get_all_for_transaction(
224
-                $transaction,
225
-                EEM_Payment_Method::scope_cart
226
-            ) as $payment_method
227
-        ) {
228
-            $type_obj = $payment_method->type_obj();
229
-            if ($type_obj instanceof EE_PMT_Base) {
230
-                $billing_form = $type_obj->generate_new_billing_form($transaction);
231
-                if ($billing_form instanceof EE_Form_Section_Proper) {
232
-                    $billing_form->enqueue_js();
233
-                }
234
-            }
235
-        }
236
-    }
237
-
238
-
239
-    /**
240
-     * initialize_reg_step
241
-     *
242
-     * @return bool
243
-     * @throws EE_Error
244
-     * @throws InvalidArgumentException
245
-     * @throws ReflectionException
246
-     * @throws InvalidDataTypeException
247
-     * @throws InvalidInterfaceException
248
-     */
249
-    public function initialize_reg_step()
250
-    {
251
-        // TODO: if /when we implement donations, then this will need overriding
252
-        if (
253
-            // don't need payment options for:
254
-            // registrations made via the admin
255
-            // completed transactions
256
-            // overpaid transactions
257
-            // $ 0.00 transactions(no payment required)
258
-            ! $this->checkout->payment_required()
259
-            // but do NOT remove if current action being called belongs to this reg step
260
-            && ! is_callable([$this, $this->checkout->action])
261
-            && ! $this->completed()
262
-        ) {
263
-            // and if so, then we no longer need the Payment Options step
264
-            if ($this->is_current_step()) {
265
-                $this->checkout->generate_reg_form = false;
266
-            }
267
-            $this->checkout->remove_reg_step($this->_slug);
268
-            // DEBUG LOG
269
-            // $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
270
-            return false;
271
-        }
272
-        // load EEM_Payment_Method
273
-        EE_Registry::instance()->load_model('Payment_Method');
274
-        // get all active payment methods
275
-        $this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
276
-            $this->checkout->transaction,
277
-            EEM_Payment_Method::scope_cart
278
-        );
279
-        return true;
280
-    }
281
-
282
-
283
-    /**
284
-     * @return EE_Form_Section_Proper
285
-     * @throws EE_Error
286
-     * @throws InvalidArgumentException
287
-     * @throws ReflectionException
288
-     * @throws EntityNotFoundException
289
-     * @throws InvalidDataTypeException
290
-     * @throws InvalidInterfaceException
291
-     * @throws InvalidStatusException
292
-     */
293
-    public function generate_reg_form()
294
-    {
295
-        // reset in case someone changes their mind
296
-        $this->_reset_selected_method_of_payment();
297
-        // set some defaults
298
-        $this->checkout->selected_method_of_payment = 'payments_closed';
299
-        $registrations_requiring_payment            = [];
300
-        $registrations_for_free_events              = [];
301
-        $registrations_requiring_pre_approval       = [];
302
-        $sold_out_events                            = [];
303
-        $insufficient_spaces_available              = [];
304
-        $no_payment_required                        = true;
305
-        // loop thru registrations to gather info
306
-        $registrations         = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
307
-        $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
308
-            $registrations,
309
-            $this->checkout->revisit
310
-        );
311
-        foreach ($registrations as $REG_ID => $registration) {
312
-            /** @var $registration EE_Registration */
313
-            // has this registration lost it's space ?
314
-            if (isset($ejected_registrations[ $REG_ID ])) {
315
-                if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
316
-                    $sold_out_events[ $registration->event()->ID() ] = $registration->event();
317
-                } else {
318
-                    $insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
319
-                }
320
-                continue;
321
-            }
322
-            // event requires admin approval
323
-            if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
324
-                // add event to list of events with pre-approval reg status
325
-                $registrations_requiring_pre_approval[ $REG_ID ] = $registration;
326
-                do_action(
327
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
328
-                    $registration->event(),
329
-                    $this
330
-                );
331
-                continue;
332
-            }
333
-            if (
334
-                $this->checkout->revisit
335
-                && $registration->status_ID() !== EEM_Registration::status_id_approved
336
-                && (
337
-                    $registration->event()->is_sold_out()
338
-                    || $registration->event()->is_sold_out(true)
339
-                )
340
-            ) {
341
-                // add event to list of events that are sold out
342
-                $sold_out_events[ $registration->event()->ID() ] = $registration->event();
343
-                do_action(
344
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
345
-                    $registration->event(),
346
-                    $this
347
-                );
348
-                continue;
349
-            }
350
-            // are they allowed to pay now and is there monies owing?
351
-            if ($registration->owes_monies_and_can_pay()) {
352
-                $registrations_requiring_payment[ $REG_ID ] = $registration;
353
-                do_action(
354
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
355
-                    $registration->event(),
356
-                    $this
357
-                );
358
-            } elseif (
359
-                ! $this->checkout->revisit
360
-                      && $registration->status_ID() !== EEM_Registration::status_id_not_approved
361
-                      && $registration->ticket()->is_free()
362
-            ) {
363
-                $registrations_for_free_events[ $registration->ticket()->ID() ] = $registration;
364
-            }
365
-        }
366
-        $subsections = [];
367
-        // now decide which template to load
368
-        if (! empty($sold_out_events)) {
369
-            $subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
370
-        }
371
-        if (! empty($insufficient_spaces_available)) {
372
-            $subsections['insufficient_space'] = $this->_insufficient_spaces_available(
373
-                $insufficient_spaces_available
374
-            );
375
-        }
376
-        if (! empty($registrations_requiring_pre_approval)) {
377
-            $subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
378
-                $registrations_requiring_pre_approval
379
-            );
380
-        }
381
-        if (! empty($registrations_for_free_events)) {
382
-            $subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
383
-        }
384
-        if (! empty($registrations_requiring_payment)) {
385
-            if ($this->checkout->amount_owing > 0) {
386
-                // autoload Line_Item_Display classes
387
-                EEH_Autoloader::register_line_item_filter_autoloaders();
388
-                $line_item_filter_processor = new EE_Line_Item_Filter_Processor(
389
-                    apply_filters(
390
-                        'FHEE__SPCO__EE_Line_Item_Filter_Collection',
391
-                        new EE_Line_Item_Filter_Collection()
392
-                    ),
393
-                    $this->checkout->cart->get_grand_total()
394
-                );
395
-                /** @var EE_Line_Item $filtered_line_item_tree */
396
-                $filtered_line_item_tree = $line_item_filter_processor->process();
397
-                EEH_Autoloader::register_line_item_display_autoloaders();
398
-                $this->set_line_item_display(new EE_Line_Item_Display('spco'));
399
-                $subsections['payment_options'] = $this->_display_payment_options(
400
-                    $this->line_item_display->display_line_item(
401
-                        $filtered_line_item_tree,
402
-                        ['registrations' => $registrations]
403
-                    )
404
-                );
405
-                $this->checkout->amount_owing   = $filtered_line_item_tree->total();
406
-                $this->_apply_registration_payments_to_amount_owing($registrations);
407
-            }
408
-            $no_payment_required = false;
409
-        } else {
410
-            $this->_hide_reg_step_submit_button_if_revisit();
411
-        }
412
-        $this->_save_selected_method_of_payment();
413
-
414
-        $subsections['default_hidden_inputs'] = $this->reg_step_hidden_inputs();
415
-        $subsections['extra_hidden_inputs']   = $this->_extra_hidden_inputs($no_payment_required);
416
-
417
-        return new EE_Form_Section_Proper(
418
-            [
419
-                'name'            => $this->reg_form_name(),
420
-                'html_id'         => $this->reg_form_name(),
421
-                'subsections'     => $subsections,
422
-                'layout_strategy' => new EE_No_Layout(),
423
-            ]
424
-        );
425
-    }
426
-
427
-
428
-    /**
429
-     * add line item filters required for this reg step
430
-     * these filters are applied via this line in EE_SPCO_Reg_Step_Payment_Options::set_hooks():
431
-     *        add_filter( 'FHEE__SPCO__EE_Line_Item_Filter_Collection', array( 'EE_SPCO_Reg_Step_Payment_Options',
432
-     *        'add_spco_line_item_filters' ) ); so any code that wants to use the same set of filters during the
433
-     *        payment options reg step, can apply these filters via the following: apply_filters(
434
-     *        'FHEE__SPCO__EE_Line_Item_Filter_Collection', new EE_Line_Item_Filter_Collection() ) or to an existing
435
-     *        filter collection by passing that instead of instantiating a new collection
436
-     *
437
-     * @param EE_Line_Item_Filter_Collection $line_item_filter_collection
438
-     * @return EE_Line_Item_Filter_Collection
439
-     * @throws EE_Error
440
-     * @throws InvalidArgumentException
441
-     * @throws ReflectionException
442
-     * @throws EntityNotFoundException
443
-     * @throws InvalidDataTypeException
444
-     * @throws InvalidInterfaceException
445
-     * @throws InvalidStatusException
446
-     */
447
-    public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
448
-    {
449
-        if (! EE_Registry::instance()->SSN instanceof EE_Session) {
450
-            return $line_item_filter_collection;
451
-        }
452
-        if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
453
-            return $line_item_filter_collection;
454
-        }
455
-        if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
456
-            return $line_item_filter_collection;
457
-        }
458
-        $line_item_filter_collection->add(
459
-            new EE_Billable_Line_Item_Filter(
460
-                EE_SPCO_Reg_Step_Payment_Options::remove_ejected_registrations(
461
-                    EE_Registry::instance()->SSN->checkout()->transaction->registrations(
462
-                        EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
463
-                    )
464
-                )
465
-            )
466
-        );
467
-        $line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
468
-        return $line_item_filter_collection;
469
-    }
470
-
471
-
472
-    /**
473
-     * remove_ejected_registrations
474
-     * if a registrant has lost their potential space at an event due to lack of payment,
475
-     * then this method removes them from the list of registrations being paid for during this request
476
-     *
477
-     * @param EE_Registration[] $registrations
478
-     * @return EE_Registration[]
479
-     * @throws EE_Error
480
-     * @throws InvalidArgumentException
481
-     * @throws ReflectionException
482
-     * @throws EntityNotFoundException
483
-     * @throws InvalidDataTypeException
484
-     * @throws InvalidInterfaceException
485
-     * @throws InvalidStatusException
486
-     */
487
-    public static function remove_ejected_registrations(array $registrations)
488
-    {
489
-        $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
490
-            $registrations,
491
-            EE_Registry::instance()->SSN->checkout()->revisit
492
-        );
493
-        foreach ($registrations as $REG_ID => $registration) {
494
-            // has this registration lost it's space ?
495
-            if (isset($ejected_registrations[ $REG_ID ])) {
496
-                unset($registrations[ $REG_ID ]);
497
-            }
498
-        }
499
-        return $registrations;
500
-    }
501
-
502
-
503
-    /**
504
-     * find_registrations_that_lost_their_space
505
-     * If a registrant chooses an offline payment method like Invoice,
506
-     * then no space is reserved for them at the event until they fully pay fo that site
507
-     * (unless the event's default reg status is set to APPROVED)
508
-     * if a registrant then later returns to pay, but the number of spaces available has been reduced due to sales,
509
-     * then this method will determine which registrations have lost the ability to complete the reg process.
510
-     *
511
-     * @param EE_Registration[] $registrations
512
-     * @param bool              $revisit
513
-     * @return array
514
-     * @throws EE_Error
515
-     * @throws InvalidArgumentException
516
-     * @throws ReflectionException
517
-     * @throws EntityNotFoundException
518
-     * @throws InvalidDataTypeException
519
-     * @throws InvalidInterfaceException
520
-     * @throws InvalidStatusException
521
-     */
522
-    public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
523
-    {
524
-        // registrations per event
525
-        $event_reg_count = [];
526
-        // spaces left per event
527
-        $event_spaces_remaining = [];
528
-        // tickets left sorted by ID
529
-        $tickets_remaining = [];
530
-        // registrations that have lost their space
531
-        $ejected_registrations = [];
532
-        foreach ($registrations as $REG_ID => $registration) {
533
-            if (
534
-                $registration->status_ID() === EEM_Registration::status_id_approved
535
-                || apply_filters(
536
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
537
-                    false,
538
-                    $registration,
539
-                    $revisit
540
-                )
541
-            ) {
542
-                continue;
543
-            }
544
-            $EVT_ID = $registration->event_ID();
545
-            $ticket = $registration->ticket();
546
-            if (! isset($tickets_remaining[ $ticket->ID() ])) {
547
-                $tickets_remaining[ $ticket->ID() ] = $ticket->remaining();
548
-            }
549
-            if ($tickets_remaining[ $ticket->ID() ] > 0) {
550
-                if (! isset($event_reg_count[ $EVT_ID ])) {
551
-                    $event_reg_count[ $EVT_ID ] = 0;
552
-                }
553
-                $event_reg_count[ $EVT_ID ]++;
554
-                if (! isset($event_spaces_remaining[ $EVT_ID ])) {
555
-                    $event_spaces_remaining[ $EVT_ID ] = $registration->event()->spaces_remaining_for_sale();
556
-                }
557
-            }
558
-            if (
559
-                $revisit
560
-                && ($tickets_remaining[ $ticket->ID() ] === 0
561
-                    || $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
562
-                )
563
-            ) {
564
-                $ejected_registrations[ $REG_ID ] = $registration->event();
565
-                if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
566
-                    /** @type EE_Registration_Processor $registration_processor */
567
-                    $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
568
-                    // at this point, we should have enough details about the registrant to consider the registration
569
-                    // NOT incomplete
570
-                    $registration_processor->manually_update_registration_status(
571
-                        $registration,
572
-                        EEM_Registration::status_id_wait_list
573
-                    );
574
-                }
575
-            }
576
-        }
577
-        return $ejected_registrations;
578
-    }
579
-
580
-
581
-    /**
582
-     * _hide_reg_step_submit_button
583
-     * removes the html for the reg step submit button
584
-     * by replacing it with an empty string via filter callback
585
-     *
586
-     * @return void
587
-     */
588
-    protected function _adjust_registration_status_if_event_old_sold()
589
-    {
590
-    }
591
-
592
-
593
-    /**
594
-     * _hide_reg_step_submit_button
595
-     * removes the html for the reg step submit button
596
-     * by replacing it with an empty string via filter callback
597
-     *
598
-     * @return void
599
-     */
600
-    protected function _hide_reg_step_submit_button_if_revisit()
601
-    {
602
-        if ($this->checkout->revisit) {
603
-            add_filter('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string');
604
-        }
605
-    }
606
-
607
-
608
-    /**
609
-     * sold_out_events
610
-     * displays notices regarding events that have sold out since hte registrant first signed up
611
-     *
612
-     * @param EE_Event[] $sold_out_events_array
613
-     * @return EE_Form_Section_Proper
614
-     * @throws EE_Error
615
-     */
616
-    private function _sold_out_events($sold_out_events_array = [])
617
-    {
618
-        // set some defaults
619
-        $this->checkout->selected_method_of_payment = 'events_sold_out';
620
-        $sold_out_events                            = '';
621
-        foreach ($sold_out_events_array as $sold_out_event) {
622
-            $sold_out_events .= EEH_HTML::li(
623
-                EEH_HTML::span(
624
-                    '  ' . $sold_out_event->name(),
625
-                    '',
626
-                    'dashicons dashicons-marker ee-icon-size-16 pink-text'
627
-                )
628
-            );
629
-        }
630
-        return new EE_Form_Section_Proper(
631
-            [
632
-                'layout_strategy' => new EE_Template_Layout(
633
-                    [
634
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
635
-                                                  . $this->_slug
636
-                                                  . '/sold_out_events.template.php',
637
-                        'template_args'        => apply_filters(
638
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
639
-                            [
640
-                                'sold_out_events'     => $sold_out_events,
641
-                                'sold_out_events_msg' => apply_filters(
642
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
643
-                                    sprintf(
644
-                                        esc_html__(
645
-                                            'It appears that the event you were about to make a payment for has sold out since you first registered. If you have already made a partial payment towards this event, please contact the event administrator for a refund.%3$s%3$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%2$s',
646
-                                            'event_espresso'
647
-                                        ),
648
-                                        '<strong>',
649
-                                        '</strong>',
650
-                                        '<br />'
651
-                                    )
652
-                                ),
653
-                            ]
654
-                        ),
655
-                    ]
656
-                ),
657
-            ]
658
-        );
659
-    }
660
-
661
-
662
-    /**
663
-     * _insufficient_spaces_available
664
-     * displays notices regarding events that do not have enough remaining spaces
665
-     * to satisfy the current number of registrations looking to pay
666
-     *
667
-     * @param EE_Event[] $insufficient_spaces_events_array
668
-     * @return EE_Form_Section_Proper
669
-     * @throws EE_Error
670
-     * @throws ReflectionException
671
-     */
672
-    private function _insufficient_spaces_available($insufficient_spaces_events_array = [])
673
-    {
674
-        // set some defaults
675
-        $this->checkout->selected_method_of_payment = 'invoice';
676
-        $insufficient_space_events                  = '';
677
-        foreach ($insufficient_spaces_events_array as $event) {
678
-            if ($event instanceof EE_Event) {
679
-                $insufficient_space_events .= EEH_HTML::li(
680
-                    EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
681
-                );
682
-            }
683
-        }
684
-        return new EE_Form_Section_Proper(
685
-            [
686
-                'subsections'     => [
687
-                    'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
688
-                    'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
689
-                ],
690
-                'layout_strategy' => new EE_Template_Layout(
691
-                    [
692
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
693
-                                                  . $this->_slug
694
-                                                  . '/sold_out_events.template.php',
695
-                        'template_args'        => apply_filters(
696
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
697
-                            [
698
-                                'sold_out_events'     => $insufficient_space_events,
699
-                                'sold_out_events_msg' => apply_filters(
700
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__insufficient_space_msg',
701
-                                    esc_html__(
702
-                                        'It appears that the event you were about to make a payment for has sold additional tickets since you first registered, and there are no longer enough spaces left to accommodate your selections. You may continue to pay and secure the available space(s) remaining, or simply cancel if you no longer wish to purchase. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
703
-                                        'event_espresso'
704
-                                    )
705
-                                ),
706
-                            ]
707
-                        ),
708
-                    ]
709
-                ),
710
-            ]
711
-        );
712
-    }
713
-
714
-
715
-    /**
716
-     * registrations_requiring_pre_approval
717
-     *
718
-     * @param array $registrations_requiring_pre_approval
719
-     * @return EE_Form_Section_Proper
720
-     * @throws EE_Error
721
-     * @throws EntityNotFoundException
722
-     * @throws ReflectionException
723
-     */
724
-    private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = [])
725
-    {
726
-        $events_requiring_pre_approval = [];
727
-        foreach ($registrations_requiring_pre_approval as $registration) {
728
-            if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
729
-                $events_requiring_pre_approval[ $registration->event()->ID() ] = EEH_HTML::li(
730
-                    EEH_HTML::span(
731
-                        '',
732
-                        '',
733
-                        'dashicons dashicons-marker ee-icon-size-16 orange-text'
734
-                    )
735
-                    . EEH_HTML::span($registration->event()->name(), '', 'orange-text')
736
-                );
737
-            }
738
-        }
739
-        return new EE_Form_Section_Proper(
740
-            [
741
-                'layout_strategy' => new EE_Template_Layout(
742
-                    [
743
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
744
-                                                  . $this->_slug
745
-                                                  . '/events_requiring_pre_approval.template.php', // layout_template
746
-                        'template_args'        => apply_filters(
747
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
748
-                            [
749
-                                'events_requiring_pre_approval'     => implode('', $events_requiring_pre_approval),
750
-                                'events_requiring_pre_approval_msg' => apply_filters(
751
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___events_requiring_pre_approval__events_requiring_pre_approval_msg',
752
-                                    esc_html__(
753
-                                        'The following events do not require payment at this time and will not be billed during this transaction. Billing will only occur after the attendee has been approved by the event organizer. You will be notified when your registration has been processed. If this is a free event, then no billing will occur.',
754
-                                        'event_espresso'
755
-                                    )
756
-                                ),
757
-                            ]
758
-                        ),
759
-                    ]
760
-                ),
761
-            ]
762
-        );
763
-    }
764
-
765
-
766
-    /**
767
-     * _no_payment_required
768
-     *
769
-     * @param EE_Event[] $registrations_for_free_events
770
-     * @return EE_Form_Section_Proper
771
-     * @throws EE_Error
772
-     */
773
-    private function _no_payment_required($registrations_for_free_events = [])
774
-    {
775
-        // set some defaults
776
-        $this->checkout->selected_method_of_payment = 'no_payment_required';
777
-        // generate no_payment_required form
778
-        return new EE_Form_Section_Proper(
779
-            [
780
-                'layout_strategy' => new EE_Template_Layout(
781
-                    [
782
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
783
-                                                  . $this->_slug
784
-                                                  . '/no_payment_required.template.php', // layout_template
785
-                        'template_args'        => apply_filters(
786
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
787
-                            [
788
-                                'revisit'                       => $this->checkout->revisit,
789
-                                'registrations'                 => [],
790
-                                'ticket_count'                  => [],
791
-                                'registrations_for_free_events' => $registrations_for_free_events,
792
-                                'no_payment_required_msg'       => EEH_HTML::p(
793
-                                    esc_html__('This is a free event, so no billing will occur.', 'event_espresso')
794
-                                ),
795
-                            ]
796
-                        ),
797
-                    ]
798
-                ),
799
-            ]
800
-        );
801
-    }
802
-
803
-
804
-    /**
805
-     * _display_payment_options
806
-     *
807
-     * @param string $transaction_details
808
-     * @return EE_Form_Section_Proper
809
-     * @throws EE_Error
810
-     * @throws InvalidArgumentException
811
-     * @throws InvalidDataTypeException
812
-     * @throws InvalidInterfaceException
813
-     */
814
-    private function _display_payment_options($transaction_details = '')
815
-    {
816
-        // has method_of_payment been set by no-js user?
817
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment();
818
-        // build payment options form
819
-        return apply_filters(
820
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__payment_options_form',
821
-            new EE_Form_Section_Proper(
822
-                [
823
-                    'subsections'     => [
824
-                        'before_payment_options' => apply_filters(
825
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
826
-                            new EE_Form_Section_Proper(
827
-                                ['layout_strategy' => new EE_Div_Per_Section_Layout()]
828
-                            )
829
-                        ),
830
-                        'payment_options'        => $this->_setup_payment_options(),
831
-                        'after_payment_options'  => apply_filters(
832
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__after_payment_options',
833
-                            new EE_Form_Section_Proper(
834
-                                ['layout_strategy' => new EE_Div_Per_Section_Layout()]
835
-                            )
836
-                        ),
837
-                    ],
838
-                    'layout_strategy' => new EE_Template_Layout(
839
-                        [
840
-                            'layout_template_file' => $this->_template,
841
-                            'template_args'        => apply_filters(
842
-                                'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
843
-                                [
844
-                                    'reg_count'                 => $this->line_item_display->total_items(),
845
-                                    'transaction_details'       => $transaction_details,
846
-                                    'available_payment_methods' => [],
847
-                                ]
848
-                            ),
849
-                        ]
850
-                    ),
851
-                ]
852
-            )
853
-        );
854
-    }
855
-
856
-
857
-    /**
858
-     * _extra_hidden_inputs
859
-     *
860
-     * @param bool $no_payment_required
861
-     * @return EE_Form_Section_Proper
862
-     * @throws EE_Error
863
-     * @throws ReflectionException
864
-     */
865
-    private function _extra_hidden_inputs($no_payment_required = true)
866
-    {
867
-        return new EE_Form_Section_Proper(
868
-            [
869
-                'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
870
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
871
-                'subsections'     => [
872
-                    'spco_no_payment_required' => new EE_Hidden_Input(
873
-                        [
874
-                            'normalization_strategy' => new EE_Boolean_Normalization(),
875
-                            'html_name'              => 'spco_no_payment_required',
876
-                            'html_id'                => 'spco-no-payment-required-payment_options',
877
-                            'default'                => $no_payment_required,
878
-                        ]
879
-                    ),
880
-                    'spco_transaction_id'      => new EE_Fixed_Hidden_Input(
881
-                        [
882
-                            'normalization_strategy' => new EE_Int_Normalization(),
883
-                            'html_name'              => 'spco_transaction_id',
884
-                            'html_id'                => 'spco-transaction-id',
885
-                            'default'                => $this->checkout->transaction->ID(),
886
-                        ]
887
-                    ),
888
-                ],
889
-            ]
890
-        );
891
-    }
892
-
893
-
894
-    /**
895
-     *    _apply_registration_payments_to_amount_owing
896
-     *
897
-     * @param array $registrations
898
-     * @throws EE_Error
899
-     */
900
-    protected function _apply_registration_payments_to_amount_owing(array $registrations)
901
-    {
902
-        $payments = [];
903
-        foreach ($registrations as $registration) {
904
-            if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
905
-                $payments += $registration->registration_payments();
906
-            }
907
-        }
908
-        if (! empty($payments)) {
909
-            foreach ($payments as $payment) {
910
-                if ($payment instanceof EE_Registration_Payment) {
911
-                    $this->checkout->amount_owing -= $payment->amount();
912
-                }
913
-            }
914
-        }
915
-    }
916
-
917
-
918
-    /**
919
-     *    _reset_selected_method_of_payment
920
-     *
921
-     * @access    private
922
-     * @param bool $force_reset
923
-     * @return void
924
-     * @throws InvalidArgumentException
925
-     * @throws InvalidDataTypeException
926
-     * @throws InvalidInterfaceException
927
-     */
928
-    private function _reset_selected_method_of_payment($force_reset = false)
929
-    {
930
-        /** @var RequestInterface $request */
931
-        $request              = LoaderFactory::getLoader()->getShared(RequestInterface::class);
932
-        $reset_payment_method = $request->getRequestParam('reset_payment_method', $force_reset, 'bool');
933
-        if ($reset_payment_method) {
934
-            $this->checkout->selected_method_of_payment = null;
935
-            $this->checkout->payment_method             = null;
936
-            $this->checkout->billing_form               = null;
937
-            $this->_save_selected_method_of_payment();
938
-        }
939
-    }
940
-
941
-
942
-    /**
943
-     * _save_selected_method_of_payment
944
-     * stores the selected_method_of_payment in the session
945
-     * so that it's available for all subsequent requests including AJAX
946
-     *
947
-     * @access        private
948
-     * @param string $selected_method_of_payment
949
-     * @return void
950
-     * @throws InvalidArgumentException
951
-     * @throws InvalidDataTypeException
952
-     * @throws InvalidInterfaceException
953
-     */
954
-    private function _save_selected_method_of_payment($selected_method_of_payment = '')
955
-    {
956
-        $selected_method_of_payment = ! empty($selected_method_of_payment)
957
-            ? $selected_method_of_payment
958
-            : $this->checkout->selected_method_of_payment;
959
-        EE_Registry::instance()->SSN->set_session_data(
960
-            ['selected_method_of_payment' => $selected_method_of_payment]
961
-        );
962
-    }
963
-
964
-
965
-    /**
966
-     * _setup_payment_options
967
-     *
968
-     * @return EE_Form_Section_Proper
969
-     * @throws EE_Error
970
-     * @throws InvalidArgumentException
971
-     * @throws InvalidDataTypeException
972
-     * @throws InvalidInterfaceException
973
-     */
974
-    public function _setup_payment_options()
975
-    {
976
-        // load payment method classes
977
-        $this->checkout->available_payment_methods = $this->_get_available_payment_methods();
978
-        if (empty($this->checkout->available_payment_methods)) {
979
-            EE_Error::add_error(
980
-                apply_filters(
981
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__error_message_no_payment_methods',
982
-                    sprintf(
983
-                        esc_html__(
984
-                            'Sorry, you cannot complete your purchase because a payment method is not active.%1$s Please contact %2$s for assistance and provide a description of the problem.',
985
-                            'event_espresso'
986
-                        ),
987
-                        '<br>',
988
-                        EE_Registry::instance()->CFG->organization->get_pretty('email')
989
-                    )
990
-                ),
991
-                __FILE__,
992
-                __FUNCTION__,
993
-                __LINE__
994
-            );
995
-        }
996
-        // switch up header depending on number of available payment methods
997
-        $payment_method_header     = count($this->checkout->available_payment_methods) > 1
998
-            ? apply_filters(
999
-                'FHEE__registration_page_payment_options__method_of_payment_hdr',
1000
-                esc_html__('Please Select Your Method of Payment', 'event_espresso')
1001
-            )
1002
-            : apply_filters(
1003
-                'FHEE__registration_page_payment_options__method_of_payment_hdr',
1004
-                esc_html__('Method of Payment', 'event_espresso')
1005
-            );
1006
-        $available_payment_methods = [
1007
-            // display the "Payment Method" header
1008
-            'payment_method_header' => new EE_Form_Section_HTML(
1009
-                apply_filters(
1010
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__payment_method_header',
1011
-                    EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr'),
1012
-                    $payment_method_header
1013
-                )
1014
-            ),
1015
-        ];
1016
-        // the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
1017
-        $available_payment_method_options = [];
1018
-        $default_payment_method_option    = [];
1019
-        // additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
1020
-        $payment_methods_billing_info = [
1021
-            new EE_Form_Section_HTML(
1022
-                EEH_HTML::div('<br />', '', '', 'clear:both;')
1023
-            ),
1024
-        ];
1025
-        // loop through payment methods
1026
-        foreach ($this->checkout->available_payment_methods as $payment_method) {
1027
-            if ($payment_method instanceof EE_Payment_Method) {
1028
-                $payment_method_button = EEH_HTML::img(
1029
-                    $payment_method->button_url(),
1030
-                    $payment_method->name(),
1031
-                    'spco-payment-method-' . $payment_method->slug() . '-btn-img',
1032
-                    'spco-payment-method-btn-img'
1033
-                );
1034
-                // check if any payment methods are set as default
1035
-                // if payment method is already selected OR nothing is selected and this payment method should be
1036
-                // open_by_default
1037
-                if (
1038
-                    ($this->checkout->selected_method_of_payment === $payment_method->slug())
1039
-                    || (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
1040
-                ) {
1041
-                    $this->checkout->selected_method_of_payment = $payment_method->slug();
1042
-                    $this->_save_selected_method_of_payment();
1043
-                    $default_payment_method_option[ $payment_method->slug() ] = $payment_method_button;
1044
-                } else {
1045
-                    $available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
1046
-                }
1047
-                $payment_methods_billing_info[ $payment_method->slug() . '-info' ] =
1048
-                    $this->_payment_method_billing_info(
1049
-                        $payment_method
1050
-                    );
1051
-            }
1052
-        }
1053
-        // prepend available_payment_method_options with default_payment_method_option so that it appears first in list
1054
-        // of PMs
1055
-        $available_payment_method_options = $default_payment_method_option + $available_payment_method_options;
1056
-        // now generate the actual form  inputs
1057
-        $available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
1058
-            $available_payment_method_options
1059
-        );
1060
-        $available_payment_methods                              += $payment_methods_billing_info;
1061
-        // build the available payment methods form
1062
-        return new EE_Form_Section_Proper(
1063
-            [
1064
-                'html_id'         => 'spco-available-methods-of-payment-dv',
1065
-                'subsections'     => $available_payment_methods,
1066
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
1067
-            ]
1068
-        );
1069
-    }
1070
-
1071
-
1072
-    /**
1073
-     * _get_available_payment_methods
1074
-     *
1075
-     * @return EE_Payment_Method[]
1076
-     * @throws EE_Error
1077
-     * @throws InvalidArgumentException
1078
-     * @throws InvalidDataTypeException
1079
-     * @throws InvalidInterfaceException
1080
-     */
1081
-    protected function _get_available_payment_methods()
1082
-    {
1083
-        if (! empty($this->checkout->available_payment_methods)) {
1084
-            return $this->checkout->available_payment_methods;
1085
-        }
1086
-        $available_payment_methods = [];
1087
-        $EEM_Payment_Method        = EEM_Payment_Method::instance();
1088
-        // get all active payment methods
1089
-        $payment_methods = $EEM_Payment_Method->get_all_for_transaction(
1090
-            $this->checkout->transaction,
1091
-            EEM_Payment_Method::scope_cart
1092
-        );
1093
-        foreach ($payment_methods as $payment_method) {
1094
-            if ($payment_method instanceof EE_Payment_Method) {
1095
-                $available_payment_methods[ $payment_method->slug() ] = $payment_method;
1096
-            }
1097
-        }
1098
-        return $available_payment_methods;
1099
-    }
1100
-
1101
-
1102
-    /**
1103
-     *    _available_payment_method_inputs
1104
-     *
1105
-     * @access    private
1106
-     * @param array $available_payment_method_options
1107
-     * @return    EE_Form_Section_Proper
1108
-     * @throws EE_Error
1109
-     * @throws EE_Error
1110
-     */
1111
-    private function _available_payment_method_inputs($available_payment_method_options = [])
1112
-    {
1113
-        // generate inputs
1114
-        return new EE_Form_Section_Proper(
1115
-            [
1116
-                'html_id'         => 'ee-available-payment-method-inputs',
1117
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
1118
-                'subsections'     => [
1119
-                    '' => new EE_Radio_Button_Input(
1120
-                        $available_payment_method_options,
1121
-                        [
1122
-                            'html_name'          => 'selected_method_of_payment',
1123
-                            'html_class'         => 'spco-payment-method',
1124
-                            'default'            => $this->checkout->selected_method_of_payment,
1125
-                            'label_size'         => 11,
1126
-                            'enforce_label_size' => true,
1127
-                        ]
1128
-                    ),
1129
-                ],
1130
-            ]
1131
-        );
1132
-    }
1133
-
1134
-
1135
-    /**
1136
-     *    _payment_method_billing_info
1137
-     *
1138
-     * @access    private
1139
-     * @param EE_Payment_Method $payment_method
1140
-     * @return EE_Form_Section_Proper
1141
-     * @throws EE_Error
1142
-     * @throws InvalidArgumentException
1143
-     * @throws InvalidDataTypeException
1144
-     * @throws InvalidInterfaceException
1145
-     */
1146
-    private function _payment_method_billing_info(EE_Payment_Method $payment_method)
1147
-    {
1148
-        $currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug();
1149
-        // generate the billing form for payment method
1150
-        $billing_form                 = $currently_selected
1151
-            ? $this->_get_billing_form_for_payment_method($payment_method)
1152
-            : new EE_Form_Section_HTML();
1153
-        $this->checkout->billing_form = $currently_selected
1154
-            ? $billing_form
1155
-            : $this->checkout->billing_form;
1156
-        // it's all in the details
1157
-        $info_html = EEH_HTML::h3(
1158
-            esc_html__('Important information regarding your payment', 'event_espresso'),
1159
-            '',
1160
-            'spco-payment-method-hdr'
1161
-        );
1162
-        // add some info regarding the step, either from what's saved in the admin,
1163
-        // or a default string depending on whether the PM has a billing form or not
1164
-        if ($payment_method->description()) {
1165
-            $payment_method_info = $payment_method->description();
1166
-        } elseif ($billing_form instanceof EE_Billing_Info_Form) {
1167
-            $payment_method_info = sprintf(
1168
-                esc_html__(
1169
-                    'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
1170
-                    'event_espresso'
1171
-                ),
1172
-                $this->submit_button_text()
1173
-            );
1174
-        } else {
1175
-            $payment_method_info = sprintf(
1176
-                esc_html__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
1177
-                $this->submit_button_text()
1178
-            );
1179
-        }
1180
-        $info_html .= EEH_HTML::div(
1181
-            apply_filters(
1182
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options___payment_method_billing_info__payment_method_info',
1183
-                $payment_method_info
1184
-            ),
1185
-            '',
1186
-            'spco-payment-method-desc ee-attention'
1187
-        );
1188
-        return new EE_Form_Section_Proper(
1189
-            [
1190
-                'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
1191
-                'html_class'      => 'spco-payment-method-info-dv',
1192
-                // only display the selected or default PM
1193
-                'html_style'      => $currently_selected ? '' : 'display:none;',
1194
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
1195
-                'subsections'     => [
1196
-                    'info'         => new EE_Form_Section_HTML($info_html),
1197
-                    'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML(),
1198
-                ],
1199
-            ]
1200
-        );
1201
-    }
1202
-
1203
-
1204
-    /**
1205
-     * get_billing_form_html_for_payment_method
1206
-     *
1207
-     * @return bool
1208
-     * @throws EE_Error
1209
-     * @throws InvalidArgumentException
1210
-     * @throws ReflectionException
1211
-     * @throws InvalidDataTypeException
1212
-     * @throws InvalidInterfaceException
1213
-     */
1214
-    public function get_billing_form_html_for_payment_method()
1215
-    {
1216
-        // how have they chosen to pay?
1217
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
1218
-        $this->checkout->payment_method             = $this->_get_payment_method_for_selected_method_of_payment();
1219
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
1220
-            return false;
1221
-        }
1222
-        if (
1223
-            apply_filters(
1224
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1225
-                false
1226
-            )
1227
-        ) {
1228
-            EE_Error::add_success(
1229
-                apply_filters(
1230
-                    'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1231
-                    sprintf(
1232
-                        esc_html__(
1233
-                            'You have selected "%s" as your method of payment. Please note the important payment information below.',
1234
-                            'event_espresso'
1235
-                        ),
1236
-                        $this->checkout->payment_method->name()
1237
-                    )
1238
-                )
1239
-            );
1240
-        }
1241
-        // now generate billing form for selected method of payment
1242
-        $payment_method_billing_form = $this->_get_billing_form_for_payment_method($this->checkout->payment_method);
1243
-        // fill form with attendee info if applicable
1244
-        if (
1245
-            $payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
1246
-            && $this->checkout->transaction_has_primary_registrant()
1247
-        ) {
1248
-            $payment_method_billing_form->populate_from_attendee(
1249
-                $this->checkout->transaction->primary_registration()->attendee()
1250
-            );
1251
-        }
1252
-        // and debug content
1253
-        if (
1254
-            $payment_method_billing_form instanceof EE_Billing_Info_Form
1255
-            && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
1256
-        ) {
1257
-            $payment_method_billing_form =
1258
-                $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
1259
-                    $payment_method_billing_form
1260
-                );
1261
-        }
1262
-        $billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
1263
-            ? $payment_method_billing_form->get_html()
1264
-            : '';
1265
-        $this->checkout->json_response->set_return_data(['payment_method_info' => $billing_info]);
1266
-        // localize validation rules for main form
1267
-        $this->checkout->current_step->reg_form->localize_validation_rules();
1268
-        $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
1269
-        return true;
1270
-    }
1271
-
1272
-
1273
-    /**
1274
-     * _get_billing_form_for_payment_method
1275
-     *
1276
-     * @param EE_Payment_Method $payment_method
1277
-     * @return EE_Billing_Info_Form|EE_Form_Section_HTML
1278
-     * @throws EE_Error
1279
-     * @throws InvalidArgumentException
1280
-     * @throws InvalidDataTypeException
1281
-     * @throws InvalidInterfaceException
1282
-     */
1283
-    private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method)
1284
-    {
1285
-        $billing_form = $payment_method->type_obj()->billing_form(
1286
-            $this->checkout->transaction,
1287
-            ['amount_owing' => $this->checkout->amount_owing]
1288
-        );
1289
-        if ($billing_form instanceof EE_Billing_Info_Form) {
1290
-            if (
1291
-                apply_filters(
1292
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1293
-                    false
1294
-                )
1295
-                && $this->request->requestParamIsSet('payment_method')
1296
-            ) {
1297
-                EE_Error::add_success(
1298
-                    apply_filters(
1299
-                        'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1300
-                        sprintf(
1301
-                            esc_html__(
1302
-                                'You have selected "%s" as your method of payment. Please note the important payment information below.',
1303
-                                'event_espresso'
1304
-                            ),
1305
-                            $payment_method->name()
1306
-                        )
1307
-                    )
1308
-                );
1309
-            }
1310
-            return apply_filters(
1311
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
1312
-                $billing_form,
1313
-                $payment_method
1314
-            );
1315
-        }
1316
-        // no actual billing form, so return empty HTML form section
1317
-        return new EE_Form_Section_HTML();
1318
-    }
1319
-
1320
-
1321
-    /**
1322
-     * _get_selected_method_of_payment
1323
-     *
1324
-     * @param boolean $required whether to throw an error if the "selected_method_of_payment"
1325
-     *                          is not found in the incoming request
1326
-     * @param string  $request_param
1327
-     * @return NULL|string
1328
-     * @throws EE_Error
1329
-     * @throws InvalidArgumentException
1330
-     * @throws InvalidDataTypeException
1331
-     * @throws InvalidInterfaceException
1332
-     */
1333
-    private function _get_selected_method_of_payment(
1334
-        $required = false,
1335
-        $request_param = 'selected_method_of_payment'
1336
-    ) {
1337
-        // is selected_method_of_payment set in the request ?
1338
-        $selected_method_of_payment = $this->request->getRequestParam($request_param);
1339
-        if ($selected_method_of_payment) {
1340
-            // sanitize it
1341
-            $selected_method_of_payment = is_array($selected_method_of_payment)
1342
-                ? array_shift($selected_method_of_payment)
1343
-                : $selected_method_of_payment;
1344
-            $selected_method_of_payment = sanitize_text_field($selected_method_of_payment);
1345
-            // store it in the session so that it's available for all subsequent requests including AJAX
1346
-            $this->_save_selected_method_of_payment($selected_method_of_payment);
1347
-        } else {
1348
-            // or is is set in the session ?
1349
-            $selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
1350
-                'selected_method_of_payment'
1351
-            );
1352
-        }
1353
-        // do ya really really gotta have it?
1354
-        if (empty($selected_method_of_payment) && $required) {
1355
-            EE_Error::add_error(
1356
-                sprintf(
1357
-                    esc_html__(
1358
-                        'The selected method of payment could not be determined.%sPlease ensure that you have selected one before proceeding.%sIf you continue to experience difficulties, then refresh your browser and try again, or contact %s for assistance.',
1359
-                        'event_espresso'
1360
-                    ),
1361
-                    '<br/>',
1362
-                    '<br/>',
1363
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
1364
-                ),
1365
-                __FILE__,
1366
-                __FUNCTION__,
1367
-                __LINE__
1368
-            );
1369
-            return null;
1370
-        }
1371
-        return $selected_method_of_payment;
1372
-    }
1373
-
1374
-
1375
-
1376
-
1377
-
1378
-
1379
-    /********************************************************************************************************/
1380
-    /***********************************  SWITCH PAYMENT METHOD  ************************************/
1381
-    /********************************************************************************************************/
1382
-    /**
1383
-     * switch_payment_method
1384
-     *
1385
-     * @return bool
1386
-     * @throws EE_Error
1387
-     * @throws InvalidArgumentException
1388
-     * @throws InvalidDataTypeException
1389
-     * @throws InvalidInterfaceException
1390
-     * @throws ReflectionException
1391
-     */
1392
-    public function switch_payment_method()
1393
-    {
1394
-        if (! $this->_verify_payment_method_is_set()) {
1395
-            return false;
1396
-        }
1397
-        if (
1398
-            apply_filters(
1399
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1400
-                false
1401
-            )
1402
-        ) {
1403
-            EE_Error::add_success(
1404
-                apply_filters(
1405
-                    'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1406
-                    sprintf(
1407
-                        esc_html__(
1408
-                            'You have selected "%s" as your method of payment. Please note the important payment information below.',
1409
-                            'event_espresso'
1410
-                        ),
1411
-                        $this->checkout->payment_method->name()
1412
-                    )
1413
-                )
1414
-            );
1415
-        }
1416
-        // generate billing form for selected method of payment if it hasn't been done already
1417
-        if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
1418
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1419
-                $this->checkout->payment_method
1420
-            );
1421
-        }
1422
-        // fill form with attendee info if applicable
1423
-        if (
1424
-            apply_filters(
1425
-                'FHEE__populate_billing_form_fields_from_attendee',
1426
-                (
1427
-                $this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
1428
-                && $this->checkout->transaction_has_primary_registrant()
1429
-                ),
1430
-                $this->checkout->billing_form,
1431
-                $this->checkout->transaction
1432
-            )
1433
-        ) {
1434
-            $this->checkout->billing_form->populate_from_attendee(
1435
-                $this->checkout->transaction->primary_registration()->attendee()
1436
-            );
1437
-        }
1438
-        // and debug content
1439
-        if (
1440
-            $this->checkout->billing_form instanceof EE_Billing_Info_Form
1441
-            && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
1442
-        ) {
1443
-            $this->checkout->billing_form =
1444
-                $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
1445
-                    $this->checkout->billing_form
1446
-                );
1447
-        }
1448
-        // get html and validation rules for form
1449
-        if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
1450
-            $this->checkout->json_response->set_return_data(
1451
-                ['payment_method_info' => $this->checkout->billing_form->get_html()]
1452
-            );
1453
-            // localize validation rules for main form
1454
-            $this->checkout->billing_form->localize_validation_rules(true);
1455
-            $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
1456
-        } else {
1457
-            $this->checkout->json_response->set_return_data(['payment_method_info' => '']);
1458
-        }
1459
-        // prevents advancement to next step
1460
-        $this->checkout->continue_reg = false;
1461
-        return true;
1462
-    }
1463
-
1464
-
1465
-    /**
1466
-     * _verify_payment_method_is_set
1467
-     *
1468
-     * @return bool
1469
-     * @throws EE_Error
1470
-     * @throws InvalidArgumentException
1471
-     * @throws ReflectionException
1472
-     * @throws InvalidDataTypeException
1473
-     * @throws InvalidInterfaceException
1474
-     */
1475
-    protected function _verify_payment_method_is_set()
1476
-    {
1477
-        // generate billing form for selected method of payment if it hasn't been done already
1478
-        if (empty($this->checkout->selected_method_of_payment)) {
1479
-            // how have they chosen to pay?
1480
-            $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
1481
-        } else {
1482
-            // choose your own adventure based on method_of_payment
1483
-            switch ($this->checkout->selected_method_of_payment) {
1484
-                case 'events_sold_out':
1485
-                    EE_Error::add_attention(
1486
-                        apply_filters(
1487
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__sold_out_events_msg',
1488
-                            esc_html__(
1489
-                                'It appears that the event you were about to make a payment for has sold out since this form first loaded. Please contact the event administrator if you believe this is an error.',
1490
-                                'event_espresso'
1491
-                            )
1492
-                        ),
1493
-                        __FILE__,
1494
-                        __FUNCTION__,
1495
-                        __LINE__
1496
-                    );
1497
-                    return false;
1498
-                case 'payments_closed':
1499
-                    EE_Error::add_attention(
1500
-                        apply_filters(
1501
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
1502
-                            esc_html__(
1503
-                                'It appears that the event you were about to make a payment for is not accepting payments at this time. Please contact the event administrator if you believe this is an error.',
1504
-                                'event_espresso'
1505
-                            )
1506
-                        ),
1507
-                        __FILE__,
1508
-                        __FUNCTION__,
1509
-                        __LINE__
1510
-                    );
1511
-                    return false;
1512
-                case 'no_payment_required':
1513
-                    EE_Error::add_attention(
1514
-                        apply_filters(
1515
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
1516
-                            esc_html__(
1517
-                                'It appears that the event you were about to make a payment for does not require payment. Please contact the event administrator if you believe this is an error.',
1518
-                                'event_espresso'
1519
-                            )
1520
-                        ),
1521
-                        __FILE__,
1522
-                        __FUNCTION__,
1523
-                        __LINE__
1524
-                    );
1525
-                    return false;
1526
-                default:
1527
-            }
1528
-        }
1529
-        // verify payment method
1530
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
1531
-            // get payment method for selected method of payment
1532
-            $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
1533
-        }
1534
-        return $this->checkout->payment_method instanceof EE_Payment_Method;
1535
-    }
1536
-
1537
-
1538
-
1539
-    /********************************************************************************************************/
1540
-    /***************************************  SAVE PAYER DETAILS  ****************************************/
1541
-    /********************************************************************************************************/
1542
-    /**
1543
-     * save_payer_details_via_ajax
1544
-     *
1545
-     * @return void
1546
-     * @throws EE_Error
1547
-     * @throws InvalidArgumentException
1548
-     * @throws ReflectionException
1549
-     * @throws RuntimeException
1550
-     * @throws InvalidDataTypeException
1551
-     * @throws InvalidInterfaceException
1552
-     */
1553
-    public function save_payer_details_via_ajax()
1554
-    {
1555
-        if (! $this->_verify_payment_method_is_set()) {
1556
-            return;
1557
-        }
1558
-        // generate billing form for selected method of payment if it hasn't been done already
1559
-        if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
1560
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1561
-                $this->checkout->payment_method
1562
-            );
1563
-        }
1564
-        // generate primary attendee from payer info if applicable
1565
-        if (! $this->checkout->transaction_has_primary_registrant()) {
1566
-            $attendee = $this->_create_attendee_from_request_data();
1567
-            if ($attendee instanceof EE_Attendee) {
1568
-                foreach ($this->checkout->transaction->registrations() as $registration) {
1569
-                    if ($registration->is_primary_registrant()) {
1570
-                        $this->checkout->primary_attendee_obj = $attendee;
1571
-                        $registration->_add_relation_to($attendee, 'Attendee');
1572
-                        $registration->set_attendee_id($attendee->ID());
1573
-                        $registration->update_cache_after_object_save('Attendee', $attendee);
1574
-                    }
1575
-                }
1576
-            }
1577
-        }
1578
-    }
1579
-
1580
-
1581
-    /**
1582
-     * create_attendee_from_request_data
1583
-     * uses info from alternate GET or POST data (such as AJAX) to create a new attendee
1584
-     *
1585
-     * @return EE_Attendee
1586
-     * @throws EE_Error
1587
-     * @throws InvalidArgumentException
1588
-     * @throws ReflectionException
1589
-     * @throws InvalidDataTypeException
1590
-     * @throws InvalidInterfaceException
1591
-     */
1592
-    protected function _create_attendee_from_request_data()
1593
-    {
1594
-        // get State ID
1595
-        $STA_ID = $this->request->getRequestParam('state');
1596
-        if (! empty($STA_ID)) {
1597
-            // can we get state object from name ?
1598
-            EE_Registry::instance()->load_model('State');
1599
-            $state  = EEM_State::instance()->get_col([['STA_name' => $STA_ID], 'limit' => 1], 'STA_ID');
1600
-            $STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
1601
-        }
1602
-        // get Country ISO
1603
-        $CNT_ISO = $this->request->getRequestParam('country');
1604
-        if (! empty($CNT_ISO)) {
1605
-            // can we get country object from name ?
1606
-            EE_Registry::instance()->load_model('Country');
1607
-            $country = EEM_Country::instance()->get_col(
1608
-                [['CNT_name' => $CNT_ISO], 'limit' => 1],
1609
-                'CNT_ISO'
1610
-            );
1611
-            $CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
1612
-        }
1613
-        // grab attendee data
1614
-        $attendee_data = [
1615
-            'ATT_fname'    => $this->request->getRequestParam('first_name'),
1616
-            'ATT_lname'    => $this->request->getRequestParam('last_name'),
1617
-            'ATT_email'    => $this->request->getRequestParam('email'),
1618
-            'ATT_address'  => $this->request->getRequestParam('address'),
1619
-            'ATT_address2' => $this->request->getRequestParam('address2'),
1620
-            'ATT_city'     => $this->request->getRequestParam('city'),
1621
-            'STA_ID'       => $STA_ID,
1622
-            'CNT_ISO'      => $CNT_ISO,
1623
-            'ATT_zip'      => $this->request->getRequestParam('zip'),
1624
-            'ATT_phone'    => $this->request->getRequestParam('phone'),
1625
-        ];
1626
-        // validate the email address since it is the most important piece of info
1627
-        if (empty($attendee_data['ATT_email'])) {
1628
-            EE_Error::add_error(
1629
-                esc_html__('An invalid email address was submitted.', 'event_espresso'),
1630
-                __FILE__,
1631
-                __FUNCTION__,
1632
-                __LINE__
1633
-            );
1634
-        }
1635
-        // does this attendee already exist in the db ? we're searching using a combination of first name, last name,
1636
-        // AND email address
1637
-        if (
1638
-            ! empty($attendee_data['ATT_fname'])
1639
-            && ! empty($attendee_data['ATT_lname'])
1640
-            && ! empty($attendee_data['ATT_email'])
1641
-        ) {
1642
-            $existing_attendee = EEM_Attendee::instance()->find_existing_attendee(
1643
-                [
1644
-                    'ATT_fname' => $attendee_data['ATT_fname'],
1645
-                    'ATT_lname' => $attendee_data['ATT_lname'],
1646
-                    'ATT_email' => $attendee_data['ATT_email'],
1647
-                ]
1648
-            );
1649
-            if ($existing_attendee instanceof EE_Attendee) {
1650
-                return $existing_attendee;
1651
-            }
1652
-        }
1653
-        // no existing attendee? kk let's create a new one
1654
-        // kinda lame, but we need a first and last name to create an attendee, so use the email address if those
1655
-        // don't exist
1656
-        $attendee_data['ATT_fname'] = ! empty($attendee_data['ATT_fname'])
1657
-            ? $attendee_data['ATT_fname']
1658
-            : $attendee_data['ATT_email'];
1659
-        $attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
1660
-            ? $attendee_data['ATT_lname']
1661
-            : $attendee_data['ATT_email'];
1662
-        return EE_Attendee::new_instance($attendee_data);
1663
-    }
1664
-
1665
-
1666
-
1667
-    /********************************************************************************************************/
1668
-    /****************************************  PROCESS REG STEP  *****************************************/
1669
-    /********************************************************************************************************/
1670
-    /**
1671
-     * process_reg_step
1672
-     *
1673
-     * @return bool
1674
-     * @throws EE_Error
1675
-     * @throws InvalidArgumentException
1676
-     * @throws ReflectionException
1677
-     * @throws EntityNotFoundException
1678
-     * @throws InvalidDataTypeException
1679
-     * @throws InvalidInterfaceException
1680
-     * @throws InvalidStatusException
1681
-     */
1682
-    public function process_reg_step()
1683
-    {
1684
-        // how have they chosen to pay?
1685
-        $this->checkout->selected_method_of_payment = $this->checkout->transaction->is_free()
1686
-            ? 'no_payment_required'
1687
-            : $this->_get_selected_method_of_payment(true);
1688
-        // choose your own adventure based on method_of_payment
1689
-        switch ($this->checkout->selected_method_of_payment) {
1690
-            case 'events_sold_out':
1691
-                $this->checkout->redirect     = true;
1692
-                $this->checkout->redirect_url = $this->checkout->cancel_page_url;
1693
-                $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
1694
-                // mark this reg step as completed
1695
-                $this->set_completed();
1696
-                return false;
1697
-
1698
-            case 'payments_closed':
1699
-                if (
1700
-                    apply_filters(
1701
-                        'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
1702
-                        false
1703
-                    )
1704
-                ) {
1705
-                    EE_Error::add_success(
1706
-                        esc_html__('no payment required at this time.', 'event_espresso'),
1707
-                        __FILE__,
1708
-                        __FUNCTION__,
1709
-                        __LINE__
1710
-                    );
1711
-                }
1712
-                // mark this reg step as completed
1713
-                $this->set_completed();
1714
-                return true;
1715
-
1716
-            case 'no_payment_required':
1717
-                if (
1718
-                    apply_filters(
1719
-                        'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
1720
-                        false
1721
-                    )
1722
-                ) {
1723
-                    EE_Error::add_success(
1724
-                        esc_html__('no payment required.', 'event_espresso'),
1725
-                        __FILE__,
1726
-                        __FUNCTION__,
1727
-                        __LINE__
1728
-                    );
1729
-                }
1730
-                // mark this reg step as completed
1731
-                $this->set_completed();
1732
-                return true;
1733
-
1734
-            default:
1735
-                $registrations         = EE_Registry::instance()->SSN->checkout()->transaction->registrations(
1736
-                    EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
1737
-                );
1738
-                $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
1739
-                    $registrations,
1740
-                    EE_Registry::instance()->SSN->checkout()->revisit
1741
-                );
1742
-                // calculate difference between the two arrays
1743
-                $registrations = array_diff($registrations, $ejected_registrations);
1744
-                if (empty($registrations)) {
1745
-                    $this->_redirect_because_event_sold_out();
1746
-                    return false;
1747
-                }
1748
-                $payment = $this->_process_payment();
1749
-                if ($payment instanceof EE_Payment) {
1750
-                    $this->checkout->continue_reg = true;
1751
-                    $this->_maybe_set_completed($payment);
1752
-                } else {
1753
-                    $this->checkout->continue_reg = false;
1754
-                }
1755
-                return $payment instanceof EE_Payment;
1756
-        }
1757
-    }
1758
-
1759
-
1760
-    /**
1761
-     * _redirect_because_event_sold_out
1762
-     *
1763
-     * @return void
1764
-     */
1765
-    protected function _redirect_because_event_sold_out()
1766
-    {
1767
-        $this->checkout->continue_reg = false;
1768
-        // set redirect URL
1769
-        $this->checkout->redirect_url = add_query_arg(
1770
-            ['e_reg_url_link' => $this->checkout->reg_url_link],
1771
-            $this->checkout->current_step->reg_step_url()
1772
-        );
1773
-        $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
1774
-    }
1775
-
1776
-
1777
-    /**
1778
-     * @param EE_Payment $payment
1779
-     * @return void
1780
-     * @throws EE_Error
1781
-     */
1782
-    protected function _maybe_set_completed(EE_Payment $payment)
1783
-    {
1784
-        // Do we need to redirect them? If so, there's more work to be done.
1785
-        if (! $payment->redirect_url()) {
1786
-            $this->set_completed();
1787
-        }
1788
-    }
1789
-
1790
-
1791
-    /**
1792
-     *    update_reg_step
1793
-     *    this is the final step after a user  revisits the site to retry a payment
1794
-     *
1795
-     * @return bool
1796
-     * @throws EE_Error
1797
-     * @throws InvalidArgumentException
1798
-     * @throws ReflectionException
1799
-     * @throws EntityNotFoundException
1800
-     * @throws InvalidDataTypeException
1801
-     * @throws InvalidInterfaceException
1802
-     * @throws InvalidStatusException
1803
-     */
1804
-    public function update_reg_step()
1805
-    {
1806
-        $success = true;
1807
-        // if payment required
1808
-        if ($this->checkout->transaction->total() > 0) {
1809
-            do_action(
1810
-                'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
1811
-                $this->checkout->transaction
1812
-            );
1813
-            // attempt payment via payment method
1814
-            $success = $this->process_reg_step();
1815
-        }
1816
-        if ($success && ! $this->checkout->redirect) {
1817
-            $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
1818
-                $this->checkout->transaction->ID()
1819
-            );
1820
-            // set return URL
1821
-            $this->checkout->redirect_url = add_query_arg(
1822
-                ['e_reg_url_link' => $this->checkout->reg_url_link],
1823
-                $this->checkout->thank_you_page_url
1824
-            );
1825
-        }
1826
-        return $success;
1827
-    }
1828
-
1829
-
1830
-    /**
1831
-     * @return EE_Payment|null
1832
-     * @throws EE_Error
1833
-     * @throws InvalidArgumentException
1834
-     * @throws ReflectionException
1835
-     * @throws RuntimeException
1836
-     * @throws InvalidDataTypeException
1837
-     * @throws InvalidInterfaceException
1838
-     */
1839
-    private function _process_payment()
1840
-    {
1841
-        // basically confirm that the event hasn't sold out since they hit the page
1842
-        if (! $this->_last_second_ticket_verifications()) {
1843
-            return null;
1844
-        }
1845
-        // ya gotta make a choice man
1846
-        if (empty($this->checkout->selected_method_of_payment)) {
1847
-            $this->checkout->json_response->set_plz_select_method_of_payment(
1848
-                esc_html__('Please select a method of payment before proceeding.', 'event_espresso')
1849
-            );
1850
-            return null;
1851
-        }
1852
-        // get EE_Payment_Method object
1853
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
1854
-            return null;
1855
-        }
1856
-        // setup billing form
1857
-        if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
1858
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1859
-                $this->checkout->payment_method
1860
-            );
1861
-            // bad billing form ?
1862
-            if (! $this->_billing_form_is_valid()) {
1863
-                return null;
1864
-            }
1865
-        }
1866
-        // ensure primary registrant has been fully processed
1867
-        if (! $this->_setup_primary_registrant_prior_to_payment()) {
1868
-            return null;
1869
-        }
1870
-        // if session is close to expiring (under 10 minutes by default)
1871
-        if ((time() - EE_Registry::instance()->SSN->expiration()) < EE_Registry::instance()->SSN->extension()) {
1872
-            // add some time to session expiration so that payment can be completed
1873
-            EE_Registry::instance()->SSN->extend_expiration();
1874
-        }
1875
-        /** @type EE_Transaction_Processor $transaction_processor */
1876
-        // $transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
1877
-        // in case a registrant leaves to an Off-Site Gateway and never returns, we want to approve any registrations
1878
-        // for events with a default reg status of Approved
1879
-        // $transaction_processor->toggle_registration_statuses_for_default_approved_events(
1880
-        //      $this->checkout->transaction, $this->checkout->reg_cache_where_params
1881
-        // );
1882
-        // attempt payment
1883
-        $payment = $this->_attempt_payment($this->checkout->payment_method);
1884
-        // process results
1885
-        $payment = $this->_validate_payment($payment);
1886
-        $payment = $this->_post_payment_processing($payment);
1887
-        // verify payment
1888
-        if ($payment instanceof EE_Payment) {
1889
-            // store that for later
1890
-            $this->checkout->payment = $payment;
1891
-            // we can also consider the TXN to not have been failed, so temporarily upgrade it's status to abandoned
1892
-            $this->checkout->transaction->toggle_failed_transaction_status();
1893
-            $payment_status = $payment->status();
1894
-            if (
1895
-                $payment_status === EEM_Payment::status_id_approved
1896
-                || $payment_status === EEM_Payment::status_id_pending
1897
-            ) {
1898
-                return $payment;
1899
-            }
1900
-            return null;
1901
-        }
1902
-        if ($payment === true) {
1903
-            // please note that offline payment methods will NOT make a payment,
1904
-            // but instead just mark themselves as the PMD_ID on the transaction, and return true
1905
-            $this->checkout->payment = $payment;
1906
-            return $payment;
1907
-        }
1908
-        // where's my money?
1909
-        return null;
1910
-    }
1911
-
1912
-
1913
-    /**
1914
-     * _last_second_ticket_verifications
1915
-     *
1916
-     * @return bool
1917
-     * @throws EE_Error
1918
-     * @throws ReflectionException
1919
-     */
1920
-    protected function _last_second_ticket_verifications()
1921
-    {
1922
-        // don't bother re-validating if not a return visit
1923
-        if (! $this->checkout->revisit) {
1924
-            return true;
1925
-        }
1926
-        $registrations = $this->checkout->transaction->registrations();
1927
-        if (empty($registrations)) {
1928
-            return false;
1929
-        }
1930
-        foreach ($registrations as $registration) {
1931
-            if ($registration instanceof EE_Registration && ! $registration->is_approved()) {
1932
-                $event = $registration->event_obj();
1933
-                if ($event instanceof EE_Event && $event->is_sold_out(true)) {
1934
-                    EE_Error::add_error(
1935
-                        apply_filters(
1936
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___last_second_ticket_verifications__sold_out_events_msg',
1937
-                            sprintf(
1938
-                                esc_html__(
1939
-                                    'It appears that the %1$s event that you were about to make a payment for has sold out since you first registered and/or arrived at this page. Please refresh the page and try again. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
1940
-                                    'event_espresso'
1941
-                                ),
1942
-                                $event->name()
1943
-                            )
1944
-                        ),
1945
-                        __FILE__,
1946
-                        __FUNCTION__,
1947
-                        __LINE__
1948
-                    );
1949
-                    return false;
1950
-                }
1951
-            }
1952
-        }
1953
-        return true;
1954
-    }
1955
-
1956
-
1957
-    /**
1958
-     * redirect_form
1959
-     *
1960
-     * @return bool
1961
-     * @throws EE_Error
1962
-     * @throws InvalidArgumentException
1963
-     * @throws ReflectionException
1964
-     * @throws InvalidDataTypeException
1965
-     * @throws InvalidInterfaceException
1966
-     */
1967
-    public function redirect_form()
1968
-    {
1969
-        $payment_method_billing_info = $this->_payment_method_billing_info(
1970
-            $this->_get_payment_method_for_selected_method_of_payment()
1971
-        );
1972
-        $html                        = $payment_method_billing_info->get_html();
1973
-        $html                        .= $this->checkout->redirect_form;
1974
-        /** @var ResponseInterface $response */
1975
-        $response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
1976
-        $response->addOutput($html);
1977
-        return true;
1978
-    }
1979
-
1980
-
1981
-    /**
1982
-     * _billing_form_is_valid
1983
-     *
1984
-     * @return bool
1985
-     * @throws EE_Error
1986
-     */
1987
-    private function _billing_form_is_valid()
1988
-    {
1989
-        if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
1990
-            return true;
1991
-        }
1992
-        if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
1993
-            if ($this->checkout->billing_form->was_submitted()) {
1994
-                $this->checkout->billing_form->receive_form_submission();
1995
-                if ($this->checkout->billing_form->is_valid()) {
1996
-                    return true;
1997
-                }
1998
-                $validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
1999
-                $error_strings     = [];
2000
-                foreach ($validation_errors as $validation_error) {
2001
-                    if ($validation_error instanceof EE_Validation_Error) {
2002
-                        $form_section = $validation_error->get_form_section();
2003
-                        if ($form_section instanceof EE_Form_Input_Base) {
2004
-                            $label = $form_section->html_label_text();
2005
-                        } elseif ($form_section instanceof EE_Form_Section_Base) {
2006
-                            $label = $form_section->name();
2007
-                        } else {
2008
-                            $label = esc_html__('Validation Error', 'event_espresso');
2009
-                        }
2010
-                        $error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
2011
-                    }
2012
-                }
2013
-                EE_Error::add_error(
2014
-                    sprintf(
2015
-                        esc_html__(
2016
-                            'One or more billing form inputs are invalid and require correction before proceeding. %1$s %2$s',
2017
-                            'event_espresso'
2018
-                        ),
2019
-                        '<br/>',
2020
-                        implode('<br/>', $error_strings)
2021
-                    ),
2022
-                    __FILE__,
2023
-                    __FUNCTION__,
2024
-                    __LINE__
2025
-                );
2026
-            } else {
2027
-                EE_Error::add_error(
2028
-                    esc_html__(
2029
-                        'The billing form was not submitted or something prevented it\'s submission.',
2030
-                        'event_espresso'
2031
-                    ),
2032
-                    __FILE__,
2033
-                    __FUNCTION__,
2034
-                    __LINE__
2035
-                );
2036
-            }
2037
-        } else {
2038
-            EE_Error::add_error(
2039
-                esc_html__(
2040
-                    'The submitted billing form is invalid possibly due to a technical reason.',
2041
-                    'event_espresso'
2042
-                ),
2043
-                __FILE__,
2044
-                __FUNCTION__,
2045
-                __LINE__
2046
-            );
2047
-        }
2048
-        return false;
2049
-    }
2050
-
2051
-
2052
-    /**
2053
-     * _setup_primary_registrant_prior_to_payment
2054
-     * ensures that the primary registrant has a valid attendee object created with the critical details populated
2055
-     * (first & last name & email) and that both the transaction object and primary registration object have been saved
2056
-     * plz note that any other registrations will NOT be saved at this point (because they may not have any details
2057
-     * yet)
2058
-     *
2059
-     * @return bool
2060
-     * @throws EE_Error
2061
-     * @throws InvalidArgumentException
2062
-     * @throws ReflectionException
2063
-     * @throws RuntimeException
2064
-     * @throws InvalidDataTypeException
2065
-     * @throws InvalidInterfaceException
2066
-     */
2067
-    private function _setup_primary_registrant_prior_to_payment()
2068
-    {
2069
-        // check if transaction has a primary registrant and that it has a related Attendee object
2070
-        // if not, then we need to at least gather some primary registrant data before attempting payment
2071
-        if (
2072
-            $this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
2073
-            && ! $this->checkout->transaction_has_primary_registrant()
2074
-            && ! $this->_capture_primary_registration_data_from_billing_form()
2075
-        ) {
2076
-            return false;
2077
-        }
2078
-        // because saving an object clears it's cache, we need to do the chevy shuffle
2079
-        // grab the primary_registration object
2080
-        $primary_registration = $this->checkout->transaction->primary_registration();
2081
-        // at this point we'll consider a TXN to not have been failed
2082
-        $this->checkout->transaction->toggle_failed_transaction_status();
2083
-        // save the TXN ( which clears cached copy of primary_registration)
2084
-        $this->checkout->transaction->save();
2085
-        // grab TXN ID and save it to the primary_registration
2086
-        $primary_registration->set_transaction_id($this->checkout->transaction->ID());
2087
-        // save what we have so far
2088
-        $primary_registration->save();
2089
-        return true;
2090
-    }
2091
-
2092
-
2093
-    /**
2094
-     * _capture_primary_registration_data_from_billing_form
2095
-     *
2096
-     * @return bool
2097
-     * @throws EE_Error
2098
-     * @throws InvalidArgumentException
2099
-     * @throws ReflectionException
2100
-     * @throws InvalidDataTypeException
2101
-     * @throws InvalidInterfaceException
2102
-     */
2103
-    private function _capture_primary_registration_data_from_billing_form()
2104
-    {
2105
-        // convert billing form data into an attendee
2106
-        $this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
2107
-        if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
2108
-            EE_Error::add_error(
2109
-                sprintf(
2110
-                    esc_html__(
2111
-                        'The billing form details could not be used for attendee details due to a technical issue.%sPlease try again or contact %s for assistance.',
2112
-                        'event_espresso'
2113
-                    ),
2114
-                    '<br/>',
2115
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2116
-                ),
2117
-                __FILE__,
2118
-                __FUNCTION__,
2119
-                __LINE__
2120
-            );
2121
-            return false;
2122
-        }
2123
-        $primary_registration = $this->checkout->transaction->primary_registration();
2124
-        if (! $primary_registration instanceof EE_Registration) {
2125
-            EE_Error::add_error(
2126
-                sprintf(
2127
-                    esc_html__(
2128
-                        'The primary registrant for this transaction could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
2129
-                        'event_espresso'
2130
-                    ),
2131
-                    '<br/>',
2132
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2133
-                ),
2134
-                __FILE__,
2135
-                __FUNCTION__,
2136
-                __LINE__
2137
-            );
2138
-            return false;
2139
-        }
2140
-        if (
2141
-            ! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
2142
-              instanceof
2143
-              EE_Attendee
2144
-        ) {
2145
-            EE_Error::add_error(
2146
-                sprintf(
2147
-                    esc_html__(
2148
-                        'The primary registrant could not be associated with this transaction due to a technical issue.%sPlease try again or contact %s for assistance.',
2149
-                        'event_espresso'
2150
-                    ),
2151
-                    '<br/>',
2152
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2153
-                ),
2154
-                __FILE__,
2155
-                __FUNCTION__,
2156
-                __LINE__
2157
-            );
2158
-            return false;
2159
-        }
2160
-        /** @type EE_Registration_Processor $registration_processor */
2161
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
2162
-        // at this point, we should have enough details about the registrant to consider the registration NOT incomplete
2163
-        $registration_processor->toggle_incomplete_registration_status_to_default($primary_registration);
2164
-        return true;
2165
-    }
2166
-
2167
-
2168
-    /**
2169
-     * _get_payment_method_for_selected_method_of_payment
2170
-     * retrieves a valid payment method
2171
-     *
2172
-     * @return EE_Payment_Method
2173
-     * @throws EE_Error
2174
-     * @throws InvalidArgumentException
2175
-     * @throws ReflectionException
2176
-     * @throws InvalidDataTypeException
2177
-     * @throws InvalidInterfaceException
2178
-     */
2179
-    private function _get_payment_method_for_selected_method_of_payment()
2180
-    {
2181
-        if ($this->checkout->selected_method_of_payment === 'events_sold_out') {
2182
-            $this->_redirect_because_event_sold_out();
2183
-            return null;
2184
-        }
2185
-        // get EE_Payment_Method object
2186
-        if (isset($this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ])) {
2187
-            $payment_method = $this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ];
2188
-        } else {
2189
-            // load EEM_Payment_Method
2190
-            EE_Registry::instance()->load_model('Payment_Method');
2191
-            $EEM_Payment_Method = EEM_Payment_Method::instance();
2192
-            $payment_method     = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
2193
-        }
2194
-        // verify $payment_method
2195
-        if (! $payment_method instanceof EE_Payment_Method) {
2196
-            // not a payment
2197
-            EE_Error::add_error(
2198
-                sprintf(
2199
-                    esc_html__(
2200
-                        'The selected method of payment could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
2201
-                        'event_espresso'
2202
-                    ),
2203
-                    '<br/>',
2204
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2205
-                ),
2206
-                __FILE__,
2207
-                __FUNCTION__,
2208
-                __LINE__
2209
-            );
2210
-            return null;
2211
-        }
2212
-        // and verify it has a valid Payment_Method Type object
2213
-        if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
2214
-            // not a payment
2215
-            EE_Error::add_error(
2216
-                sprintf(
2217
-                    esc_html__(
2218
-                        'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
2219
-                        'event_espresso'
2220
-                    ),
2221
-                    '<br/>',
2222
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2223
-                ),
2224
-                __FILE__,
2225
-                __FUNCTION__,
2226
-                __LINE__
2227
-            );
2228
-            return null;
2229
-        }
2230
-        return $payment_method;
2231
-    }
2232
-
2233
-
2234
-    /**
2235
-     *    _attempt_payment
2236
-     *
2237
-     * @access    private
2238
-     * @type    EE_Payment_Method $payment_method
2239
-     * @return mixed EE_Payment | boolean
2240
-     * @throws EE_Error
2241
-     * @throws InvalidArgumentException
2242
-     * @throws ReflectionException
2243
-     * @throws InvalidDataTypeException
2244
-     * @throws InvalidInterfaceException
2245
-     */
2246
-    private function _attempt_payment(EE_Payment_Method $payment_method)
2247
-    {
2248
-        $payment = null;
2249
-        $this->checkout->transaction->save();
2250
-        $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
2251
-        if (! $payment_processor instanceof EE_Payment_Processor) {
2252
-            return false;
2253
-        }
2254
-        try {
2255
-            $payment_processor->set_revisit($this->checkout->revisit);
2256
-            // generate payment object
2257
-            $payment = $payment_processor->process_payment(
2258
-                $payment_method,
2259
-                $this->checkout->transaction,
2260
-                $this->checkout->amount_owing,
2261
-                $this->checkout->billing_form,
2262
-                $this->_get_return_url($payment_method),
2263
-                'CART',
2264
-                $this->checkout->admin_request,
2265
-                true,
2266
-                $this->reg_step_url()
2267
-            );
2268
-        } catch (Exception $e) {
2269
-            $this->_handle_payment_processor_exception($e);
2270
-        }
2271
-        return $payment;
2272
-    }
2273
-
2274
-
2275
-    /**
2276
-     * _handle_payment_processor_exception
2277
-     *
2278
-     * @param Exception $e
2279
-     * @return void
2280
-     * @throws EE_Error
2281
-     * @throws InvalidArgumentException
2282
-     * @throws InvalidDataTypeException
2283
-     * @throws InvalidInterfaceException
2284
-     */
2285
-    protected function _handle_payment_processor_exception(Exception $e)
2286
-    {
2287
-        EE_Error::add_error(
2288
-            sprintf(
2289
-                esc_html__(
2290
-                    'The payment could not br processed due to a technical issue.%1$sPlease try again or contact %2$s for assistance.||The following Exception was thrown in %4$s on line %5$s:%1$s%3$s',
2291
-                    'event_espresso'
2292
-                ),
2293
-                '<br/>',
2294
-                EE_Registry::instance()->CFG->organization->get_pretty('email'),
2295
-                $e->getMessage(),
2296
-                $e->getFile(),
2297
-                $e->getLine()
2298
-            ),
2299
-            __FILE__,
2300
-            __FUNCTION__,
2301
-            __LINE__
2302
-        );
2303
-    }
2304
-
2305
-
2306
-    /**
2307
-     * _get_return_url
2308
-     *
2309
-     * @param EE_Payment_Method $payment_method
2310
-     * @return string
2311
-     * @throws EE_Error
2312
-     * @throws ReflectionException
2313
-     */
2314
-    protected function _get_return_url(EE_Payment_Method $payment_method)
2315
-    {
2316
-        $return_url = '';
2317
-        switch ($payment_method->type_obj()->payment_occurs()) {
2318
-            case EE_PMT_Base::offsite:
2319
-                $return_url = add_query_arg(
2320
-                    [
2321
-                        'action'                     => 'process_gateway_response',
2322
-                        'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
2323
-                        'spco_txn'                   => $this->checkout->transaction->ID(),
2324
-                    ],
2325
-                    $this->reg_step_url()
2326
-                );
2327
-                break;
2328
-            case EE_PMT_Base::onsite:
2329
-            case EE_PMT_Base::offline:
2330
-                $return_url = $this->checkout->next_step->reg_step_url();
2331
-                break;
2332
-        }
2333
-        return $return_url;
2334
-    }
2335
-
2336
-
2337
-    /**
2338
-     * _validate_payment
2339
-     *
2340
-     * @param EE_Payment $payment
2341
-     * @return EE_Payment|FALSE
2342
-     * @throws EE_Error
2343
-     * @throws InvalidArgumentException
2344
-     * @throws InvalidDataTypeException
2345
-     * @throws InvalidInterfaceException
2346
-     */
2347
-    private function _validate_payment($payment = null)
2348
-    {
2349
-        if ($this->checkout->payment_method->is_off_line()) {
2350
-            return true;
2351
-        }
2352
-        // verify payment object
2353
-        if (! $payment instanceof EE_Payment) {
2354
-            // not a payment
2355
-            EE_Error::add_error(
2356
-                sprintf(
2357
-                    esc_html__(
2358
-                        'A valid payment was not generated due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
2359
-                        'event_espresso'
2360
-                    ),
2361
-                    '<br/>',
2362
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2363
-                ),
2364
-                __FILE__,
2365
-                __FUNCTION__,
2366
-                __LINE__
2367
-            );
2368
-            return false;
2369
-        }
2370
-        return $payment;
2371
-    }
2372
-
2373
-
2374
-    /**
2375
-     * _post_payment_processing
2376
-     *
2377
-     * @param EE_Payment|bool $payment
2378
-     * @return bool|EE_Payment
2379
-     * @throws EE_Error
2380
-     * @throws InvalidArgumentException
2381
-     * @throws InvalidDataTypeException
2382
-     * @throws InvalidInterfaceException
2383
-     * @throws ReflectionException
2384
-     */
2385
-    private function _post_payment_processing($payment = null)
2386
-    {
2387
-        // Off-Line payment?
2388
-        if ($payment === true) {
2389
-            return true;
2390
-        }
2391
-        if ($payment instanceof EE_Payment) {
2392
-            // Should the user be redirected?
2393
-            if ($payment->redirect_url()) {
2394
-                do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()');
2395
-                $this->checkout->redirect      = true;
2396
-                $this->checkout->redirect_form = $payment->redirect_form();
2397
-                $this->checkout->redirect_url  = $this->reg_step_url('redirect_form');
2398
-                // set JSON response
2399
-                $this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
2400
-                // and lastly, let's bump the payment status to pending
2401
-                $payment->set_status(EEM_Payment::status_id_pending);
2402
-                $payment->save();
2403
-            } elseif (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
2404
-                // User shouldn't be redirected. So let's process it here.
2405
-                // $this->_setup_redirect_for_next_step();
2406
-                $this->checkout->continue_reg = false;
2407
-            }
2408
-            return $payment;
2409
-        }
2410
-        // ummm ya... not Off-Line, not On-Site, not off-Site ????
2411
-        $this->checkout->continue_reg = false;
2412
-        return false;
2413
-    }
2414
-
2415
-
2416
-    /**
2417
-     *    _process_payment_status
2418
-     *
2419
-     * @type    EE_Payment $payment
2420
-     * @param string       $payment_occurs
2421
-     * @return bool
2422
-     * @throws EE_Error
2423
-     * @throws InvalidArgumentException
2424
-     * @throws InvalidDataTypeException
2425
-     * @throws InvalidInterfaceException
2426
-     */
2427
-    private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline)
2428
-    {
2429
-        // off-line payment? carry on
2430
-        if ($payment_occurs === EE_PMT_Base::offline) {
2431
-            return true;
2432
-        }
2433
-        // verify payment validity
2434
-        if ($payment instanceof EE_Payment) {
2435
-            do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()');
2436
-            $msg = $payment->gateway_response();
2437
-            // check results
2438
-            switch ($payment->status()) {
2439
-                // good payment
2440
-                case EEM_Payment::status_id_approved:
2441
-                    EE_Error::add_success(
2442
-                        esc_html__('Your payment was processed successfully.', 'event_espresso'),
2443
-                        __FILE__,
2444
-                        __FUNCTION__,
2445
-                        __LINE__
2446
-                    );
2447
-                    return true;
2448
-                // slow payment
2449
-                case EEM_Payment::status_id_pending:
2450
-                    if (empty($msg)) {
2451
-                        $msg = esc_html__(
2452
-                            'Your payment appears to have been processed successfully, but the Instant Payment Notification has not yet been received. It should arrive shortly.',
2453
-                            'event_espresso'
2454
-                        );
2455
-                    }
2456
-                    EE_Error::add_success($msg, __FILE__, __FUNCTION__, __LINE__);
2457
-                    return true;
2458
-                // don't wanna payment
2459
-                case EEM_Payment::status_id_cancelled:
2460
-                    if (empty($msg)) {
2461
-                        $msg = _n(
2462
-                            'Payment cancelled. Please try again.',
2463
-                            'Payment cancelled. Please try again or select another method of payment.',
2464
-                            count($this->checkout->available_payment_methods),
2465
-                            'event_espresso'
2466
-                        );
2467
-                    }
2468
-                    EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
2469
-                    return false;
2470
-                // not enough payment
2471
-                case EEM_Payment::status_id_declined:
2472
-                    if (empty($msg)) {
2473
-                        $msg = _n(
2474
-                            'We\'re sorry but your payment was declined. Please try again.',
2475
-                            'We\'re sorry but your payment was declined. Please try again or select another method of payment.',
2476
-                            count($this->checkout->available_payment_methods),
2477
-                            'event_espresso'
2478
-                        );
2479
-                    }
2480
-                    EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
2481
-                    return false;
2482
-                // bad payment
2483
-                case EEM_Payment::status_id_failed:
2484
-                    if (! empty($msg)) {
2485
-                        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2486
-                        return false;
2487
-                    }
2488
-                    // default to error below
2489
-                    break;
2490
-            }
2491
-        }
2492
-        // off-site payment gateway responses are too unreliable, so let's just assume that
2493
-        // the payment processing is just running slower than the registrant's request
2494
-        if ($payment_occurs === EE_PMT_Base::offsite) {
2495
-            return true;
2496
-        }
2497
-        EE_Error::add_error(
2498
-            sprintf(
2499
-                esc_html__(
2500
-                    'Your payment could not be processed successfully due to a technical issue.%sPlease try again or contact %s for assistance.',
2501
-                    'event_espresso'
2502
-                ),
2503
-                '<br/>',
2504
-                EE_Registry::instance()->CFG->organization->get_pretty('email')
2505
-            ),
2506
-            __FILE__,
2507
-            __FUNCTION__,
2508
-            __LINE__
2509
-        );
2510
-        return false;
2511
-    }
2512
-
2513
-
2514
-
2515
-
2516
-
2517
-
2518
-    /********************************************************************************************************/
2519
-    /**********************************  PROCESS GATEWAY RESPONSE  **********************************/
2520
-    /********************************************************************************************************/
2521
-    /**
2522
-     * process_gateway_response
2523
-     * this is the return point for Off-Site Payment Methods
2524
-     * It will attempt to "handle the IPN" if it appears that this has not already occurred,
2525
-     * otherwise, it will load up the last payment made for the TXN.
2526
-     * If the payment retrieved looks good, it will then either:
2527
-     *    complete the current step and allow advancement to the next reg step
2528
-     *        or present the payment options again
2529
-     *
2530
-     * @return bool
2531
-     * @throws EE_Error
2532
-     * @throws InvalidArgumentException
2533
-     * @throws ReflectionException
2534
-     * @throws InvalidDataTypeException
2535
-     * @throws InvalidInterfaceException
2536
-     */
2537
-    public function process_gateway_response()
2538
-    {
2539
-        // how have they chosen to pay?
2540
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
2541
-        // get EE_Payment_Method object
2542
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
2543
-            $this->checkout->continue_reg = false;
2544
-            return false;
2545
-        }
2546
-        if (! $this->checkout->payment_method->is_off_site()) {
2547
-            return false;
2548
-        }
2549
-        $this->_validate_offsite_return();
2550
-        // verify TXN
2551
-        if ($this->checkout->transaction instanceof EE_Transaction) {
2552
-            $gateway = $this->checkout->payment_method->type_obj()->get_gateway();
2553
-            if (! $gateway instanceof EE_Offsite_Gateway) {
2554
-                $this->checkout->continue_reg = false;
2555
-                return false;
2556
-            }
2557
-            $payment = $this->_process_off_site_payment($gateway);
2558
-            $payment = $this->_process_cancelled_payments($payment);
2559
-            $payment = $this->_validate_payment($payment);
2560
-            // if payment was not declined by the payment gateway or cancelled by the registrant
2561
-            if ($this->_process_payment_status($payment, EE_PMT_Base::offsite)) {
2562
-                // $this->_setup_redirect_for_next_step();
2563
-                // store that for later
2564
-                $this->checkout->payment = $payment;
2565
-                // mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
2566
-                // because we will complete this step during the IPN processing then
2567
-                if (! $this->handle_IPN_in_this_request()) {
2568
-                    $this->set_completed();
2569
-                }
2570
-                return true;
2571
-            }
2572
-        }
2573
-        // DEBUG LOG
2574
-        // $this->checkout->log(
2575
-        //     __CLASS__,
2576
-        //     __FUNCTION__,
2577
-        //     __LINE__,
2578
-        //     array('payment' => $payment)
2579
-        // );
2580
-        $this->checkout->continue_reg = false;
2581
-        return false;
2582
-    }
2583
-
2584
-
2585
-    /**
2586
-     * _validate_return
2587
-     *
2588
-     * @return void
2589
-     * @throws EE_Error
2590
-     * @throws InvalidArgumentException
2591
-     * @throws InvalidDataTypeException
2592
-     * @throws InvalidInterfaceException
2593
-     * @throws ReflectionException
2594
-     */
2595
-    private function _validate_offsite_return()
2596
-    {
2597
-        $TXN_ID = $this->request->getRequestParam('spco_txn', 0, 'int');
2598
-        if ($TXN_ID !== $this->checkout->transaction->ID()) {
2599
-            // Houston... we might have a problem
2600
-            $invalid_TXN = false;
2601
-            // first gather some info
2602
-            $valid_TXN          = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
2603
-            $primary_registrant = $valid_TXN instanceof EE_Transaction
2604
-                ? $valid_TXN->primary_registration()
2605
-                : null;
2606
-            // let's start by retrieving the cart for this TXN
2607
-            $cart = $this->checkout->get_cart_for_transaction($this->checkout->transaction);
2608
-            if ($cart instanceof EE_Cart) {
2609
-                // verify that the current cart has tickets
2610
-                $tickets = $cart->get_tickets();
2611
-                if (empty($tickets)) {
2612
-                    $invalid_TXN = true;
2613
-                }
2614
-            } else {
2615
-                $invalid_TXN = true;
2616
-            }
2617
-            $valid_TXN_SID = $primary_registrant instanceof EE_Registration
2618
-                ? $primary_registrant->session_ID()
2619
-                : null;
2620
-            // validate current Session ID and compare against valid TXN session ID
2621
-            if (
2622
-                $invalid_TXN // if this is already true, then skip other checks
2623
-                || EE_Session::instance()->id() === null
2624
-                || (
2625
-                    // WARNING !!!
2626
-                    // this could be PayPal sending back duplicate requests (ya they do that)
2627
-                    // or it **could** mean someone is simply registering AGAIN after having just done so
2628
-                    // so now we need to determine if this current TXN looks valid or not
2629
-                    // and whether this reg step has even been started ?
2630
-                    EE_Session::instance()->id() === $valid_TXN_SID
2631
-                    // really? you're half way through this reg step, but you never started it ?
2632
-                    && $this->checkout->transaction->reg_step_completed($this->slug()) === false
2633
-                )
2634
-            ) {
2635
-                $invalid_TXN = true;
2636
-            }
2637
-            if ($invalid_TXN) {
2638
-                // is the valid TXN completed ?
2639
-                if ($valid_TXN instanceof EE_Transaction) {
2640
-                    // has this step even been started ?
2641
-                    $reg_step_completed = $valid_TXN->reg_step_completed($this->slug());
2642
-                    if ($reg_step_completed !== false && $reg_step_completed !== true) {
2643
-                        // so it **looks** like this is a double request from PayPal
2644
-                        // so let's try to pick up where we left off
2645
-                        $this->checkout->transaction = $valid_TXN;
2646
-                        $this->checkout->refresh_all_entities(true);
2647
-                        return;
2648
-                    }
2649
-                }
2650
-                // you appear to be lost?
2651
-                $this->_redirect_wayward_request($primary_registrant);
2652
-            }
2653
-        }
2654
-    }
2655
-
2656
-
2657
-    /**
2658
-     * _redirect_wayward_request
2659
-     *
2660
-     * @param EE_Registration|null $primary_registrant
2661
-     * @return void
2662
-     * @throws EE_Error
2663
-     * @throws InvalidArgumentException
2664
-     * @throws InvalidDataTypeException
2665
-     * @throws InvalidInterfaceException
2666
-     * @throws ReflectionException
2667
-     */
2668
-    private function _redirect_wayward_request(EE_Registration $primary_registrant)
2669
-    {
2670
-        if (! $primary_registrant instanceof EE_Registration) {
2671
-            // try redirecting based on the current TXN
2672
-            $primary_registrant = $this->checkout->transaction instanceof EE_Transaction
2673
-                ? $this->checkout->transaction->primary_registration()
2674
-                : null;
2675
-        }
2676
-        if (! $primary_registrant instanceof EE_Registration) {
2677
-            EE_Error::add_error(
2678
-                sprintf(
2679
-                    esc_html__(
2680
-                        'Invalid information was received from the Off-Site Payment Processor and your Transaction details could not be retrieved from the database.%1$sPlease try again or contact %2$s for assistance.',
2681
-                        'event_espresso'
2682
-                    ),
2683
-                    '<br/>',
2684
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2685
-                ),
2686
-                __FILE__,
2687
-                __FUNCTION__,
2688
-                __LINE__
2689
-            );
2690
-            return;
2691
-        }
2692
-        // make sure transaction is not locked
2693
-        $this->checkout->transaction->unlock();
2694
-        wp_safe_redirect(
2695
-            add_query_arg(
2696
-                [
2697
-                    'e_reg_url_link' => $primary_registrant->reg_url_link(),
2698
-                ],
2699
-                $this->checkout->thank_you_page_url
2700
-            )
2701
-        );
2702
-        exit();
2703
-    }
2704
-
2705
-
2706
-    /**
2707
-     * _process_off_site_payment
2708
-     *
2709
-     * @param EE_Offsite_Gateway $gateway
2710
-     * @return EE_Payment
2711
-     * @throws EE_Error
2712
-     * @throws InvalidArgumentException
2713
-     * @throws InvalidDataTypeException
2714
-     * @throws InvalidInterfaceException
2715
-     * @throws ReflectionException
2716
-     */
2717
-    private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
2718
-    {
2719
-        try {
2720
-            $request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
2721
-            $request_data = $request->requestParams();
2722
-            // if gateway uses_separate_IPN_request, then we don't have to process the IPN manually
2723
-            $this->set_handle_IPN_in_this_request(
2724
-                $gateway->handle_IPN_in_this_request($request_data, false)
2725
-            );
2726
-            if ($this->handle_IPN_in_this_request()) {
2727
-                // get payment details and process results
2728
-                /** @type EE_Payment_Processor $payment_processor */
2729
-                $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
2730
-                $payment           = $payment_processor->process_ipn(
2731
-                    $request_data,
2732
-                    $this->checkout->transaction,
2733
-                    $this->checkout->payment_method,
2734
-                    true,
2735
-                    false
2736
-                );
2737
-                // $payment_source = 'process_ipn';
2738
-            } else {
2739
-                $payment = $this->checkout->transaction->last_payment();
2740
-                // $payment_source = 'last_payment';
2741
-            }
2742
-        } catch (Exception $e) {
2743
-            // let's just eat the exception and try to move on using any previously set payment info
2744
-            $payment = $this->checkout->transaction->last_payment();
2745
-            // $payment_source = 'last_payment after Exception';
2746
-            // but if we STILL don't have a payment object
2747
-            if (! $payment instanceof EE_Payment) {
2748
-                // then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
2749
-                $this->_handle_payment_processor_exception($e);
2750
-            }
2751
-        }
2752
-        return $payment;
2753
-    }
2754
-
2755
-
2756
-    /**
2757
-     * _process_cancelled_payments
2758
-     * just makes sure that the payment status gets updated correctly
2759
-     * so tha tan error isn't generated during payment validation
2760
-     *
2761
-     * @param EE_Payment $payment
2762
-     * @return EE_Payment|null
2763
-     * @throws EE_Error
2764
-     */
2765
-    private function _process_cancelled_payments($payment = null)
2766
-    {
2767
-        if (
2768
-            $payment instanceof EE_Payment
2769
-            && $this->request->requestParamIsSet('ee_cancel_payment')
2770
-            && $payment->status() === EEM_Payment::status_id_failed
2771
-        ) {
2772
-            $payment->set_status(EEM_Payment::status_id_cancelled);
2773
-        }
2774
-        return $payment;
2775
-    }
2776
-
2777
-
2778
-    /**
2779
-     *    get_transaction_details_for_gateways
2780
-     *
2781
-     * @access    public
2782
-     * @return void
2783
-     * @throws EE_Error
2784
-     * @throws InvalidArgumentException
2785
-     * @throws ReflectionException
2786
-     * @throws InvalidDataTypeException
2787
-     * @throws InvalidInterfaceException
2788
-     */
2789
-    public function get_transaction_details_for_gateways()
2790
-    {
2791
-        $txn_details = [];
2792
-        // ya gotta make a choice man
2793
-        if (empty($this->checkout->selected_method_of_payment)) {
2794
-            $txn_details = [
2795
-                'error' => esc_html__('Please select a method of payment before proceeding.', 'event_espresso'),
2796
-            ];
2797
-        }
2798
-        // get EE_Payment_Method object
2799
-        if (
2800
-            empty($txn_details)
2801
-            && ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
2802
-        ) {
2803
-            $txn_details = [
2804
-                'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
2805
-                'error'                      => esc_html__(
2806
-                    'A valid Payment Method could not be determined.',
2807
-                    'event_espresso'
2808
-                ),
2809
-            ];
2810
-        }
2811
-        if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
2812
-            $return_url  = $this->_get_return_url($this->checkout->payment_method);
2813
-            $txn_details = [
2814
-                'TXN_ID'         => $this->checkout->transaction->ID(),
2815
-                'TXN_timestamp'  => $this->checkout->transaction->datetime(),
2816
-                'TXN_total'      => $this->checkout->transaction->total(),
2817
-                'TXN_paid'       => $this->checkout->transaction->paid(),
2818
-                'TXN_reg_steps'  => $this->checkout->transaction->reg_steps(),
2819
-                'STS_ID'         => $this->checkout->transaction->status_ID(),
2820
-                'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
2821
-                'payment_amount' => $this->checkout->amount_owing,
2822
-                'return_url'     => $return_url,
2823
-                'cancel_url'     => add_query_arg(['ee_cancel_payment' => true], $return_url),
2824
-                'notify_url'     => EE_Config::instance()->core->txn_page_url(
2825
-                    [
2826
-                        'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
2827
-                        'ee_payment_method' => $this->checkout->payment_method->slug(),
2828
-                    ]
2829
-                ),
2830
-            ];
2831
-        }
2832
-        echo wp_json_encode($txn_details);
2833
-        exit();
2834
-    }
2835
-
2836
-
2837
-    /**
2838
-     *    __sleep
2839
-     * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
2840
-     * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
2841
-     * reg form, because if needed, it will be regenerated anyways
2842
-     *
2843
-     * @return array
2844
-     */
2845
-    public function __sleep()
2846
-    {
2847
-        // remove the reg form and the checkout
2848
-        return array_diff(array_keys(get_object_vars($this)), ['reg_form', 'checkout', 'line_item_display']);
2849
-    }
22
+	/**
23
+	 * @var EE_Line_Item_Display $Line_Item_Display
24
+	 */
25
+	protected $line_item_display;
26
+
27
+	/**
28
+	 * @var boolean $handle_IPN_in_this_request
29
+	 */
30
+	protected $handle_IPN_in_this_request = false;
31
+
32
+
33
+	/**
34
+	 *    set_hooks - for hooking into EE Core, other modules, etc
35
+	 *
36
+	 * @access    public
37
+	 * @return    void
38
+	 */
39
+	public static function set_hooks()
40
+	{
41
+		add_filter(
42
+			'FHEE__SPCO__EE_Line_Item_Filter_Collection',
43
+			['EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters']
44
+		);
45
+		add_action(
46
+			'wp_ajax_switch_spco_billing_form',
47
+			['EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form']
48
+		);
49
+		add_action(
50
+			'wp_ajax_nopriv_switch_spco_billing_form',
51
+			['EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form']
52
+		);
53
+		add_action('wp_ajax_save_payer_details', ['EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details']);
54
+		add_action(
55
+			'wp_ajax_nopriv_save_payer_details',
56
+			['EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details']
57
+		);
58
+		add_action(
59
+			'wp_ajax_get_transaction_details_for_gateways',
60
+			['EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details']
61
+		);
62
+		add_action(
63
+			'wp_ajax_nopriv_get_transaction_details_for_gateways',
64
+			['EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details']
65
+		);
66
+		add_filter(
67
+			'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
68
+			['EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'],
69
+			10,
70
+			1
71
+		);
72
+	}
73
+
74
+
75
+	/**
76
+	 *    ajax switch_spco_billing_form
77
+	 *
78
+	 */
79
+	public static function switch_spco_billing_form()
80
+	{
81
+		EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
82
+	}
83
+
84
+
85
+	/**
86
+	 *    ajax save_payer_details
87
+	 *
88
+	 */
89
+	public static function save_payer_details()
90
+	{
91
+		EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
92
+	}
93
+
94
+
95
+	/**
96
+	 *    ajax get_transaction_details
97
+	 *
98
+	 */
99
+	public static function get_transaction_details()
100
+	{
101
+		EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
102
+	}
103
+
104
+
105
+	/**
106
+	 * bypass_recaptcha_for_load_payment_method
107
+	 *
108
+	 * @access public
109
+	 * @return array
110
+	 * @throws InvalidArgumentException
111
+	 * @throws InvalidDataTypeException
112
+	 * @throws InvalidInterfaceException
113
+	 */
114
+	public static function bypass_recaptcha_for_load_payment_method()
115
+	{
116
+		return [
117
+			'EESID'  => EE_Registry::instance()->SSN->id(),
118
+			'step'   => 'payment_options',
119
+			'action' => 'spco_billing_form',
120
+		];
121
+	}
122
+
123
+
124
+	/**
125
+	 *    class constructor
126
+	 *
127
+	 * @access    public
128
+	 * @param EE_Checkout $checkout
129
+	 */
130
+	public function __construct(EE_Checkout $checkout)
131
+	{
132
+		$this->request   = EED_Single_Page_Checkout::getRequest();
133
+		$this->_slug     = 'payment_options';
134
+		$this->_name     = esc_html__('Payment Options', 'event_espresso');
135
+		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . '/payment_options_main.template.php';
136
+		$this->checkout  = $checkout;
137
+		$this->_reset_success_message();
138
+		$this->set_instructions(
139
+			esc_html__(
140
+				'Please select a method of payment and provide any necessary billing information before proceeding.',
141
+				'event_espresso'
142
+			)
143
+		);
144
+	}
145
+
146
+
147
+	/**
148
+	 * @return null
149
+	 */
150
+	public function line_item_display()
151
+	{
152
+		return $this->line_item_display;
153
+	}
154
+
155
+
156
+	/**
157
+	 * @param null $line_item_display
158
+	 */
159
+	public function set_line_item_display($line_item_display)
160
+	{
161
+		$this->line_item_display = $line_item_display;
162
+	}
163
+
164
+
165
+	/**
166
+	 * @return boolean
167
+	 */
168
+	public function handle_IPN_in_this_request()
169
+	{
170
+		return $this->handle_IPN_in_this_request;
171
+	}
172
+
173
+
174
+	/**
175
+	 * @param boolean $handle_IPN_in_this_request
176
+	 */
177
+	public function set_handle_IPN_in_this_request($handle_IPN_in_this_request)
178
+	{
179
+		$this->handle_IPN_in_this_request = filter_var($handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN);
180
+	}
181
+
182
+
183
+	/**
184
+	 * translate_js_strings
185
+	 *
186
+	 * @return void
187
+	 */
188
+	public function translate_js_strings()
189
+	{
190
+		EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
191
+			'Please select a method of payment in order to continue.',
192
+			'event_espresso'
193
+		);
194
+		EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
195
+			'A valid method of payment could not be determined. Please refresh the page and try again.',
196
+			'event_espresso'
197
+		);
198
+		EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
199
+			'Forwarding to Secure Payment Provider.',
200
+			'event_espresso'
201
+		);
202
+	}
203
+
204
+
205
+	/**
206
+	 * enqueue_styles_and_scripts
207
+	 *
208
+	 * @return void
209
+	 * @throws EE_Error
210
+	 * @throws InvalidArgumentException
211
+	 * @throws InvalidDataTypeException
212
+	 * @throws InvalidInterfaceException
213
+	 * @throws ReflectionException
214
+	 */
215
+	public function enqueue_styles_and_scripts()
216
+	{
217
+		$transaction = $this->checkout->transaction;
218
+		// if the transaction isn't set or nothing is owed on it, don't enqueue any JS
219
+		if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
220
+			return;
221
+		}
222
+		foreach (
223
+			EEM_Payment_Method::instance()->get_all_for_transaction(
224
+				$transaction,
225
+				EEM_Payment_Method::scope_cart
226
+			) as $payment_method
227
+		) {
228
+			$type_obj = $payment_method->type_obj();
229
+			if ($type_obj instanceof EE_PMT_Base) {
230
+				$billing_form = $type_obj->generate_new_billing_form($transaction);
231
+				if ($billing_form instanceof EE_Form_Section_Proper) {
232
+					$billing_form->enqueue_js();
233
+				}
234
+			}
235
+		}
236
+	}
237
+
238
+
239
+	/**
240
+	 * initialize_reg_step
241
+	 *
242
+	 * @return bool
243
+	 * @throws EE_Error
244
+	 * @throws InvalidArgumentException
245
+	 * @throws ReflectionException
246
+	 * @throws InvalidDataTypeException
247
+	 * @throws InvalidInterfaceException
248
+	 */
249
+	public function initialize_reg_step()
250
+	{
251
+		// TODO: if /when we implement donations, then this will need overriding
252
+		if (
253
+			// don't need payment options for:
254
+			// registrations made via the admin
255
+			// completed transactions
256
+			// overpaid transactions
257
+			// $ 0.00 transactions(no payment required)
258
+			! $this->checkout->payment_required()
259
+			// but do NOT remove if current action being called belongs to this reg step
260
+			&& ! is_callable([$this, $this->checkout->action])
261
+			&& ! $this->completed()
262
+		) {
263
+			// and if so, then we no longer need the Payment Options step
264
+			if ($this->is_current_step()) {
265
+				$this->checkout->generate_reg_form = false;
266
+			}
267
+			$this->checkout->remove_reg_step($this->_slug);
268
+			// DEBUG LOG
269
+			// $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
270
+			return false;
271
+		}
272
+		// load EEM_Payment_Method
273
+		EE_Registry::instance()->load_model('Payment_Method');
274
+		// get all active payment methods
275
+		$this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
276
+			$this->checkout->transaction,
277
+			EEM_Payment_Method::scope_cart
278
+		);
279
+		return true;
280
+	}
281
+
282
+
283
+	/**
284
+	 * @return EE_Form_Section_Proper
285
+	 * @throws EE_Error
286
+	 * @throws InvalidArgumentException
287
+	 * @throws ReflectionException
288
+	 * @throws EntityNotFoundException
289
+	 * @throws InvalidDataTypeException
290
+	 * @throws InvalidInterfaceException
291
+	 * @throws InvalidStatusException
292
+	 */
293
+	public function generate_reg_form()
294
+	{
295
+		// reset in case someone changes their mind
296
+		$this->_reset_selected_method_of_payment();
297
+		// set some defaults
298
+		$this->checkout->selected_method_of_payment = 'payments_closed';
299
+		$registrations_requiring_payment            = [];
300
+		$registrations_for_free_events              = [];
301
+		$registrations_requiring_pre_approval       = [];
302
+		$sold_out_events                            = [];
303
+		$insufficient_spaces_available              = [];
304
+		$no_payment_required                        = true;
305
+		// loop thru registrations to gather info
306
+		$registrations         = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
307
+		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
308
+			$registrations,
309
+			$this->checkout->revisit
310
+		);
311
+		foreach ($registrations as $REG_ID => $registration) {
312
+			/** @var $registration EE_Registration */
313
+			// has this registration lost it's space ?
314
+			if (isset($ejected_registrations[ $REG_ID ])) {
315
+				if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
316
+					$sold_out_events[ $registration->event()->ID() ] = $registration->event();
317
+				} else {
318
+					$insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
319
+				}
320
+				continue;
321
+			}
322
+			// event requires admin approval
323
+			if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
324
+				// add event to list of events with pre-approval reg status
325
+				$registrations_requiring_pre_approval[ $REG_ID ] = $registration;
326
+				do_action(
327
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
328
+					$registration->event(),
329
+					$this
330
+				);
331
+				continue;
332
+			}
333
+			if (
334
+				$this->checkout->revisit
335
+				&& $registration->status_ID() !== EEM_Registration::status_id_approved
336
+				&& (
337
+					$registration->event()->is_sold_out()
338
+					|| $registration->event()->is_sold_out(true)
339
+				)
340
+			) {
341
+				// add event to list of events that are sold out
342
+				$sold_out_events[ $registration->event()->ID() ] = $registration->event();
343
+				do_action(
344
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
345
+					$registration->event(),
346
+					$this
347
+				);
348
+				continue;
349
+			}
350
+			// are they allowed to pay now and is there monies owing?
351
+			if ($registration->owes_monies_and_can_pay()) {
352
+				$registrations_requiring_payment[ $REG_ID ] = $registration;
353
+				do_action(
354
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
355
+					$registration->event(),
356
+					$this
357
+				);
358
+			} elseif (
359
+				! $this->checkout->revisit
360
+					  && $registration->status_ID() !== EEM_Registration::status_id_not_approved
361
+					  && $registration->ticket()->is_free()
362
+			) {
363
+				$registrations_for_free_events[ $registration->ticket()->ID() ] = $registration;
364
+			}
365
+		}
366
+		$subsections = [];
367
+		// now decide which template to load
368
+		if (! empty($sold_out_events)) {
369
+			$subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
370
+		}
371
+		if (! empty($insufficient_spaces_available)) {
372
+			$subsections['insufficient_space'] = $this->_insufficient_spaces_available(
373
+				$insufficient_spaces_available
374
+			);
375
+		}
376
+		if (! empty($registrations_requiring_pre_approval)) {
377
+			$subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
378
+				$registrations_requiring_pre_approval
379
+			);
380
+		}
381
+		if (! empty($registrations_for_free_events)) {
382
+			$subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
383
+		}
384
+		if (! empty($registrations_requiring_payment)) {
385
+			if ($this->checkout->amount_owing > 0) {
386
+				// autoload Line_Item_Display classes
387
+				EEH_Autoloader::register_line_item_filter_autoloaders();
388
+				$line_item_filter_processor = new EE_Line_Item_Filter_Processor(
389
+					apply_filters(
390
+						'FHEE__SPCO__EE_Line_Item_Filter_Collection',
391
+						new EE_Line_Item_Filter_Collection()
392
+					),
393
+					$this->checkout->cart->get_grand_total()
394
+				);
395
+				/** @var EE_Line_Item $filtered_line_item_tree */
396
+				$filtered_line_item_tree = $line_item_filter_processor->process();
397
+				EEH_Autoloader::register_line_item_display_autoloaders();
398
+				$this->set_line_item_display(new EE_Line_Item_Display('spco'));
399
+				$subsections['payment_options'] = $this->_display_payment_options(
400
+					$this->line_item_display->display_line_item(
401
+						$filtered_line_item_tree,
402
+						['registrations' => $registrations]
403
+					)
404
+				);
405
+				$this->checkout->amount_owing   = $filtered_line_item_tree->total();
406
+				$this->_apply_registration_payments_to_amount_owing($registrations);
407
+			}
408
+			$no_payment_required = false;
409
+		} else {
410
+			$this->_hide_reg_step_submit_button_if_revisit();
411
+		}
412
+		$this->_save_selected_method_of_payment();
413
+
414
+		$subsections['default_hidden_inputs'] = $this->reg_step_hidden_inputs();
415
+		$subsections['extra_hidden_inputs']   = $this->_extra_hidden_inputs($no_payment_required);
416
+
417
+		return new EE_Form_Section_Proper(
418
+			[
419
+				'name'            => $this->reg_form_name(),
420
+				'html_id'         => $this->reg_form_name(),
421
+				'subsections'     => $subsections,
422
+				'layout_strategy' => new EE_No_Layout(),
423
+			]
424
+		);
425
+	}
426
+
427
+
428
+	/**
429
+	 * add line item filters required for this reg step
430
+	 * these filters are applied via this line in EE_SPCO_Reg_Step_Payment_Options::set_hooks():
431
+	 *        add_filter( 'FHEE__SPCO__EE_Line_Item_Filter_Collection', array( 'EE_SPCO_Reg_Step_Payment_Options',
432
+	 *        'add_spco_line_item_filters' ) ); so any code that wants to use the same set of filters during the
433
+	 *        payment options reg step, can apply these filters via the following: apply_filters(
434
+	 *        'FHEE__SPCO__EE_Line_Item_Filter_Collection', new EE_Line_Item_Filter_Collection() ) or to an existing
435
+	 *        filter collection by passing that instead of instantiating a new collection
436
+	 *
437
+	 * @param EE_Line_Item_Filter_Collection $line_item_filter_collection
438
+	 * @return EE_Line_Item_Filter_Collection
439
+	 * @throws EE_Error
440
+	 * @throws InvalidArgumentException
441
+	 * @throws ReflectionException
442
+	 * @throws EntityNotFoundException
443
+	 * @throws InvalidDataTypeException
444
+	 * @throws InvalidInterfaceException
445
+	 * @throws InvalidStatusException
446
+	 */
447
+	public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
448
+	{
449
+		if (! EE_Registry::instance()->SSN instanceof EE_Session) {
450
+			return $line_item_filter_collection;
451
+		}
452
+		if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
453
+			return $line_item_filter_collection;
454
+		}
455
+		if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
456
+			return $line_item_filter_collection;
457
+		}
458
+		$line_item_filter_collection->add(
459
+			new EE_Billable_Line_Item_Filter(
460
+				EE_SPCO_Reg_Step_Payment_Options::remove_ejected_registrations(
461
+					EE_Registry::instance()->SSN->checkout()->transaction->registrations(
462
+						EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
463
+					)
464
+				)
465
+			)
466
+		);
467
+		$line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
468
+		return $line_item_filter_collection;
469
+	}
470
+
471
+
472
+	/**
473
+	 * remove_ejected_registrations
474
+	 * if a registrant has lost their potential space at an event due to lack of payment,
475
+	 * then this method removes them from the list of registrations being paid for during this request
476
+	 *
477
+	 * @param EE_Registration[] $registrations
478
+	 * @return EE_Registration[]
479
+	 * @throws EE_Error
480
+	 * @throws InvalidArgumentException
481
+	 * @throws ReflectionException
482
+	 * @throws EntityNotFoundException
483
+	 * @throws InvalidDataTypeException
484
+	 * @throws InvalidInterfaceException
485
+	 * @throws InvalidStatusException
486
+	 */
487
+	public static function remove_ejected_registrations(array $registrations)
488
+	{
489
+		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
490
+			$registrations,
491
+			EE_Registry::instance()->SSN->checkout()->revisit
492
+		);
493
+		foreach ($registrations as $REG_ID => $registration) {
494
+			// has this registration lost it's space ?
495
+			if (isset($ejected_registrations[ $REG_ID ])) {
496
+				unset($registrations[ $REG_ID ]);
497
+			}
498
+		}
499
+		return $registrations;
500
+	}
501
+
502
+
503
+	/**
504
+	 * find_registrations_that_lost_their_space
505
+	 * If a registrant chooses an offline payment method like Invoice,
506
+	 * then no space is reserved for them at the event until they fully pay fo that site
507
+	 * (unless the event's default reg status is set to APPROVED)
508
+	 * if a registrant then later returns to pay, but the number of spaces available has been reduced due to sales,
509
+	 * then this method will determine which registrations have lost the ability to complete the reg process.
510
+	 *
511
+	 * @param EE_Registration[] $registrations
512
+	 * @param bool              $revisit
513
+	 * @return array
514
+	 * @throws EE_Error
515
+	 * @throws InvalidArgumentException
516
+	 * @throws ReflectionException
517
+	 * @throws EntityNotFoundException
518
+	 * @throws InvalidDataTypeException
519
+	 * @throws InvalidInterfaceException
520
+	 * @throws InvalidStatusException
521
+	 */
522
+	public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
523
+	{
524
+		// registrations per event
525
+		$event_reg_count = [];
526
+		// spaces left per event
527
+		$event_spaces_remaining = [];
528
+		// tickets left sorted by ID
529
+		$tickets_remaining = [];
530
+		// registrations that have lost their space
531
+		$ejected_registrations = [];
532
+		foreach ($registrations as $REG_ID => $registration) {
533
+			if (
534
+				$registration->status_ID() === EEM_Registration::status_id_approved
535
+				|| apply_filters(
536
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
537
+					false,
538
+					$registration,
539
+					$revisit
540
+				)
541
+			) {
542
+				continue;
543
+			}
544
+			$EVT_ID = $registration->event_ID();
545
+			$ticket = $registration->ticket();
546
+			if (! isset($tickets_remaining[ $ticket->ID() ])) {
547
+				$tickets_remaining[ $ticket->ID() ] = $ticket->remaining();
548
+			}
549
+			if ($tickets_remaining[ $ticket->ID() ] > 0) {
550
+				if (! isset($event_reg_count[ $EVT_ID ])) {
551
+					$event_reg_count[ $EVT_ID ] = 0;
552
+				}
553
+				$event_reg_count[ $EVT_ID ]++;
554
+				if (! isset($event_spaces_remaining[ $EVT_ID ])) {
555
+					$event_spaces_remaining[ $EVT_ID ] = $registration->event()->spaces_remaining_for_sale();
556
+				}
557
+			}
558
+			if (
559
+				$revisit
560
+				&& ($tickets_remaining[ $ticket->ID() ] === 0
561
+					|| $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
562
+				)
563
+			) {
564
+				$ejected_registrations[ $REG_ID ] = $registration->event();
565
+				if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
566
+					/** @type EE_Registration_Processor $registration_processor */
567
+					$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
568
+					// at this point, we should have enough details about the registrant to consider the registration
569
+					// NOT incomplete
570
+					$registration_processor->manually_update_registration_status(
571
+						$registration,
572
+						EEM_Registration::status_id_wait_list
573
+					);
574
+				}
575
+			}
576
+		}
577
+		return $ejected_registrations;
578
+	}
579
+
580
+
581
+	/**
582
+	 * _hide_reg_step_submit_button
583
+	 * removes the html for the reg step submit button
584
+	 * by replacing it with an empty string via filter callback
585
+	 *
586
+	 * @return void
587
+	 */
588
+	protected function _adjust_registration_status_if_event_old_sold()
589
+	{
590
+	}
591
+
592
+
593
+	/**
594
+	 * _hide_reg_step_submit_button
595
+	 * removes the html for the reg step submit button
596
+	 * by replacing it with an empty string via filter callback
597
+	 *
598
+	 * @return void
599
+	 */
600
+	protected function _hide_reg_step_submit_button_if_revisit()
601
+	{
602
+		if ($this->checkout->revisit) {
603
+			add_filter('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string');
604
+		}
605
+	}
606
+
607
+
608
+	/**
609
+	 * sold_out_events
610
+	 * displays notices regarding events that have sold out since hte registrant first signed up
611
+	 *
612
+	 * @param EE_Event[] $sold_out_events_array
613
+	 * @return EE_Form_Section_Proper
614
+	 * @throws EE_Error
615
+	 */
616
+	private function _sold_out_events($sold_out_events_array = [])
617
+	{
618
+		// set some defaults
619
+		$this->checkout->selected_method_of_payment = 'events_sold_out';
620
+		$sold_out_events                            = '';
621
+		foreach ($sold_out_events_array as $sold_out_event) {
622
+			$sold_out_events .= EEH_HTML::li(
623
+				EEH_HTML::span(
624
+					'  ' . $sold_out_event->name(),
625
+					'',
626
+					'dashicons dashicons-marker ee-icon-size-16 pink-text'
627
+				)
628
+			);
629
+		}
630
+		return new EE_Form_Section_Proper(
631
+			[
632
+				'layout_strategy' => new EE_Template_Layout(
633
+					[
634
+						'layout_template_file' => SPCO_REG_STEPS_PATH
635
+												  . $this->_slug
636
+												  . '/sold_out_events.template.php',
637
+						'template_args'        => apply_filters(
638
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
639
+							[
640
+								'sold_out_events'     => $sold_out_events,
641
+								'sold_out_events_msg' => apply_filters(
642
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
643
+									sprintf(
644
+										esc_html__(
645
+											'It appears that the event you were about to make a payment for has sold out since you first registered. If you have already made a partial payment towards this event, please contact the event administrator for a refund.%3$s%3$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%2$s',
646
+											'event_espresso'
647
+										),
648
+										'<strong>',
649
+										'</strong>',
650
+										'<br />'
651
+									)
652
+								),
653
+							]
654
+						),
655
+					]
656
+				),
657
+			]
658
+		);
659
+	}
660
+
661
+
662
+	/**
663
+	 * _insufficient_spaces_available
664
+	 * displays notices regarding events that do not have enough remaining spaces
665
+	 * to satisfy the current number of registrations looking to pay
666
+	 *
667
+	 * @param EE_Event[] $insufficient_spaces_events_array
668
+	 * @return EE_Form_Section_Proper
669
+	 * @throws EE_Error
670
+	 * @throws ReflectionException
671
+	 */
672
+	private function _insufficient_spaces_available($insufficient_spaces_events_array = [])
673
+	{
674
+		// set some defaults
675
+		$this->checkout->selected_method_of_payment = 'invoice';
676
+		$insufficient_space_events                  = '';
677
+		foreach ($insufficient_spaces_events_array as $event) {
678
+			if ($event instanceof EE_Event) {
679
+				$insufficient_space_events .= EEH_HTML::li(
680
+					EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
681
+				);
682
+			}
683
+		}
684
+		return new EE_Form_Section_Proper(
685
+			[
686
+				'subsections'     => [
687
+					'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
688
+					'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
689
+				],
690
+				'layout_strategy' => new EE_Template_Layout(
691
+					[
692
+						'layout_template_file' => SPCO_REG_STEPS_PATH
693
+												  . $this->_slug
694
+												  . '/sold_out_events.template.php',
695
+						'template_args'        => apply_filters(
696
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
697
+							[
698
+								'sold_out_events'     => $insufficient_space_events,
699
+								'sold_out_events_msg' => apply_filters(
700
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__insufficient_space_msg',
701
+									esc_html__(
702
+										'It appears that the event you were about to make a payment for has sold additional tickets since you first registered, and there are no longer enough spaces left to accommodate your selections. You may continue to pay and secure the available space(s) remaining, or simply cancel if you no longer wish to purchase. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
703
+										'event_espresso'
704
+									)
705
+								),
706
+							]
707
+						),
708
+					]
709
+				),
710
+			]
711
+		);
712
+	}
713
+
714
+
715
+	/**
716
+	 * registrations_requiring_pre_approval
717
+	 *
718
+	 * @param array $registrations_requiring_pre_approval
719
+	 * @return EE_Form_Section_Proper
720
+	 * @throws EE_Error
721
+	 * @throws EntityNotFoundException
722
+	 * @throws ReflectionException
723
+	 */
724
+	private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = [])
725
+	{
726
+		$events_requiring_pre_approval = [];
727
+		foreach ($registrations_requiring_pre_approval as $registration) {
728
+			if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
729
+				$events_requiring_pre_approval[ $registration->event()->ID() ] = EEH_HTML::li(
730
+					EEH_HTML::span(
731
+						'',
732
+						'',
733
+						'dashicons dashicons-marker ee-icon-size-16 orange-text'
734
+					)
735
+					. EEH_HTML::span($registration->event()->name(), '', 'orange-text')
736
+				);
737
+			}
738
+		}
739
+		return new EE_Form_Section_Proper(
740
+			[
741
+				'layout_strategy' => new EE_Template_Layout(
742
+					[
743
+						'layout_template_file' => SPCO_REG_STEPS_PATH
744
+												  . $this->_slug
745
+												  . '/events_requiring_pre_approval.template.php', // layout_template
746
+						'template_args'        => apply_filters(
747
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
748
+							[
749
+								'events_requiring_pre_approval'     => implode('', $events_requiring_pre_approval),
750
+								'events_requiring_pre_approval_msg' => apply_filters(
751
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___events_requiring_pre_approval__events_requiring_pre_approval_msg',
752
+									esc_html__(
753
+										'The following events do not require payment at this time and will not be billed during this transaction. Billing will only occur after the attendee has been approved by the event organizer. You will be notified when your registration has been processed. If this is a free event, then no billing will occur.',
754
+										'event_espresso'
755
+									)
756
+								),
757
+							]
758
+						),
759
+					]
760
+				),
761
+			]
762
+		);
763
+	}
764
+
765
+
766
+	/**
767
+	 * _no_payment_required
768
+	 *
769
+	 * @param EE_Event[] $registrations_for_free_events
770
+	 * @return EE_Form_Section_Proper
771
+	 * @throws EE_Error
772
+	 */
773
+	private function _no_payment_required($registrations_for_free_events = [])
774
+	{
775
+		// set some defaults
776
+		$this->checkout->selected_method_of_payment = 'no_payment_required';
777
+		// generate no_payment_required form
778
+		return new EE_Form_Section_Proper(
779
+			[
780
+				'layout_strategy' => new EE_Template_Layout(
781
+					[
782
+						'layout_template_file' => SPCO_REG_STEPS_PATH
783
+												  . $this->_slug
784
+												  . '/no_payment_required.template.php', // layout_template
785
+						'template_args'        => apply_filters(
786
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
787
+							[
788
+								'revisit'                       => $this->checkout->revisit,
789
+								'registrations'                 => [],
790
+								'ticket_count'                  => [],
791
+								'registrations_for_free_events' => $registrations_for_free_events,
792
+								'no_payment_required_msg'       => EEH_HTML::p(
793
+									esc_html__('This is a free event, so no billing will occur.', 'event_espresso')
794
+								),
795
+							]
796
+						),
797
+					]
798
+				),
799
+			]
800
+		);
801
+	}
802
+
803
+
804
+	/**
805
+	 * _display_payment_options
806
+	 *
807
+	 * @param string $transaction_details
808
+	 * @return EE_Form_Section_Proper
809
+	 * @throws EE_Error
810
+	 * @throws InvalidArgumentException
811
+	 * @throws InvalidDataTypeException
812
+	 * @throws InvalidInterfaceException
813
+	 */
814
+	private function _display_payment_options($transaction_details = '')
815
+	{
816
+		// has method_of_payment been set by no-js user?
817
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment();
818
+		// build payment options form
819
+		return apply_filters(
820
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__payment_options_form',
821
+			new EE_Form_Section_Proper(
822
+				[
823
+					'subsections'     => [
824
+						'before_payment_options' => apply_filters(
825
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
826
+							new EE_Form_Section_Proper(
827
+								['layout_strategy' => new EE_Div_Per_Section_Layout()]
828
+							)
829
+						),
830
+						'payment_options'        => $this->_setup_payment_options(),
831
+						'after_payment_options'  => apply_filters(
832
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__after_payment_options',
833
+							new EE_Form_Section_Proper(
834
+								['layout_strategy' => new EE_Div_Per_Section_Layout()]
835
+							)
836
+						),
837
+					],
838
+					'layout_strategy' => new EE_Template_Layout(
839
+						[
840
+							'layout_template_file' => $this->_template,
841
+							'template_args'        => apply_filters(
842
+								'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
843
+								[
844
+									'reg_count'                 => $this->line_item_display->total_items(),
845
+									'transaction_details'       => $transaction_details,
846
+									'available_payment_methods' => [],
847
+								]
848
+							),
849
+						]
850
+					),
851
+				]
852
+			)
853
+		);
854
+	}
855
+
856
+
857
+	/**
858
+	 * _extra_hidden_inputs
859
+	 *
860
+	 * @param bool $no_payment_required
861
+	 * @return EE_Form_Section_Proper
862
+	 * @throws EE_Error
863
+	 * @throws ReflectionException
864
+	 */
865
+	private function _extra_hidden_inputs($no_payment_required = true)
866
+	{
867
+		return new EE_Form_Section_Proper(
868
+			[
869
+				'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
870
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
871
+				'subsections'     => [
872
+					'spco_no_payment_required' => new EE_Hidden_Input(
873
+						[
874
+							'normalization_strategy' => new EE_Boolean_Normalization(),
875
+							'html_name'              => 'spco_no_payment_required',
876
+							'html_id'                => 'spco-no-payment-required-payment_options',
877
+							'default'                => $no_payment_required,
878
+						]
879
+					),
880
+					'spco_transaction_id'      => new EE_Fixed_Hidden_Input(
881
+						[
882
+							'normalization_strategy' => new EE_Int_Normalization(),
883
+							'html_name'              => 'spco_transaction_id',
884
+							'html_id'                => 'spco-transaction-id',
885
+							'default'                => $this->checkout->transaction->ID(),
886
+						]
887
+					),
888
+				],
889
+			]
890
+		);
891
+	}
892
+
893
+
894
+	/**
895
+	 *    _apply_registration_payments_to_amount_owing
896
+	 *
897
+	 * @param array $registrations
898
+	 * @throws EE_Error
899
+	 */
900
+	protected function _apply_registration_payments_to_amount_owing(array $registrations)
901
+	{
902
+		$payments = [];
903
+		foreach ($registrations as $registration) {
904
+			if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
905
+				$payments += $registration->registration_payments();
906
+			}
907
+		}
908
+		if (! empty($payments)) {
909
+			foreach ($payments as $payment) {
910
+				if ($payment instanceof EE_Registration_Payment) {
911
+					$this->checkout->amount_owing -= $payment->amount();
912
+				}
913
+			}
914
+		}
915
+	}
916
+
917
+
918
+	/**
919
+	 *    _reset_selected_method_of_payment
920
+	 *
921
+	 * @access    private
922
+	 * @param bool $force_reset
923
+	 * @return void
924
+	 * @throws InvalidArgumentException
925
+	 * @throws InvalidDataTypeException
926
+	 * @throws InvalidInterfaceException
927
+	 */
928
+	private function _reset_selected_method_of_payment($force_reset = false)
929
+	{
930
+		/** @var RequestInterface $request */
931
+		$request              = LoaderFactory::getLoader()->getShared(RequestInterface::class);
932
+		$reset_payment_method = $request->getRequestParam('reset_payment_method', $force_reset, 'bool');
933
+		if ($reset_payment_method) {
934
+			$this->checkout->selected_method_of_payment = null;
935
+			$this->checkout->payment_method             = null;
936
+			$this->checkout->billing_form               = null;
937
+			$this->_save_selected_method_of_payment();
938
+		}
939
+	}
940
+
941
+
942
+	/**
943
+	 * _save_selected_method_of_payment
944
+	 * stores the selected_method_of_payment in the session
945
+	 * so that it's available for all subsequent requests including AJAX
946
+	 *
947
+	 * @access        private
948
+	 * @param string $selected_method_of_payment
949
+	 * @return void
950
+	 * @throws InvalidArgumentException
951
+	 * @throws InvalidDataTypeException
952
+	 * @throws InvalidInterfaceException
953
+	 */
954
+	private function _save_selected_method_of_payment($selected_method_of_payment = '')
955
+	{
956
+		$selected_method_of_payment = ! empty($selected_method_of_payment)
957
+			? $selected_method_of_payment
958
+			: $this->checkout->selected_method_of_payment;
959
+		EE_Registry::instance()->SSN->set_session_data(
960
+			['selected_method_of_payment' => $selected_method_of_payment]
961
+		);
962
+	}
963
+
964
+
965
+	/**
966
+	 * _setup_payment_options
967
+	 *
968
+	 * @return EE_Form_Section_Proper
969
+	 * @throws EE_Error
970
+	 * @throws InvalidArgumentException
971
+	 * @throws InvalidDataTypeException
972
+	 * @throws InvalidInterfaceException
973
+	 */
974
+	public function _setup_payment_options()
975
+	{
976
+		// load payment method classes
977
+		$this->checkout->available_payment_methods = $this->_get_available_payment_methods();
978
+		if (empty($this->checkout->available_payment_methods)) {
979
+			EE_Error::add_error(
980
+				apply_filters(
981
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__error_message_no_payment_methods',
982
+					sprintf(
983
+						esc_html__(
984
+							'Sorry, you cannot complete your purchase because a payment method is not active.%1$s Please contact %2$s for assistance and provide a description of the problem.',
985
+							'event_espresso'
986
+						),
987
+						'<br>',
988
+						EE_Registry::instance()->CFG->organization->get_pretty('email')
989
+					)
990
+				),
991
+				__FILE__,
992
+				__FUNCTION__,
993
+				__LINE__
994
+			);
995
+		}
996
+		// switch up header depending on number of available payment methods
997
+		$payment_method_header     = count($this->checkout->available_payment_methods) > 1
998
+			? apply_filters(
999
+				'FHEE__registration_page_payment_options__method_of_payment_hdr',
1000
+				esc_html__('Please Select Your Method of Payment', 'event_espresso')
1001
+			)
1002
+			: apply_filters(
1003
+				'FHEE__registration_page_payment_options__method_of_payment_hdr',
1004
+				esc_html__('Method of Payment', 'event_espresso')
1005
+			);
1006
+		$available_payment_methods = [
1007
+			// display the "Payment Method" header
1008
+			'payment_method_header' => new EE_Form_Section_HTML(
1009
+				apply_filters(
1010
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__payment_method_header',
1011
+					EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr'),
1012
+					$payment_method_header
1013
+				)
1014
+			),
1015
+		];
1016
+		// the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
1017
+		$available_payment_method_options = [];
1018
+		$default_payment_method_option    = [];
1019
+		// additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
1020
+		$payment_methods_billing_info = [
1021
+			new EE_Form_Section_HTML(
1022
+				EEH_HTML::div('<br />', '', '', 'clear:both;')
1023
+			),
1024
+		];
1025
+		// loop through payment methods
1026
+		foreach ($this->checkout->available_payment_methods as $payment_method) {
1027
+			if ($payment_method instanceof EE_Payment_Method) {
1028
+				$payment_method_button = EEH_HTML::img(
1029
+					$payment_method->button_url(),
1030
+					$payment_method->name(),
1031
+					'spco-payment-method-' . $payment_method->slug() . '-btn-img',
1032
+					'spco-payment-method-btn-img'
1033
+				);
1034
+				// check if any payment methods are set as default
1035
+				// if payment method is already selected OR nothing is selected and this payment method should be
1036
+				// open_by_default
1037
+				if (
1038
+					($this->checkout->selected_method_of_payment === $payment_method->slug())
1039
+					|| (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
1040
+				) {
1041
+					$this->checkout->selected_method_of_payment = $payment_method->slug();
1042
+					$this->_save_selected_method_of_payment();
1043
+					$default_payment_method_option[ $payment_method->slug() ] = $payment_method_button;
1044
+				} else {
1045
+					$available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
1046
+				}
1047
+				$payment_methods_billing_info[ $payment_method->slug() . '-info' ] =
1048
+					$this->_payment_method_billing_info(
1049
+						$payment_method
1050
+					);
1051
+			}
1052
+		}
1053
+		// prepend available_payment_method_options with default_payment_method_option so that it appears first in list
1054
+		// of PMs
1055
+		$available_payment_method_options = $default_payment_method_option + $available_payment_method_options;
1056
+		// now generate the actual form  inputs
1057
+		$available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
1058
+			$available_payment_method_options
1059
+		);
1060
+		$available_payment_methods                              += $payment_methods_billing_info;
1061
+		// build the available payment methods form
1062
+		return new EE_Form_Section_Proper(
1063
+			[
1064
+				'html_id'         => 'spco-available-methods-of-payment-dv',
1065
+				'subsections'     => $available_payment_methods,
1066
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
1067
+			]
1068
+		);
1069
+	}
1070
+
1071
+
1072
+	/**
1073
+	 * _get_available_payment_methods
1074
+	 *
1075
+	 * @return EE_Payment_Method[]
1076
+	 * @throws EE_Error
1077
+	 * @throws InvalidArgumentException
1078
+	 * @throws InvalidDataTypeException
1079
+	 * @throws InvalidInterfaceException
1080
+	 */
1081
+	protected function _get_available_payment_methods()
1082
+	{
1083
+		if (! empty($this->checkout->available_payment_methods)) {
1084
+			return $this->checkout->available_payment_methods;
1085
+		}
1086
+		$available_payment_methods = [];
1087
+		$EEM_Payment_Method        = EEM_Payment_Method::instance();
1088
+		// get all active payment methods
1089
+		$payment_methods = $EEM_Payment_Method->get_all_for_transaction(
1090
+			$this->checkout->transaction,
1091
+			EEM_Payment_Method::scope_cart
1092
+		);
1093
+		foreach ($payment_methods as $payment_method) {
1094
+			if ($payment_method instanceof EE_Payment_Method) {
1095
+				$available_payment_methods[ $payment_method->slug() ] = $payment_method;
1096
+			}
1097
+		}
1098
+		return $available_payment_methods;
1099
+	}
1100
+
1101
+
1102
+	/**
1103
+	 *    _available_payment_method_inputs
1104
+	 *
1105
+	 * @access    private
1106
+	 * @param array $available_payment_method_options
1107
+	 * @return    EE_Form_Section_Proper
1108
+	 * @throws EE_Error
1109
+	 * @throws EE_Error
1110
+	 */
1111
+	private function _available_payment_method_inputs($available_payment_method_options = [])
1112
+	{
1113
+		// generate inputs
1114
+		return new EE_Form_Section_Proper(
1115
+			[
1116
+				'html_id'         => 'ee-available-payment-method-inputs',
1117
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
1118
+				'subsections'     => [
1119
+					'' => new EE_Radio_Button_Input(
1120
+						$available_payment_method_options,
1121
+						[
1122
+							'html_name'          => 'selected_method_of_payment',
1123
+							'html_class'         => 'spco-payment-method',
1124
+							'default'            => $this->checkout->selected_method_of_payment,
1125
+							'label_size'         => 11,
1126
+							'enforce_label_size' => true,
1127
+						]
1128
+					),
1129
+				],
1130
+			]
1131
+		);
1132
+	}
1133
+
1134
+
1135
+	/**
1136
+	 *    _payment_method_billing_info
1137
+	 *
1138
+	 * @access    private
1139
+	 * @param EE_Payment_Method $payment_method
1140
+	 * @return EE_Form_Section_Proper
1141
+	 * @throws EE_Error
1142
+	 * @throws InvalidArgumentException
1143
+	 * @throws InvalidDataTypeException
1144
+	 * @throws InvalidInterfaceException
1145
+	 */
1146
+	private function _payment_method_billing_info(EE_Payment_Method $payment_method)
1147
+	{
1148
+		$currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug();
1149
+		// generate the billing form for payment method
1150
+		$billing_form                 = $currently_selected
1151
+			? $this->_get_billing_form_for_payment_method($payment_method)
1152
+			: new EE_Form_Section_HTML();
1153
+		$this->checkout->billing_form = $currently_selected
1154
+			? $billing_form
1155
+			: $this->checkout->billing_form;
1156
+		// it's all in the details
1157
+		$info_html = EEH_HTML::h3(
1158
+			esc_html__('Important information regarding your payment', 'event_espresso'),
1159
+			'',
1160
+			'spco-payment-method-hdr'
1161
+		);
1162
+		// add some info regarding the step, either from what's saved in the admin,
1163
+		// or a default string depending on whether the PM has a billing form or not
1164
+		if ($payment_method->description()) {
1165
+			$payment_method_info = $payment_method->description();
1166
+		} elseif ($billing_form instanceof EE_Billing_Info_Form) {
1167
+			$payment_method_info = sprintf(
1168
+				esc_html__(
1169
+					'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
1170
+					'event_espresso'
1171
+				),
1172
+				$this->submit_button_text()
1173
+			);
1174
+		} else {
1175
+			$payment_method_info = sprintf(
1176
+				esc_html__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
1177
+				$this->submit_button_text()
1178
+			);
1179
+		}
1180
+		$info_html .= EEH_HTML::div(
1181
+			apply_filters(
1182
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options___payment_method_billing_info__payment_method_info',
1183
+				$payment_method_info
1184
+			),
1185
+			'',
1186
+			'spco-payment-method-desc ee-attention'
1187
+		);
1188
+		return new EE_Form_Section_Proper(
1189
+			[
1190
+				'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
1191
+				'html_class'      => 'spco-payment-method-info-dv',
1192
+				// only display the selected or default PM
1193
+				'html_style'      => $currently_selected ? '' : 'display:none;',
1194
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
1195
+				'subsections'     => [
1196
+					'info'         => new EE_Form_Section_HTML($info_html),
1197
+					'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML(),
1198
+				],
1199
+			]
1200
+		);
1201
+	}
1202
+
1203
+
1204
+	/**
1205
+	 * get_billing_form_html_for_payment_method
1206
+	 *
1207
+	 * @return bool
1208
+	 * @throws EE_Error
1209
+	 * @throws InvalidArgumentException
1210
+	 * @throws ReflectionException
1211
+	 * @throws InvalidDataTypeException
1212
+	 * @throws InvalidInterfaceException
1213
+	 */
1214
+	public function get_billing_form_html_for_payment_method()
1215
+	{
1216
+		// how have they chosen to pay?
1217
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
1218
+		$this->checkout->payment_method             = $this->_get_payment_method_for_selected_method_of_payment();
1219
+		if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
1220
+			return false;
1221
+		}
1222
+		if (
1223
+			apply_filters(
1224
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1225
+				false
1226
+			)
1227
+		) {
1228
+			EE_Error::add_success(
1229
+				apply_filters(
1230
+					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1231
+					sprintf(
1232
+						esc_html__(
1233
+							'You have selected "%s" as your method of payment. Please note the important payment information below.',
1234
+							'event_espresso'
1235
+						),
1236
+						$this->checkout->payment_method->name()
1237
+					)
1238
+				)
1239
+			);
1240
+		}
1241
+		// now generate billing form for selected method of payment
1242
+		$payment_method_billing_form = $this->_get_billing_form_for_payment_method($this->checkout->payment_method);
1243
+		// fill form with attendee info if applicable
1244
+		if (
1245
+			$payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
1246
+			&& $this->checkout->transaction_has_primary_registrant()
1247
+		) {
1248
+			$payment_method_billing_form->populate_from_attendee(
1249
+				$this->checkout->transaction->primary_registration()->attendee()
1250
+			);
1251
+		}
1252
+		// and debug content
1253
+		if (
1254
+			$payment_method_billing_form instanceof EE_Billing_Info_Form
1255
+			&& $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
1256
+		) {
1257
+			$payment_method_billing_form =
1258
+				$this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
1259
+					$payment_method_billing_form
1260
+				);
1261
+		}
1262
+		$billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
1263
+			? $payment_method_billing_form->get_html()
1264
+			: '';
1265
+		$this->checkout->json_response->set_return_data(['payment_method_info' => $billing_info]);
1266
+		// localize validation rules for main form
1267
+		$this->checkout->current_step->reg_form->localize_validation_rules();
1268
+		$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
1269
+		return true;
1270
+	}
1271
+
1272
+
1273
+	/**
1274
+	 * _get_billing_form_for_payment_method
1275
+	 *
1276
+	 * @param EE_Payment_Method $payment_method
1277
+	 * @return EE_Billing_Info_Form|EE_Form_Section_HTML
1278
+	 * @throws EE_Error
1279
+	 * @throws InvalidArgumentException
1280
+	 * @throws InvalidDataTypeException
1281
+	 * @throws InvalidInterfaceException
1282
+	 */
1283
+	private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method)
1284
+	{
1285
+		$billing_form = $payment_method->type_obj()->billing_form(
1286
+			$this->checkout->transaction,
1287
+			['amount_owing' => $this->checkout->amount_owing]
1288
+		);
1289
+		if ($billing_form instanceof EE_Billing_Info_Form) {
1290
+			if (
1291
+				apply_filters(
1292
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1293
+					false
1294
+				)
1295
+				&& $this->request->requestParamIsSet('payment_method')
1296
+			) {
1297
+				EE_Error::add_success(
1298
+					apply_filters(
1299
+						'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1300
+						sprintf(
1301
+							esc_html__(
1302
+								'You have selected "%s" as your method of payment. Please note the important payment information below.',
1303
+								'event_espresso'
1304
+							),
1305
+							$payment_method->name()
1306
+						)
1307
+					)
1308
+				);
1309
+			}
1310
+			return apply_filters(
1311
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
1312
+				$billing_form,
1313
+				$payment_method
1314
+			);
1315
+		}
1316
+		// no actual billing form, so return empty HTML form section
1317
+		return new EE_Form_Section_HTML();
1318
+	}
1319
+
1320
+
1321
+	/**
1322
+	 * _get_selected_method_of_payment
1323
+	 *
1324
+	 * @param boolean $required whether to throw an error if the "selected_method_of_payment"
1325
+	 *                          is not found in the incoming request
1326
+	 * @param string  $request_param
1327
+	 * @return NULL|string
1328
+	 * @throws EE_Error
1329
+	 * @throws InvalidArgumentException
1330
+	 * @throws InvalidDataTypeException
1331
+	 * @throws InvalidInterfaceException
1332
+	 */
1333
+	private function _get_selected_method_of_payment(
1334
+		$required = false,
1335
+		$request_param = 'selected_method_of_payment'
1336
+	) {
1337
+		// is selected_method_of_payment set in the request ?
1338
+		$selected_method_of_payment = $this->request->getRequestParam($request_param);
1339
+		if ($selected_method_of_payment) {
1340
+			// sanitize it
1341
+			$selected_method_of_payment = is_array($selected_method_of_payment)
1342
+				? array_shift($selected_method_of_payment)
1343
+				: $selected_method_of_payment;
1344
+			$selected_method_of_payment = sanitize_text_field($selected_method_of_payment);
1345
+			// store it in the session so that it's available for all subsequent requests including AJAX
1346
+			$this->_save_selected_method_of_payment($selected_method_of_payment);
1347
+		} else {
1348
+			// or is is set in the session ?
1349
+			$selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
1350
+				'selected_method_of_payment'
1351
+			);
1352
+		}
1353
+		// do ya really really gotta have it?
1354
+		if (empty($selected_method_of_payment) && $required) {
1355
+			EE_Error::add_error(
1356
+				sprintf(
1357
+					esc_html__(
1358
+						'The selected method of payment could not be determined.%sPlease ensure that you have selected one before proceeding.%sIf you continue to experience difficulties, then refresh your browser and try again, or contact %s for assistance.',
1359
+						'event_espresso'
1360
+					),
1361
+					'<br/>',
1362
+					'<br/>',
1363
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
1364
+				),
1365
+				__FILE__,
1366
+				__FUNCTION__,
1367
+				__LINE__
1368
+			);
1369
+			return null;
1370
+		}
1371
+		return $selected_method_of_payment;
1372
+	}
1373
+
1374
+
1375
+
1376
+
1377
+
1378
+
1379
+	/********************************************************************************************************/
1380
+	/***********************************  SWITCH PAYMENT METHOD  ************************************/
1381
+	/********************************************************************************************************/
1382
+	/**
1383
+	 * switch_payment_method
1384
+	 *
1385
+	 * @return bool
1386
+	 * @throws EE_Error
1387
+	 * @throws InvalidArgumentException
1388
+	 * @throws InvalidDataTypeException
1389
+	 * @throws InvalidInterfaceException
1390
+	 * @throws ReflectionException
1391
+	 */
1392
+	public function switch_payment_method()
1393
+	{
1394
+		if (! $this->_verify_payment_method_is_set()) {
1395
+			return false;
1396
+		}
1397
+		if (
1398
+			apply_filters(
1399
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1400
+				false
1401
+			)
1402
+		) {
1403
+			EE_Error::add_success(
1404
+				apply_filters(
1405
+					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1406
+					sprintf(
1407
+						esc_html__(
1408
+							'You have selected "%s" as your method of payment. Please note the important payment information below.',
1409
+							'event_espresso'
1410
+						),
1411
+						$this->checkout->payment_method->name()
1412
+					)
1413
+				)
1414
+			);
1415
+		}
1416
+		// generate billing form for selected method of payment if it hasn't been done already
1417
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
1418
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1419
+				$this->checkout->payment_method
1420
+			);
1421
+		}
1422
+		// fill form with attendee info if applicable
1423
+		if (
1424
+			apply_filters(
1425
+				'FHEE__populate_billing_form_fields_from_attendee',
1426
+				(
1427
+				$this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
1428
+				&& $this->checkout->transaction_has_primary_registrant()
1429
+				),
1430
+				$this->checkout->billing_form,
1431
+				$this->checkout->transaction
1432
+			)
1433
+		) {
1434
+			$this->checkout->billing_form->populate_from_attendee(
1435
+				$this->checkout->transaction->primary_registration()->attendee()
1436
+			);
1437
+		}
1438
+		// and debug content
1439
+		if (
1440
+			$this->checkout->billing_form instanceof EE_Billing_Info_Form
1441
+			&& $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
1442
+		) {
1443
+			$this->checkout->billing_form =
1444
+				$this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
1445
+					$this->checkout->billing_form
1446
+				);
1447
+		}
1448
+		// get html and validation rules for form
1449
+		if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
1450
+			$this->checkout->json_response->set_return_data(
1451
+				['payment_method_info' => $this->checkout->billing_form->get_html()]
1452
+			);
1453
+			// localize validation rules for main form
1454
+			$this->checkout->billing_form->localize_validation_rules(true);
1455
+			$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
1456
+		} else {
1457
+			$this->checkout->json_response->set_return_data(['payment_method_info' => '']);
1458
+		}
1459
+		// prevents advancement to next step
1460
+		$this->checkout->continue_reg = false;
1461
+		return true;
1462
+	}
1463
+
1464
+
1465
+	/**
1466
+	 * _verify_payment_method_is_set
1467
+	 *
1468
+	 * @return bool
1469
+	 * @throws EE_Error
1470
+	 * @throws InvalidArgumentException
1471
+	 * @throws ReflectionException
1472
+	 * @throws InvalidDataTypeException
1473
+	 * @throws InvalidInterfaceException
1474
+	 */
1475
+	protected function _verify_payment_method_is_set()
1476
+	{
1477
+		// generate billing form for selected method of payment if it hasn't been done already
1478
+		if (empty($this->checkout->selected_method_of_payment)) {
1479
+			// how have they chosen to pay?
1480
+			$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
1481
+		} else {
1482
+			// choose your own adventure based on method_of_payment
1483
+			switch ($this->checkout->selected_method_of_payment) {
1484
+				case 'events_sold_out':
1485
+					EE_Error::add_attention(
1486
+						apply_filters(
1487
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__sold_out_events_msg',
1488
+							esc_html__(
1489
+								'It appears that the event you were about to make a payment for has sold out since this form first loaded. Please contact the event administrator if you believe this is an error.',
1490
+								'event_espresso'
1491
+							)
1492
+						),
1493
+						__FILE__,
1494
+						__FUNCTION__,
1495
+						__LINE__
1496
+					);
1497
+					return false;
1498
+				case 'payments_closed':
1499
+					EE_Error::add_attention(
1500
+						apply_filters(
1501
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
1502
+							esc_html__(
1503
+								'It appears that the event you were about to make a payment for is not accepting payments at this time. Please contact the event administrator if you believe this is an error.',
1504
+								'event_espresso'
1505
+							)
1506
+						),
1507
+						__FILE__,
1508
+						__FUNCTION__,
1509
+						__LINE__
1510
+					);
1511
+					return false;
1512
+				case 'no_payment_required':
1513
+					EE_Error::add_attention(
1514
+						apply_filters(
1515
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
1516
+							esc_html__(
1517
+								'It appears that the event you were about to make a payment for does not require payment. Please contact the event administrator if you believe this is an error.',
1518
+								'event_espresso'
1519
+							)
1520
+						),
1521
+						__FILE__,
1522
+						__FUNCTION__,
1523
+						__LINE__
1524
+					);
1525
+					return false;
1526
+				default:
1527
+			}
1528
+		}
1529
+		// verify payment method
1530
+		if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
1531
+			// get payment method for selected method of payment
1532
+			$this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
1533
+		}
1534
+		return $this->checkout->payment_method instanceof EE_Payment_Method;
1535
+	}
1536
+
1537
+
1538
+
1539
+	/********************************************************************************************************/
1540
+	/***************************************  SAVE PAYER DETAILS  ****************************************/
1541
+	/********************************************************************************************************/
1542
+	/**
1543
+	 * save_payer_details_via_ajax
1544
+	 *
1545
+	 * @return void
1546
+	 * @throws EE_Error
1547
+	 * @throws InvalidArgumentException
1548
+	 * @throws ReflectionException
1549
+	 * @throws RuntimeException
1550
+	 * @throws InvalidDataTypeException
1551
+	 * @throws InvalidInterfaceException
1552
+	 */
1553
+	public function save_payer_details_via_ajax()
1554
+	{
1555
+		if (! $this->_verify_payment_method_is_set()) {
1556
+			return;
1557
+		}
1558
+		// generate billing form for selected method of payment if it hasn't been done already
1559
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
1560
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1561
+				$this->checkout->payment_method
1562
+			);
1563
+		}
1564
+		// generate primary attendee from payer info if applicable
1565
+		if (! $this->checkout->transaction_has_primary_registrant()) {
1566
+			$attendee = $this->_create_attendee_from_request_data();
1567
+			if ($attendee instanceof EE_Attendee) {
1568
+				foreach ($this->checkout->transaction->registrations() as $registration) {
1569
+					if ($registration->is_primary_registrant()) {
1570
+						$this->checkout->primary_attendee_obj = $attendee;
1571
+						$registration->_add_relation_to($attendee, 'Attendee');
1572
+						$registration->set_attendee_id($attendee->ID());
1573
+						$registration->update_cache_after_object_save('Attendee', $attendee);
1574
+					}
1575
+				}
1576
+			}
1577
+		}
1578
+	}
1579
+
1580
+
1581
+	/**
1582
+	 * create_attendee_from_request_data
1583
+	 * uses info from alternate GET or POST data (such as AJAX) to create a new attendee
1584
+	 *
1585
+	 * @return EE_Attendee
1586
+	 * @throws EE_Error
1587
+	 * @throws InvalidArgumentException
1588
+	 * @throws ReflectionException
1589
+	 * @throws InvalidDataTypeException
1590
+	 * @throws InvalidInterfaceException
1591
+	 */
1592
+	protected function _create_attendee_from_request_data()
1593
+	{
1594
+		// get State ID
1595
+		$STA_ID = $this->request->getRequestParam('state');
1596
+		if (! empty($STA_ID)) {
1597
+			// can we get state object from name ?
1598
+			EE_Registry::instance()->load_model('State');
1599
+			$state  = EEM_State::instance()->get_col([['STA_name' => $STA_ID], 'limit' => 1], 'STA_ID');
1600
+			$STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
1601
+		}
1602
+		// get Country ISO
1603
+		$CNT_ISO = $this->request->getRequestParam('country');
1604
+		if (! empty($CNT_ISO)) {
1605
+			// can we get country object from name ?
1606
+			EE_Registry::instance()->load_model('Country');
1607
+			$country = EEM_Country::instance()->get_col(
1608
+				[['CNT_name' => $CNT_ISO], 'limit' => 1],
1609
+				'CNT_ISO'
1610
+			);
1611
+			$CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
1612
+		}
1613
+		// grab attendee data
1614
+		$attendee_data = [
1615
+			'ATT_fname'    => $this->request->getRequestParam('first_name'),
1616
+			'ATT_lname'    => $this->request->getRequestParam('last_name'),
1617
+			'ATT_email'    => $this->request->getRequestParam('email'),
1618
+			'ATT_address'  => $this->request->getRequestParam('address'),
1619
+			'ATT_address2' => $this->request->getRequestParam('address2'),
1620
+			'ATT_city'     => $this->request->getRequestParam('city'),
1621
+			'STA_ID'       => $STA_ID,
1622
+			'CNT_ISO'      => $CNT_ISO,
1623
+			'ATT_zip'      => $this->request->getRequestParam('zip'),
1624
+			'ATT_phone'    => $this->request->getRequestParam('phone'),
1625
+		];
1626
+		// validate the email address since it is the most important piece of info
1627
+		if (empty($attendee_data['ATT_email'])) {
1628
+			EE_Error::add_error(
1629
+				esc_html__('An invalid email address was submitted.', 'event_espresso'),
1630
+				__FILE__,
1631
+				__FUNCTION__,
1632
+				__LINE__
1633
+			);
1634
+		}
1635
+		// does this attendee already exist in the db ? we're searching using a combination of first name, last name,
1636
+		// AND email address
1637
+		if (
1638
+			! empty($attendee_data['ATT_fname'])
1639
+			&& ! empty($attendee_data['ATT_lname'])
1640
+			&& ! empty($attendee_data['ATT_email'])
1641
+		) {
1642
+			$existing_attendee = EEM_Attendee::instance()->find_existing_attendee(
1643
+				[
1644
+					'ATT_fname' => $attendee_data['ATT_fname'],
1645
+					'ATT_lname' => $attendee_data['ATT_lname'],
1646
+					'ATT_email' => $attendee_data['ATT_email'],
1647
+				]
1648
+			);
1649
+			if ($existing_attendee instanceof EE_Attendee) {
1650
+				return $existing_attendee;
1651
+			}
1652
+		}
1653
+		// no existing attendee? kk let's create a new one
1654
+		// kinda lame, but we need a first and last name to create an attendee, so use the email address if those
1655
+		// don't exist
1656
+		$attendee_data['ATT_fname'] = ! empty($attendee_data['ATT_fname'])
1657
+			? $attendee_data['ATT_fname']
1658
+			: $attendee_data['ATT_email'];
1659
+		$attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
1660
+			? $attendee_data['ATT_lname']
1661
+			: $attendee_data['ATT_email'];
1662
+		return EE_Attendee::new_instance($attendee_data);
1663
+	}
1664
+
1665
+
1666
+
1667
+	/********************************************************************************************************/
1668
+	/****************************************  PROCESS REG STEP  *****************************************/
1669
+	/********************************************************************************************************/
1670
+	/**
1671
+	 * process_reg_step
1672
+	 *
1673
+	 * @return bool
1674
+	 * @throws EE_Error
1675
+	 * @throws InvalidArgumentException
1676
+	 * @throws ReflectionException
1677
+	 * @throws EntityNotFoundException
1678
+	 * @throws InvalidDataTypeException
1679
+	 * @throws InvalidInterfaceException
1680
+	 * @throws InvalidStatusException
1681
+	 */
1682
+	public function process_reg_step()
1683
+	{
1684
+		// how have they chosen to pay?
1685
+		$this->checkout->selected_method_of_payment = $this->checkout->transaction->is_free()
1686
+			? 'no_payment_required'
1687
+			: $this->_get_selected_method_of_payment(true);
1688
+		// choose your own adventure based on method_of_payment
1689
+		switch ($this->checkout->selected_method_of_payment) {
1690
+			case 'events_sold_out':
1691
+				$this->checkout->redirect     = true;
1692
+				$this->checkout->redirect_url = $this->checkout->cancel_page_url;
1693
+				$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
1694
+				// mark this reg step as completed
1695
+				$this->set_completed();
1696
+				return false;
1697
+
1698
+			case 'payments_closed':
1699
+				if (
1700
+					apply_filters(
1701
+						'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
1702
+						false
1703
+					)
1704
+				) {
1705
+					EE_Error::add_success(
1706
+						esc_html__('no payment required at this time.', 'event_espresso'),
1707
+						__FILE__,
1708
+						__FUNCTION__,
1709
+						__LINE__
1710
+					);
1711
+				}
1712
+				// mark this reg step as completed
1713
+				$this->set_completed();
1714
+				return true;
1715
+
1716
+			case 'no_payment_required':
1717
+				if (
1718
+					apply_filters(
1719
+						'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
1720
+						false
1721
+					)
1722
+				) {
1723
+					EE_Error::add_success(
1724
+						esc_html__('no payment required.', 'event_espresso'),
1725
+						__FILE__,
1726
+						__FUNCTION__,
1727
+						__LINE__
1728
+					);
1729
+				}
1730
+				// mark this reg step as completed
1731
+				$this->set_completed();
1732
+				return true;
1733
+
1734
+			default:
1735
+				$registrations         = EE_Registry::instance()->SSN->checkout()->transaction->registrations(
1736
+					EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
1737
+				);
1738
+				$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
1739
+					$registrations,
1740
+					EE_Registry::instance()->SSN->checkout()->revisit
1741
+				);
1742
+				// calculate difference between the two arrays
1743
+				$registrations = array_diff($registrations, $ejected_registrations);
1744
+				if (empty($registrations)) {
1745
+					$this->_redirect_because_event_sold_out();
1746
+					return false;
1747
+				}
1748
+				$payment = $this->_process_payment();
1749
+				if ($payment instanceof EE_Payment) {
1750
+					$this->checkout->continue_reg = true;
1751
+					$this->_maybe_set_completed($payment);
1752
+				} else {
1753
+					$this->checkout->continue_reg = false;
1754
+				}
1755
+				return $payment instanceof EE_Payment;
1756
+		}
1757
+	}
1758
+
1759
+
1760
+	/**
1761
+	 * _redirect_because_event_sold_out
1762
+	 *
1763
+	 * @return void
1764
+	 */
1765
+	protected function _redirect_because_event_sold_out()
1766
+	{
1767
+		$this->checkout->continue_reg = false;
1768
+		// set redirect URL
1769
+		$this->checkout->redirect_url = add_query_arg(
1770
+			['e_reg_url_link' => $this->checkout->reg_url_link],
1771
+			$this->checkout->current_step->reg_step_url()
1772
+		);
1773
+		$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
1774
+	}
1775
+
1776
+
1777
+	/**
1778
+	 * @param EE_Payment $payment
1779
+	 * @return void
1780
+	 * @throws EE_Error
1781
+	 */
1782
+	protected function _maybe_set_completed(EE_Payment $payment)
1783
+	{
1784
+		// Do we need to redirect them? If so, there's more work to be done.
1785
+		if (! $payment->redirect_url()) {
1786
+			$this->set_completed();
1787
+		}
1788
+	}
1789
+
1790
+
1791
+	/**
1792
+	 *    update_reg_step
1793
+	 *    this is the final step after a user  revisits the site to retry a payment
1794
+	 *
1795
+	 * @return bool
1796
+	 * @throws EE_Error
1797
+	 * @throws InvalidArgumentException
1798
+	 * @throws ReflectionException
1799
+	 * @throws EntityNotFoundException
1800
+	 * @throws InvalidDataTypeException
1801
+	 * @throws InvalidInterfaceException
1802
+	 * @throws InvalidStatusException
1803
+	 */
1804
+	public function update_reg_step()
1805
+	{
1806
+		$success = true;
1807
+		// if payment required
1808
+		if ($this->checkout->transaction->total() > 0) {
1809
+			do_action(
1810
+				'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
1811
+				$this->checkout->transaction
1812
+			);
1813
+			// attempt payment via payment method
1814
+			$success = $this->process_reg_step();
1815
+		}
1816
+		if ($success && ! $this->checkout->redirect) {
1817
+			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
1818
+				$this->checkout->transaction->ID()
1819
+			);
1820
+			// set return URL
1821
+			$this->checkout->redirect_url = add_query_arg(
1822
+				['e_reg_url_link' => $this->checkout->reg_url_link],
1823
+				$this->checkout->thank_you_page_url
1824
+			);
1825
+		}
1826
+		return $success;
1827
+	}
1828
+
1829
+
1830
+	/**
1831
+	 * @return EE_Payment|null
1832
+	 * @throws EE_Error
1833
+	 * @throws InvalidArgumentException
1834
+	 * @throws ReflectionException
1835
+	 * @throws RuntimeException
1836
+	 * @throws InvalidDataTypeException
1837
+	 * @throws InvalidInterfaceException
1838
+	 */
1839
+	private function _process_payment()
1840
+	{
1841
+		// basically confirm that the event hasn't sold out since they hit the page
1842
+		if (! $this->_last_second_ticket_verifications()) {
1843
+			return null;
1844
+		}
1845
+		// ya gotta make a choice man
1846
+		if (empty($this->checkout->selected_method_of_payment)) {
1847
+			$this->checkout->json_response->set_plz_select_method_of_payment(
1848
+				esc_html__('Please select a method of payment before proceeding.', 'event_espresso')
1849
+			);
1850
+			return null;
1851
+		}
1852
+		// get EE_Payment_Method object
1853
+		if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
1854
+			return null;
1855
+		}
1856
+		// setup billing form
1857
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
1858
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1859
+				$this->checkout->payment_method
1860
+			);
1861
+			// bad billing form ?
1862
+			if (! $this->_billing_form_is_valid()) {
1863
+				return null;
1864
+			}
1865
+		}
1866
+		// ensure primary registrant has been fully processed
1867
+		if (! $this->_setup_primary_registrant_prior_to_payment()) {
1868
+			return null;
1869
+		}
1870
+		// if session is close to expiring (under 10 minutes by default)
1871
+		if ((time() - EE_Registry::instance()->SSN->expiration()) < EE_Registry::instance()->SSN->extension()) {
1872
+			// add some time to session expiration so that payment can be completed
1873
+			EE_Registry::instance()->SSN->extend_expiration();
1874
+		}
1875
+		/** @type EE_Transaction_Processor $transaction_processor */
1876
+		// $transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
1877
+		// in case a registrant leaves to an Off-Site Gateway and never returns, we want to approve any registrations
1878
+		// for events with a default reg status of Approved
1879
+		// $transaction_processor->toggle_registration_statuses_for_default_approved_events(
1880
+		//      $this->checkout->transaction, $this->checkout->reg_cache_where_params
1881
+		// );
1882
+		// attempt payment
1883
+		$payment = $this->_attempt_payment($this->checkout->payment_method);
1884
+		// process results
1885
+		$payment = $this->_validate_payment($payment);
1886
+		$payment = $this->_post_payment_processing($payment);
1887
+		// verify payment
1888
+		if ($payment instanceof EE_Payment) {
1889
+			// store that for later
1890
+			$this->checkout->payment = $payment;
1891
+			// we can also consider the TXN to not have been failed, so temporarily upgrade it's status to abandoned
1892
+			$this->checkout->transaction->toggle_failed_transaction_status();
1893
+			$payment_status = $payment->status();
1894
+			if (
1895
+				$payment_status === EEM_Payment::status_id_approved
1896
+				|| $payment_status === EEM_Payment::status_id_pending
1897
+			) {
1898
+				return $payment;
1899
+			}
1900
+			return null;
1901
+		}
1902
+		if ($payment === true) {
1903
+			// please note that offline payment methods will NOT make a payment,
1904
+			// but instead just mark themselves as the PMD_ID on the transaction, and return true
1905
+			$this->checkout->payment = $payment;
1906
+			return $payment;
1907
+		}
1908
+		// where's my money?
1909
+		return null;
1910
+	}
1911
+
1912
+
1913
+	/**
1914
+	 * _last_second_ticket_verifications
1915
+	 *
1916
+	 * @return bool
1917
+	 * @throws EE_Error
1918
+	 * @throws ReflectionException
1919
+	 */
1920
+	protected function _last_second_ticket_verifications()
1921
+	{
1922
+		// don't bother re-validating if not a return visit
1923
+		if (! $this->checkout->revisit) {
1924
+			return true;
1925
+		}
1926
+		$registrations = $this->checkout->transaction->registrations();
1927
+		if (empty($registrations)) {
1928
+			return false;
1929
+		}
1930
+		foreach ($registrations as $registration) {
1931
+			if ($registration instanceof EE_Registration && ! $registration->is_approved()) {
1932
+				$event = $registration->event_obj();
1933
+				if ($event instanceof EE_Event && $event->is_sold_out(true)) {
1934
+					EE_Error::add_error(
1935
+						apply_filters(
1936
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___last_second_ticket_verifications__sold_out_events_msg',
1937
+							sprintf(
1938
+								esc_html__(
1939
+									'It appears that the %1$s event that you were about to make a payment for has sold out since you first registered and/or arrived at this page. Please refresh the page and try again. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
1940
+									'event_espresso'
1941
+								),
1942
+								$event->name()
1943
+							)
1944
+						),
1945
+						__FILE__,
1946
+						__FUNCTION__,
1947
+						__LINE__
1948
+					);
1949
+					return false;
1950
+				}
1951
+			}
1952
+		}
1953
+		return true;
1954
+	}
1955
+
1956
+
1957
+	/**
1958
+	 * redirect_form
1959
+	 *
1960
+	 * @return bool
1961
+	 * @throws EE_Error
1962
+	 * @throws InvalidArgumentException
1963
+	 * @throws ReflectionException
1964
+	 * @throws InvalidDataTypeException
1965
+	 * @throws InvalidInterfaceException
1966
+	 */
1967
+	public function redirect_form()
1968
+	{
1969
+		$payment_method_billing_info = $this->_payment_method_billing_info(
1970
+			$this->_get_payment_method_for_selected_method_of_payment()
1971
+		);
1972
+		$html                        = $payment_method_billing_info->get_html();
1973
+		$html                        .= $this->checkout->redirect_form;
1974
+		/** @var ResponseInterface $response */
1975
+		$response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
1976
+		$response->addOutput($html);
1977
+		return true;
1978
+	}
1979
+
1980
+
1981
+	/**
1982
+	 * _billing_form_is_valid
1983
+	 *
1984
+	 * @return bool
1985
+	 * @throws EE_Error
1986
+	 */
1987
+	private function _billing_form_is_valid()
1988
+	{
1989
+		if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
1990
+			return true;
1991
+		}
1992
+		if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
1993
+			if ($this->checkout->billing_form->was_submitted()) {
1994
+				$this->checkout->billing_form->receive_form_submission();
1995
+				if ($this->checkout->billing_form->is_valid()) {
1996
+					return true;
1997
+				}
1998
+				$validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
1999
+				$error_strings     = [];
2000
+				foreach ($validation_errors as $validation_error) {
2001
+					if ($validation_error instanceof EE_Validation_Error) {
2002
+						$form_section = $validation_error->get_form_section();
2003
+						if ($form_section instanceof EE_Form_Input_Base) {
2004
+							$label = $form_section->html_label_text();
2005
+						} elseif ($form_section instanceof EE_Form_Section_Base) {
2006
+							$label = $form_section->name();
2007
+						} else {
2008
+							$label = esc_html__('Validation Error', 'event_espresso');
2009
+						}
2010
+						$error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
2011
+					}
2012
+				}
2013
+				EE_Error::add_error(
2014
+					sprintf(
2015
+						esc_html__(
2016
+							'One or more billing form inputs are invalid and require correction before proceeding. %1$s %2$s',
2017
+							'event_espresso'
2018
+						),
2019
+						'<br/>',
2020
+						implode('<br/>', $error_strings)
2021
+					),
2022
+					__FILE__,
2023
+					__FUNCTION__,
2024
+					__LINE__
2025
+				);
2026
+			} else {
2027
+				EE_Error::add_error(
2028
+					esc_html__(
2029
+						'The billing form was not submitted or something prevented it\'s submission.',
2030
+						'event_espresso'
2031
+					),
2032
+					__FILE__,
2033
+					__FUNCTION__,
2034
+					__LINE__
2035
+				);
2036
+			}
2037
+		} else {
2038
+			EE_Error::add_error(
2039
+				esc_html__(
2040
+					'The submitted billing form is invalid possibly due to a technical reason.',
2041
+					'event_espresso'
2042
+				),
2043
+				__FILE__,
2044
+				__FUNCTION__,
2045
+				__LINE__
2046
+			);
2047
+		}
2048
+		return false;
2049
+	}
2050
+
2051
+
2052
+	/**
2053
+	 * _setup_primary_registrant_prior_to_payment
2054
+	 * ensures that the primary registrant has a valid attendee object created with the critical details populated
2055
+	 * (first & last name & email) and that both the transaction object and primary registration object have been saved
2056
+	 * plz note that any other registrations will NOT be saved at this point (because they may not have any details
2057
+	 * yet)
2058
+	 *
2059
+	 * @return bool
2060
+	 * @throws EE_Error
2061
+	 * @throws InvalidArgumentException
2062
+	 * @throws ReflectionException
2063
+	 * @throws RuntimeException
2064
+	 * @throws InvalidDataTypeException
2065
+	 * @throws InvalidInterfaceException
2066
+	 */
2067
+	private function _setup_primary_registrant_prior_to_payment()
2068
+	{
2069
+		// check if transaction has a primary registrant and that it has a related Attendee object
2070
+		// if not, then we need to at least gather some primary registrant data before attempting payment
2071
+		if (
2072
+			$this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
2073
+			&& ! $this->checkout->transaction_has_primary_registrant()
2074
+			&& ! $this->_capture_primary_registration_data_from_billing_form()
2075
+		) {
2076
+			return false;
2077
+		}
2078
+		// because saving an object clears it's cache, we need to do the chevy shuffle
2079
+		// grab the primary_registration object
2080
+		$primary_registration = $this->checkout->transaction->primary_registration();
2081
+		// at this point we'll consider a TXN to not have been failed
2082
+		$this->checkout->transaction->toggle_failed_transaction_status();
2083
+		// save the TXN ( which clears cached copy of primary_registration)
2084
+		$this->checkout->transaction->save();
2085
+		// grab TXN ID and save it to the primary_registration
2086
+		$primary_registration->set_transaction_id($this->checkout->transaction->ID());
2087
+		// save what we have so far
2088
+		$primary_registration->save();
2089
+		return true;
2090
+	}
2091
+
2092
+
2093
+	/**
2094
+	 * _capture_primary_registration_data_from_billing_form
2095
+	 *
2096
+	 * @return bool
2097
+	 * @throws EE_Error
2098
+	 * @throws InvalidArgumentException
2099
+	 * @throws ReflectionException
2100
+	 * @throws InvalidDataTypeException
2101
+	 * @throws InvalidInterfaceException
2102
+	 */
2103
+	private function _capture_primary_registration_data_from_billing_form()
2104
+	{
2105
+		// convert billing form data into an attendee
2106
+		$this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
2107
+		if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
2108
+			EE_Error::add_error(
2109
+				sprintf(
2110
+					esc_html__(
2111
+						'The billing form details could not be used for attendee details due to a technical issue.%sPlease try again or contact %s for assistance.',
2112
+						'event_espresso'
2113
+					),
2114
+					'<br/>',
2115
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2116
+				),
2117
+				__FILE__,
2118
+				__FUNCTION__,
2119
+				__LINE__
2120
+			);
2121
+			return false;
2122
+		}
2123
+		$primary_registration = $this->checkout->transaction->primary_registration();
2124
+		if (! $primary_registration instanceof EE_Registration) {
2125
+			EE_Error::add_error(
2126
+				sprintf(
2127
+					esc_html__(
2128
+						'The primary registrant for this transaction could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
2129
+						'event_espresso'
2130
+					),
2131
+					'<br/>',
2132
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2133
+				),
2134
+				__FILE__,
2135
+				__FUNCTION__,
2136
+				__LINE__
2137
+			);
2138
+			return false;
2139
+		}
2140
+		if (
2141
+			! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
2142
+			  instanceof
2143
+			  EE_Attendee
2144
+		) {
2145
+			EE_Error::add_error(
2146
+				sprintf(
2147
+					esc_html__(
2148
+						'The primary registrant could not be associated with this transaction due to a technical issue.%sPlease try again or contact %s for assistance.',
2149
+						'event_espresso'
2150
+					),
2151
+					'<br/>',
2152
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2153
+				),
2154
+				__FILE__,
2155
+				__FUNCTION__,
2156
+				__LINE__
2157
+			);
2158
+			return false;
2159
+		}
2160
+		/** @type EE_Registration_Processor $registration_processor */
2161
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
2162
+		// at this point, we should have enough details about the registrant to consider the registration NOT incomplete
2163
+		$registration_processor->toggle_incomplete_registration_status_to_default($primary_registration);
2164
+		return true;
2165
+	}
2166
+
2167
+
2168
+	/**
2169
+	 * _get_payment_method_for_selected_method_of_payment
2170
+	 * retrieves a valid payment method
2171
+	 *
2172
+	 * @return EE_Payment_Method
2173
+	 * @throws EE_Error
2174
+	 * @throws InvalidArgumentException
2175
+	 * @throws ReflectionException
2176
+	 * @throws InvalidDataTypeException
2177
+	 * @throws InvalidInterfaceException
2178
+	 */
2179
+	private function _get_payment_method_for_selected_method_of_payment()
2180
+	{
2181
+		if ($this->checkout->selected_method_of_payment === 'events_sold_out') {
2182
+			$this->_redirect_because_event_sold_out();
2183
+			return null;
2184
+		}
2185
+		// get EE_Payment_Method object
2186
+		if (isset($this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ])) {
2187
+			$payment_method = $this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ];
2188
+		} else {
2189
+			// load EEM_Payment_Method
2190
+			EE_Registry::instance()->load_model('Payment_Method');
2191
+			$EEM_Payment_Method = EEM_Payment_Method::instance();
2192
+			$payment_method     = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
2193
+		}
2194
+		// verify $payment_method
2195
+		if (! $payment_method instanceof EE_Payment_Method) {
2196
+			// not a payment
2197
+			EE_Error::add_error(
2198
+				sprintf(
2199
+					esc_html__(
2200
+						'The selected method of payment could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
2201
+						'event_espresso'
2202
+					),
2203
+					'<br/>',
2204
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2205
+				),
2206
+				__FILE__,
2207
+				__FUNCTION__,
2208
+				__LINE__
2209
+			);
2210
+			return null;
2211
+		}
2212
+		// and verify it has a valid Payment_Method Type object
2213
+		if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
2214
+			// not a payment
2215
+			EE_Error::add_error(
2216
+				sprintf(
2217
+					esc_html__(
2218
+						'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
2219
+						'event_espresso'
2220
+					),
2221
+					'<br/>',
2222
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2223
+				),
2224
+				__FILE__,
2225
+				__FUNCTION__,
2226
+				__LINE__
2227
+			);
2228
+			return null;
2229
+		}
2230
+		return $payment_method;
2231
+	}
2232
+
2233
+
2234
+	/**
2235
+	 *    _attempt_payment
2236
+	 *
2237
+	 * @access    private
2238
+	 * @type    EE_Payment_Method $payment_method
2239
+	 * @return mixed EE_Payment | boolean
2240
+	 * @throws EE_Error
2241
+	 * @throws InvalidArgumentException
2242
+	 * @throws ReflectionException
2243
+	 * @throws InvalidDataTypeException
2244
+	 * @throws InvalidInterfaceException
2245
+	 */
2246
+	private function _attempt_payment(EE_Payment_Method $payment_method)
2247
+	{
2248
+		$payment = null;
2249
+		$this->checkout->transaction->save();
2250
+		$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
2251
+		if (! $payment_processor instanceof EE_Payment_Processor) {
2252
+			return false;
2253
+		}
2254
+		try {
2255
+			$payment_processor->set_revisit($this->checkout->revisit);
2256
+			// generate payment object
2257
+			$payment = $payment_processor->process_payment(
2258
+				$payment_method,
2259
+				$this->checkout->transaction,
2260
+				$this->checkout->amount_owing,
2261
+				$this->checkout->billing_form,
2262
+				$this->_get_return_url($payment_method),
2263
+				'CART',
2264
+				$this->checkout->admin_request,
2265
+				true,
2266
+				$this->reg_step_url()
2267
+			);
2268
+		} catch (Exception $e) {
2269
+			$this->_handle_payment_processor_exception($e);
2270
+		}
2271
+		return $payment;
2272
+	}
2273
+
2274
+
2275
+	/**
2276
+	 * _handle_payment_processor_exception
2277
+	 *
2278
+	 * @param Exception $e
2279
+	 * @return void
2280
+	 * @throws EE_Error
2281
+	 * @throws InvalidArgumentException
2282
+	 * @throws InvalidDataTypeException
2283
+	 * @throws InvalidInterfaceException
2284
+	 */
2285
+	protected function _handle_payment_processor_exception(Exception $e)
2286
+	{
2287
+		EE_Error::add_error(
2288
+			sprintf(
2289
+				esc_html__(
2290
+					'The payment could not br processed due to a technical issue.%1$sPlease try again or contact %2$s for assistance.||The following Exception was thrown in %4$s on line %5$s:%1$s%3$s',
2291
+					'event_espresso'
2292
+				),
2293
+				'<br/>',
2294
+				EE_Registry::instance()->CFG->organization->get_pretty('email'),
2295
+				$e->getMessage(),
2296
+				$e->getFile(),
2297
+				$e->getLine()
2298
+			),
2299
+			__FILE__,
2300
+			__FUNCTION__,
2301
+			__LINE__
2302
+		);
2303
+	}
2304
+
2305
+
2306
+	/**
2307
+	 * _get_return_url
2308
+	 *
2309
+	 * @param EE_Payment_Method $payment_method
2310
+	 * @return string
2311
+	 * @throws EE_Error
2312
+	 * @throws ReflectionException
2313
+	 */
2314
+	protected function _get_return_url(EE_Payment_Method $payment_method)
2315
+	{
2316
+		$return_url = '';
2317
+		switch ($payment_method->type_obj()->payment_occurs()) {
2318
+			case EE_PMT_Base::offsite:
2319
+				$return_url = add_query_arg(
2320
+					[
2321
+						'action'                     => 'process_gateway_response',
2322
+						'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
2323
+						'spco_txn'                   => $this->checkout->transaction->ID(),
2324
+					],
2325
+					$this->reg_step_url()
2326
+				);
2327
+				break;
2328
+			case EE_PMT_Base::onsite:
2329
+			case EE_PMT_Base::offline:
2330
+				$return_url = $this->checkout->next_step->reg_step_url();
2331
+				break;
2332
+		}
2333
+		return $return_url;
2334
+	}
2335
+
2336
+
2337
+	/**
2338
+	 * _validate_payment
2339
+	 *
2340
+	 * @param EE_Payment $payment
2341
+	 * @return EE_Payment|FALSE
2342
+	 * @throws EE_Error
2343
+	 * @throws InvalidArgumentException
2344
+	 * @throws InvalidDataTypeException
2345
+	 * @throws InvalidInterfaceException
2346
+	 */
2347
+	private function _validate_payment($payment = null)
2348
+	{
2349
+		if ($this->checkout->payment_method->is_off_line()) {
2350
+			return true;
2351
+		}
2352
+		// verify payment object
2353
+		if (! $payment instanceof EE_Payment) {
2354
+			// not a payment
2355
+			EE_Error::add_error(
2356
+				sprintf(
2357
+					esc_html__(
2358
+						'A valid payment was not generated due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
2359
+						'event_espresso'
2360
+					),
2361
+					'<br/>',
2362
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2363
+				),
2364
+				__FILE__,
2365
+				__FUNCTION__,
2366
+				__LINE__
2367
+			);
2368
+			return false;
2369
+		}
2370
+		return $payment;
2371
+	}
2372
+
2373
+
2374
+	/**
2375
+	 * _post_payment_processing
2376
+	 *
2377
+	 * @param EE_Payment|bool $payment
2378
+	 * @return bool|EE_Payment
2379
+	 * @throws EE_Error
2380
+	 * @throws InvalidArgumentException
2381
+	 * @throws InvalidDataTypeException
2382
+	 * @throws InvalidInterfaceException
2383
+	 * @throws ReflectionException
2384
+	 */
2385
+	private function _post_payment_processing($payment = null)
2386
+	{
2387
+		// Off-Line payment?
2388
+		if ($payment === true) {
2389
+			return true;
2390
+		}
2391
+		if ($payment instanceof EE_Payment) {
2392
+			// Should the user be redirected?
2393
+			if ($payment->redirect_url()) {
2394
+				do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()');
2395
+				$this->checkout->redirect      = true;
2396
+				$this->checkout->redirect_form = $payment->redirect_form();
2397
+				$this->checkout->redirect_url  = $this->reg_step_url('redirect_form');
2398
+				// set JSON response
2399
+				$this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
2400
+				// and lastly, let's bump the payment status to pending
2401
+				$payment->set_status(EEM_Payment::status_id_pending);
2402
+				$payment->save();
2403
+			} elseif (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
2404
+				// User shouldn't be redirected. So let's process it here.
2405
+				// $this->_setup_redirect_for_next_step();
2406
+				$this->checkout->continue_reg = false;
2407
+			}
2408
+			return $payment;
2409
+		}
2410
+		// ummm ya... not Off-Line, not On-Site, not off-Site ????
2411
+		$this->checkout->continue_reg = false;
2412
+		return false;
2413
+	}
2414
+
2415
+
2416
+	/**
2417
+	 *    _process_payment_status
2418
+	 *
2419
+	 * @type    EE_Payment $payment
2420
+	 * @param string       $payment_occurs
2421
+	 * @return bool
2422
+	 * @throws EE_Error
2423
+	 * @throws InvalidArgumentException
2424
+	 * @throws InvalidDataTypeException
2425
+	 * @throws InvalidInterfaceException
2426
+	 */
2427
+	private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline)
2428
+	{
2429
+		// off-line payment? carry on
2430
+		if ($payment_occurs === EE_PMT_Base::offline) {
2431
+			return true;
2432
+		}
2433
+		// verify payment validity
2434
+		if ($payment instanceof EE_Payment) {
2435
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()');
2436
+			$msg = $payment->gateway_response();
2437
+			// check results
2438
+			switch ($payment->status()) {
2439
+				// good payment
2440
+				case EEM_Payment::status_id_approved:
2441
+					EE_Error::add_success(
2442
+						esc_html__('Your payment was processed successfully.', 'event_espresso'),
2443
+						__FILE__,
2444
+						__FUNCTION__,
2445
+						__LINE__
2446
+					);
2447
+					return true;
2448
+				// slow payment
2449
+				case EEM_Payment::status_id_pending:
2450
+					if (empty($msg)) {
2451
+						$msg = esc_html__(
2452
+							'Your payment appears to have been processed successfully, but the Instant Payment Notification has not yet been received. It should arrive shortly.',
2453
+							'event_espresso'
2454
+						);
2455
+					}
2456
+					EE_Error::add_success($msg, __FILE__, __FUNCTION__, __LINE__);
2457
+					return true;
2458
+				// don't wanna payment
2459
+				case EEM_Payment::status_id_cancelled:
2460
+					if (empty($msg)) {
2461
+						$msg = _n(
2462
+							'Payment cancelled. Please try again.',
2463
+							'Payment cancelled. Please try again or select another method of payment.',
2464
+							count($this->checkout->available_payment_methods),
2465
+							'event_espresso'
2466
+						);
2467
+					}
2468
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
2469
+					return false;
2470
+				// not enough payment
2471
+				case EEM_Payment::status_id_declined:
2472
+					if (empty($msg)) {
2473
+						$msg = _n(
2474
+							'We\'re sorry but your payment was declined. Please try again.',
2475
+							'We\'re sorry but your payment was declined. Please try again or select another method of payment.',
2476
+							count($this->checkout->available_payment_methods),
2477
+							'event_espresso'
2478
+						);
2479
+					}
2480
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
2481
+					return false;
2482
+				// bad payment
2483
+				case EEM_Payment::status_id_failed:
2484
+					if (! empty($msg)) {
2485
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2486
+						return false;
2487
+					}
2488
+					// default to error below
2489
+					break;
2490
+			}
2491
+		}
2492
+		// off-site payment gateway responses are too unreliable, so let's just assume that
2493
+		// the payment processing is just running slower than the registrant's request
2494
+		if ($payment_occurs === EE_PMT_Base::offsite) {
2495
+			return true;
2496
+		}
2497
+		EE_Error::add_error(
2498
+			sprintf(
2499
+				esc_html__(
2500
+					'Your payment could not be processed successfully due to a technical issue.%sPlease try again or contact %s for assistance.',
2501
+					'event_espresso'
2502
+				),
2503
+				'<br/>',
2504
+				EE_Registry::instance()->CFG->organization->get_pretty('email')
2505
+			),
2506
+			__FILE__,
2507
+			__FUNCTION__,
2508
+			__LINE__
2509
+		);
2510
+		return false;
2511
+	}
2512
+
2513
+
2514
+
2515
+
2516
+
2517
+
2518
+	/********************************************************************************************************/
2519
+	/**********************************  PROCESS GATEWAY RESPONSE  **********************************/
2520
+	/********************************************************************************************************/
2521
+	/**
2522
+	 * process_gateway_response
2523
+	 * this is the return point for Off-Site Payment Methods
2524
+	 * It will attempt to "handle the IPN" if it appears that this has not already occurred,
2525
+	 * otherwise, it will load up the last payment made for the TXN.
2526
+	 * If the payment retrieved looks good, it will then either:
2527
+	 *    complete the current step and allow advancement to the next reg step
2528
+	 *        or present the payment options again
2529
+	 *
2530
+	 * @return bool
2531
+	 * @throws EE_Error
2532
+	 * @throws InvalidArgumentException
2533
+	 * @throws ReflectionException
2534
+	 * @throws InvalidDataTypeException
2535
+	 * @throws InvalidInterfaceException
2536
+	 */
2537
+	public function process_gateway_response()
2538
+	{
2539
+		// how have they chosen to pay?
2540
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
2541
+		// get EE_Payment_Method object
2542
+		if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
2543
+			$this->checkout->continue_reg = false;
2544
+			return false;
2545
+		}
2546
+		if (! $this->checkout->payment_method->is_off_site()) {
2547
+			return false;
2548
+		}
2549
+		$this->_validate_offsite_return();
2550
+		// verify TXN
2551
+		if ($this->checkout->transaction instanceof EE_Transaction) {
2552
+			$gateway = $this->checkout->payment_method->type_obj()->get_gateway();
2553
+			if (! $gateway instanceof EE_Offsite_Gateway) {
2554
+				$this->checkout->continue_reg = false;
2555
+				return false;
2556
+			}
2557
+			$payment = $this->_process_off_site_payment($gateway);
2558
+			$payment = $this->_process_cancelled_payments($payment);
2559
+			$payment = $this->_validate_payment($payment);
2560
+			// if payment was not declined by the payment gateway or cancelled by the registrant
2561
+			if ($this->_process_payment_status($payment, EE_PMT_Base::offsite)) {
2562
+				// $this->_setup_redirect_for_next_step();
2563
+				// store that for later
2564
+				$this->checkout->payment = $payment;
2565
+				// mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
2566
+				// because we will complete this step during the IPN processing then
2567
+				if (! $this->handle_IPN_in_this_request()) {
2568
+					$this->set_completed();
2569
+				}
2570
+				return true;
2571
+			}
2572
+		}
2573
+		// DEBUG LOG
2574
+		// $this->checkout->log(
2575
+		//     __CLASS__,
2576
+		//     __FUNCTION__,
2577
+		//     __LINE__,
2578
+		//     array('payment' => $payment)
2579
+		// );
2580
+		$this->checkout->continue_reg = false;
2581
+		return false;
2582
+	}
2583
+
2584
+
2585
+	/**
2586
+	 * _validate_return
2587
+	 *
2588
+	 * @return void
2589
+	 * @throws EE_Error
2590
+	 * @throws InvalidArgumentException
2591
+	 * @throws InvalidDataTypeException
2592
+	 * @throws InvalidInterfaceException
2593
+	 * @throws ReflectionException
2594
+	 */
2595
+	private function _validate_offsite_return()
2596
+	{
2597
+		$TXN_ID = $this->request->getRequestParam('spco_txn', 0, 'int');
2598
+		if ($TXN_ID !== $this->checkout->transaction->ID()) {
2599
+			// Houston... we might have a problem
2600
+			$invalid_TXN = false;
2601
+			// first gather some info
2602
+			$valid_TXN          = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
2603
+			$primary_registrant = $valid_TXN instanceof EE_Transaction
2604
+				? $valid_TXN->primary_registration()
2605
+				: null;
2606
+			// let's start by retrieving the cart for this TXN
2607
+			$cart = $this->checkout->get_cart_for_transaction($this->checkout->transaction);
2608
+			if ($cart instanceof EE_Cart) {
2609
+				// verify that the current cart has tickets
2610
+				$tickets = $cart->get_tickets();
2611
+				if (empty($tickets)) {
2612
+					$invalid_TXN = true;
2613
+				}
2614
+			} else {
2615
+				$invalid_TXN = true;
2616
+			}
2617
+			$valid_TXN_SID = $primary_registrant instanceof EE_Registration
2618
+				? $primary_registrant->session_ID()
2619
+				: null;
2620
+			// validate current Session ID and compare against valid TXN session ID
2621
+			if (
2622
+				$invalid_TXN // if this is already true, then skip other checks
2623
+				|| EE_Session::instance()->id() === null
2624
+				|| (
2625
+					// WARNING !!!
2626
+					// this could be PayPal sending back duplicate requests (ya they do that)
2627
+					// or it **could** mean someone is simply registering AGAIN after having just done so
2628
+					// so now we need to determine if this current TXN looks valid or not
2629
+					// and whether this reg step has even been started ?
2630
+					EE_Session::instance()->id() === $valid_TXN_SID
2631
+					// really? you're half way through this reg step, but you never started it ?
2632
+					&& $this->checkout->transaction->reg_step_completed($this->slug()) === false
2633
+				)
2634
+			) {
2635
+				$invalid_TXN = true;
2636
+			}
2637
+			if ($invalid_TXN) {
2638
+				// is the valid TXN completed ?
2639
+				if ($valid_TXN instanceof EE_Transaction) {
2640
+					// has this step even been started ?
2641
+					$reg_step_completed = $valid_TXN->reg_step_completed($this->slug());
2642
+					if ($reg_step_completed !== false && $reg_step_completed !== true) {
2643
+						// so it **looks** like this is a double request from PayPal
2644
+						// so let's try to pick up where we left off
2645
+						$this->checkout->transaction = $valid_TXN;
2646
+						$this->checkout->refresh_all_entities(true);
2647
+						return;
2648
+					}
2649
+				}
2650
+				// you appear to be lost?
2651
+				$this->_redirect_wayward_request($primary_registrant);
2652
+			}
2653
+		}
2654
+	}
2655
+
2656
+
2657
+	/**
2658
+	 * _redirect_wayward_request
2659
+	 *
2660
+	 * @param EE_Registration|null $primary_registrant
2661
+	 * @return void
2662
+	 * @throws EE_Error
2663
+	 * @throws InvalidArgumentException
2664
+	 * @throws InvalidDataTypeException
2665
+	 * @throws InvalidInterfaceException
2666
+	 * @throws ReflectionException
2667
+	 */
2668
+	private function _redirect_wayward_request(EE_Registration $primary_registrant)
2669
+	{
2670
+		if (! $primary_registrant instanceof EE_Registration) {
2671
+			// try redirecting based on the current TXN
2672
+			$primary_registrant = $this->checkout->transaction instanceof EE_Transaction
2673
+				? $this->checkout->transaction->primary_registration()
2674
+				: null;
2675
+		}
2676
+		if (! $primary_registrant instanceof EE_Registration) {
2677
+			EE_Error::add_error(
2678
+				sprintf(
2679
+					esc_html__(
2680
+						'Invalid information was received from the Off-Site Payment Processor and your Transaction details could not be retrieved from the database.%1$sPlease try again or contact %2$s for assistance.',
2681
+						'event_espresso'
2682
+					),
2683
+					'<br/>',
2684
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2685
+				),
2686
+				__FILE__,
2687
+				__FUNCTION__,
2688
+				__LINE__
2689
+			);
2690
+			return;
2691
+		}
2692
+		// make sure transaction is not locked
2693
+		$this->checkout->transaction->unlock();
2694
+		wp_safe_redirect(
2695
+			add_query_arg(
2696
+				[
2697
+					'e_reg_url_link' => $primary_registrant->reg_url_link(),
2698
+				],
2699
+				$this->checkout->thank_you_page_url
2700
+			)
2701
+		);
2702
+		exit();
2703
+	}
2704
+
2705
+
2706
+	/**
2707
+	 * _process_off_site_payment
2708
+	 *
2709
+	 * @param EE_Offsite_Gateway $gateway
2710
+	 * @return EE_Payment
2711
+	 * @throws EE_Error
2712
+	 * @throws InvalidArgumentException
2713
+	 * @throws InvalidDataTypeException
2714
+	 * @throws InvalidInterfaceException
2715
+	 * @throws ReflectionException
2716
+	 */
2717
+	private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
2718
+	{
2719
+		try {
2720
+			$request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
2721
+			$request_data = $request->requestParams();
2722
+			// if gateway uses_separate_IPN_request, then we don't have to process the IPN manually
2723
+			$this->set_handle_IPN_in_this_request(
2724
+				$gateway->handle_IPN_in_this_request($request_data, false)
2725
+			);
2726
+			if ($this->handle_IPN_in_this_request()) {
2727
+				// get payment details and process results
2728
+				/** @type EE_Payment_Processor $payment_processor */
2729
+				$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
2730
+				$payment           = $payment_processor->process_ipn(
2731
+					$request_data,
2732
+					$this->checkout->transaction,
2733
+					$this->checkout->payment_method,
2734
+					true,
2735
+					false
2736
+				);
2737
+				// $payment_source = 'process_ipn';
2738
+			} else {
2739
+				$payment = $this->checkout->transaction->last_payment();
2740
+				// $payment_source = 'last_payment';
2741
+			}
2742
+		} catch (Exception $e) {
2743
+			// let's just eat the exception and try to move on using any previously set payment info
2744
+			$payment = $this->checkout->transaction->last_payment();
2745
+			// $payment_source = 'last_payment after Exception';
2746
+			// but if we STILL don't have a payment object
2747
+			if (! $payment instanceof EE_Payment) {
2748
+				// then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
2749
+				$this->_handle_payment_processor_exception($e);
2750
+			}
2751
+		}
2752
+		return $payment;
2753
+	}
2754
+
2755
+
2756
+	/**
2757
+	 * _process_cancelled_payments
2758
+	 * just makes sure that the payment status gets updated correctly
2759
+	 * so tha tan error isn't generated during payment validation
2760
+	 *
2761
+	 * @param EE_Payment $payment
2762
+	 * @return EE_Payment|null
2763
+	 * @throws EE_Error
2764
+	 */
2765
+	private function _process_cancelled_payments($payment = null)
2766
+	{
2767
+		if (
2768
+			$payment instanceof EE_Payment
2769
+			&& $this->request->requestParamIsSet('ee_cancel_payment')
2770
+			&& $payment->status() === EEM_Payment::status_id_failed
2771
+		) {
2772
+			$payment->set_status(EEM_Payment::status_id_cancelled);
2773
+		}
2774
+		return $payment;
2775
+	}
2776
+
2777
+
2778
+	/**
2779
+	 *    get_transaction_details_for_gateways
2780
+	 *
2781
+	 * @access    public
2782
+	 * @return void
2783
+	 * @throws EE_Error
2784
+	 * @throws InvalidArgumentException
2785
+	 * @throws ReflectionException
2786
+	 * @throws InvalidDataTypeException
2787
+	 * @throws InvalidInterfaceException
2788
+	 */
2789
+	public function get_transaction_details_for_gateways()
2790
+	{
2791
+		$txn_details = [];
2792
+		// ya gotta make a choice man
2793
+		if (empty($this->checkout->selected_method_of_payment)) {
2794
+			$txn_details = [
2795
+				'error' => esc_html__('Please select a method of payment before proceeding.', 'event_espresso'),
2796
+			];
2797
+		}
2798
+		// get EE_Payment_Method object
2799
+		if (
2800
+			empty($txn_details)
2801
+			&& ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
2802
+		) {
2803
+			$txn_details = [
2804
+				'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
2805
+				'error'                      => esc_html__(
2806
+					'A valid Payment Method could not be determined.',
2807
+					'event_espresso'
2808
+				),
2809
+			];
2810
+		}
2811
+		if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
2812
+			$return_url  = $this->_get_return_url($this->checkout->payment_method);
2813
+			$txn_details = [
2814
+				'TXN_ID'         => $this->checkout->transaction->ID(),
2815
+				'TXN_timestamp'  => $this->checkout->transaction->datetime(),
2816
+				'TXN_total'      => $this->checkout->transaction->total(),
2817
+				'TXN_paid'       => $this->checkout->transaction->paid(),
2818
+				'TXN_reg_steps'  => $this->checkout->transaction->reg_steps(),
2819
+				'STS_ID'         => $this->checkout->transaction->status_ID(),
2820
+				'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
2821
+				'payment_amount' => $this->checkout->amount_owing,
2822
+				'return_url'     => $return_url,
2823
+				'cancel_url'     => add_query_arg(['ee_cancel_payment' => true], $return_url),
2824
+				'notify_url'     => EE_Config::instance()->core->txn_page_url(
2825
+					[
2826
+						'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
2827
+						'ee_payment_method' => $this->checkout->payment_method->slug(),
2828
+					]
2829
+				),
2830
+			];
2831
+		}
2832
+		echo wp_json_encode($txn_details);
2833
+		exit();
2834
+	}
2835
+
2836
+
2837
+	/**
2838
+	 *    __sleep
2839
+	 * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
2840
+	 * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
2841
+	 * reg form, because if needed, it will be regenerated anyways
2842
+	 *
2843
+	 * @return array
2844
+	 */
2845
+	public function __sleep()
2846
+	{
2847
+		// remove the reg form and the checkout
2848
+		return array_diff(array_keys(get_object_vars($this)), ['reg_form', 'checkout', 'line_item_display']);
2849
+	}
2850 2850
 }
Please login to merge, or discard this patch.
Spacing   +80 added lines, -80 removed lines patch added patch discarded remove patch
@@ -132,7 +132,7 @@  discard block
 block discarded – undo
132 132
         $this->request   = EED_Single_Page_Checkout::getRequest();
133 133
         $this->_slug     = 'payment_options';
134 134
         $this->_name     = esc_html__('Payment Options', 'event_espresso');
135
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . '/payment_options_main.template.php';
135
+        $this->_template = SPCO_REG_STEPS_PATH.$this->_slug.'/payment_options_main.template.php';
136 136
         $this->checkout  = $checkout;
137 137
         $this->_reset_success_message();
138 138
         $this->set_instructions(
@@ -187,7 +187,7 @@  discard block
 block discarded – undo
187 187
      */
188 188
     public function translate_js_strings()
189 189
     {
190
-        EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
190
+        EE_Registry::$i18n_js_strings['no_payment_method'] = esc_html__(
191 191
             'Please select a method of payment in order to continue.',
192 192
             'event_espresso'
193 193
         );
@@ -195,7 +195,7 @@  discard block
 block discarded – undo
195 195
             'A valid method of payment could not be determined. Please refresh the page and try again.',
196 196
             'event_espresso'
197 197
         );
198
-        EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
198
+        EE_Registry::$i18n_js_strings['forwarding_to_offsite'] = esc_html__(
199 199
             'Forwarding to Secure Payment Provider.',
200 200
             'event_espresso'
201 201
         );
@@ -216,7 +216,7 @@  discard block
 block discarded – undo
216 216
     {
217 217
         $transaction = $this->checkout->transaction;
218 218
         // if the transaction isn't set or nothing is owed on it, don't enqueue any JS
219
-        if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
219
+        if ( ! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
220 220
             return;
221 221
         }
222 222
         foreach (
@@ -311,18 +311,18 @@  discard block
 block discarded – undo
311 311
         foreach ($registrations as $REG_ID => $registration) {
312 312
             /** @var $registration EE_Registration */
313 313
             // has this registration lost it's space ?
314
-            if (isset($ejected_registrations[ $REG_ID ])) {
314
+            if (isset($ejected_registrations[$REG_ID])) {
315 315
                 if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
316
-                    $sold_out_events[ $registration->event()->ID() ] = $registration->event();
316
+                    $sold_out_events[$registration->event()->ID()] = $registration->event();
317 317
                 } else {
318
-                    $insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
318
+                    $insufficient_spaces_available[$registration->event()->ID()] = $registration->event();
319 319
                 }
320 320
                 continue;
321 321
             }
322 322
             // event requires admin approval
323 323
             if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
324 324
                 // add event to list of events with pre-approval reg status
325
-                $registrations_requiring_pre_approval[ $REG_ID ] = $registration;
325
+                $registrations_requiring_pre_approval[$REG_ID] = $registration;
326 326
                 do_action(
327 327
                     'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
328 328
                     $registration->event(),
@@ -339,7 +339,7 @@  discard block
 block discarded – undo
339 339
                 )
340 340
             ) {
341 341
                 // add event to list of events that are sold out
342
-                $sold_out_events[ $registration->event()->ID() ] = $registration->event();
342
+                $sold_out_events[$registration->event()->ID()] = $registration->event();
343 343
                 do_action(
344 344
                     'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
345 345
                     $registration->event(),
@@ -349,7 +349,7 @@  discard block
 block discarded – undo
349 349
             }
350 350
             // are they allowed to pay now and is there monies owing?
351 351
             if ($registration->owes_monies_and_can_pay()) {
352
-                $registrations_requiring_payment[ $REG_ID ] = $registration;
352
+                $registrations_requiring_payment[$REG_ID] = $registration;
353 353
                 do_action(
354 354
                     'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
355 355
                     $registration->event(),
@@ -360,28 +360,28 @@  discard block
 block discarded – undo
360 360
                       && $registration->status_ID() !== EEM_Registration::status_id_not_approved
361 361
                       && $registration->ticket()->is_free()
362 362
             ) {
363
-                $registrations_for_free_events[ $registration->ticket()->ID() ] = $registration;
363
+                $registrations_for_free_events[$registration->ticket()->ID()] = $registration;
364 364
             }
365 365
         }
366 366
         $subsections = [];
367 367
         // now decide which template to load
368
-        if (! empty($sold_out_events)) {
368
+        if ( ! empty($sold_out_events)) {
369 369
             $subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
370 370
         }
371
-        if (! empty($insufficient_spaces_available)) {
371
+        if ( ! empty($insufficient_spaces_available)) {
372 372
             $subsections['insufficient_space'] = $this->_insufficient_spaces_available(
373 373
                 $insufficient_spaces_available
374 374
             );
375 375
         }
376
-        if (! empty($registrations_requiring_pre_approval)) {
376
+        if ( ! empty($registrations_requiring_pre_approval)) {
377 377
             $subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
378 378
                 $registrations_requiring_pre_approval
379 379
             );
380 380
         }
381
-        if (! empty($registrations_for_free_events)) {
381
+        if ( ! empty($registrations_for_free_events)) {
382 382
             $subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
383 383
         }
384
-        if (! empty($registrations_requiring_payment)) {
384
+        if ( ! empty($registrations_requiring_payment)) {
385 385
             if ($this->checkout->amount_owing > 0) {
386 386
                 // autoload Line_Item_Display classes
387 387
                 EEH_Autoloader::register_line_item_filter_autoloaders();
@@ -402,7 +402,7 @@  discard block
 block discarded – undo
402 402
                         ['registrations' => $registrations]
403 403
                     )
404 404
                 );
405
-                $this->checkout->amount_owing   = $filtered_line_item_tree->total();
405
+                $this->checkout->amount_owing = $filtered_line_item_tree->total();
406 406
                 $this->_apply_registration_payments_to_amount_owing($registrations);
407 407
             }
408 408
             $no_payment_required = false;
@@ -446,13 +446,13 @@  discard block
 block discarded – undo
446 446
      */
447 447
     public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
448 448
     {
449
-        if (! EE_Registry::instance()->SSN instanceof EE_Session) {
449
+        if ( ! EE_Registry::instance()->SSN instanceof EE_Session) {
450 450
             return $line_item_filter_collection;
451 451
         }
452
-        if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
452
+        if ( ! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
453 453
             return $line_item_filter_collection;
454 454
         }
455
-        if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
455
+        if ( ! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
456 456
             return $line_item_filter_collection;
457 457
         }
458 458
         $line_item_filter_collection->add(
@@ -492,8 +492,8 @@  discard block
 block discarded – undo
492 492
         );
493 493
         foreach ($registrations as $REG_ID => $registration) {
494 494
             // has this registration lost it's space ?
495
-            if (isset($ejected_registrations[ $REG_ID ])) {
496
-                unset($registrations[ $REG_ID ]);
495
+            if (isset($ejected_registrations[$REG_ID])) {
496
+                unset($registrations[$REG_ID]);
497 497
             }
498 498
         }
499 499
         return $registrations;
@@ -543,25 +543,25 @@  discard block
 block discarded – undo
543 543
             }
544 544
             $EVT_ID = $registration->event_ID();
545 545
             $ticket = $registration->ticket();
546
-            if (! isset($tickets_remaining[ $ticket->ID() ])) {
547
-                $tickets_remaining[ $ticket->ID() ] = $ticket->remaining();
546
+            if ( ! isset($tickets_remaining[$ticket->ID()])) {
547
+                $tickets_remaining[$ticket->ID()] = $ticket->remaining();
548 548
             }
549
-            if ($tickets_remaining[ $ticket->ID() ] > 0) {
550
-                if (! isset($event_reg_count[ $EVT_ID ])) {
551
-                    $event_reg_count[ $EVT_ID ] = 0;
549
+            if ($tickets_remaining[$ticket->ID()] > 0) {
550
+                if ( ! isset($event_reg_count[$EVT_ID])) {
551
+                    $event_reg_count[$EVT_ID] = 0;
552 552
                 }
553
-                $event_reg_count[ $EVT_ID ]++;
554
-                if (! isset($event_spaces_remaining[ $EVT_ID ])) {
555
-                    $event_spaces_remaining[ $EVT_ID ] = $registration->event()->spaces_remaining_for_sale();
553
+                $event_reg_count[$EVT_ID]++;
554
+                if ( ! isset($event_spaces_remaining[$EVT_ID])) {
555
+                    $event_spaces_remaining[$EVT_ID] = $registration->event()->spaces_remaining_for_sale();
556 556
                 }
557 557
             }
558 558
             if (
559 559
                 $revisit
560
-                && ($tickets_remaining[ $ticket->ID() ] === 0
561
-                    || $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
560
+                && ($tickets_remaining[$ticket->ID()] === 0
561
+                    || $event_reg_count[$EVT_ID] > $event_spaces_remaining[$EVT_ID]
562 562
                 )
563 563
             ) {
564
-                $ejected_registrations[ $REG_ID ] = $registration->event();
564
+                $ejected_registrations[$REG_ID] = $registration->event();
565 565
                 if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
566 566
                     /** @type EE_Registration_Processor $registration_processor */
567 567
                     $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
@@ -621,7 +621,7 @@  discard block
 block discarded – undo
621 621
         foreach ($sold_out_events_array as $sold_out_event) {
622 622
             $sold_out_events .= EEH_HTML::li(
623 623
                 EEH_HTML::span(
624
-                    '  ' . $sold_out_event->name(),
624
+                    '  '.$sold_out_event->name(),
625 625
                     '',
626 626
                     'dashicons dashicons-marker ee-icon-size-16 pink-text'
627 627
                 )
@@ -677,7 +677,7 @@  discard block
 block discarded – undo
677 677
         foreach ($insufficient_spaces_events_array as $event) {
678 678
             if ($event instanceof EE_Event) {
679 679
                 $insufficient_space_events .= EEH_HTML::li(
680
-                    EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
680
+                    EEH_HTML::span(' '.$event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
681 681
                 );
682 682
             }
683 683
         }
@@ -726,7 +726,7 @@  discard block
 block discarded – undo
726 726
         $events_requiring_pre_approval = [];
727 727
         foreach ($registrations_requiring_pre_approval as $registration) {
728 728
             if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
729
-                $events_requiring_pre_approval[ $registration->event()->ID() ] = EEH_HTML::li(
729
+                $events_requiring_pre_approval[$registration->event()->ID()] = EEH_HTML::li(
730 730
                     EEH_HTML::span(
731 731
                         '',
732 732
                         '',
@@ -866,7 +866,7 @@  discard block
 block discarded – undo
866 866
     {
867 867
         return new EE_Form_Section_Proper(
868 868
             [
869
-                'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
869
+                'html_id'         => 'ee-'.$this->slug().'-extra-hidden-inputs',
870 870
                 'layout_strategy' => new EE_Div_Per_Section_Layout(),
871 871
                 'subsections'     => [
872 872
                     'spco_no_payment_required' => new EE_Hidden_Input(
@@ -905,7 +905,7 @@  discard block
 block discarded – undo
905 905
                 $payments += $registration->registration_payments();
906 906
             }
907 907
         }
908
-        if (! empty($payments)) {
908
+        if ( ! empty($payments)) {
909 909
             foreach ($payments as $payment) {
910 910
                 if ($payment instanceof EE_Registration_Payment) {
911 911
                     $this->checkout->amount_owing -= $payment->amount();
@@ -994,7 +994,7 @@  discard block
 block discarded – undo
994 994
             );
995 995
         }
996 996
         // switch up header depending on number of available payment methods
997
-        $payment_method_header     = count($this->checkout->available_payment_methods) > 1
997
+        $payment_method_header = count($this->checkout->available_payment_methods) > 1
998 998
             ? apply_filters(
999 999
                 'FHEE__registration_page_payment_options__method_of_payment_hdr',
1000 1000
                 esc_html__('Please Select Your Method of Payment', 'event_espresso')
@@ -1028,7 +1028,7 @@  discard block
 block discarded – undo
1028 1028
                 $payment_method_button = EEH_HTML::img(
1029 1029
                     $payment_method->button_url(),
1030 1030
                     $payment_method->name(),
1031
-                    'spco-payment-method-' . $payment_method->slug() . '-btn-img',
1031
+                    'spco-payment-method-'.$payment_method->slug().'-btn-img',
1032 1032
                     'spco-payment-method-btn-img'
1033 1033
                 );
1034 1034
                 // check if any payment methods are set as default
@@ -1036,15 +1036,15 @@  discard block
 block discarded – undo
1036 1036
                 // open_by_default
1037 1037
                 if (
1038 1038
                     ($this->checkout->selected_method_of_payment === $payment_method->slug())
1039
-                    || (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
1039
+                    || ( ! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
1040 1040
                 ) {
1041 1041
                     $this->checkout->selected_method_of_payment = $payment_method->slug();
1042 1042
                     $this->_save_selected_method_of_payment();
1043
-                    $default_payment_method_option[ $payment_method->slug() ] = $payment_method_button;
1043
+                    $default_payment_method_option[$payment_method->slug()] = $payment_method_button;
1044 1044
                 } else {
1045
-                    $available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
1045
+                    $available_payment_method_options[$payment_method->slug()] = $payment_method_button;
1046 1046
                 }
1047
-                $payment_methods_billing_info[ $payment_method->slug() . '-info' ] =
1047
+                $payment_methods_billing_info[$payment_method->slug().'-info'] =
1048 1048
                     $this->_payment_method_billing_info(
1049 1049
                         $payment_method
1050 1050
                     );
@@ -1057,7 +1057,7 @@  discard block
 block discarded – undo
1057 1057
         $available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
1058 1058
             $available_payment_method_options
1059 1059
         );
1060
-        $available_payment_methods                              += $payment_methods_billing_info;
1060
+        $available_payment_methods += $payment_methods_billing_info;
1061 1061
         // build the available payment methods form
1062 1062
         return new EE_Form_Section_Proper(
1063 1063
             [
@@ -1080,7 +1080,7 @@  discard block
 block discarded – undo
1080 1080
      */
1081 1081
     protected function _get_available_payment_methods()
1082 1082
     {
1083
-        if (! empty($this->checkout->available_payment_methods)) {
1083
+        if ( ! empty($this->checkout->available_payment_methods)) {
1084 1084
             return $this->checkout->available_payment_methods;
1085 1085
         }
1086 1086
         $available_payment_methods = [];
@@ -1092,7 +1092,7 @@  discard block
 block discarded – undo
1092 1092
         );
1093 1093
         foreach ($payment_methods as $payment_method) {
1094 1094
             if ($payment_method instanceof EE_Payment_Method) {
1095
-                $available_payment_methods[ $payment_method->slug() ] = $payment_method;
1095
+                $available_payment_methods[$payment_method->slug()] = $payment_method;
1096 1096
             }
1097 1097
         }
1098 1098
         return $available_payment_methods;
@@ -1187,7 +1187,7 @@  discard block
 block discarded – undo
1187 1187
         );
1188 1188
         return new EE_Form_Section_Proper(
1189 1189
             [
1190
-                'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
1190
+                'html_id'         => 'spco-payment-method-info-'.$payment_method->slug(),
1191 1191
                 'html_class'      => 'spco-payment-method-info-dv',
1192 1192
                 // only display the selected or default PM
1193 1193
                 'html_style'      => $currently_selected ? '' : 'display:none;',
@@ -1216,7 +1216,7 @@  discard block
 block discarded – undo
1216 1216
         // how have they chosen to pay?
1217 1217
         $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
1218 1218
         $this->checkout->payment_method             = $this->_get_payment_method_for_selected_method_of_payment();
1219
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
1219
+        if ( ! $this->checkout->payment_method instanceof EE_Payment_Method) {
1220 1220
             return false;
1221 1221
         }
1222 1222
         if (
@@ -1391,7 +1391,7 @@  discard block
 block discarded – undo
1391 1391
      */
1392 1392
     public function switch_payment_method()
1393 1393
     {
1394
-        if (! $this->_verify_payment_method_is_set()) {
1394
+        if ( ! $this->_verify_payment_method_is_set()) {
1395 1395
             return false;
1396 1396
         }
1397 1397
         if (
@@ -1527,7 +1527,7 @@  discard block
 block discarded – undo
1527 1527
             }
1528 1528
         }
1529 1529
         // verify payment method
1530
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
1530
+        if ( ! $this->checkout->payment_method instanceof EE_Payment_Method) {
1531 1531
             // get payment method for selected method of payment
1532 1532
             $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
1533 1533
         }
@@ -1552,7 +1552,7 @@  discard block
 block discarded – undo
1552 1552
      */
1553 1553
     public function save_payer_details_via_ajax()
1554 1554
     {
1555
-        if (! $this->_verify_payment_method_is_set()) {
1555
+        if ( ! $this->_verify_payment_method_is_set()) {
1556 1556
             return;
1557 1557
         }
1558 1558
         // generate billing form for selected method of payment if it hasn't been done already
@@ -1562,7 +1562,7 @@  discard block
 block discarded – undo
1562 1562
             );
1563 1563
         }
1564 1564
         // generate primary attendee from payer info if applicable
1565
-        if (! $this->checkout->transaction_has_primary_registrant()) {
1565
+        if ( ! $this->checkout->transaction_has_primary_registrant()) {
1566 1566
             $attendee = $this->_create_attendee_from_request_data();
1567 1567
             if ($attendee instanceof EE_Attendee) {
1568 1568
                 foreach ($this->checkout->transaction->registrations() as $registration) {
@@ -1593,7 +1593,7 @@  discard block
 block discarded – undo
1593 1593
     {
1594 1594
         // get State ID
1595 1595
         $STA_ID = $this->request->getRequestParam('state');
1596
-        if (! empty($STA_ID)) {
1596
+        if ( ! empty($STA_ID)) {
1597 1597
             // can we get state object from name ?
1598 1598
             EE_Registry::instance()->load_model('State');
1599 1599
             $state  = EEM_State::instance()->get_col([['STA_name' => $STA_ID], 'limit' => 1], 'STA_ID');
@@ -1601,7 +1601,7 @@  discard block
 block discarded – undo
1601 1601
         }
1602 1602
         // get Country ISO
1603 1603
         $CNT_ISO = $this->request->getRequestParam('country');
1604
-        if (! empty($CNT_ISO)) {
1604
+        if ( ! empty($CNT_ISO)) {
1605 1605
             // can we get country object from name ?
1606 1606
             EE_Registry::instance()->load_model('Country');
1607 1607
             $country = EEM_Country::instance()->get_col(
@@ -1782,7 +1782,7 @@  discard block
 block discarded – undo
1782 1782
     protected function _maybe_set_completed(EE_Payment $payment)
1783 1783
     {
1784 1784
         // Do we need to redirect them? If so, there's more work to be done.
1785
-        if (! $payment->redirect_url()) {
1785
+        if ( ! $payment->redirect_url()) {
1786 1786
             $this->set_completed();
1787 1787
         }
1788 1788
     }
@@ -1839,7 +1839,7 @@  discard block
 block discarded – undo
1839 1839
     private function _process_payment()
1840 1840
     {
1841 1841
         // basically confirm that the event hasn't sold out since they hit the page
1842
-        if (! $this->_last_second_ticket_verifications()) {
1842
+        if ( ! $this->_last_second_ticket_verifications()) {
1843 1843
             return null;
1844 1844
         }
1845 1845
         // ya gotta make a choice man
@@ -1850,7 +1850,7 @@  discard block
 block discarded – undo
1850 1850
             return null;
1851 1851
         }
1852 1852
         // get EE_Payment_Method object
1853
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
1853
+        if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
1854 1854
             return null;
1855 1855
         }
1856 1856
         // setup billing form
@@ -1859,12 +1859,12 @@  discard block
 block discarded – undo
1859 1859
                 $this->checkout->payment_method
1860 1860
             );
1861 1861
             // bad billing form ?
1862
-            if (! $this->_billing_form_is_valid()) {
1862
+            if ( ! $this->_billing_form_is_valid()) {
1863 1863
                 return null;
1864 1864
             }
1865 1865
         }
1866 1866
         // ensure primary registrant has been fully processed
1867
-        if (! $this->_setup_primary_registrant_prior_to_payment()) {
1867
+        if ( ! $this->_setup_primary_registrant_prior_to_payment()) {
1868 1868
             return null;
1869 1869
         }
1870 1870
         // if session is close to expiring (under 10 minutes by default)
@@ -1920,7 +1920,7 @@  discard block
 block discarded – undo
1920 1920
     protected function _last_second_ticket_verifications()
1921 1921
     {
1922 1922
         // don't bother re-validating if not a return visit
1923
-        if (! $this->checkout->revisit) {
1923
+        if ( ! $this->checkout->revisit) {
1924 1924
             return true;
1925 1925
         }
1926 1926
         $registrations = $this->checkout->transaction->registrations();
@@ -1970,7 +1970,7 @@  discard block
 block discarded – undo
1970 1970
             $this->_get_payment_method_for_selected_method_of_payment()
1971 1971
         );
1972 1972
         $html                        = $payment_method_billing_info->get_html();
1973
-        $html                        .= $this->checkout->redirect_form;
1973
+        $html .= $this->checkout->redirect_form;
1974 1974
         /** @var ResponseInterface $response */
1975 1975
         $response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
1976 1976
         $response->addOutput($html);
@@ -1986,7 +1986,7 @@  discard block
 block discarded – undo
1986 1986
      */
1987 1987
     private function _billing_form_is_valid()
1988 1988
     {
1989
-        if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
1989
+        if ( ! $this->checkout->payment_method->type_obj()->has_billing_form()) {
1990 1990
             return true;
1991 1991
         }
1992 1992
         if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
@@ -2104,7 +2104,7 @@  discard block
 block discarded – undo
2104 2104
     {
2105 2105
         // convert billing form data into an attendee
2106 2106
         $this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
2107
-        if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
2107
+        if ( ! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
2108 2108
             EE_Error::add_error(
2109 2109
                 sprintf(
2110 2110
                     esc_html__(
@@ -2121,7 +2121,7 @@  discard block
 block discarded – undo
2121 2121
             return false;
2122 2122
         }
2123 2123
         $primary_registration = $this->checkout->transaction->primary_registration();
2124
-        if (! $primary_registration instanceof EE_Registration) {
2124
+        if ( ! $primary_registration instanceof EE_Registration) {
2125 2125
             EE_Error::add_error(
2126 2126
                 sprintf(
2127 2127
                     esc_html__(
@@ -2183,8 +2183,8 @@  discard block
 block discarded – undo
2183 2183
             return null;
2184 2184
         }
2185 2185
         // get EE_Payment_Method object
2186
-        if (isset($this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ])) {
2187
-            $payment_method = $this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ];
2186
+        if (isset($this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment])) {
2187
+            $payment_method = $this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment];
2188 2188
         } else {
2189 2189
             // load EEM_Payment_Method
2190 2190
             EE_Registry::instance()->load_model('Payment_Method');
@@ -2192,7 +2192,7 @@  discard block
 block discarded – undo
2192 2192
             $payment_method     = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
2193 2193
         }
2194 2194
         // verify $payment_method
2195
-        if (! $payment_method instanceof EE_Payment_Method) {
2195
+        if ( ! $payment_method instanceof EE_Payment_Method) {
2196 2196
             // not a payment
2197 2197
             EE_Error::add_error(
2198 2198
                 sprintf(
@@ -2210,7 +2210,7 @@  discard block
 block discarded – undo
2210 2210
             return null;
2211 2211
         }
2212 2212
         // and verify it has a valid Payment_Method Type object
2213
-        if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
2213
+        if ( ! $payment_method->type_obj() instanceof EE_PMT_Base) {
2214 2214
             // not a payment
2215 2215
             EE_Error::add_error(
2216 2216
                 sprintf(
@@ -2248,7 +2248,7 @@  discard block
 block discarded – undo
2248 2248
         $payment = null;
2249 2249
         $this->checkout->transaction->save();
2250 2250
         $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
2251
-        if (! $payment_processor instanceof EE_Payment_Processor) {
2251
+        if ( ! $payment_processor instanceof EE_Payment_Processor) {
2252 2252
             return false;
2253 2253
         }
2254 2254
         try {
@@ -2350,7 +2350,7 @@  discard block
 block discarded – undo
2350 2350
             return true;
2351 2351
         }
2352 2352
         // verify payment object
2353
-        if (! $payment instanceof EE_Payment) {
2353
+        if ( ! $payment instanceof EE_Payment) {
2354 2354
             // not a payment
2355 2355
             EE_Error::add_error(
2356 2356
                 sprintf(
@@ -2400,7 +2400,7 @@  discard block
 block discarded – undo
2400 2400
                 // and lastly, let's bump the payment status to pending
2401 2401
                 $payment->set_status(EEM_Payment::status_id_pending);
2402 2402
                 $payment->save();
2403
-            } elseif (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
2403
+            } elseif ( ! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
2404 2404
                 // User shouldn't be redirected. So let's process it here.
2405 2405
                 // $this->_setup_redirect_for_next_step();
2406 2406
                 $this->checkout->continue_reg = false;
@@ -2481,7 +2481,7 @@  discard block
 block discarded – undo
2481 2481
                     return false;
2482 2482
                 // bad payment
2483 2483
                 case EEM_Payment::status_id_failed:
2484
-                    if (! empty($msg)) {
2484
+                    if ( ! empty($msg)) {
2485 2485
                         EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2486 2486
                         return false;
2487 2487
                     }
@@ -2539,18 +2539,18 @@  discard block
 block discarded – undo
2539 2539
         // how have they chosen to pay?
2540 2540
         $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
2541 2541
         // get EE_Payment_Method object
2542
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
2542
+        if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
2543 2543
             $this->checkout->continue_reg = false;
2544 2544
             return false;
2545 2545
         }
2546
-        if (! $this->checkout->payment_method->is_off_site()) {
2546
+        if ( ! $this->checkout->payment_method->is_off_site()) {
2547 2547
             return false;
2548 2548
         }
2549 2549
         $this->_validate_offsite_return();
2550 2550
         // verify TXN
2551 2551
         if ($this->checkout->transaction instanceof EE_Transaction) {
2552 2552
             $gateway = $this->checkout->payment_method->type_obj()->get_gateway();
2553
-            if (! $gateway instanceof EE_Offsite_Gateway) {
2553
+            if ( ! $gateway instanceof EE_Offsite_Gateway) {
2554 2554
                 $this->checkout->continue_reg = false;
2555 2555
                 return false;
2556 2556
             }
@@ -2564,7 +2564,7 @@  discard block
 block discarded – undo
2564 2564
                 $this->checkout->payment = $payment;
2565 2565
                 // mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
2566 2566
                 // because we will complete this step during the IPN processing then
2567
-                if (! $this->handle_IPN_in_this_request()) {
2567
+                if ( ! $this->handle_IPN_in_this_request()) {
2568 2568
                     $this->set_completed();
2569 2569
                 }
2570 2570
                 return true;
@@ -2667,13 +2667,13 @@  discard block
 block discarded – undo
2667 2667
      */
2668 2668
     private function _redirect_wayward_request(EE_Registration $primary_registrant)
2669 2669
     {
2670
-        if (! $primary_registrant instanceof EE_Registration) {
2670
+        if ( ! $primary_registrant instanceof EE_Registration) {
2671 2671
             // try redirecting based on the current TXN
2672 2672
             $primary_registrant = $this->checkout->transaction instanceof EE_Transaction
2673 2673
                 ? $this->checkout->transaction->primary_registration()
2674 2674
                 : null;
2675 2675
         }
2676
-        if (! $primary_registrant instanceof EE_Registration) {
2676
+        if ( ! $primary_registrant instanceof EE_Registration) {
2677 2677
             EE_Error::add_error(
2678 2678
                 sprintf(
2679 2679
                     esc_html__(
@@ -2744,7 +2744,7 @@  discard block
 block discarded – undo
2744 2744
             $payment = $this->checkout->transaction->last_payment();
2745 2745
             // $payment_source = 'last_payment after Exception';
2746 2746
             // but if we STILL don't have a payment object
2747
-            if (! $payment instanceof EE_Payment) {
2747
+            if ( ! $payment instanceof EE_Payment) {
2748 2748
                 // then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
2749 2749
                 $this->_handle_payment_processor_exception($e);
2750 2750
             }
Please login to merge, or discard this patch.
espresso.php 1 patch
Indentation   +80 added lines, -80 removed lines patch added patch discarded remove patch
@@ -38,103 +38,103 @@
 block discarded – undo
38 38
  * @since           4.0
39 39
  */
40 40
 if (function_exists('espresso_version')) {
41
-    if (! function_exists('espresso_duplicate_plugin_error')) {
42
-        /**
43
-         *    espresso_duplicate_plugin_error
44
-         *    displays if more than one version of EE is activated at the same time
45
-         */
46
-        function espresso_duplicate_plugin_error()
47
-        {
48
-            ?>
41
+	if (! function_exists('espresso_duplicate_plugin_error')) {
42
+		/**
43
+		 *    espresso_duplicate_plugin_error
44
+		 *    displays if more than one version of EE is activated at the same time
45
+		 */
46
+		function espresso_duplicate_plugin_error()
47
+		{
48
+			?>
49 49
             <div class="error">
50 50
                 <p>
51 51
                     <?php
52
-                    echo esc_html__(
53
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
54
-                        'event_espresso'
55
-                    ); ?>
52
+					echo esc_html__(
53
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
54
+						'event_espresso'
55
+					); ?>
56 56
                 </p>
57 57
             </div>
58 58
             <?php
59
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
60
-        }
61
-    }
62
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
59
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
60
+		}
61
+	}
62
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
63 63
 } else {
64
-    define('EE_MIN_PHP_VER_REQUIRED', '5.6.2');
65
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
66
-        /**
67
-         * espresso_minimum_php_version_error
68
-         *
69
-         * @return void
70
-         */
71
-        function espresso_minimum_php_version_error()
72
-        {
73
-            ?>
64
+	define('EE_MIN_PHP_VER_REQUIRED', '5.6.2');
65
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
66
+		/**
67
+		 * espresso_minimum_php_version_error
68
+		 *
69
+		 * @return void
70
+		 */
71
+		function espresso_minimum_php_version_error()
72
+		{
73
+			?>
74 74
             <div class="error">
75 75
                 <p>
76 76
                     <?php
77
-                    printf(
78
-                        esc_html__(
79
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
80
-                            'event_espresso'
81
-                        ),
82
-                        EE_MIN_PHP_VER_REQUIRED,
83
-                        PHP_VERSION,
84
-                        '<br/>',
85
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
86
-                    );
87
-                    ?>
77
+					printf(
78
+						esc_html__(
79
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
80
+							'event_espresso'
81
+						),
82
+						EE_MIN_PHP_VER_REQUIRED,
83
+						PHP_VERSION,
84
+						'<br/>',
85
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
86
+					);
87
+					?>
88 88
                 </p>
89 89
             </div>
90 90
             <?php
91
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
92
-        }
91
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
92
+		}
93 93
 
94
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
95
-    } else {
96
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
97
-        /**
98
-         * espresso_version
99
-         * Returns the plugin version
100
-         *
101
-         * @return string
102
-         */
103
-        function espresso_version()
104
-        {
105
-            return apply_filters('FHEE__espresso__espresso_version', '4.10.38.rc.000');
106
-        }
94
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
95
+	} else {
96
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
97
+		/**
98
+		 * espresso_version
99
+		 * Returns the plugin version
100
+		 *
101
+		 * @return string
102
+		 */
103
+		function espresso_version()
104
+		{
105
+			return apply_filters('FHEE__espresso__espresso_version', '4.10.38.rc.000');
106
+		}
107 107
 
108
-        /**
109
-         * espresso_plugin_activation
110
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
111
-         */
112
-        function espresso_plugin_activation()
113
-        {
114
-            update_option('ee_espresso_activation', true);
115
-        }
108
+		/**
109
+		 * espresso_plugin_activation
110
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
111
+		 */
112
+		function espresso_plugin_activation()
113
+		{
114
+			update_option('ee_espresso_activation', true);
115
+		}
116 116
 
117
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
117
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
118 118
 
119
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
120
-        bootstrap_espresso();
121
-    }
119
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
120
+		bootstrap_espresso();
121
+	}
122 122
 }
123 123
 if (! function_exists('espresso_deactivate_plugin')) {
124
-    /**
125
-     *    deactivate_plugin
126
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
127
-     *
128
-     * @access public
129
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
130
-     * @return    void
131
-     */
132
-    function espresso_deactivate_plugin($plugin_basename = '')
133
-    {
134
-        if (! function_exists('deactivate_plugins')) {
135
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
136
-        }
137
-        unset($_GET['activate'], $_REQUEST['activate']);
138
-        deactivate_plugins($plugin_basename);
139
-    }
124
+	/**
125
+	 *    deactivate_plugin
126
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
127
+	 *
128
+	 * @access public
129
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
130
+	 * @return    void
131
+	 */
132
+	function espresso_deactivate_plugin($plugin_basename = '')
133
+	{
134
+		if (! function_exists('deactivate_plugins')) {
135
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
136
+		}
137
+		unset($_GET['activate'], $_REQUEST['activate']);
138
+		deactivate_plugins($plugin_basename);
139
+	}
140 140
 }
141 141
\ No newline at end of file
Please login to merge, or discard this patch.