Completed
Pull Request — master (#1436)
by Darren
10:07
created
reg_steps/payment_options/EE_SPCO_Reg_Step_Payment_Options.class.php 3 patches
Doc Comments   +11 added lines, -11 removed lines patch added patch discarded remove patch
@@ -142,7 +142,7 @@  discard block
 block discarded – undo
142 142
 
143 143
 
144 144
     /**
145
-     * @return null
145
+     * @return EE_Line_Item_Display
146 146
      */
147 147
     public function line_item_display()
148 148
     {
@@ -151,7 +151,7 @@  discard block
 block discarded – undo
151 151
 
152 152
 
153 153
     /**
154
-     * @param null $line_item_display
154
+     * @param EE_Line_Item_Display $line_item_display
155 155
      */
156 156
     public function set_line_item_display($line_item_display)
157 157
     {
@@ -882,7 +882,7 @@  discard block
 block discarded – undo
882 882
      *    _apply_registration_payments_to_amount_owing
883 883
      *
884 884
      * @access protected
885
-     * @param array $registrations
885
+     * @param EE_Base_Class[] $registrations
886 886
      * @throws EE_Error
887 887
      */
888 888
     protected function _apply_registration_payments_to_amount_owing(array $registrations)
@@ -1197,7 +1197,7 @@  discard block
 block discarded – undo
1197 1197
      * get_billing_form_html_for_payment_method
1198 1198
      *
1199 1199
      * @access public
1200
-     * @return string
1200
+     * @return boolean
1201 1201
      * @throws EE_Error
1202 1202
      * @throws InvalidArgumentException
1203 1203
      * @throws ReflectionException
@@ -1373,7 +1373,7 @@  discard block
 block discarded – undo
1373 1373
      * switch_payment_method
1374 1374
      *
1375 1375
      * @access public
1376
-     * @return string
1376
+     * @return boolean
1377 1377
      * @throws EE_Error
1378 1378
      * @throws InvalidArgumentException
1379 1379
      * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
@@ -1658,7 +1658,7 @@  discard block
 block discarded – undo
1658 1658
     /**
1659 1659
      * process_reg_step
1660 1660
      *
1661
-     * @return bool
1661
+     * @return null|boolean
1662 1662
      * @throws EE_Error
1663 1663
      * @throws InvalidArgumentException
1664 1664
      * @throws ReflectionException
@@ -1788,7 +1788,7 @@  discard block
 block discarded – undo
1788 1788
      *    update_reg_step
1789 1789
      *    this is the final step after a user  revisits the site to retry a payment
1790 1790
      *
1791
-     * @return bool
1791
+     * @return null|boolean
1792 1792
      * @throws EE_Error
1793 1793
      * @throws InvalidArgumentException
1794 1794
      * @throws ReflectionException
@@ -2236,7 +2236,7 @@  discard block
 block discarded – undo
2236 2236
      *
2237 2237
      * @access    private
2238 2238
      * @type    EE_Payment_Method $payment_method
2239
-     * @return mixed EE_Payment | boolean
2239
+     * @return EE_Payment|null EE_Payment | boolean
2240 2240
      * @throws EE_Error
2241 2241
      * @throws InvalidArgumentException
2242 2242
      * @throws ReflectionException
@@ -2555,7 +2555,7 @@  discard block
 block discarded – undo
2555 2555
      *        or present the payment options again
2556 2556
      *
2557 2557
      * @access private
2558
-     * @return EE_Payment|FALSE
2558
+     * @return boolean
2559 2559
      * @throws EE_Error
2560 2560
      * @throws InvalidArgumentException
2561 2561
      * @throws ReflectionException
@@ -2699,8 +2699,8 @@  discard block
 block discarded – undo
2699 2699
      * _redirect_wayward_request
2700 2700
      *
2701 2701
      * @access private
2702
-     * @param \EE_Registration|null $primary_registrant
2703
-     * @return bool
2702
+     * @param EE_Registration $primary_registrant
2703
+     * @return false|null
2704 2704
      * @throws EE_Error
2705 2705
      * @throws InvalidArgumentException
2706 2706
      * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
Please login to merge, or discard this patch.
Indentation   +2885 added lines, -2885 removed lines patch added patch discarded remove patch
@@ -12,2889 +12,2889 @@
 block discarded – undo
12 12
 class EE_SPCO_Reg_Step_Payment_Options extends EE_SPCO_Reg_Step
13 13
 {
14 14
 
15
-    /**
16
-     * @access protected
17
-     * @var EE_Line_Item_Display $Line_Item_Display
18
-     */
19
-    protected $line_item_display;
20
-
21
-    /**
22
-     * @access protected
23
-     * @var boolean $handle_IPN_in_this_request
24
-     */
25
-    protected $handle_IPN_in_this_request = false;
26
-
27
-
28
-    /**
29
-     *    set_hooks - for hooking into EE Core, other modules, etc
30
-     *
31
-     * @access    public
32
-     * @return    void
33
-     */
34
-    public static function set_hooks()
35
-    {
36
-        add_filter(
37
-            'FHEE__SPCO__EE_Line_Item_Filter_Collection',
38
-            array('EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters')
39
-        );
40
-        add_action(
41
-            'wp_ajax_switch_spco_billing_form',
42
-            array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
43
-        );
44
-        add_action(
45
-            'wp_ajax_nopriv_switch_spco_billing_form',
46
-            array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
47
-        );
48
-        add_action('wp_ajax_save_payer_details', array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details'));
49
-        add_action(
50
-            'wp_ajax_nopriv_save_payer_details',
51
-            array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details')
52
-        );
53
-        add_action(
54
-            'wp_ajax_get_transaction_details_for_gateways',
55
-            array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
56
-        );
57
-        add_action(
58
-            'wp_ajax_nopriv_get_transaction_details_for_gateways',
59
-            array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
60
-        );
61
-        add_filter(
62
-            'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
63
-            array('EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'),
64
-            10,
65
-            1
66
-        );
67
-    }
68
-
69
-
70
-    /**
71
-     *    ajax switch_spco_billing_form
72
-     *
73
-     * @throws \EE_Error
74
-     */
75
-    public static function switch_spco_billing_form()
76
-    {
77
-        EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
78
-    }
79
-
80
-
81
-    /**
82
-     *    ajax save_payer_details
83
-     *
84
-     * @throws \EE_Error
85
-     */
86
-    public static function save_payer_details()
87
-    {
88
-        EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
89
-    }
90
-
91
-
92
-    /**
93
-     *    ajax get_transaction_details
94
-     *
95
-     * @throws \EE_Error
96
-     */
97
-    public static function get_transaction_details()
98
-    {
99
-        EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
100
-    }
101
-
102
-
103
-    /**
104
-     * bypass_recaptcha_for_load_payment_method
105
-     *
106
-     * @access public
107
-     * @return array
108
-     * @throws InvalidArgumentException
109
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
110
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
111
-     */
112
-    public static function bypass_recaptcha_for_load_payment_method()
113
-    {
114
-        return array(
115
-            'EESID'  => EE_Registry::instance()->SSN->id(),
116
-            'step'   => 'payment_options',
117
-            'action' => 'spco_billing_form',
118
-        );
119
-    }
120
-
121
-
122
-    /**
123
-     *    class constructor
124
-     *
125
-     * @access    public
126
-     * @param    EE_Checkout $checkout
127
-     */
128
-    public function __construct(EE_Checkout $checkout)
129
-    {
130
-        $this->_slug = 'payment_options';
131
-        $this->_name = esc_html__('Payment Options', 'event_espresso');
132
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . '/payment_options_main.template.php';
133
-        $this->checkout = $checkout;
134
-        $this->_reset_success_message();
135
-        $this->set_instructions(
136
-            esc_html__(
137
-                'Please select a method of payment and provide any necessary billing information before proceeding.',
138
-                'event_espresso'
139
-            )
140
-        );
141
-    }
142
-
143
-
144
-    /**
145
-     * @return null
146
-     */
147
-    public function line_item_display()
148
-    {
149
-        return $this->line_item_display;
150
-    }
151
-
152
-
153
-    /**
154
-     * @param null $line_item_display
155
-     */
156
-    public function set_line_item_display($line_item_display)
157
-    {
158
-        $this->line_item_display = $line_item_display;
159
-    }
160
-
161
-
162
-    /**
163
-     * @return boolean
164
-     */
165
-    public function handle_IPN_in_this_request()
166
-    {
167
-        return $this->handle_IPN_in_this_request;
168
-    }
169
-
170
-
171
-    /**
172
-     * @param boolean $handle_IPN_in_this_request
173
-     */
174
-    public function set_handle_IPN_in_this_request($handle_IPN_in_this_request)
175
-    {
176
-        $this->handle_IPN_in_this_request = filter_var($handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN);
177
-    }
178
-
179
-
180
-    /**
181
-     * translate_js_strings
182
-     *
183
-     * @return void
184
-     */
185
-    public function translate_js_strings()
186
-    {
187
-        EE_Registry::$i18n_js_strings['no_payment_method'] = esc_html__(
188
-            'Please select a method of payment in order to continue.',
189
-            'event_espresso'
190
-        );
191
-        EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
192
-            'A valid method of payment could not be determined. Please refresh the page and try again.',
193
-            'event_espresso'
194
-        );
195
-        EE_Registry::$i18n_js_strings['forwarding_to_offsite'] = esc_html__(
196
-            'Forwarding to Secure Payment Provider.',
197
-            'event_espresso'
198
-        );
199
-    }
200
-
201
-
202
-    /**
203
-     * enqueue_styles_and_scripts
204
-     *
205
-     * @return void
206
-     * @throws EE_Error
207
-     * @throws InvalidArgumentException
208
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
209
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
210
-     */
211
-    public function enqueue_styles_and_scripts()
212
-    {
213
-        $transaction = $this->checkout->transaction;
214
-        // if the transaction isn't set or nothing is owed on it, don't enqueue any JS
215
-        if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
216
-            return;
217
-        }
218
-        foreach (EEM_Payment_Method::instance()->get_all_for_transaction(
219
-            $transaction,
220
-            EEM_Payment_Method::scope_cart
221
-        ) as $payment_method) {
222
-            $type_obj = $payment_method->type_obj();
223
-            if ($type_obj instanceof EE_PMT_Base) {
224
-                $billing_form = $type_obj->generate_new_billing_form($transaction);
225
-                if ($billing_form instanceof EE_Form_Section_Proper) {
226
-                    $billing_form->enqueue_js();
227
-                }
228
-            }
229
-        }
230
-    }
231
-
232
-
233
-    /**
234
-     * initialize_reg_step
235
-     *
236
-     * @return bool
237
-     * @throws EE_Error
238
-     * @throws InvalidArgumentException
239
-     * @throws ReflectionException
240
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
241
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
242
-     */
243
-    public function initialize_reg_step()
244
-    {
245
-        // TODO: if /when we implement donations, then this will need overriding
246
-        if (// don't need payment options for:
247
-            // registrations made via the admin
248
-            // completed transactions
249
-            // overpaid transactions
250
-            // $ 0.00 transactions(no payment required)
251
-            ! $this->checkout->payment_required()
252
-            // but do NOT remove if current action being called belongs to this reg step
253
-            && ! is_callable(array($this, $this->checkout->action))
254
-            && ! $this->completed()
255
-        ) {
256
-            // and if so, then we no longer need the Payment Options step
257
-            if ($this->is_current_step()) {
258
-                $this->checkout->generate_reg_form = false;
259
-            }
260
-            $this->checkout->remove_reg_step($this->_slug);
261
-            // DEBUG LOG
262
-            // $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
263
-            return false;
264
-        }
265
-        // load EEM_Payment_Method
266
-        EE_Registry::instance()->load_model('Payment_Method');
267
-        // get all active payment methods
268
-        $this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
269
-            $this->checkout->transaction,
270
-            EEM_Payment_Method::scope_cart
271
-        );
272
-        return true;
273
-    }
274
-
275
-
276
-    /**
277
-     * @return EE_Form_Section_Proper
278
-     * @throws EE_Error
279
-     * @throws InvalidArgumentException
280
-     * @throws ReflectionException
281
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
282
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
283
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
284
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
285
-     */
286
-    public function generate_reg_form()
287
-    {
288
-        // reset in case someone changes their mind
289
-        $this->_reset_selected_method_of_payment();
290
-        // set some defaults
291
-        $this->checkout->selected_method_of_payment = 'payments_closed';
292
-        $registrations_requiring_payment = array();
293
-        $registrations_for_free_events = array();
294
-        $registrations_requiring_pre_approval = array();
295
-        $sold_out_events = array();
296
-        $insufficient_spaces_available = array();
297
-        $no_payment_required = true;
298
-        // loop thru registrations to gather info
299
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
300
-        $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
301
-            $registrations,
302
-            $this->checkout->revisit
303
-        );
304
-        foreach ($registrations as $REG_ID => $registration) {
305
-            /** @var $registration EE_Registration */
306
-            // has this registration lost it's space ?
307
-            if (isset($ejected_registrations[ $REG_ID ])) {
308
-                if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
309
-                    $sold_out_events[ $registration->event()->ID() ] = $registration->event();
310
-                } else {
311
-                    $insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
312
-                }
313
-                continue;
314
-            }
315
-            // event requires admin approval
316
-            if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
317
-                // add event to list of events with pre-approval reg status
318
-                $registrations_requiring_pre_approval[ $REG_ID ] = $registration;
319
-                do_action(
320
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
321
-                    $registration->event(),
322
-                    $this
323
-                );
324
-                continue;
325
-            }
326
-            if ($this->checkout->revisit
327
-                && $registration->status_ID() !== EEM_Registration::status_id_approved
328
-                && (
329
-                    $registration->event()->is_sold_out()
330
-                    || $registration->event()->is_sold_out(true)
331
-                )
332
-            ) {
333
-                // add event to list of events that are sold out
334
-                $sold_out_events[ $registration->event()->ID() ] = $registration->event();
335
-                do_action(
336
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
337
-                    $registration->event(),
338
-                    $this
339
-                );
340
-                continue;
341
-            }
342
-            // are they allowed to pay now and is there monies owing?
343
-            if ($registration->owes_monies_and_can_pay()) {
344
-                $registrations_requiring_payment[ $REG_ID ] = $registration;
345
-                do_action(
346
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
347
-                    $registration->event(),
348
-                    $this
349
-                );
350
-            } elseif (! $this->checkout->revisit
351
-                      && $registration->status_ID() !== EEM_Registration::status_id_not_approved
352
-                      && $registration->ticket()->is_free()
353
-            ) {
354
-                $registrations_for_free_events[ $registration->ticket()->ID() ] = $registration;
355
-            }
356
-        }
357
-        $subsections = array();
358
-        // now decide which template to load
359
-        if (! empty($sold_out_events)) {
360
-            $subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
361
-        }
362
-        if (! empty($insufficient_spaces_available)) {
363
-            $subsections['insufficient_space'] = $this->_insufficient_spaces_available(
364
-                $insufficient_spaces_available
365
-            );
366
-        }
367
-        if (! empty($registrations_requiring_pre_approval)) {
368
-            $subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
369
-                $registrations_requiring_pre_approval
370
-            );
371
-        }
372
-        if (! empty($registrations_for_free_events)) {
373
-            $subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
374
-        }
375
-        if (! empty($registrations_requiring_payment)) {
376
-            if ($this->checkout->amount_owing > 0) {
377
-                // autoload Line_Item_Display classes
378
-                EEH_Autoloader::register_line_item_filter_autoloaders();
379
-                $line_item_filter_processor = new EE_Line_Item_Filter_Processor(
380
-                    apply_filters(
381
-                        'FHEE__SPCO__EE_Line_Item_Filter_Collection',
382
-                        new EE_Line_Item_Filter_Collection()
383
-                    ),
384
-                    $this->checkout->cart->get_grand_total()
385
-                );
386
-                /** @var EE_Line_Item $filtered_line_item_tree */
387
-                $filtered_line_item_tree = $line_item_filter_processor->process();
388
-                EEH_Autoloader::register_line_item_display_autoloaders();
389
-                $this->set_line_item_display(new EE_Line_Item_Display('spco'));
390
-                $subsections['payment_options'] = $this->_display_payment_options(
391
-                    $this->line_item_display->display_line_item(
392
-                        $filtered_line_item_tree,
393
-                        array('registrations' => $registrations)
394
-                    )
395
-                );
396
-                $this->checkout->amount_owing = $filtered_line_item_tree->total();
397
-                $this->_apply_registration_payments_to_amount_owing($registrations);
398
-            }
399
-            $no_payment_required = false;
400
-        } else {
401
-            $this->_hide_reg_step_submit_button_if_revisit();
402
-        }
403
-        $this->_save_selected_method_of_payment();
404
-
405
-        $subsections['default_hidden_inputs'] = $this->reg_step_hidden_inputs();
406
-        $subsections['extra_hidden_inputs'] = $this->_extra_hidden_inputs($no_payment_required);
407
-
408
-        return new EE_Form_Section_Proper(
409
-            array(
410
-                'name'            => $this->reg_form_name(),
411
-                'html_id'         => $this->reg_form_name(),
412
-                'subsections'     => $subsections,
413
-                'layout_strategy' => new EE_No_Layout(),
414
-            )
415
-        );
416
-    }
417
-
418
-
419
-    /**
420
-     * add line item filters required for this reg step
421
-     * these filters are applied via this line in EE_SPCO_Reg_Step_Payment_Options::set_hooks():
422
-     *        add_filter( 'FHEE__SPCO__EE_Line_Item_Filter_Collection', array( 'EE_SPCO_Reg_Step_Payment_Options',
423
-     *        'add_spco_line_item_filters' ) ); so any code that wants to use the same set of filters during the
424
-     *        payment options reg step, can apply these filters via the following: apply_filters(
425
-     *        'FHEE__SPCO__EE_Line_Item_Filter_Collection', new EE_Line_Item_Filter_Collection() ) or to an existing
426
-     *        filter collection by passing that instead of instantiating a new collection
427
-     *
428
-     * @param \EE_Line_Item_Filter_Collection $line_item_filter_collection
429
-     * @return EE_Line_Item_Filter_Collection
430
-     * @throws EE_Error
431
-     * @throws InvalidArgumentException
432
-     * @throws ReflectionException
433
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
434
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
435
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
436
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
437
-     */
438
-    public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
439
-    {
440
-        if (! EE_Registry::instance()->SSN instanceof EE_Session) {
441
-            return $line_item_filter_collection;
442
-        }
443
-        if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
444
-            return $line_item_filter_collection;
445
-        }
446
-        if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
447
-            return $line_item_filter_collection;
448
-        }
449
-        $line_item_filter_collection->add(
450
-            new EE_Billable_Line_Item_Filter(
451
-                EE_SPCO_Reg_Step_Payment_Options::remove_ejected_registrations(
452
-                    EE_Registry::instance()->SSN->checkout()->transaction->registrations(
453
-                        EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
454
-                    )
455
-                )
456
-            )
457
-        );
458
-        $line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
459
-        return $line_item_filter_collection;
460
-    }
461
-
462
-
463
-    /**
464
-     * remove_ejected_registrations
465
-     * if a registrant has lost their potential space at an event due to lack of payment,
466
-     * then this method removes them from the list of registrations being paid for during this request
467
-     *
468
-     * @param \EE_Registration[] $registrations
469
-     * @return EE_Registration[]
470
-     * @throws EE_Error
471
-     * @throws InvalidArgumentException
472
-     * @throws ReflectionException
473
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
474
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
475
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
476
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
477
-     */
478
-    public static function remove_ejected_registrations(array $registrations)
479
-    {
480
-        $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
481
-            $registrations,
482
-            EE_Registry::instance()->SSN->checkout()->revisit
483
-        );
484
-        foreach ($registrations as $REG_ID => $registration) {
485
-            // has this registration lost it's space ?
486
-            if (isset($ejected_registrations[ $REG_ID ])) {
487
-                unset($registrations[ $REG_ID ]);
488
-                continue;
489
-            }
490
-        }
491
-        return $registrations;
492
-    }
493
-
494
-
495
-    /**
496
-     * find_registrations_that_lost_their_space
497
-     * If a registrant chooses an offline payment method like Invoice,
498
-     * then no space is reserved for them at the event until they fully pay fo that site
499
-     * (unless the event's default reg status is set to APPROVED)
500
-     * if a registrant then later returns to pay, but the number of spaces available has been reduced due to sales,
501
-     * then this method will determine which registrations have lost the ability to complete the reg process.
502
-     *
503
-     * @param \EE_Registration[] $registrations
504
-     * @param bool               $revisit
505
-     * @return array
506
-     * @throws EE_Error
507
-     * @throws InvalidArgumentException
508
-     * @throws ReflectionException
509
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
510
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
511
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
512
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
513
-     */
514
-    public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
515
-    {
516
-        // registrations per event
517
-        $event_reg_count = array();
518
-        // spaces left per event
519
-        $event_spaces_remaining = array();
520
-        // tickets left sorted by ID
521
-        $tickets_remaining = array();
522
-        // registrations that have lost their space
523
-        $ejected_registrations = array();
524
-        foreach ($registrations as $REG_ID => $registration) {
525
-            if ($registration->status_ID() === EEM_Registration::status_id_approved
526
-                || apply_filters(
527
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
528
-                    false,
529
-                    $registration,
530
-                    $revisit
531
-                )
532
-            ) {
533
-                continue;
534
-            }
535
-            $EVT_ID = $registration->event_ID();
536
-            $ticket = $registration->ticket();
537
-            if (! isset($tickets_remaining[ $ticket->ID() ])) {
538
-                $tickets_remaining[ $ticket->ID() ] = $ticket->remaining();
539
-            }
540
-            if ($tickets_remaining[ $ticket->ID() ] > 0) {
541
-                if (! isset($event_reg_count[ $EVT_ID ])) {
542
-                    $event_reg_count[ $EVT_ID ] = 0;
543
-                }
544
-                $event_reg_count[ $EVT_ID ]++;
545
-                if (! isset($event_spaces_remaining[ $EVT_ID ])) {
546
-                    $event_spaces_remaining[ $EVT_ID ] = $registration->event()->spaces_remaining_for_sale();
547
-                }
548
-            }
549
-            if ($revisit
550
-                && ($tickets_remaining[ $ticket->ID() ] === 0
551
-                    || $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
552
-                )
553
-            ) {
554
-                $ejected_registrations[ $REG_ID ] = $registration->event();
555
-                if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
556
-                    /** @type EE_Registration_Processor $registration_processor */
557
-                    $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
558
-                    // at this point, we should have enough details about the registrant to consider the registration
559
-                    // NOT incomplete
560
-                    $registration_processor->manually_update_registration_status(
561
-                        $registration,
562
-                        EEM_Registration::status_id_wait_list
563
-                    );
564
-                }
565
-            }
566
-        }
567
-        return $ejected_registrations;
568
-    }
569
-
570
-
571
-    /**
572
-     * _hide_reg_step_submit_button
573
-     * removes the html for the reg step submit button
574
-     * by replacing it with an empty string via filter callback
575
-     *
576
-     * @return void
577
-     */
578
-    protected function _adjust_registration_status_if_event_old_sold()
579
-    {
580
-    }
581
-
582
-
583
-    /**
584
-     * _hide_reg_step_submit_button
585
-     * removes the html for the reg step submit button
586
-     * by replacing it with an empty string via filter callback
587
-     *
588
-     * @return void
589
-     */
590
-    protected function _hide_reg_step_submit_button_if_revisit()
591
-    {
592
-        if ($this->checkout->revisit) {
593
-            add_filter('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string');
594
-        }
595
-    }
596
-
597
-
598
-    /**
599
-     * sold_out_events
600
-     * displays notices regarding events that have sold out since hte registrant first signed up
601
-     *
602
-     * @param \EE_Event[] $sold_out_events_array
603
-     * @return \EE_Form_Section_Proper
604
-     * @throws \EE_Error
605
-     */
606
-    private function _sold_out_events($sold_out_events_array = array())
607
-    {
608
-        // set some defaults
609
-        $this->checkout->selected_method_of_payment = 'events_sold_out';
610
-        $sold_out_events = '';
611
-        foreach ($sold_out_events_array as $sold_out_event) {
612
-            $sold_out_events .= EEH_HTML::li(
613
-                EEH_HTML::span(
614
-                    '  ' . $sold_out_event->name(),
615
-                    '',
616
-                    'dashicons dashicons-marker ee-icon-size-16 pink-text'
617
-                )
618
-            );
619
-        }
620
-        return new EE_Form_Section_Proper(
621
-            array(
622
-                'layout_strategy' => new EE_Template_Layout(
623
-                    array(
624
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
625
-                                                  . $this->_slug
626
-                                                  . '/sold_out_events.template.php',
627
-                        'template_args'        => apply_filters(
628
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
629
-                            array(
630
-                                'sold_out_events'     => $sold_out_events,
631
-                                'sold_out_events_msg' => apply_filters(
632
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
633
-                                    sprintf(
634
-                                        esc_html__(
635
-                                            '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',
636
-                                            'event_espresso'
637
-                                        ),
638
-                                        '<strong>',
639
-                                        '</strong>',
640
-                                        '<br />'
641
-                                    )
642
-                                ),
643
-                            )
644
-                        ),
645
-                    )
646
-                ),
647
-            )
648
-        );
649
-    }
650
-
651
-
652
-    /**
653
-     * _insufficient_spaces_available
654
-     * displays notices regarding events that do not have enough remaining spaces
655
-     * to satisfy the current number of registrations looking to pay
656
-     *
657
-     * @param \EE_Event[] $insufficient_spaces_events_array
658
-     * @return \EE_Form_Section_Proper
659
-     * @throws \EE_Error
660
-     */
661
-    private function _insufficient_spaces_available($insufficient_spaces_events_array = array())
662
-    {
663
-        // set some defaults
664
-        $this->checkout->selected_method_of_payment = 'invoice';
665
-        $insufficient_space_events = '';
666
-        foreach ($insufficient_spaces_events_array as $event) {
667
-            if ($event instanceof EE_Event) {
668
-                $insufficient_space_events .= EEH_HTML::li(
669
-                    EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
670
-                );
671
-            }
672
-        }
673
-        return new EE_Form_Section_Proper(
674
-            array(
675
-                'subsections'     => array(
676
-                    'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
677
-                    'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
678
-                ),
679
-                'layout_strategy' => new EE_Template_Layout(
680
-                    array(
681
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
682
-                                                  . $this->_slug
683
-                                                  . '/sold_out_events.template.php',
684
-                        'template_args'        => apply_filters(
685
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
686
-                            array(
687
-                                'sold_out_events'     => $insufficient_space_events,
688
-                                'sold_out_events_msg' => apply_filters(
689
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__insufficient_space_msg',
690
-                                    esc_html__(
691
-                                        '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.',
692
-                                        'event_espresso'
693
-                                    )
694
-                                ),
695
-                            )
696
-                        ),
697
-                    )
698
-                ),
699
-            )
700
-        );
701
-    }
702
-
703
-
704
-    /**
705
-     * registrations_requiring_pre_approval
706
-     *
707
-     * @param array $registrations_requiring_pre_approval
708
-     * @return EE_Form_Section_Proper
709
-     * @throws EE_Error
710
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
711
-     */
712
-    private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = array())
713
-    {
714
-        $events_requiring_pre_approval = array();
715
-        foreach ($registrations_requiring_pre_approval as $registration) {
716
-            if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
717
-                $events_requiring_pre_approval[ $registration->event()->ID() ] = EEH_HTML::li(
718
-                    EEH_HTML::span(
719
-                        '',
720
-                        '',
721
-                        'dashicons dashicons-marker ee-icon-size-16 orange-text'
722
-                    )
723
-                    . EEH_HTML::span($registration->event()->name(), '', 'orange-text')
724
-                );
725
-            }
726
-        }
727
-        return new EE_Form_Section_Proper(
728
-            array(
729
-                'layout_strategy' => new EE_Template_Layout(
730
-                    array(
731
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
732
-                                                  . $this->_slug
733
-                                                  . '/events_requiring_pre_approval.template.php', // layout_template
734
-                        'template_args'        => apply_filters(
735
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
736
-                            array(
737
-                                'events_requiring_pre_approval'     => implode('', $events_requiring_pre_approval),
738
-                                'events_requiring_pre_approval_msg' => apply_filters(
739
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___events_requiring_pre_approval__events_requiring_pre_approval_msg',
740
-                                    esc_html__(
741
-                                        '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.',
742
-                                        'event_espresso'
743
-                                    )
744
-                                ),
745
-                            )
746
-                        ),
747
-                    )
748
-                ),
749
-            )
750
-        );
751
-    }
752
-
753
-
754
-    /**
755
-     * _no_payment_required
756
-     *
757
-     * @param \EE_Event[] $registrations_for_free_events
758
-     * @return \EE_Form_Section_Proper
759
-     * @throws \EE_Error
760
-     */
761
-    private function _no_payment_required($registrations_for_free_events = array())
762
-    {
763
-        // set some defaults
764
-        $this->checkout->selected_method_of_payment = 'no_payment_required';
765
-        // generate no_payment_required form
766
-        return new EE_Form_Section_Proper(
767
-            array(
768
-                'layout_strategy' => new EE_Template_Layout(
769
-                    array(
770
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
771
-                                                  . $this->_slug
772
-                                                  . '/no_payment_required.template.php', // layout_template
773
-                        'template_args'        => apply_filters(
774
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
775
-                            array(
776
-                                'revisit'                       => $this->checkout->revisit,
777
-                                'registrations'                 => array(),
778
-                                'ticket_count'                  => array(),
779
-                                'registrations_for_free_events' => $registrations_for_free_events,
780
-                                'no_payment_required_msg'       => EEH_HTML::p(
781
-                                    esc_html__('This is a free event, so no billing will occur.', 'event_espresso')
782
-                                ),
783
-                            )
784
-                        ),
785
-                    )
786
-                ),
787
-            )
788
-        );
789
-    }
790
-
791
-
792
-    /**
793
-     * _display_payment_options
794
-     *
795
-     * @param string $transaction_details
796
-     * @return EE_Form_Section_Proper
797
-     * @throws EE_Error
798
-     * @throws InvalidArgumentException
799
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
800
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
801
-     */
802
-    private function _display_payment_options($transaction_details = '')
803
-    {
804
-        // has method_of_payment been set by no-js user?
805
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment();
806
-        // build payment options form
807
-        return apply_filters(
808
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__payment_options_form',
809
-            new EE_Form_Section_Proper(
810
-                array(
811
-                    'subsections'     => array(
812
-                        'before_payment_options' => apply_filters(
813
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
814
-                            new EE_Form_Section_Proper(
815
-                                array('layout_strategy' => new EE_Div_Per_Section_Layout())
816
-                            )
817
-                        ),
818
-                        'payment_options'        => $this->_setup_payment_options(),
819
-                        'after_payment_options'  => apply_filters(
820
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__after_payment_options',
821
-                            new EE_Form_Section_Proper(
822
-                                array('layout_strategy' => new EE_Div_Per_Section_Layout())
823
-                            )
824
-                        ),
825
-                    ),
826
-                    'layout_strategy' => new EE_Template_Layout(
827
-                        array(
828
-                            'layout_template_file' => $this->_template,
829
-                            'template_args'        => apply_filters(
830
-                                'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
831
-                                array(
832
-                                    'reg_count'                 => $this->line_item_display->total_items(),
833
-                                    'transaction_details'       => $transaction_details,
834
-                                    'available_payment_methods' => array(),
835
-                                )
836
-                            ),
837
-                        )
838
-                    ),
839
-                )
840
-            )
841
-        );
842
-    }
843
-
844
-
845
-    /**
846
-     * _extra_hidden_inputs
847
-     *
848
-     * @param bool $no_payment_required
849
-     * @return \EE_Form_Section_Proper
850
-     * @throws \EE_Error
851
-     */
852
-    private function _extra_hidden_inputs($no_payment_required = true)
853
-    {
854
-        return new EE_Form_Section_Proper(
855
-            array(
856
-                'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
857
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
858
-                'subsections'     => array(
859
-                    'spco_no_payment_required' => new EE_Hidden_Input(
860
-                        array(
861
-                            'normalization_strategy' => new EE_Boolean_Normalization(),
862
-                            'html_name'              => 'spco_no_payment_required',
863
-                            'html_id'                => 'spco-no-payment-required-payment_options',
864
-                            'default'                => $no_payment_required,
865
-                        )
866
-                    ),
867
-                    'spco_transaction_id'      => new EE_Fixed_Hidden_Input(
868
-                        array(
869
-                            'normalization_strategy' => new EE_Int_Normalization(),
870
-                            'html_name'              => 'spco_transaction_id',
871
-                            'html_id'                => 'spco-transaction-id',
872
-                            'default'                => $this->checkout->transaction->ID(),
873
-                        )
874
-                    ),
875
-                ),
876
-            )
877
-        );
878
-    }
879
-
880
-
881
-    /**
882
-     *    _apply_registration_payments_to_amount_owing
883
-     *
884
-     * @access protected
885
-     * @param array $registrations
886
-     * @throws EE_Error
887
-     */
888
-    protected function _apply_registration_payments_to_amount_owing(array $registrations)
889
-    {
890
-        $payments = array();
891
-        foreach ($registrations as $registration) {
892
-            if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
893
-                $payments += $registration->registration_payments();
894
-            }
895
-        }
896
-        if (! empty($payments)) {
897
-            foreach ($payments as $payment) {
898
-                if ($payment instanceof EE_Registration_Payment) {
899
-                    $this->checkout->amount_owing -= $payment->amount();
900
-                }
901
-            }
902
-        }
903
-    }
904
-
905
-
906
-    /**
907
-     *    _reset_selected_method_of_payment
908
-     *
909
-     * @access    private
910
-     * @param    bool $force_reset
911
-     * @return void
912
-     * @throws InvalidArgumentException
913
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
914
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
915
-     */
916
-    private function _reset_selected_method_of_payment($force_reset = false)
917
-    {
918
-        $reset_payment_method = $force_reset
919
-            ? true
920
-            : sanitize_text_field(EE_Registry::instance()->REQ->get('reset_payment_method', false));
921
-        if ($reset_payment_method) {
922
-            $this->checkout->selected_method_of_payment = null;
923
-            $this->checkout->payment_method = null;
924
-            $this->checkout->billing_form = null;
925
-            $this->_save_selected_method_of_payment();
926
-        }
927
-    }
928
-
929
-
930
-    /**
931
-     * _save_selected_method_of_payment
932
-     * stores the selected_method_of_payment in the session
933
-     * so that it's available for all subsequent requests including AJAX
934
-     *
935
-     * @access        private
936
-     * @param string $selected_method_of_payment
937
-     * @return void
938
-     * @throws InvalidArgumentException
939
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
940
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
941
-     */
942
-    private function _save_selected_method_of_payment($selected_method_of_payment = '')
943
-    {
944
-        $selected_method_of_payment = ! empty($selected_method_of_payment)
945
-            ? $selected_method_of_payment
946
-            : $this->checkout->selected_method_of_payment;
947
-        EE_Registry::instance()->SSN->set_session_data(
948
-            array('selected_method_of_payment' => $selected_method_of_payment)
949
-        );
950
-    }
951
-
952
-
953
-    /**
954
-     * _setup_payment_options
955
-     *
956
-     * @return EE_Form_Section_Proper
957
-     * @throws EE_Error
958
-     * @throws InvalidArgumentException
959
-     * @throws ReflectionException
960
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
961
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
962
-     */
963
-    public function _setup_payment_options()
964
-    {
965
-        // load payment method classes
966
-        $this->checkout->available_payment_methods = $this->_get_available_payment_methods();
967
-        if (empty($this->checkout->available_payment_methods)) {
968
-            EE_Error::add_error(
969
-                apply_filters(
970
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__error_message_no_payment_methods',
971
-                    sprintf(
972
-                        esc_html__(
973
-                            '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.',
974
-                            'event_espresso'
975
-                        ),
976
-                        '<br>',
977
-                        EE_Registry::instance()->CFG->organization->get_pretty('email')
978
-                    )
979
-                ),
980
-                __FILE__,
981
-                __FUNCTION__,
982
-                __LINE__
983
-            );
984
-        }
985
-        // switch up header depending on number of available payment methods
986
-        $payment_method_header = count($this->checkout->available_payment_methods) > 1
987
-            ? apply_filters(
988
-                'FHEE__registration_page_payment_options__method_of_payment_hdr',
989
-                esc_html__('Please Select Your Method of Payment', 'event_espresso')
990
-            )
991
-            : apply_filters(
992
-                'FHEE__registration_page_payment_options__method_of_payment_hdr',
993
-                esc_html__('Method of Payment', 'event_espresso')
994
-            );
995
-        $available_payment_methods = array(
996
-            // display the "Payment Method" header
997
-            'payment_method_header' => new EE_Form_Section_HTML(
998
-                apply_filters(
999
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__payment_method_header',
1000
-                    EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr'),
1001
-                    $payment_method_header
1002
-                )
1003
-            ),
1004
-        );
1005
-        // the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
1006
-        $available_payment_method_options = array();
1007
-        $default_payment_method_option = array();
1008
-        // additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
1009
-        $payment_methods_billing_info = array(
1010
-            new EE_Form_Section_HTML(
1011
-                EEH_HTML::div('<br />', '', '', 'clear:both;')
1012
-            ),
1013
-        );
1014
-        // loop through payment methods
1015
-        foreach ($this->checkout->available_payment_methods as $payment_method) {
1016
-            if ($payment_method instanceof EE_Payment_Method) {
1017
-                $payment_method_button = EEH_HTML::img(
1018
-                    $payment_method->button_url(),
1019
-                    $payment_method->name(),
1020
-                    'spco-payment-method-' . $payment_method->slug() . '-btn-img',
1021
-                    'spco-payment-method-btn-img'
1022
-                );
1023
-                // check if any payment methods are set as default
1024
-                // if payment method is already selected OR nothing is selected and this payment method should be
1025
-                // open_by_default
1026
-                if (($this->checkout->selected_method_of_payment === $payment_method->slug())
1027
-                    || (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
1028
-                ) {
1029
-                    $this->checkout->selected_method_of_payment = $payment_method->slug();
1030
-                    $this->_save_selected_method_of_payment();
1031
-                    $default_payment_method_option[ $payment_method->slug() ] = $payment_method_button;
1032
-                } else {
1033
-                    $available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
1034
-                }
1035
-                $payment_methods_billing_info[ $payment_method->slug(
1036
-                ) . '-info' ] = $this->_payment_method_billing_info(
1037
-                    $payment_method
1038
-                );
1039
-            }
1040
-        }
1041
-        // prepend available_payment_method_options with default_payment_method_option so that it appears first in list
1042
-        // of PMs
1043
-        $available_payment_method_options = $default_payment_method_option + $available_payment_method_options;
1044
-        // now generate the actual form  inputs
1045
-        $available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
1046
-            $available_payment_method_options
1047
-        );
1048
-        $available_payment_methods += $payment_methods_billing_info;
1049
-        // build the available payment methods form
1050
-        return new EE_Form_Section_Proper(
1051
-            array(
1052
-                'html_id'         => 'spco-available-methods-of-payment-dv',
1053
-                'subsections'     => $available_payment_methods,
1054
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
1055
-            )
1056
-        );
1057
-    }
1058
-
1059
-
1060
-    /**
1061
-     * _get_available_payment_methods
1062
-     *
1063
-     * @return EE_Payment_Method[]
1064
-     * @throws EE_Error
1065
-     * @throws InvalidArgumentException
1066
-     * @throws ReflectionException
1067
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1068
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1069
-     */
1070
-    protected function _get_available_payment_methods()
1071
-    {
1072
-        if (! empty($this->checkout->available_payment_methods)) {
1073
-            return $this->checkout->available_payment_methods;
1074
-        }
1075
-        $available_payment_methods = array();
1076
-        // load EEM_Payment_Method
1077
-        EE_Registry::instance()->load_model('Payment_Method');
1078
-        /** @type EEM_Payment_Method $EEM_Payment_Method */
1079
-        $EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
1080
-        // get all active payment methods
1081
-        $payment_methods = $EEM_Payment_Method->get_all_for_transaction(
1082
-            $this->checkout->transaction,
1083
-            EEM_Payment_Method::scope_cart
1084
-        );
1085
-        foreach ($payment_methods as $payment_method) {
1086
-            if ($payment_method instanceof EE_Payment_Method) {
1087
-                $available_payment_methods[ $payment_method->slug() ] = $payment_method;
1088
-            }
1089
-        }
1090
-        return $available_payment_methods;
1091
-    }
1092
-
1093
-
1094
-    /**
1095
-     *    _available_payment_method_inputs
1096
-     *
1097
-     * @access    private
1098
-     * @param    array $available_payment_method_options
1099
-     * @return    \EE_Form_Section_Proper
1100
-     */
1101
-    private function _available_payment_method_inputs($available_payment_method_options = array())
1102
-    {
1103
-        // generate inputs
1104
-        return new EE_Form_Section_Proper(
1105
-            array(
1106
-                'html_id'         => 'ee-available-payment-method-inputs',
1107
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
1108
-                'subsections'     => array(
1109
-                    '' => new EE_Radio_Button_Input(
1110
-                        $available_payment_method_options,
1111
-                        array(
1112
-                            'html_name'          => 'selected_method_of_payment',
1113
-                            'html_class'         => 'spco-payment-method',
1114
-                            'default'            => $this->checkout->selected_method_of_payment,
1115
-                            'label_size'         => 11,
1116
-                            'enforce_label_size' => true,
1117
-                        )
1118
-                    ),
1119
-                ),
1120
-            )
1121
-        );
1122
-    }
1123
-
1124
-
1125
-    /**
1126
-     *    _payment_method_billing_info
1127
-     *
1128
-     * @access    private
1129
-     * @param    EE_Payment_Method $payment_method
1130
-     * @return EE_Form_Section_Proper
1131
-     * @throws EE_Error
1132
-     * @throws InvalidArgumentException
1133
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1134
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1135
-     */
1136
-    private function _payment_method_billing_info(EE_Payment_Method $payment_method)
1137
-    {
1138
-        $currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug()
1139
-            ? true
1140
-            : false;
1141
-        // generate the billing form for payment method
1142
-        $billing_form = $currently_selected
1143
-            ? $this->_get_billing_form_for_payment_method($payment_method)
1144
-            : new EE_Form_Section_HTML();
1145
-        $this->checkout->billing_form = $currently_selected
1146
-            ? $billing_form
1147
-            : $this->checkout->billing_form;
1148
-        // it's all in the details
1149
-        $info_html = EEH_HTML::h3(
1150
-            esc_html__('Important information regarding your payment', 'event_espresso'),
1151
-            '',
1152
-            'spco-payment-method-hdr'
1153
-        );
1154
-        // add some info regarding the step, either from what's saved in the admin,
1155
-        // or a default string depending on whether the PM has a billing form or not
1156
-        if ($payment_method->description()) {
1157
-            $payment_method_info = $payment_method->description();
1158
-        } elseif ($billing_form instanceof EE_Billing_Info_Form) {
1159
-            $payment_method_info = sprintf(
1160
-                esc_html__(
1161
-                    'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
1162
-                    'event_espresso'
1163
-                ),
1164
-                $this->submit_button_text()
1165
-            );
1166
-        } else {
1167
-            $payment_method_info = sprintf(
1168
-                esc_html__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
1169
-                $this->submit_button_text()
1170
-            );
1171
-        }
1172
-        $info_html .= EEH_HTML::div(
1173
-            apply_filters(
1174
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options___payment_method_billing_info__payment_method_info',
1175
-                $payment_method_info
1176
-            ),
1177
-            '',
1178
-            'spco-payment-method-desc ee-attention'
1179
-        );
1180
-        return new EE_Form_Section_Proper(
1181
-            array(
1182
-                'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
1183
-                'html_class'      => 'spco-payment-method-info-dv',
1184
-                // only display the selected or default PM
1185
-                'html_style'      => $currently_selected ? '' : 'display:none;',
1186
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
1187
-                'subsections'     => array(
1188
-                    'info'         => new EE_Form_Section_HTML($info_html),
1189
-                    'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML(),
1190
-                ),
1191
-            )
1192
-        );
1193
-    }
1194
-
1195
-
1196
-    /**
1197
-     * get_billing_form_html_for_payment_method
1198
-     *
1199
-     * @access public
1200
-     * @return string
1201
-     * @throws EE_Error
1202
-     * @throws InvalidArgumentException
1203
-     * @throws ReflectionException
1204
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1205
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1206
-     */
1207
-    public function get_billing_form_html_for_payment_method()
1208
-    {
1209
-        // how have they chosen to pay?
1210
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
1211
-        $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
1212
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
1213
-            return false;
1214
-        }
1215
-        if (apply_filters(
1216
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1217
-            false
1218
-        )) {
1219
-            EE_Error::add_success(
1220
-                apply_filters(
1221
-                    'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1222
-                    sprintf(
1223
-                        esc_html__(
1224
-                            'You have selected "%s" as your method of payment. Please note the important payment information below.',
1225
-                            'event_espresso'
1226
-                        ),
1227
-                        $this->checkout->payment_method->name()
1228
-                    )
1229
-                )
1230
-            );
1231
-        }
1232
-        // now generate billing form for selected method of payment
1233
-        $payment_method_billing_form = $this->_get_billing_form_for_payment_method($this->checkout->payment_method);
1234
-        // fill form with attendee info if applicable
1235
-        if ($payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
1236
-            && $this->checkout->transaction_has_primary_registrant()
1237
-        ) {
1238
-            $payment_method_billing_form->populate_from_attendee(
1239
-                $this->checkout->transaction->primary_registration()->attendee()
1240
-            );
1241
-        }
1242
-        // and debug content
1243
-        if ($payment_method_billing_form instanceof EE_Billing_Info_Form
1244
-            && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
1245
-        ) {
1246
-            $payment_method_billing_form =
1247
-                $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
1248
-                    $payment_method_billing_form
1249
-                );
1250
-        }
1251
-        $billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
1252
-            ? $payment_method_billing_form->get_html()
1253
-            : '';
1254
-        $this->checkout->json_response->set_return_data(array('payment_method_info' => $billing_info));
1255
-        // localize validation rules for main form
1256
-        $this->checkout->current_step->reg_form->localize_validation_rules();
1257
-        $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
1258
-        return true;
1259
-    }
1260
-
1261
-
1262
-    /**
1263
-     * _get_billing_form_for_payment_method
1264
-     *
1265
-     * @access private
1266
-     * @param EE_Payment_Method $payment_method
1267
-     * @return EE_Billing_Info_Form|EE_Form_Section_HTML
1268
-     * @throws EE_Error
1269
-     * @throws InvalidArgumentException
1270
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1271
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1272
-     */
1273
-    private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method)
1274
-    {
1275
-        $billing_form = $payment_method->type_obj()->billing_form(
1276
-            $this->checkout->transaction,
1277
-            array('amount_owing' => $this->checkout->amount_owing)
1278
-        );
1279
-        if ($billing_form instanceof EE_Billing_Info_Form) {
1280
-            if (apply_filters(
1281
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1282
-                false
1283
-            )
1284
-                && EE_Registry::instance()->REQ->is_set('payment_method')
1285
-            ) {
1286
-                EE_Error::add_success(
1287
-                    apply_filters(
1288
-                        'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1289
-                        sprintf(
1290
-                            esc_html__(
1291
-                                'You have selected "%s" as your method of payment. Please note the important payment information below.',
1292
-                                'event_espresso'
1293
-                            ),
1294
-                            $payment_method->name()
1295
-                        )
1296
-                    )
1297
-                );
1298
-            }
1299
-            return apply_filters(
1300
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
1301
-                $billing_form,
1302
-                $payment_method
1303
-            );
1304
-        }
1305
-        // no actual billing form, so return empty HTML form section
1306
-        return new EE_Form_Section_HTML();
1307
-    }
1308
-
1309
-
1310
-    /**
1311
-     * _get_selected_method_of_payment
1312
-     *
1313
-     * @access private
1314
-     * @param boolean $required whether to throw an error if the "selected_method_of_payment"
1315
-     *                          is not found in the incoming request
1316
-     * @param string  $request_param
1317
-     * @return NULL|string
1318
-     * @throws EE_Error
1319
-     * @throws InvalidArgumentException
1320
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1321
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1322
-     */
1323
-    private function _get_selected_method_of_payment(
1324
-        $required = false,
1325
-        $request_param = 'selected_method_of_payment'
1326
-    ) {
1327
-        // is selected_method_of_payment set in the request ?
1328
-        $selected_method_of_payment = EE_Registry::instance()->REQ->get($request_param, false);
1329
-        if ($selected_method_of_payment) {
1330
-            // sanitize it
1331
-            $selected_method_of_payment = is_array($selected_method_of_payment)
1332
-                ? array_shift($selected_method_of_payment)
1333
-                : $selected_method_of_payment;
1334
-            $selected_method_of_payment = sanitize_text_field($selected_method_of_payment);
1335
-            // store it in the session so that it's available for all subsequent requests including AJAX
1336
-            $this->_save_selected_method_of_payment($selected_method_of_payment);
1337
-        } else {
1338
-            // or is is set in the session ?
1339
-            $selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
1340
-                'selected_method_of_payment'
1341
-            );
1342
-        }
1343
-        // do ya really really gotta have it?
1344
-        if (empty($selected_method_of_payment) && $required) {
1345
-            EE_Error::add_error(
1346
-                sprintf(
1347
-                    esc_html__(
1348
-                        '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.',
1349
-                        'event_espresso'
1350
-                    ),
1351
-                    '<br/>',
1352
-                    '<br/>',
1353
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
1354
-                ),
1355
-                __FILE__,
1356
-                __FUNCTION__,
1357
-                __LINE__
1358
-            );
1359
-            return null;
1360
-        }
1361
-        return $selected_method_of_payment;
1362
-    }
1363
-
1364
-
1365
-
1366
-
1367
-
1368
-
1369
-    /********************************************************************************************************/
1370
-    /***********************************  SWITCH PAYMENT METHOD  ************************************/
1371
-    /********************************************************************************************************/
1372
-    /**
1373
-     * switch_payment_method
1374
-     *
1375
-     * @access public
1376
-     * @return string
1377
-     * @throws EE_Error
1378
-     * @throws InvalidArgumentException
1379
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1380
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1381
-     */
1382
-    public function switch_payment_method()
1383
-    {
1384
-        if (! $this->_verify_payment_method_is_set()) {
1385
-            return false;
1386
-        }
1387
-        if (apply_filters(
1388
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1389
-            false
1390
-        )) {
1391
-            EE_Error::add_success(
1392
-                apply_filters(
1393
-                    'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1394
-                    sprintf(
1395
-                        esc_html__(
1396
-                            'You have selected "%s" as your method of payment. Please note the important payment information below.',
1397
-                            'event_espresso'
1398
-                        ),
1399
-                        $this->checkout->payment_method->name()
1400
-                    )
1401
-                )
1402
-            );
1403
-        }
1404
-        // generate billing form for selected method of payment if it hasn't been done already
1405
-        if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
1406
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1407
-                $this->checkout->payment_method
1408
-            );
1409
-        }
1410
-        // fill form with attendee info if applicable
1411
-        if (apply_filters(
1412
-            'FHEE__populate_billing_form_fields_from_attendee',
1413
-            (
1414
-                $this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
1415
-                && $this->checkout->transaction_has_primary_registrant()
1416
-            ),
1417
-            $this->checkout->billing_form,
1418
-            $this->checkout->transaction
1419
-        )
1420
-        ) {
1421
-            $this->checkout->billing_form->populate_from_attendee(
1422
-                $this->checkout->transaction->primary_registration()->attendee()
1423
-            );
1424
-        }
1425
-        // and debug content
1426
-        if ($this->checkout->billing_form instanceof EE_Billing_Info_Form
1427
-            && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
1428
-        ) {
1429
-            $this->checkout->billing_form =
1430
-                $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
1431
-                    $this->checkout->billing_form
1432
-                );
1433
-        }
1434
-        // get html and validation rules for form
1435
-        if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
1436
-            $this->checkout->json_response->set_return_data(
1437
-                array('payment_method_info' => $this->checkout->billing_form->get_html())
1438
-            );
1439
-            // localize validation rules for main form
1440
-            $this->checkout->billing_form->localize_validation_rules(true);
1441
-            $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
1442
-        } else {
1443
-            $this->checkout->json_response->set_return_data(array('payment_method_info' => ''));
1444
-        }
1445
-        // prevents advancement to next step
1446
-        $this->checkout->continue_reg = false;
1447
-        return true;
1448
-    }
1449
-
1450
-
1451
-    /**
1452
-     * _verify_payment_method_is_set
1453
-     *
1454
-     * @return bool
1455
-     * @throws EE_Error
1456
-     * @throws InvalidArgumentException
1457
-     * @throws ReflectionException
1458
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1459
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1460
-     */
1461
-    protected function _verify_payment_method_is_set()
1462
-    {
1463
-        // generate billing form for selected method of payment if it hasn't been done already
1464
-        if (empty($this->checkout->selected_method_of_payment)) {
1465
-            // how have they chosen to pay?
1466
-            $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
1467
-        } else {
1468
-            // choose your own adventure based on method_of_payment
1469
-            switch ($this->checkout->selected_method_of_payment) {
1470
-                case 'events_sold_out':
1471
-                    EE_Error::add_attention(
1472
-                        apply_filters(
1473
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__sold_out_events_msg',
1474
-                            esc_html__(
1475
-                                '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.',
1476
-                                'event_espresso'
1477
-                            )
1478
-                        ),
1479
-                        __FILE__,
1480
-                        __FUNCTION__,
1481
-                        __LINE__
1482
-                    );
1483
-                    return false;
1484
-                    break;
1485
-                case 'payments_closed':
1486
-                    EE_Error::add_attention(
1487
-                        apply_filters(
1488
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
1489
-                            esc_html__(
1490
-                                '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.',
1491
-                                'event_espresso'
1492
-                            )
1493
-                        ),
1494
-                        __FILE__,
1495
-                        __FUNCTION__,
1496
-                        __LINE__
1497
-                    );
1498
-                    return false;
1499
-                    break;
1500
-                case 'no_payment_required':
1501
-                    EE_Error::add_attention(
1502
-                        apply_filters(
1503
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
1504
-                            esc_html__(
1505
-                                '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.',
1506
-                                'event_espresso'
1507
-                            )
1508
-                        ),
1509
-                        __FILE__,
1510
-                        __FUNCTION__,
1511
-                        __LINE__
1512
-                    );
1513
-                    return false;
1514
-                    break;
1515
-                default:
1516
-            }
1517
-        }
1518
-        // verify payment method
1519
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
1520
-            // get payment method for selected method of payment
1521
-            $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
1522
-        }
1523
-        return $this->checkout->payment_method instanceof EE_Payment_Method ? true : false;
1524
-    }
1525
-
1526
-
1527
-
1528
-    /********************************************************************************************************/
1529
-    /***************************************  SAVE PAYER DETAILS  ****************************************/
1530
-    /********************************************************************************************************/
1531
-    /**
1532
-     * save_payer_details_via_ajax
1533
-     *
1534
-     * @return void
1535
-     * @throws EE_Error
1536
-     * @throws InvalidArgumentException
1537
-     * @throws ReflectionException
1538
-     * @throws RuntimeException
1539
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1540
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1541
-     */
1542
-    public function save_payer_details_via_ajax()
1543
-    {
1544
-        if (! $this->_verify_payment_method_is_set()) {
1545
-            return;
1546
-        }
1547
-        // generate billing form for selected method of payment if it hasn't been done already
1548
-        if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
1549
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1550
-                $this->checkout->payment_method
1551
-            );
1552
-        }
1553
-        // generate primary attendee from payer info if applicable
1554
-        if (! $this->checkout->transaction_has_primary_registrant()) {
1555
-            $attendee = $this->_create_attendee_from_request_data();
1556
-            if ($attendee instanceof EE_Attendee) {
1557
-                foreach ($this->checkout->transaction->registrations() as $registration) {
1558
-                    if ($registration->is_primary_registrant()) {
1559
-                        $this->checkout->primary_attendee_obj = $attendee;
1560
-                        $registration->_add_relation_to($attendee, 'Attendee');
1561
-                        $registration->set_attendee_id($attendee->ID());
1562
-                        $registration->update_cache_after_object_save('Attendee', $attendee);
1563
-                    }
1564
-                }
1565
-            }
1566
-        }
1567
-    }
1568
-
1569
-
1570
-    /**
1571
-     * create_attendee_from_request_data
1572
-     * uses info from alternate GET or POST data (such as AJAX) to create a new attendee
1573
-     *
1574
-     * @return EE_Attendee
1575
-     * @throws EE_Error
1576
-     * @throws InvalidArgumentException
1577
-     * @throws ReflectionException
1578
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1579
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1580
-     */
1581
-    protected function _create_attendee_from_request_data()
1582
-    {
1583
-        // get State ID
1584
-        $STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['state']) : '';
1585
-        if (! empty($STA_ID)) {
1586
-            // can we get state object from name ?
1587
-            EE_Registry::instance()->load_model('State');
1588
-            $state = EEM_State::instance()->get_col(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
1589
-            $STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
1590
-        }
1591
-        // get Country ISO
1592
-        $CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['country']) : '';
1593
-        if (! empty($CNT_ISO)) {
1594
-            // can we get country object from name ?
1595
-            EE_Registry::instance()->load_model('Country');
1596
-            $country = EEM_Country::instance()->get_col(
1597
-                array(array('CNT_name' => $CNT_ISO), 'limit' => 1),
1598
-                'CNT_ISO'
1599
-            );
1600
-            $CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
1601
-        }
1602
-        // grab attendee data
1603
-        $attendee_data = array(
1604
-            'ATT_fname'    => ! empty($_REQUEST['first_name']) ? sanitize_text_field($_REQUEST['first_name']) : '',
1605
-            'ATT_lname'    => ! empty($_REQUEST['last_name']) ? sanitize_text_field($_REQUEST['last_name']) : '',
1606
-            'ATT_email'    => ! empty($_REQUEST['email']) ? sanitize_email($_REQUEST['email']) : '',
1607
-            'ATT_address'  => ! empty($_REQUEST['address']) ? sanitize_text_field($_REQUEST['address']) : '',
1608
-            'ATT_address2' => ! empty($_REQUEST['address2']) ? sanitize_text_field($_REQUEST['address2']) : '',
1609
-            'ATT_city'     => ! empty($_REQUEST['city']) ? sanitize_text_field($_REQUEST['city']) : '',
1610
-            'STA_ID'       => $STA_ID,
1611
-            'CNT_ISO'      => $CNT_ISO,
1612
-            'ATT_zip'      => ! empty($_REQUEST['zip']) ? sanitize_text_field($_REQUEST['zip']) : '',
1613
-            'ATT_phone'    => ! empty($_REQUEST['phone']) ? sanitize_text_field($_REQUEST['phone']) : '',
1614
-        );
1615
-        // validate the email address since it is the most important piece of info
1616
-        if (empty($attendee_data['ATT_email']) || $attendee_data['ATT_email'] !== $_REQUEST['email']) {
1617
-            EE_Error::add_error(
1618
-                esc_html__('An invalid email address was submitted.', 'event_espresso'),
1619
-                __FILE__,
1620
-                __FUNCTION__,
1621
-                __LINE__
1622
-            );
1623
-        }
1624
-        // does this attendee already exist in the db ? we're searching using a combination of first name, last name,
1625
-        // AND email address
1626
-        if (! empty($attendee_data['ATT_fname'])
1627
-            && ! empty($attendee_data['ATT_lname'])
1628
-            && ! empty($attendee_data['ATT_email'])
1629
-        ) {
1630
-            $existing_attendee = EE_Registry::instance()->LIB->EEM_Attendee->find_existing_attendee(
1631
-                array(
1632
-                    'ATT_fname' => $attendee_data['ATT_fname'],
1633
-                    'ATT_lname' => $attendee_data['ATT_lname'],
1634
-                    'ATT_email' => $attendee_data['ATT_email'],
1635
-                )
1636
-            );
1637
-            if ($existing_attendee instanceof EE_Attendee) {
1638
-                return $existing_attendee;
1639
-            }
1640
-        }
1641
-        // no existing attendee? kk let's create a new one
1642
-        // kinda lame, but we need a first and last name to create an attendee, so use the email address if those
1643
-        // don't exist
1644
-        $attendee_data['ATT_fname'] = ! empty($attendee_data['ATT_fname'])
1645
-            ? $attendee_data['ATT_fname']
1646
-            : $attendee_data['ATT_email'];
1647
-        $attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
1648
-            ? $attendee_data['ATT_lname']
1649
-            : $attendee_data['ATT_email'];
1650
-        return EE_Attendee::new_instance($attendee_data);
1651
-    }
1652
-
1653
-
1654
-
1655
-    /********************************************************************************************************/
1656
-    /****************************************  PROCESS REG STEP  *****************************************/
1657
-    /********************************************************************************************************/
1658
-    /**
1659
-     * process_reg_step
1660
-     *
1661
-     * @return bool
1662
-     * @throws EE_Error
1663
-     * @throws InvalidArgumentException
1664
-     * @throws ReflectionException
1665
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
1666
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1667
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1668
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
1669
-     */
1670
-    public function process_reg_step()
1671
-    {
1672
-        // how have they chosen to pay?
1673
-        $this->checkout->selected_method_of_payment = $this->checkout->transaction->is_free()
1674
-            ? 'no_payment_required'
1675
-            : $this->_get_selected_method_of_payment(true);
1676
-        // choose your own adventure based on method_of_payment
1677
-        switch ($this->checkout->selected_method_of_payment) {
1678
-            case 'events_sold_out':
1679
-                $this->checkout->redirect = true;
1680
-                $this->checkout->redirect_url = $this->checkout->cancel_page_url;
1681
-                $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
1682
-                // mark this reg step as completed
1683
-                $this->set_completed();
1684
-                return false;
1685
-                break;
1686
-
1687
-            case 'payments_closed':
1688
-                if (apply_filters(
1689
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
1690
-                    false
1691
-                )) {
1692
-                    EE_Error::add_success(
1693
-                        esc_html__('no payment required at this time.', 'event_espresso'),
1694
-                        __FILE__,
1695
-                        __FUNCTION__,
1696
-                        __LINE__
1697
-                    );
1698
-                }
1699
-                // mark this reg step as completed
1700
-                $this->set_completed();
1701
-                return true;
1702
-                break;
1703
-
1704
-            case 'no_payment_required':
1705
-                if (apply_filters(
1706
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
1707
-                    false
1708
-                )) {
1709
-                    EE_Error::add_success(
1710
-                        esc_html__('no payment required.', 'event_espresso'),
1711
-                        __FILE__,
1712
-                        __FUNCTION__,
1713
-                        __LINE__
1714
-                    );
1715
-                }
1716
-                // mark this reg step as completed
1717
-                $this->set_completed();
1718
-                return true;
1719
-                break;
1720
-
1721
-            default:
1722
-                $registrations = EE_Registry::instance()->SSN->checkout()->transaction->registrations(
1723
-                    EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
1724
-                );
1725
-                $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
1726
-                    $registrations,
1727
-                    EE_Registry::instance()->SSN->checkout()->revisit
1728
-                );
1729
-                // calculate difference between the two arrays
1730
-                $registrations = array_diff($registrations, $ejected_registrations);
1731
-                if (empty($registrations)) {
1732
-                    $this->_redirect_because_event_sold_out();
1733
-                    return false;
1734
-                }
1735
-                $payment_successful = $this->_process_payment();
1736
-                if ($payment_successful) {
1737
-                    $this->checkout->continue_reg = true;
1738
-                    $this->_maybe_set_completed($this->checkout->payment_method);
1739
-                } else {
1740
-                    $this->checkout->continue_reg = false;
1741
-                }
1742
-                return $payment_successful;
1743
-        }
1744
-    }
1745
-
1746
-
1747
-    /**
1748
-     * _redirect_because_event_sold_out
1749
-     *
1750
-     * @access protected
1751
-     * @return void
1752
-     */
1753
-    protected function _redirect_because_event_sold_out()
1754
-    {
1755
-        $this->checkout->continue_reg = false;
1756
-        // set redirect URL
1757
-        $this->checkout->redirect_url = add_query_arg(
1758
-            array('e_reg_url_link' => $this->checkout->reg_url_link),
1759
-            $this->checkout->current_step->reg_step_url()
1760
-        );
1761
-        $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
1762
-    }
1763
-
1764
-
1765
-    /**
1766
-     * _maybe_set_completed
1767
-     *
1768
-     * @access protected
1769
-     * @param \EE_Payment_Method $payment_method
1770
-     * @return void
1771
-     * @throws \EE_Error
1772
-     */
1773
-    protected function _maybe_set_completed(EE_Payment_Method $payment_method)
1774
-    {
1775
-        switch ($payment_method->type_obj()->payment_occurs()) {
1776
-            case EE_PMT_Base::offsite:
1777
-                break;
1778
-            case EE_PMT_Base::onsite:
1779
-            case EE_PMT_Base::offline:
1780
-                // mark this reg step as completed
1781
-                $this->set_completed();
1782
-                break;
1783
-        }
1784
-    }
1785
-
1786
-
1787
-    /**
1788
-     *    update_reg_step
1789
-     *    this is the final step after a user  revisits the site to retry a payment
1790
-     *
1791
-     * @return bool
1792
-     * @throws EE_Error
1793
-     * @throws InvalidArgumentException
1794
-     * @throws ReflectionException
1795
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
1796
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1797
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1798
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
1799
-     */
1800
-    public function update_reg_step()
1801
-    {
1802
-        $success = true;
1803
-        // if payment required
1804
-        if ($this->checkout->transaction->total() > 0) {
1805
-            do_action(
1806
-                'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
1807
-                $this->checkout->transaction
1808
-            );
1809
-            // attempt payment via payment method
1810
-            $success = $this->process_reg_step();
1811
-        }
1812
-        if ($success && ! $this->checkout->redirect) {
1813
-            $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
1814
-                $this->checkout->transaction->ID()
1815
-            );
1816
-            // set return URL
1817
-            $this->checkout->redirect_url = add_query_arg(
1818
-                array('e_reg_url_link' => $this->checkout->reg_url_link),
1819
-                $this->checkout->thank_you_page_url
1820
-            );
1821
-        }
1822
-        return $success;
1823
-    }
1824
-
1825
-
1826
-    /**
1827
-     *    _process_payment
1828
-     *
1829
-     * @access private
1830
-     * @return bool
1831
-     * @throws EE_Error
1832
-     * @throws InvalidArgumentException
1833
-     * @throws ReflectionException
1834
-     * @throws RuntimeException
1835
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1836
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1837
-     */
1838
-    private function _process_payment()
1839
-    {
1840
-        // basically confirm that the event hasn't sold out since they hit the page
1841
-        if (! $this->_last_second_ticket_verifications()) {
1842
-            return false;
1843
-        }
1844
-        // ya gotta make a choice man
1845
-        if (empty($this->checkout->selected_method_of_payment)) {
1846
-            $this->checkout->json_response->set_plz_select_method_of_payment(
1847
-                esc_html__('Please select a method of payment before proceeding.', 'event_espresso')
1848
-            );
1849
-            return false;
1850
-        }
1851
-        // get EE_Payment_Method object
1852
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
1853
-            return false;
1854
-        }
1855
-        // setup billing form
1856
-        if ($this->checkout->payment_method->is_on_site()) {
1857
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1858
-                $this->checkout->payment_method
1859
-            );
1860
-            // bad billing form ?
1861
-            if (! $this->_billing_form_is_valid()) {
1862
-                return false;
1863
-            }
1864
-        }
1865
-        // ensure primary registrant has been fully processed
1866
-        if (! $this->_setup_primary_registrant_prior_to_payment()) {
1867
-            return false;
1868
-        }
1869
-        // if session is close to expiring (under 10 minutes by default)
1870
-        if ((time() - EE_Registry::instance()->SSN->expiration()) < EE_Registry::instance()->SSN->extension()) {
1871
-            // add some time to session expiration so that payment can be completed
1872
-            EE_Registry::instance()->SSN->extend_expiration();
1873
-        }
1874
-        /** @type EE_Transaction_Processor $transaction_processor */
1875
-        // $transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
1876
-        // in case a registrant leaves to an Off-Site Gateway and never returns, we want to approve any registrations
1877
-        // for events with a default reg status of Approved
1878
-        // $transaction_processor->toggle_registration_statuses_for_default_approved_events(
1879
-        //      $this->checkout->transaction, $this->checkout->reg_cache_where_params
1880
-        // );
1881
-        // attempt payment
1882
-        $payment = $this->_attempt_payment($this->checkout->payment_method);
1883
-        // process results
1884
-        $payment = $this->_validate_payment($payment);
1885
-        $payment = $this->_post_payment_processing($payment);
1886
-        // verify payment
1887
-        if ($payment instanceof EE_Payment) {
1888
-            // store that for later
1889
-            $this->checkout->payment = $payment;
1890
-            // we can also consider the TXN to not have been failed, so temporarily upgrade it's status to abandoned
1891
-            $this->checkout->transaction->toggle_failed_transaction_status();
1892
-            $payment_status = $payment->status();
1893
-            if ($payment_status === EEM_Payment::status_id_approved
1894
-                || $payment_status === EEM_Payment::status_id_pending
1895
-            ) {
1896
-                return true;
1897
-            } else {
1898
-                return false;
1899
-            }
1900
-        } elseif ($payment === true) {
1901
-            // please note that offline payment methods will NOT make a payment,
1902
-            // but instead just mark themselves as the PMD_ID on the transaction, and return true
1903
-            $this->checkout->payment = $payment;
1904
-            return true;
1905
-        }
1906
-        // where's my money?
1907
-        return false;
1908
-    }
1909
-
1910
-
1911
-    /**
1912
-     * _last_second_ticket_verifications
1913
-     *
1914
-     * @access public
1915
-     * @return bool
1916
-     * @throws EE_Error
1917
-     */
1918
-    protected function _last_second_ticket_verifications()
1919
-    {
1920
-        // don't bother re-validating if not a return visit
1921
-        if (! $this->checkout->revisit) {
1922
-            return true;
1923
-        }
1924
-        $registrations = $this->checkout->transaction->registrations();
1925
-        if (empty($registrations)) {
1926
-            return false;
1927
-        }
1928
-        foreach ($registrations as $registration) {
1929
-            if ($registration instanceof EE_Registration && ! $registration->is_approved()) {
1930
-                $event = $registration->event_obj();
1931
-                if ($event instanceof EE_Event && $event->is_sold_out(true)) {
1932
-                    EE_Error::add_error(
1933
-                        apply_filters(
1934
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___last_second_ticket_verifications__sold_out_events_msg',
1935
-                            sprintf(
1936
-                                esc_html__(
1937
-                                    '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.',
1938
-                                    'event_espresso'
1939
-                                ),
1940
-                                $event->name()
1941
-                            )
1942
-                        ),
1943
-                        __FILE__,
1944
-                        __FUNCTION__,
1945
-                        __LINE__
1946
-                    );
1947
-                    return false;
1948
-                }
1949
-            }
1950
-        }
1951
-        return true;
1952
-    }
1953
-
1954
-
1955
-    /**
1956
-     * redirect_form
1957
-     *
1958
-     * @access public
1959
-     * @return bool
1960
-     * @throws EE_Error
1961
-     * @throws InvalidArgumentException
1962
-     * @throws ReflectionException
1963
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1964
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1965
-     */
1966
-    public function redirect_form()
1967
-    {
1968
-        $payment_method_billing_info = $this->_payment_method_billing_info(
1969
-            $this->_get_payment_method_for_selected_method_of_payment()
1970
-        );
1971
-        $html = $payment_method_billing_info->get_html();
1972
-        $html .= $this->checkout->redirect_form;
1973
-        EE_Registry::instance()->REQ->add_output($html);
1974
-        return true;
1975
-    }
1976
-
1977
-
1978
-    /**
1979
-     * _billing_form_is_valid
1980
-     *
1981
-     * @access private
1982
-     * @return bool
1983
-     * @throws \EE_Error
1984
-     */
1985
-    private function _billing_form_is_valid()
1986
-    {
1987
-        if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
1988
-            return true;
1989
-        }
1990
-        if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
1991
-            if ($this->checkout->billing_form->was_submitted()) {
1992
-                $this->checkout->billing_form->receive_form_submission();
1993
-                if ($this->checkout->billing_form->is_valid()) {
1994
-                    return true;
1995
-                }
1996
-                $validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
1997
-                $error_strings = array();
1998
-                foreach ($validation_errors as $validation_error) {
1999
-                    if ($validation_error instanceof EE_Validation_Error) {
2000
-                        $form_section = $validation_error->get_form_section();
2001
-                        if ($form_section instanceof EE_Form_Input_Base) {
2002
-                            $label = $form_section->html_label_text();
2003
-                        } elseif ($form_section instanceof EE_Form_Section_Base) {
2004
-                            $label = $form_section->name();
2005
-                        } else {
2006
-                            $label = esc_html__('Validation Error', 'event_espresso');
2007
-                        }
2008
-                        $error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
2009
-                    }
2010
-                }
2011
-                EE_Error::add_error(
2012
-                    sprintf(
2013
-                        esc_html__(
2014
-                            'One or more billing form inputs are invalid and require correction before proceeding. %1$s %2$s',
2015
-                            'event_espresso'
2016
-                        ),
2017
-                        '<br/>',
2018
-                        implode('<br/>', $error_strings)
2019
-                    ),
2020
-                    __FILE__,
2021
-                    __FUNCTION__,
2022
-                    __LINE__
2023
-                );
2024
-            } else {
2025
-                EE_Error::add_error(
2026
-                    esc_html__(
2027
-                        'The billing form was not submitted or something prevented it\'s submission.',
2028
-                        'event_espresso'
2029
-                    ),
2030
-                    __FILE__,
2031
-                    __FUNCTION__,
2032
-                    __LINE__
2033
-                );
2034
-            }
2035
-        } else {
2036
-            EE_Error::add_error(
2037
-                esc_html__(
2038
-                    'The submitted billing form is invalid possibly due to a technical reason.',
2039
-                    'event_espresso'
2040
-                ),
2041
-                __FILE__,
2042
-                __FUNCTION__,
2043
-                __LINE__
2044
-            );
2045
-        }
2046
-        return false;
2047
-    }
2048
-
2049
-
2050
-    /**
2051
-     * _setup_primary_registrant_prior_to_payment
2052
-     * ensures that the primary registrant has a valid attendee object created with the critical details populated
2053
-     * (first & last name & email) and that both the transaction object and primary registration object have been saved
2054
-     * plz note that any other registrations will NOT be saved at this point (because they may not have any details
2055
-     * yet)
2056
-     *
2057
-     * @access private
2058
-     * @return bool
2059
-     * @throws EE_Error
2060
-     * @throws InvalidArgumentException
2061
-     * @throws ReflectionException
2062
-     * @throws RuntimeException
2063
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2064
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2065
-     */
2066
-    private function _setup_primary_registrant_prior_to_payment()
2067
-    {
2068
-        // check if transaction has a primary registrant and that it has a related Attendee object
2069
-        // if not, then we need to at least gather some primary registrant data before attempting payment
2070
-        if ($this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
2071
-            && ! $this->checkout->transaction_has_primary_registrant()
2072
-            && ! $this->_capture_primary_registration_data_from_billing_form()
2073
-        ) {
2074
-            return false;
2075
-        }
2076
-        // because saving an object clears it's cache, we need to do the chevy shuffle
2077
-        // grab the primary_registration object
2078
-        $primary_registration = $this->checkout->transaction->primary_registration();
2079
-        // at this point we'll consider a TXN to not have been failed
2080
-        $this->checkout->transaction->toggle_failed_transaction_status();
2081
-        // save the TXN ( which clears cached copy of primary_registration)
2082
-        $this->checkout->transaction->save();
2083
-        // grab TXN ID and save it to the primary_registration
2084
-        $primary_registration->set_transaction_id($this->checkout->transaction->ID());
2085
-        // save what we have so far
2086
-        $primary_registration->save();
2087
-        return true;
2088
-    }
2089
-
2090
-
2091
-    /**
2092
-     * _capture_primary_registration_data_from_billing_form
2093
-     *
2094
-     * @access private
2095
-     * @return bool
2096
-     * @throws EE_Error
2097
-     * @throws InvalidArgumentException
2098
-     * @throws ReflectionException
2099
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2100
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2101
-     */
2102
-    private function _capture_primary_registration_data_from_billing_form()
2103
-    {
2104
-        // convert billing form data into an attendee
2105
-        $this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
2106
-        if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
2107
-            EE_Error::add_error(
2108
-                sprintf(
2109
-                    esc_html__(
2110
-                        'The billing form details could not be used for attendee details due to a technical issue.%sPlease try again or contact %s for assistance.',
2111
-                        'event_espresso'
2112
-                    ),
2113
-                    '<br/>',
2114
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2115
-                ),
2116
-                __FILE__,
2117
-                __FUNCTION__,
2118
-                __LINE__
2119
-            );
2120
-            return false;
2121
-        }
2122
-        $primary_registration = $this->checkout->transaction->primary_registration();
2123
-        if (! $primary_registration instanceof EE_Registration) {
2124
-            EE_Error::add_error(
2125
-                sprintf(
2126
-                    esc_html__(
2127
-                        'The primary registrant for this transaction could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
2128
-                        'event_espresso'
2129
-                    ),
2130
-                    '<br/>',
2131
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2132
-                ),
2133
-                __FILE__,
2134
-                __FUNCTION__,
2135
-                __LINE__
2136
-            );
2137
-            return false;
2138
-        }
2139
-        if (! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
2140
-              instanceof
2141
-              EE_Attendee
2142
-        ) {
2143
-            EE_Error::add_error(
2144
-                sprintf(
2145
-                    esc_html__(
2146
-                        'The primary registrant could not be associated with this transaction due to a technical issue.%sPlease try again or contact %s for assistance.',
2147
-                        'event_espresso'
2148
-                    ),
2149
-                    '<br/>',
2150
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2151
-                ),
2152
-                __FILE__,
2153
-                __FUNCTION__,
2154
-                __LINE__
2155
-            );
2156
-            return false;
2157
-        }
2158
-        /** @type EE_Registration_Processor $registration_processor */
2159
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
2160
-        // at this point, we should have enough details about the registrant to consider the registration NOT incomplete
2161
-        $registration_processor->toggle_incomplete_registration_status_to_default($primary_registration);
2162
-        return true;
2163
-    }
2164
-
2165
-
2166
-    /**
2167
-     * _get_payment_method_for_selected_method_of_payment
2168
-     * retrieves a valid payment method
2169
-     *
2170
-     * @access public
2171
-     * @return EE_Payment_Method
2172
-     * @throws EE_Error
2173
-     * @throws InvalidArgumentException
2174
-     * @throws ReflectionException
2175
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2176
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2177
-     */
2178
-    private function _get_payment_method_for_selected_method_of_payment()
2179
-    {
2180
-        if ($this->checkout->selected_method_of_payment === 'events_sold_out') {
2181
-            $this->_redirect_because_event_sold_out();
2182
-            return null;
2183
-        }
2184
-        // get EE_Payment_Method object
2185
-        if (isset($this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ])) {
2186
-            $payment_method = $this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ];
2187
-        } else {
2188
-            // load EEM_Payment_Method
2189
-            EE_Registry::instance()->load_model('Payment_Method');
2190
-            /** @type EEM_Payment_Method $EEM_Payment_Method */
2191
-            $EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
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 \EventEspresso\core\exceptions\InvalidDataTypeException
2244
-     * @throws \EventEspresso\core\exceptions\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
-     * @access protected
2279
-     * @param \Exception $e
2280
-     * @return void
2281
-     * @throws EE_Error
2282
-     * @throws InvalidArgumentException
2283
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2284
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2285
-     */
2286
-    protected function _handle_payment_processor_exception(Exception $e)
2287
-    {
2288
-        EE_Error::add_error(
2289
-            sprintf(
2290
-                esc_html__(
2291
-                    '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',
2292
-                    'event_espresso'
2293
-                ),
2294
-                '<br/>',
2295
-                EE_Registry::instance()->CFG->organization->get_pretty('email'),
2296
-                $e->getMessage(),
2297
-                $e->getFile(),
2298
-                $e->getLine()
2299
-            ),
2300
-            __FILE__,
2301
-            __FUNCTION__,
2302
-            __LINE__
2303
-        );
2304
-    }
2305
-
2306
-
2307
-    /**
2308
-     * _get_return_url
2309
-     *
2310
-     * @access protected
2311
-     * @param \EE_Payment_Method $payment_method
2312
-     * @return string
2313
-     * @throws \EE_Error
2314
-     */
2315
-    protected function _get_return_url(EE_Payment_Method $payment_method)
2316
-    {
2317
-        $return_url = '';
2318
-        switch ($payment_method->type_obj()->payment_occurs()) {
2319
-            case EE_PMT_Base::offsite:
2320
-                $return_url = add_query_arg(
2321
-                    array(
2322
-                        'action'                     => 'process_gateway_response',
2323
-                        'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
2324
-                        'spco_txn'                   => $this->checkout->transaction->ID(),
2325
-                    ),
2326
-                    $this->reg_step_url()
2327
-                );
2328
-                break;
2329
-            case EE_PMT_Base::onsite:
2330
-            case EE_PMT_Base::offline:
2331
-                $return_url = $this->checkout->next_step->reg_step_url();
2332
-                break;
2333
-        }
2334
-        return $return_url;
2335
-    }
2336
-
2337
-
2338
-    /**
2339
-     * _validate_payment
2340
-     *
2341
-     * @access private
2342
-     * @param EE_Payment $payment
2343
-     * @return EE_Payment|FALSE
2344
-     * @throws EE_Error
2345
-     * @throws InvalidArgumentException
2346
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2347
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2348
-     */
2349
-    private function _validate_payment($payment = null)
2350
-    {
2351
-        if ($this->checkout->payment_method->is_off_line()) {
2352
-            return true;
2353
-        }
2354
-        // verify payment object
2355
-        if (! $payment instanceof EE_Payment) {
2356
-            // not a payment
2357
-            EE_Error::add_error(
2358
-                sprintf(
2359
-                    esc_html__(
2360
-                        'A valid payment was not generated due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
2361
-                        'event_espresso'
2362
-                    ),
2363
-                    '<br/>',
2364
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2365
-                ),
2366
-                __FILE__,
2367
-                __FUNCTION__,
2368
-                __LINE__
2369
-            );
2370
-            return false;
2371
-        }
2372
-        return $payment;
2373
-    }
2374
-
2375
-
2376
-    /**
2377
-     * _post_payment_processing
2378
-     *
2379
-     * @access private
2380
-     * @param EE_Payment|bool $payment
2381
-     * @return bool
2382
-     * @throws EE_Error
2383
-     * @throws InvalidArgumentException
2384
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2385
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2386
-     */
2387
-    private function _post_payment_processing($payment = null)
2388
-    {
2389
-        // Off-Line payment?
2390
-        if ($payment === true) {
2391
-            // $this->_setup_redirect_for_next_step();
2392
-            return true;
2393
-            // On-Site payment?
2394
-        } elseif ($this->checkout->payment_method->is_on_site()) {
2395
-            if (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
2396
-                // $this->_setup_redirect_for_next_step();
2397
-                $this->checkout->continue_reg = false;
2398
-            }
2399
-            // Off-Site payment?
2400
-        } elseif ($this->checkout->payment_method->is_off_site()) {
2401
-            // if a payment object was made and it specifies a redirect url, then we'll setup that redirect info
2402
-            if ($payment instanceof EE_Payment && $payment->redirect_url()) {
2403
-                do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()');
2404
-                $this->checkout->redirect = true;
2405
-                $this->checkout->redirect_form = $payment->redirect_form();
2406
-                $this->checkout->redirect_url = $this->reg_step_url('redirect_form');
2407
-                // set JSON response
2408
-                $this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
2409
-                // and lastly, let's bump the payment status to pending
2410
-                $payment->set_status(EEM_Payment::status_id_pending);
2411
-                $payment->save();
2412
-            } else {
2413
-                // not a payment
2414
-                $this->checkout->continue_reg = false;
2415
-                EE_Error::add_error(
2416
-                    sprintf(
2417
-                        esc_html__(
2418
-                            'It appears the Off Site Payment Method was not configured properly.%sPlease try again or contact %s for assistance.',
2419
-                            'event_espresso'
2420
-                        ),
2421
-                        '<br/>',
2422
-                        EE_Registry::instance()->CFG->organization->get_pretty('email')
2423
-                    ),
2424
-                    __FILE__,
2425
-                    __FUNCTION__,
2426
-                    __LINE__
2427
-                );
2428
-            }
2429
-        } else {
2430
-            // ummm ya... not Off-Line, not On-Site, not off-Site ????
2431
-            $this->checkout->continue_reg = false;
2432
-            return false;
2433
-        }
2434
-        return $payment;
2435
-    }
2436
-
2437
-
2438
-    /**
2439
-     *    _process_payment_status
2440
-     *
2441
-     * @access private
2442
-     * @type    EE_Payment $payment
2443
-     * @param string       $payment_occurs
2444
-     * @return bool
2445
-     * @throws EE_Error
2446
-     * @throws InvalidArgumentException
2447
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2448
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2449
-     */
2450
-    private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline)
2451
-    {
2452
-        // off-line payment? carry on
2453
-        if ($payment_occurs === EE_PMT_Base::offline) {
2454
-            return true;
2455
-        }
2456
-        // verify payment validity
2457
-        if ($payment instanceof EE_Payment) {
2458
-            do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()');
2459
-            $msg = $payment->gateway_response();
2460
-            // check results
2461
-            switch ($payment->status()) {
2462
-                // good payment
2463
-                case EEM_Payment::status_id_approved:
2464
-                    EE_Error::add_success(
2465
-                        esc_html__('Your payment was processed successfully.', 'event_espresso'),
2466
-                        __FILE__,
2467
-                        __FUNCTION__,
2468
-                        __LINE__
2469
-                    );
2470
-                    return true;
2471
-                    break;
2472
-                // slow payment
2473
-                case EEM_Payment::status_id_pending:
2474
-                    if (empty($msg)) {
2475
-                        $msg = esc_html__(
2476
-                            'Your payment appears to have been processed successfully, but the Instant Payment Notification has not yet been received. It should arrive shortly.',
2477
-                            'event_espresso'
2478
-                        );
2479
-                    }
2480
-                    EE_Error::add_success($msg, __FILE__, __FUNCTION__, __LINE__);
2481
-                    return true;
2482
-                    break;
2483
-                // don't wanna payment
2484
-                case EEM_Payment::status_id_cancelled:
2485
-                    if (empty($msg)) {
2486
-                        $msg = _n(
2487
-                            'Payment cancelled. Please try again.',
2488
-                            'Payment cancelled. Please try again or select another method of payment.',
2489
-                            count($this->checkout->available_payment_methods),
2490
-                            'event_espresso'
2491
-                        );
2492
-                    }
2493
-                    EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
2494
-                    return false;
2495
-                    break;
2496
-                // not enough payment
2497
-                case EEM_Payment::status_id_declined:
2498
-                    if (empty($msg)) {
2499
-                        $msg = _n(
2500
-                            'We\'re sorry but your payment was declined. Please try again.',
2501
-                            'We\'re sorry but your payment was declined. Please try again or select another method of payment.',
2502
-                            count($this->checkout->available_payment_methods),
2503
-                            'event_espresso'
2504
-                        );
2505
-                    }
2506
-                    EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
2507
-                    return false;
2508
-                    break;
2509
-                // bad payment
2510
-                case EEM_Payment::status_id_failed:
2511
-                    if (! empty($msg)) {
2512
-                        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2513
-                        return false;
2514
-                    }
2515
-                    // default to error below
2516
-                    break;
2517
-            }
2518
-        }
2519
-        // off-site payment gateway responses are too unreliable, so let's just assume that
2520
-        // the payment processing is just running slower than the registrant's request
2521
-        if ($payment_occurs === EE_PMT_Base::offsite) {
2522
-            return true;
2523
-        }
2524
-        EE_Error::add_error(
2525
-            sprintf(
2526
-                esc_html__(
2527
-                    'Your payment could not be processed successfully due to a technical issue.%sPlease try again or contact %s for assistance.',
2528
-                    'event_espresso'
2529
-                ),
2530
-                '<br/>',
2531
-                EE_Registry::instance()->CFG->organization->get_pretty('email')
2532
-            ),
2533
-            __FILE__,
2534
-            __FUNCTION__,
2535
-            __LINE__
2536
-        );
2537
-        return false;
2538
-    }
2539
-
2540
-
2541
-
2542
-
2543
-
2544
-
2545
-    /********************************************************************************************************/
2546
-    /**********************************  PROCESS GATEWAY RESPONSE  **********************************/
2547
-    /********************************************************************************************************/
2548
-    /**
2549
-     * process_gateway_response
2550
-     * this is the return point for Off-Site Payment Methods
2551
-     * It will attempt to "handle the IPN" if it appears that this has not already occurred,
2552
-     * otherwise, it will load up the last payment made for the TXN.
2553
-     * If the payment retrieved looks good, it will then either:
2554
-     *    complete the current step and allow advancement to the next reg step
2555
-     *        or present the payment options again
2556
-     *
2557
-     * @access private
2558
-     * @return EE_Payment|FALSE
2559
-     * @throws EE_Error
2560
-     * @throws InvalidArgumentException
2561
-     * @throws ReflectionException
2562
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2563
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2564
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
2565
-     */
2566
-    public function process_gateway_response()
2567
-    {
2568
-        $payment = null;
2569
-        // how have they chosen to pay?
2570
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
2571
-        // get EE_Payment_Method object
2572
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
2573
-            $this->checkout->continue_reg = false;
2574
-            return false;
2575
-        }
2576
-        if (! $this->checkout->payment_method->is_off_site()) {
2577
-            return false;
2578
-        }
2579
-        $this->_validate_offsite_return();
2580
-        // DEBUG LOG
2581
-        // $this->checkout->log(
2582
-        //     __CLASS__,
2583
-        //     __FUNCTION__,
2584
-        //     __LINE__,
2585
-        //     array(
2586
-        //         'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
2587
-        //         'payment_method'             => $this->checkout->payment_method,
2588
-        //     ),
2589
-        //     true
2590
-        // );
2591
-        // verify TXN
2592
-        if ($this->checkout->transaction instanceof EE_Transaction) {
2593
-            $gateway = $this->checkout->payment_method->type_obj()->get_gateway();
2594
-            if (! $gateway instanceof EE_Offsite_Gateway) {
2595
-                $this->checkout->continue_reg = false;
2596
-                return false;
2597
-            }
2598
-            $payment = $this->_process_off_site_payment($gateway);
2599
-            $payment = $this->_process_cancelled_payments($payment);
2600
-            $payment = $this->_validate_payment($payment);
2601
-            // if payment was not declined by the payment gateway or cancelled by the registrant
2602
-            if ($this->_process_payment_status($payment, EE_PMT_Base::offsite)) {
2603
-                // $this->_setup_redirect_for_next_step();
2604
-                // store that for later
2605
-                $this->checkout->payment = $payment;
2606
-                // mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
2607
-                // because we will complete this step during the IPN processing then
2608
-                if ($gateway instanceof EE_Offsite_Gateway && ! $this->handle_IPN_in_this_request()) {
2609
-                    $this->set_completed();
2610
-                }
2611
-                return true;
2612
-            }
2613
-        }
2614
-        // DEBUG LOG
2615
-        // $this->checkout->log(
2616
-        //     __CLASS__,
2617
-        //     __FUNCTION__,
2618
-        //     __LINE__,
2619
-        //     array('payment' => $payment)
2620
-        // );
2621
-        $this->checkout->continue_reg = false;
2622
-        return false;
2623
-    }
2624
-
2625
-
2626
-    /**
2627
-     * _validate_return
2628
-     *
2629
-     * @access private
2630
-     * @return void
2631
-     * @throws EE_Error
2632
-     * @throws InvalidArgumentException
2633
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2634
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2635
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
2636
-     */
2637
-    private function _validate_offsite_return()
2638
-    {
2639
-        $TXN_ID = (int) EE_Registry::instance()->REQ->get('spco_txn', 0);
2640
-        if ($TXN_ID !== $this->checkout->transaction->ID()) {
2641
-            // Houston... we might have a problem
2642
-            $invalid_TXN = false;
2643
-            // first gather some info
2644
-            $valid_TXN = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
2645
-            $primary_registrant = $valid_TXN instanceof EE_Transaction
2646
-                ? $valid_TXN->primary_registration()
2647
-                : null;
2648
-            // let's start by retrieving the cart for this TXN
2649
-            $cart = $this->checkout->get_cart_for_transaction($this->checkout->transaction);
2650
-            if ($cart instanceof EE_Cart) {
2651
-                // verify that the current cart has tickets
2652
-                $tickets = $cart->get_tickets();
2653
-                if (empty($tickets)) {
2654
-                    $invalid_TXN = true;
2655
-                }
2656
-            } else {
2657
-                $invalid_TXN = true;
2658
-            }
2659
-            $valid_TXN_SID = $primary_registrant instanceof EE_Registration
2660
-                ? $primary_registrant->session_ID()
2661
-                : null;
2662
-            // validate current Session ID and compare against valid TXN session ID
2663
-            if ($invalid_TXN // if this is already true, then skip other checks
2664
-                || EE_Session::instance()->id() === null
2665
-                || (
2666
-                    // WARNING !!!
2667
-                    // this could be PayPal sending back duplicate requests (ya they do that)
2668
-                    // or it **could** mean someone is simply registering AGAIN after having just done so
2669
-                    // so now we need to determine if this current TXN looks valid or not
2670
-                    // and whether this reg step has even been started ?
2671
-                    EE_Session::instance()->id() === $valid_TXN_SID
2672
-                    // really? you're half way through this reg step, but you never started it ?
2673
-                    && $this->checkout->transaction->reg_step_completed($this->slug()) === false
2674
-                )
2675
-            ) {
2676
-                $invalid_TXN = true;
2677
-            }
2678
-            if ($invalid_TXN) {
2679
-                // is the valid TXN completed ?
2680
-                if ($valid_TXN instanceof EE_Transaction) {
2681
-                    // has this step even been started ?
2682
-                    $reg_step_completed = $valid_TXN->reg_step_completed($this->slug());
2683
-                    if ($reg_step_completed !== false && $reg_step_completed !== true) {
2684
-                        // so it **looks** like this is a double request from PayPal
2685
-                        // so let's try to pick up where we left off
2686
-                        $this->checkout->transaction = $valid_TXN;
2687
-                        $this->checkout->refresh_all_entities(true);
2688
-                        return;
2689
-                    }
2690
-                }
2691
-                // you appear to be lost?
2692
-                $this->_redirect_wayward_request($primary_registrant);
2693
-            }
2694
-        }
2695
-    }
2696
-
2697
-
2698
-    /**
2699
-     * _redirect_wayward_request
2700
-     *
2701
-     * @access private
2702
-     * @param \EE_Registration|null $primary_registrant
2703
-     * @return bool
2704
-     * @throws EE_Error
2705
-     * @throws InvalidArgumentException
2706
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2707
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2708
-     */
2709
-    private function _redirect_wayward_request(EE_Registration $primary_registrant)
2710
-    {
2711
-        if (! $primary_registrant instanceof EE_Registration) {
2712
-            // try redirecting based on the current TXN
2713
-            $primary_registrant = $this->checkout->transaction instanceof EE_Transaction
2714
-                ? $this->checkout->transaction->primary_registration()
2715
-                : null;
2716
-        }
2717
-        if (! $primary_registrant instanceof EE_Registration) {
2718
-            EE_Error::add_error(
2719
-                sprintf(
2720
-                    esc_html__(
2721
-                        '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.',
2722
-                        'event_espresso'
2723
-                    ),
2724
-                    '<br/>',
2725
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2726
-                ),
2727
-                __FILE__,
2728
-                __FUNCTION__,
2729
-                __LINE__
2730
-            );
2731
-            return false;
2732
-        }
2733
-        // make sure transaction is not locked
2734
-        $this->checkout->transaction->unlock();
2735
-        wp_safe_redirect(
2736
-            add_query_arg(
2737
-                array(
2738
-                    'e_reg_url_link' => $primary_registrant->reg_url_link(),
2739
-                ),
2740
-                $this->checkout->thank_you_page_url
2741
-            )
2742
-        );
2743
-        exit();
2744
-    }
2745
-
2746
-
2747
-    /**
2748
-     * _process_off_site_payment
2749
-     *
2750
-     * @access private
2751
-     * @param \EE_Offsite_Gateway $gateway
2752
-     * @return EE_Payment
2753
-     * @throws EE_Error
2754
-     * @throws InvalidArgumentException
2755
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2756
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2757
-     */
2758
-    private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
2759
-    {
2760
-        try {
2761
-            $request_data = \EE_Registry::instance()->REQ->params();
2762
-            // if gateway uses_separate_IPN_request, then we don't have to process the IPN manually
2763
-            $this->set_handle_IPN_in_this_request(
2764
-                $gateway->handle_IPN_in_this_request($request_data, false)
2765
-            );
2766
-            if ($this->handle_IPN_in_this_request()) {
2767
-                // get payment details and process results
2768
-                /** @type EE_Payment_Processor $payment_processor */
2769
-                $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
2770
-                $payment = $payment_processor->process_ipn(
2771
-                    $request_data,
2772
-                    $this->checkout->transaction,
2773
-                    $this->checkout->payment_method,
2774
-                    true,
2775
-                    false
2776
-                );
2777
-                // $payment_source = 'process_ipn';
2778
-            } else {
2779
-                $payment = $this->checkout->transaction->last_payment();
2780
-                // $payment_source = 'last_payment';
2781
-            }
2782
-        } catch (Exception $e) {
2783
-            // let's just eat the exception and try to move on using any previously set payment info
2784
-            $payment = $this->checkout->transaction->last_payment();
2785
-            // $payment_source = 'last_payment after Exception';
2786
-            // but if we STILL don't have a payment object
2787
-            if (! $payment instanceof EE_Payment) {
2788
-                // then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
2789
-                $this->_handle_payment_processor_exception($e);
2790
-            }
2791
-        }
2792
-        // DEBUG LOG
2793
-        // $this->checkout->log(
2794
-        //     __CLASS__,
2795
-        //     __FUNCTION__,
2796
-        //     __LINE__,
2797
-        //     array(
2798
-        //         'process_ipn_payment' => $payment,
2799
-        //         'payment_source'      => $payment_source,
2800
-        //     )
2801
-        // );
2802
-        return $payment;
2803
-    }
2804
-
2805
-
2806
-    /**
2807
-     * _process_cancelled_payments
2808
-     * just makes sure that the payment status gets updated correctly
2809
-     * so tha tan error isn't generated during payment validation
2810
-     *
2811
-     * @access private
2812
-     * @param EE_Payment $payment
2813
-     * @return EE_Payment | FALSE
2814
-     * @throws \EE_Error
2815
-     */
2816
-    private function _process_cancelled_payments($payment = null)
2817
-    {
2818
-        if ($payment instanceof EE_Payment
2819
-            && isset($_REQUEST['ee_cancel_payment'])
2820
-            && $payment->status() === EEM_Payment::status_id_failed
2821
-        ) {
2822
-            $payment->set_status(EEM_Payment::status_id_cancelled);
2823
-        }
2824
-        return $payment;
2825
-    }
2826
-
2827
-
2828
-    /**
2829
-     *    get_transaction_details_for_gateways
2830
-     *
2831
-     * @access    public
2832
-     * @return int
2833
-     * @throws EE_Error
2834
-     * @throws InvalidArgumentException
2835
-     * @throws ReflectionException
2836
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2837
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2838
-     */
2839
-    public function get_transaction_details_for_gateways()
2840
-    {
2841
-        $txn_details = array();
2842
-        // ya gotta make a choice man
2843
-        if (empty($this->checkout->selected_method_of_payment)) {
2844
-            $txn_details = array(
2845
-                'error' => esc_html__('Please select a method of payment before proceeding.', 'event_espresso'),
2846
-            );
2847
-        }
2848
-        // get EE_Payment_Method object
2849
-        if (empty($txn_details)
2850
-            &&
2851
-            ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
2852
-        ) {
2853
-            $txn_details = array(
2854
-                'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
2855
-                'error'                      => esc_html__(
2856
-                    'A valid Payment Method could not be determined.',
2857
-                    'event_espresso'
2858
-                ),
2859
-            );
2860
-        }
2861
-        if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
2862
-            $return_url = $this->_get_return_url($this->checkout->payment_method);
2863
-            $txn_details = array(
2864
-                'TXN_ID'         => $this->checkout->transaction->ID(),
2865
-                'TXN_timestamp'  => $this->checkout->transaction->datetime(),
2866
-                'TXN_total'      => $this->checkout->transaction->total(),
2867
-                'TXN_paid'       => $this->checkout->transaction->paid(),
2868
-                'TXN_reg_steps'  => $this->checkout->transaction->reg_steps(),
2869
-                'STS_ID'         => $this->checkout->transaction->status_ID(),
2870
-                'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
2871
-                'payment_amount' => $this->checkout->amount_owing,
2872
-                'return_url'     => $return_url,
2873
-                'cancel_url'     => add_query_arg(array('ee_cancel_payment' => true), $return_url),
2874
-                'notify_url'     => EE_Config::instance()->core->txn_page_url(
2875
-                    array(
2876
-                        'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
2877
-                        'ee_payment_method' => $this->checkout->payment_method->slug(),
2878
-                    )
2879
-                ),
2880
-            );
2881
-        }
2882
-        echo wp_json_encode($txn_details);
2883
-        exit();
2884
-    }
2885
-
2886
-
2887
-    /**
2888
-     *    __sleep
2889
-     * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
2890
-     * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
2891
-     * reg form, because if needed, it will be regenerated anyways
2892
-     *
2893
-     * @return array
2894
-     */
2895
-    public function __sleep()
2896
-    {
2897
-        // remove the reg form and the checkout
2898
-        return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout', 'line_item_display'));
2899
-    }
15
+	/**
16
+	 * @access protected
17
+	 * @var EE_Line_Item_Display $Line_Item_Display
18
+	 */
19
+	protected $line_item_display;
20
+
21
+	/**
22
+	 * @access protected
23
+	 * @var boolean $handle_IPN_in_this_request
24
+	 */
25
+	protected $handle_IPN_in_this_request = false;
26
+
27
+
28
+	/**
29
+	 *    set_hooks - for hooking into EE Core, other modules, etc
30
+	 *
31
+	 * @access    public
32
+	 * @return    void
33
+	 */
34
+	public static function set_hooks()
35
+	{
36
+		add_filter(
37
+			'FHEE__SPCO__EE_Line_Item_Filter_Collection',
38
+			array('EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters')
39
+		);
40
+		add_action(
41
+			'wp_ajax_switch_spco_billing_form',
42
+			array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
43
+		);
44
+		add_action(
45
+			'wp_ajax_nopriv_switch_spco_billing_form',
46
+			array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
47
+		);
48
+		add_action('wp_ajax_save_payer_details', array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details'));
49
+		add_action(
50
+			'wp_ajax_nopriv_save_payer_details',
51
+			array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details')
52
+		);
53
+		add_action(
54
+			'wp_ajax_get_transaction_details_for_gateways',
55
+			array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
56
+		);
57
+		add_action(
58
+			'wp_ajax_nopriv_get_transaction_details_for_gateways',
59
+			array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
60
+		);
61
+		add_filter(
62
+			'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
63
+			array('EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'),
64
+			10,
65
+			1
66
+		);
67
+	}
68
+
69
+
70
+	/**
71
+	 *    ajax switch_spco_billing_form
72
+	 *
73
+	 * @throws \EE_Error
74
+	 */
75
+	public static function switch_spco_billing_form()
76
+	{
77
+		EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
78
+	}
79
+
80
+
81
+	/**
82
+	 *    ajax save_payer_details
83
+	 *
84
+	 * @throws \EE_Error
85
+	 */
86
+	public static function save_payer_details()
87
+	{
88
+		EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
89
+	}
90
+
91
+
92
+	/**
93
+	 *    ajax get_transaction_details
94
+	 *
95
+	 * @throws \EE_Error
96
+	 */
97
+	public static function get_transaction_details()
98
+	{
99
+		EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
100
+	}
101
+
102
+
103
+	/**
104
+	 * bypass_recaptcha_for_load_payment_method
105
+	 *
106
+	 * @access public
107
+	 * @return array
108
+	 * @throws InvalidArgumentException
109
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
110
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
111
+	 */
112
+	public static function bypass_recaptcha_for_load_payment_method()
113
+	{
114
+		return array(
115
+			'EESID'  => EE_Registry::instance()->SSN->id(),
116
+			'step'   => 'payment_options',
117
+			'action' => 'spco_billing_form',
118
+		);
119
+	}
120
+
121
+
122
+	/**
123
+	 *    class constructor
124
+	 *
125
+	 * @access    public
126
+	 * @param    EE_Checkout $checkout
127
+	 */
128
+	public function __construct(EE_Checkout $checkout)
129
+	{
130
+		$this->_slug = 'payment_options';
131
+		$this->_name = esc_html__('Payment Options', 'event_espresso');
132
+		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . '/payment_options_main.template.php';
133
+		$this->checkout = $checkout;
134
+		$this->_reset_success_message();
135
+		$this->set_instructions(
136
+			esc_html__(
137
+				'Please select a method of payment and provide any necessary billing information before proceeding.',
138
+				'event_espresso'
139
+			)
140
+		);
141
+	}
142
+
143
+
144
+	/**
145
+	 * @return null
146
+	 */
147
+	public function line_item_display()
148
+	{
149
+		return $this->line_item_display;
150
+	}
151
+
152
+
153
+	/**
154
+	 * @param null $line_item_display
155
+	 */
156
+	public function set_line_item_display($line_item_display)
157
+	{
158
+		$this->line_item_display = $line_item_display;
159
+	}
160
+
161
+
162
+	/**
163
+	 * @return boolean
164
+	 */
165
+	public function handle_IPN_in_this_request()
166
+	{
167
+		return $this->handle_IPN_in_this_request;
168
+	}
169
+
170
+
171
+	/**
172
+	 * @param boolean $handle_IPN_in_this_request
173
+	 */
174
+	public function set_handle_IPN_in_this_request($handle_IPN_in_this_request)
175
+	{
176
+		$this->handle_IPN_in_this_request = filter_var($handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN);
177
+	}
178
+
179
+
180
+	/**
181
+	 * translate_js_strings
182
+	 *
183
+	 * @return void
184
+	 */
185
+	public function translate_js_strings()
186
+	{
187
+		EE_Registry::$i18n_js_strings['no_payment_method'] = esc_html__(
188
+			'Please select a method of payment in order to continue.',
189
+			'event_espresso'
190
+		);
191
+		EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
192
+			'A valid method of payment could not be determined. Please refresh the page and try again.',
193
+			'event_espresso'
194
+		);
195
+		EE_Registry::$i18n_js_strings['forwarding_to_offsite'] = esc_html__(
196
+			'Forwarding to Secure Payment Provider.',
197
+			'event_espresso'
198
+		);
199
+	}
200
+
201
+
202
+	/**
203
+	 * enqueue_styles_and_scripts
204
+	 *
205
+	 * @return void
206
+	 * @throws EE_Error
207
+	 * @throws InvalidArgumentException
208
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
209
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
210
+	 */
211
+	public function enqueue_styles_and_scripts()
212
+	{
213
+		$transaction = $this->checkout->transaction;
214
+		// if the transaction isn't set or nothing is owed on it, don't enqueue any JS
215
+		if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
216
+			return;
217
+		}
218
+		foreach (EEM_Payment_Method::instance()->get_all_for_transaction(
219
+			$transaction,
220
+			EEM_Payment_Method::scope_cart
221
+		) as $payment_method) {
222
+			$type_obj = $payment_method->type_obj();
223
+			if ($type_obj instanceof EE_PMT_Base) {
224
+				$billing_form = $type_obj->generate_new_billing_form($transaction);
225
+				if ($billing_form instanceof EE_Form_Section_Proper) {
226
+					$billing_form->enqueue_js();
227
+				}
228
+			}
229
+		}
230
+	}
231
+
232
+
233
+	/**
234
+	 * initialize_reg_step
235
+	 *
236
+	 * @return bool
237
+	 * @throws EE_Error
238
+	 * @throws InvalidArgumentException
239
+	 * @throws ReflectionException
240
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
241
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
242
+	 */
243
+	public function initialize_reg_step()
244
+	{
245
+		// TODO: if /when we implement donations, then this will need overriding
246
+		if (// don't need payment options for:
247
+			// registrations made via the admin
248
+			// completed transactions
249
+			// overpaid transactions
250
+			// $ 0.00 transactions(no payment required)
251
+			! $this->checkout->payment_required()
252
+			// but do NOT remove if current action being called belongs to this reg step
253
+			&& ! is_callable(array($this, $this->checkout->action))
254
+			&& ! $this->completed()
255
+		) {
256
+			// and if so, then we no longer need the Payment Options step
257
+			if ($this->is_current_step()) {
258
+				$this->checkout->generate_reg_form = false;
259
+			}
260
+			$this->checkout->remove_reg_step($this->_slug);
261
+			// DEBUG LOG
262
+			// $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
263
+			return false;
264
+		}
265
+		// load EEM_Payment_Method
266
+		EE_Registry::instance()->load_model('Payment_Method');
267
+		// get all active payment methods
268
+		$this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
269
+			$this->checkout->transaction,
270
+			EEM_Payment_Method::scope_cart
271
+		);
272
+		return true;
273
+	}
274
+
275
+
276
+	/**
277
+	 * @return EE_Form_Section_Proper
278
+	 * @throws EE_Error
279
+	 * @throws InvalidArgumentException
280
+	 * @throws ReflectionException
281
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
282
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
283
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
284
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
285
+	 */
286
+	public function generate_reg_form()
287
+	{
288
+		// reset in case someone changes their mind
289
+		$this->_reset_selected_method_of_payment();
290
+		// set some defaults
291
+		$this->checkout->selected_method_of_payment = 'payments_closed';
292
+		$registrations_requiring_payment = array();
293
+		$registrations_for_free_events = array();
294
+		$registrations_requiring_pre_approval = array();
295
+		$sold_out_events = array();
296
+		$insufficient_spaces_available = array();
297
+		$no_payment_required = true;
298
+		// loop thru registrations to gather info
299
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
300
+		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
301
+			$registrations,
302
+			$this->checkout->revisit
303
+		);
304
+		foreach ($registrations as $REG_ID => $registration) {
305
+			/** @var $registration EE_Registration */
306
+			// has this registration lost it's space ?
307
+			if (isset($ejected_registrations[ $REG_ID ])) {
308
+				if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
309
+					$sold_out_events[ $registration->event()->ID() ] = $registration->event();
310
+				} else {
311
+					$insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
312
+				}
313
+				continue;
314
+			}
315
+			// event requires admin approval
316
+			if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
317
+				// add event to list of events with pre-approval reg status
318
+				$registrations_requiring_pre_approval[ $REG_ID ] = $registration;
319
+				do_action(
320
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
321
+					$registration->event(),
322
+					$this
323
+				);
324
+				continue;
325
+			}
326
+			if ($this->checkout->revisit
327
+				&& $registration->status_ID() !== EEM_Registration::status_id_approved
328
+				&& (
329
+					$registration->event()->is_sold_out()
330
+					|| $registration->event()->is_sold_out(true)
331
+				)
332
+			) {
333
+				// add event to list of events that are sold out
334
+				$sold_out_events[ $registration->event()->ID() ] = $registration->event();
335
+				do_action(
336
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
337
+					$registration->event(),
338
+					$this
339
+				);
340
+				continue;
341
+			}
342
+			// are they allowed to pay now and is there monies owing?
343
+			if ($registration->owes_monies_and_can_pay()) {
344
+				$registrations_requiring_payment[ $REG_ID ] = $registration;
345
+				do_action(
346
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
347
+					$registration->event(),
348
+					$this
349
+				);
350
+			} elseif (! $this->checkout->revisit
351
+					  && $registration->status_ID() !== EEM_Registration::status_id_not_approved
352
+					  && $registration->ticket()->is_free()
353
+			) {
354
+				$registrations_for_free_events[ $registration->ticket()->ID() ] = $registration;
355
+			}
356
+		}
357
+		$subsections = array();
358
+		// now decide which template to load
359
+		if (! empty($sold_out_events)) {
360
+			$subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
361
+		}
362
+		if (! empty($insufficient_spaces_available)) {
363
+			$subsections['insufficient_space'] = $this->_insufficient_spaces_available(
364
+				$insufficient_spaces_available
365
+			);
366
+		}
367
+		if (! empty($registrations_requiring_pre_approval)) {
368
+			$subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
369
+				$registrations_requiring_pre_approval
370
+			);
371
+		}
372
+		if (! empty($registrations_for_free_events)) {
373
+			$subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
374
+		}
375
+		if (! empty($registrations_requiring_payment)) {
376
+			if ($this->checkout->amount_owing > 0) {
377
+				// autoload Line_Item_Display classes
378
+				EEH_Autoloader::register_line_item_filter_autoloaders();
379
+				$line_item_filter_processor = new EE_Line_Item_Filter_Processor(
380
+					apply_filters(
381
+						'FHEE__SPCO__EE_Line_Item_Filter_Collection',
382
+						new EE_Line_Item_Filter_Collection()
383
+					),
384
+					$this->checkout->cart->get_grand_total()
385
+				);
386
+				/** @var EE_Line_Item $filtered_line_item_tree */
387
+				$filtered_line_item_tree = $line_item_filter_processor->process();
388
+				EEH_Autoloader::register_line_item_display_autoloaders();
389
+				$this->set_line_item_display(new EE_Line_Item_Display('spco'));
390
+				$subsections['payment_options'] = $this->_display_payment_options(
391
+					$this->line_item_display->display_line_item(
392
+						$filtered_line_item_tree,
393
+						array('registrations' => $registrations)
394
+					)
395
+				);
396
+				$this->checkout->amount_owing = $filtered_line_item_tree->total();
397
+				$this->_apply_registration_payments_to_amount_owing($registrations);
398
+			}
399
+			$no_payment_required = false;
400
+		} else {
401
+			$this->_hide_reg_step_submit_button_if_revisit();
402
+		}
403
+		$this->_save_selected_method_of_payment();
404
+
405
+		$subsections['default_hidden_inputs'] = $this->reg_step_hidden_inputs();
406
+		$subsections['extra_hidden_inputs'] = $this->_extra_hidden_inputs($no_payment_required);
407
+
408
+		return new EE_Form_Section_Proper(
409
+			array(
410
+				'name'            => $this->reg_form_name(),
411
+				'html_id'         => $this->reg_form_name(),
412
+				'subsections'     => $subsections,
413
+				'layout_strategy' => new EE_No_Layout(),
414
+			)
415
+		);
416
+	}
417
+
418
+
419
+	/**
420
+	 * add line item filters required for this reg step
421
+	 * these filters are applied via this line in EE_SPCO_Reg_Step_Payment_Options::set_hooks():
422
+	 *        add_filter( 'FHEE__SPCO__EE_Line_Item_Filter_Collection', array( 'EE_SPCO_Reg_Step_Payment_Options',
423
+	 *        'add_spco_line_item_filters' ) ); so any code that wants to use the same set of filters during the
424
+	 *        payment options reg step, can apply these filters via the following: apply_filters(
425
+	 *        'FHEE__SPCO__EE_Line_Item_Filter_Collection', new EE_Line_Item_Filter_Collection() ) or to an existing
426
+	 *        filter collection by passing that instead of instantiating a new collection
427
+	 *
428
+	 * @param \EE_Line_Item_Filter_Collection $line_item_filter_collection
429
+	 * @return EE_Line_Item_Filter_Collection
430
+	 * @throws EE_Error
431
+	 * @throws InvalidArgumentException
432
+	 * @throws ReflectionException
433
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
434
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
435
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
436
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
437
+	 */
438
+	public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
439
+	{
440
+		if (! EE_Registry::instance()->SSN instanceof EE_Session) {
441
+			return $line_item_filter_collection;
442
+		}
443
+		if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
444
+			return $line_item_filter_collection;
445
+		}
446
+		if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
447
+			return $line_item_filter_collection;
448
+		}
449
+		$line_item_filter_collection->add(
450
+			new EE_Billable_Line_Item_Filter(
451
+				EE_SPCO_Reg_Step_Payment_Options::remove_ejected_registrations(
452
+					EE_Registry::instance()->SSN->checkout()->transaction->registrations(
453
+						EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
454
+					)
455
+				)
456
+			)
457
+		);
458
+		$line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
459
+		return $line_item_filter_collection;
460
+	}
461
+
462
+
463
+	/**
464
+	 * remove_ejected_registrations
465
+	 * if a registrant has lost their potential space at an event due to lack of payment,
466
+	 * then this method removes them from the list of registrations being paid for during this request
467
+	 *
468
+	 * @param \EE_Registration[] $registrations
469
+	 * @return EE_Registration[]
470
+	 * @throws EE_Error
471
+	 * @throws InvalidArgumentException
472
+	 * @throws ReflectionException
473
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
474
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
475
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
476
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
477
+	 */
478
+	public static function remove_ejected_registrations(array $registrations)
479
+	{
480
+		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
481
+			$registrations,
482
+			EE_Registry::instance()->SSN->checkout()->revisit
483
+		);
484
+		foreach ($registrations as $REG_ID => $registration) {
485
+			// has this registration lost it's space ?
486
+			if (isset($ejected_registrations[ $REG_ID ])) {
487
+				unset($registrations[ $REG_ID ]);
488
+				continue;
489
+			}
490
+		}
491
+		return $registrations;
492
+	}
493
+
494
+
495
+	/**
496
+	 * find_registrations_that_lost_their_space
497
+	 * If a registrant chooses an offline payment method like Invoice,
498
+	 * then no space is reserved for them at the event until they fully pay fo that site
499
+	 * (unless the event's default reg status is set to APPROVED)
500
+	 * if a registrant then later returns to pay, but the number of spaces available has been reduced due to sales,
501
+	 * then this method will determine which registrations have lost the ability to complete the reg process.
502
+	 *
503
+	 * @param \EE_Registration[] $registrations
504
+	 * @param bool               $revisit
505
+	 * @return array
506
+	 * @throws EE_Error
507
+	 * @throws InvalidArgumentException
508
+	 * @throws ReflectionException
509
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
510
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
511
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
512
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
513
+	 */
514
+	public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
515
+	{
516
+		// registrations per event
517
+		$event_reg_count = array();
518
+		// spaces left per event
519
+		$event_spaces_remaining = array();
520
+		// tickets left sorted by ID
521
+		$tickets_remaining = array();
522
+		// registrations that have lost their space
523
+		$ejected_registrations = array();
524
+		foreach ($registrations as $REG_ID => $registration) {
525
+			if ($registration->status_ID() === EEM_Registration::status_id_approved
526
+				|| apply_filters(
527
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
528
+					false,
529
+					$registration,
530
+					$revisit
531
+				)
532
+			) {
533
+				continue;
534
+			}
535
+			$EVT_ID = $registration->event_ID();
536
+			$ticket = $registration->ticket();
537
+			if (! isset($tickets_remaining[ $ticket->ID() ])) {
538
+				$tickets_remaining[ $ticket->ID() ] = $ticket->remaining();
539
+			}
540
+			if ($tickets_remaining[ $ticket->ID() ] > 0) {
541
+				if (! isset($event_reg_count[ $EVT_ID ])) {
542
+					$event_reg_count[ $EVT_ID ] = 0;
543
+				}
544
+				$event_reg_count[ $EVT_ID ]++;
545
+				if (! isset($event_spaces_remaining[ $EVT_ID ])) {
546
+					$event_spaces_remaining[ $EVT_ID ] = $registration->event()->spaces_remaining_for_sale();
547
+				}
548
+			}
549
+			if ($revisit
550
+				&& ($tickets_remaining[ $ticket->ID() ] === 0
551
+					|| $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
552
+				)
553
+			) {
554
+				$ejected_registrations[ $REG_ID ] = $registration->event();
555
+				if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
556
+					/** @type EE_Registration_Processor $registration_processor */
557
+					$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
558
+					// at this point, we should have enough details about the registrant to consider the registration
559
+					// NOT incomplete
560
+					$registration_processor->manually_update_registration_status(
561
+						$registration,
562
+						EEM_Registration::status_id_wait_list
563
+					);
564
+				}
565
+			}
566
+		}
567
+		return $ejected_registrations;
568
+	}
569
+
570
+
571
+	/**
572
+	 * _hide_reg_step_submit_button
573
+	 * removes the html for the reg step submit button
574
+	 * by replacing it with an empty string via filter callback
575
+	 *
576
+	 * @return void
577
+	 */
578
+	protected function _adjust_registration_status_if_event_old_sold()
579
+	{
580
+	}
581
+
582
+
583
+	/**
584
+	 * _hide_reg_step_submit_button
585
+	 * removes the html for the reg step submit button
586
+	 * by replacing it with an empty string via filter callback
587
+	 *
588
+	 * @return void
589
+	 */
590
+	protected function _hide_reg_step_submit_button_if_revisit()
591
+	{
592
+		if ($this->checkout->revisit) {
593
+			add_filter('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string');
594
+		}
595
+	}
596
+
597
+
598
+	/**
599
+	 * sold_out_events
600
+	 * displays notices regarding events that have sold out since hte registrant first signed up
601
+	 *
602
+	 * @param \EE_Event[] $sold_out_events_array
603
+	 * @return \EE_Form_Section_Proper
604
+	 * @throws \EE_Error
605
+	 */
606
+	private function _sold_out_events($sold_out_events_array = array())
607
+	{
608
+		// set some defaults
609
+		$this->checkout->selected_method_of_payment = 'events_sold_out';
610
+		$sold_out_events = '';
611
+		foreach ($sold_out_events_array as $sold_out_event) {
612
+			$sold_out_events .= EEH_HTML::li(
613
+				EEH_HTML::span(
614
+					'  ' . $sold_out_event->name(),
615
+					'',
616
+					'dashicons dashicons-marker ee-icon-size-16 pink-text'
617
+				)
618
+			);
619
+		}
620
+		return new EE_Form_Section_Proper(
621
+			array(
622
+				'layout_strategy' => new EE_Template_Layout(
623
+					array(
624
+						'layout_template_file' => SPCO_REG_STEPS_PATH
625
+												  . $this->_slug
626
+												  . '/sold_out_events.template.php',
627
+						'template_args'        => apply_filters(
628
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
629
+							array(
630
+								'sold_out_events'     => $sold_out_events,
631
+								'sold_out_events_msg' => apply_filters(
632
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
633
+									sprintf(
634
+										esc_html__(
635
+											'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',
636
+											'event_espresso'
637
+										),
638
+										'<strong>',
639
+										'</strong>',
640
+										'<br />'
641
+									)
642
+								),
643
+							)
644
+						),
645
+					)
646
+				),
647
+			)
648
+		);
649
+	}
650
+
651
+
652
+	/**
653
+	 * _insufficient_spaces_available
654
+	 * displays notices regarding events that do not have enough remaining spaces
655
+	 * to satisfy the current number of registrations looking to pay
656
+	 *
657
+	 * @param \EE_Event[] $insufficient_spaces_events_array
658
+	 * @return \EE_Form_Section_Proper
659
+	 * @throws \EE_Error
660
+	 */
661
+	private function _insufficient_spaces_available($insufficient_spaces_events_array = array())
662
+	{
663
+		// set some defaults
664
+		$this->checkout->selected_method_of_payment = 'invoice';
665
+		$insufficient_space_events = '';
666
+		foreach ($insufficient_spaces_events_array as $event) {
667
+			if ($event instanceof EE_Event) {
668
+				$insufficient_space_events .= EEH_HTML::li(
669
+					EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
670
+				);
671
+			}
672
+		}
673
+		return new EE_Form_Section_Proper(
674
+			array(
675
+				'subsections'     => array(
676
+					'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
677
+					'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
678
+				),
679
+				'layout_strategy' => new EE_Template_Layout(
680
+					array(
681
+						'layout_template_file' => SPCO_REG_STEPS_PATH
682
+												  . $this->_slug
683
+												  . '/sold_out_events.template.php',
684
+						'template_args'        => apply_filters(
685
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
686
+							array(
687
+								'sold_out_events'     => $insufficient_space_events,
688
+								'sold_out_events_msg' => apply_filters(
689
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__insufficient_space_msg',
690
+									esc_html__(
691
+										'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.',
692
+										'event_espresso'
693
+									)
694
+								),
695
+							)
696
+						),
697
+					)
698
+				),
699
+			)
700
+		);
701
+	}
702
+
703
+
704
+	/**
705
+	 * registrations_requiring_pre_approval
706
+	 *
707
+	 * @param array $registrations_requiring_pre_approval
708
+	 * @return EE_Form_Section_Proper
709
+	 * @throws EE_Error
710
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
711
+	 */
712
+	private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = array())
713
+	{
714
+		$events_requiring_pre_approval = array();
715
+		foreach ($registrations_requiring_pre_approval as $registration) {
716
+			if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
717
+				$events_requiring_pre_approval[ $registration->event()->ID() ] = EEH_HTML::li(
718
+					EEH_HTML::span(
719
+						'',
720
+						'',
721
+						'dashicons dashicons-marker ee-icon-size-16 orange-text'
722
+					)
723
+					. EEH_HTML::span($registration->event()->name(), '', 'orange-text')
724
+				);
725
+			}
726
+		}
727
+		return new EE_Form_Section_Proper(
728
+			array(
729
+				'layout_strategy' => new EE_Template_Layout(
730
+					array(
731
+						'layout_template_file' => SPCO_REG_STEPS_PATH
732
+												  . $this->_slug
733
+												  . '/events_requiring_pre_approval.template.php', // layout_template
734
+						'template_args'        => apply_filters(
735
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
736
+							array(
737
+								'events_requiring_pre_approval'     => implode('', $events_requiring_pre_approval),
738
+								'events_requiring_pre_approval_msg' => apply_filters(
739
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___events_requiring_pre_approval__events_requiring_pre_approval_msg',
740
+									esc_html__(
741
+										'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.',
742
+										'event_espresso'
743
+									)
744
+								),
745
+							)
746
+						),
747
+					)
748
+				),
749
+			)
750
+		);
751
+	}
752
+
753
+
754
+	/**
755
+	 * _no_payment_required
756
+	 *
757
+	 * @param \EE_Event[] $registrations_for_free_events
758
+	 * @return \EE_Form_Section_Proper
759
+	 * @throws \EE_Error
760
+	 */
761
+	private function _no_payment_required($registrations_for_free_events = array())
762
+	{
763
+		// set some defaults
764
+		$this->checkout->selected_method_of_payment = 'no_payment_required';
765
+		// generate no_payment_required form
766
+		return new EE_Form_Section_Proper(
767
+			array(
768
+				'layout_strategy' => new EE_Template_Layout(
769
+					array(
770
+						'layout_template_file' => SPCO_REG_STEPS_PATH
771
+												  . $this->_slug
772
+												  . '/no_payment_required.template.php', // layout_template
773
+						'template_args'        => apply_filters(
774
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
775
+							array(
776
+								'revisit'                       => $this->checkout->revisit,
777
+								'registrations'                 => array(),
778
+								'ticket_count'                  => array(),
779
+								'registrations_for_free_events' => $registrations_for_free_events,
780
+								'no_payment_required_msg'       => EEH_HTML::p(
781
+									esc_html__('This is a free event, so no billing will occur.', 'event_espresso')
782
+								),
783
+							)
784
+						),
785
+					)
786
+				),
787
+			)
788
+		);
789
+	}
790
+
791
+
792
+	/**
793
+	 * _display_payment_options
794
+	 *
795
+	 * @param string $transaction_details
796
+	 * @return EE_Form_Section_Proper
797
+	 * @throws EE_Error
798
+	 * @throws InvalidArgumentException
799
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
800
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
801
+	 */
802
+	private function _display_payment_options($transaction_details = '')
803
+	{
804
+		// has method_of_payment been set by no-js user?
805
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment();
806
+		// build payment options form
807
+		return apply_filters(
808
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__payment_options_form',
809
+			new EE_Form_Section_Proper(
810
+				array(
811
+					'subsections'     => array(
812
+						'before_payment_options' => apply_filters(
813
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
814
+							new EE_Form_Section_Proper(
815
+								array('layout_strategy' => new EE_Div_Per_Section_Layout())
816
+							)
817
+						),
818
+						'payment_options'        => $this->_setup_payment_options(),
819
+						'after_payment_options'  => apply_filters(
820
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__after_payment_options',
821
+							new EE_Form_Section_Proper(
822
+								array('layout_strategy' => new EE_Div_Per_Section_Layout())
823
+							)
824
+						),
825
+					),
826
+					'layout_strategy' => new EE_Template_Layout(
827
+						array(
828
+							'layout_template_file' => $this->_template,
829
+							'template_args'        => apply_filters(
830
+								'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
831
+								array(
832
+									'reg_count'                 => $this->line_item_display->total_items(),
833
+									'transaction_details'       => $transaction_details,
834
+									'available_payment_methods' => array(),
835
+								)
836
+							),
837
+						)
838
+					),
839
+				)
840
+			)
841
+		);
842
+	}
843
+
844
+
845
+	/**
846
+	 * _extra_hidden_inputs
847
+	 *
848
+	 * @param bool $no_payment_required
849
+	 * @return \EE_Form_Section_Proper
850
+	 * @throws \EE_Error
851
+	 */
852
+	private function _extra_hidden_inputs($no_payment_required = true)
853
+	{
854
+		return new EE_Form_Section_Proper(
855
+			array(
856
+				'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
857
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
858
+				'subsections'     => array(
859
+					'spco_no_payment_required' => new EE_Hidden_Input(
860
+						array(
861
+							'normalization_strategy' => new EE_Boolean_Normalization(),
862
+							'html_name'              => 'spco_no_payment_required',
863
+							'html_id'                => 'spco-no-payment-required-payment_options',
864
+							'default'                => $no_payment_required,
865
+						)
866
+					),
867
+					'spco_transaction_id'      => new EE_Fixed_Hidden_Input(
868
+						array(
869
+							'normalization_strategy' => new EE_Int_Normalization(),
870
+							'html_name'              => 'spco_transaction_id',
871
+							'html_id'                => 'spco-transaction-id',
872
+							'default'                => $this->checkout->transaction->ID(),
873
+						)
874
+					),
875
+				),
876
+			)
877
+		);
878
+	}
879
+
880
+
881
+	/**
882
+	 *    _apply_registration_payments_to_amount_owing
883
+	 *
884
+	 * @access protected
885
+	 * @param array $registrations
886
+	 * @throws EE_Error
887
+	 */
888
+	protected function _apply_registration_payments_to_amount_owing(array $registrations)
889
+	{
890
+		$payments = array();
891
+		foreach ($registrations as $registration) {
892
+			if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
893
+				$payments += $registration->registration_payments();
894
+			}
895
+		}
896
+		if (! empty($payments)) {
897
+			foreach ($payments as $payment) {
898
+				if ($payment instanceof EE_Registration_Payment) {
899
+					$this->checkout->amount_owing -= $payment->amount();
900
+				}
901
+			}
902
+		}
903
+	}
904
+
905
+
906
+	/**
907
+	 *    _reset_selected_method_of_payment
908
+	 *
909
+	 * @access    private
910
+	 * @param    bool $force_reset
911
+	 * @return void
912
+	 * @throws InvalidArgumentException
913
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
914
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
915
+	 */
916
+	private function _reset_selected_method_of_payment($force_reset = false)
917
+	{
918
+		$reset_payment_method = $force_reset
919
+			? true
920
+			: sanitize_text_field(EE_Registry::instance()->REQ->get('reset_payment_method', false));
921
+		if ($reset_payment_method) {
922
+			$this->checkout->selected_method_of_payment = null;
923
+			$this->checkout->payment_method = null;
924
+			$this->checkout->billing_form = null;
925
+			$this->_save_selected_method_of_payment();
926
+		}
927
+	}
928
+
929
+
930
+	/**
931
+	 * _save_selected_method_of_payment
932
+	 * stores the selected_method_of_payment in the session
933
+	 * so that it's available for all subsequent requests including AJAX
934
+	 *
935
+	 * @access        private
936
+	 * @param string $selected_method_of_payment
937
+	 * @return void
938
+	 * @throws InvalidArgumentException
939
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
940
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
941
+	 */
942
+	private function _save_selected_method_of_payment($selected_method_of_payment = '')
943
+	{
944
+		$selected_method_of_payment = ! empty($selected_method_of_payment)
945
+			? $selected_method_of_payment
946
+			: $this->checkout->selected_method_of_payment;
947
+		EE_Registry::instance()->SSN->set_session_data(
948
+			array('selected_method_of_payment' => $selected_method_of_payment)
949
+		);
950
+	}
951
+
952
+
953
+	/**
954
+	 * _setup_payment_options
955
+	 *
956
+	 * @return EE_Form_Section_Proper
957
+	 * @throws EE_Error
958
+	 * @throws InvalidArgumentException
959
+	 * @throws ReflectionException
960
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
961
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
962
+	 */
963
+	public function _setup_payment_options()
964
+	{
965
+		// load payment method classes
966
+		$this->checkout->available_payment_methods = $this->_get_available_payment_methods();
967
+		if (empty($this->checkout->available_payment_methods)) {
968
+			EE_Error::add_error(
969
+				apply_filters(
970
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__error_message_no_payment_methods',
971
+					sprintf(
972
+						esc_html__(
973
+							'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.',
974
+							'event_espresso'
975
+						),
976
+						'<br>',
977
+						EE_Registry::instance()->CFG->organization->get_pretty('email')
978
+					)
979
+				),
980
+				__FILE__,
981
+				__FUNCTION__,
982
+				__LINE__
983
+			);
984
+		}
985
+		// switch up header depending on number of available payment methods
986
+		$payment_method_header = count($this->checkout->available_payment_methods) > 1
987
+			? apply_filters(
988
+				'FHEE__registration_page_payment_options__method_of_payment_hdr',
989
+				esc_html__('Please Select Your Method of Payment', 'event_espresso')
990
+			)
991
+			: apply_filters(
992
+				'FHEE__registration_page_payment_options__method_of_payment_hdr',
993
+				esc_html__('Method of Payment', 'event_espresso')
994
+			);
995
+		$available_payment_methods = array(
996
+			// display the "Payment Method" header
997
+			'payment_method_header' => new EE_Form_Section_HTML(
998
+				apply_filters(
999
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__payment_method_header',
1000
+					EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr'),
1001
+					$payment_method_header
1002
+				)
1003
+			),
1004
+		);
1005
+		// the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
1006
+		$available_payment_method_options = array();
1007
+		$default_payment_method_option = array();
1008
+		// additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
1009
+		$payment_methods_billing_info = array(
1010
+			new EE_Form_Section_HTML(
1011
+				EEH_HTML::div('<br />', '', '', 'clear:both;')
1012
+			),
1013
+		);
1014
+		// loop through payment methods
1015
+		foreach ($this->checkout->available_payment_methods as $payment_method) {
1016
+			if ($payment_method instanceof EE_Payment_Method) {
1017
+				$payment_method_button = EEH_HTML::img(
1018
+					$payment_method->button_url(),
1019
+					$payment_method->name(),
1020
+					'spco-payment-method-' . $payment_method->slug() . '-btn-img',
1021
+					'spco-payment-method-btn-img'
1022
+				);
1023
+				// check if any payment methods are set as default
1024
+				// if payment method is already selected OR nothing is selected and this payment method should be
1025
+				// open_by_default
1026
+				if (($this->checkout->selected_method_of_payment === $payment_method->slug())
1027
+					|| (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
1028
+				) {
1029
+					$this->checkout->selected_method_of_payment = $payment_method->slug();
1030
+					$this->_save_selected_method_of_payment();
1031
+					$default_payment_method_option[ $payment_method->slug() ] = $payment_method_button;
1032
+				} else {
1033
+					$available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
1034
+				}
1035
+				$payment_methods_billing_info[ $payment_method->slug(
1036
+				) . '-info' ] = $this->_payment_method_billing_info(
1037
+					$payment_method
1038
+				);
1039
+			}
1040
+		}
1041
+		// prepend available_payment_method_options with default_payment_method_option so that it appears first in list
1042
+		// of PMs
1043
+		$available_payment_method_options = $default_payment_method_option + $available_payment_method_options;
1044
+		// now generate the actual form  inputs
1045
+		$available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
1046
+			$available_payment_method_options
1047
+		);
1048
+		$available_payment_methods += $payment_methods_billing_info;
1049
+		// build the available payment methods form
1050
+		return new EE_Form_Section_Proper(
1051
+			array(
1052
+				'html_id'         => 'spco-available-methods-of-payment-dv',
1053
+				'subsections'     => $available_payment_methods,
1054
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
1055
+			)
1056
+		);
1057
+	}
1058
+
1059
+
1060
+	/**
1061
+	 * _get_available_payment_methods
1062
+	 *
1063
+	 * @return EE_Payment_Method[]
1064
+	 * @throws EE_Error
1065
+	 * @throws InvalidArgumentException
1066
+	 * @throws ReflectionException
1067
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1068
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1069
+	 */
1070
+	protected function _get_available_payment_methods()
1071
+	{
1072
+		if (! empty($this->checkout->available_payment_methods)) {
1073
+			return $this->checkout->available_payment_methods;
1074
+		}
1075
+		$available_payment_methods = array();
1076
+		// load EEM_Payment_Method
1077
+		EE_Registry::instance()->load_model('Payment_Method');
1078
+		/** @type EEM_Payment_Method $EEM_Payment_Method */
1079
+		$EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
1080
+		// get all active payment methods
1081
+		$payment_methods = $EEM_Payment_Method->get_all_for_transaction(
1082
+			$this->checkout->transaction,
1083
+			EEM_Payment_Method::scope_cart
1084
+		);
1085
+		foreach ($payment_methods as $payment_method) {
1086
+			if ($payment_method instanceof EE_Payment_Method) {
1087
+				$available_payment_methods[ $payment_method->slug() ] = $payment_method;
1088
+			}
1089
+		}
1090
+		return $available_payment_methods;
1091
+	}
1092
+
1093
+
1094
+	/**
1095
+	 *    _available_payment_method_inputs
1096
+	 *
1097
+	 * @access    private
1098
+	 * @param    array $available_payment_method_options
1099
+	 * @return    \EE_Form_Section_Proper
1100
+	 */
1101
+	private function _available_payment_method_inputs($available_payment_method_options = array())
1102
+	{
1103
+		// generate inputs
1104
+		return new EE_Form_Section_Proper(
1105
+			array(
1106
+				'html_id'         => 'ee-available-payment-method-inputs',
1107
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
1108
+				'subsections'     => array(
1109
+					'' => new EE_Radio_Button_Input(
1110
+						$available_payment_method_options,
1111
+						array(
1112
+							'html_name'          => 'selected_method_of_payment',
1113
+							'html_class'         => 'spco-payment-method',
1114
+							'default'            => $this->checkout->selected_method_of_payment,
1115
+							'label_size'         => 11,
1116
+							'enforce_label_size' => true,
1117
+						)
1118
+					),
1119
+				),
1120
+			)
1121
+		);
1122
+	}
1123
+
1124
+
1125
+	/**
1126
+	 *    _payment_method_billing_info
1127
+	 *
1128
+	 * @access    private
1129
+	 * @param    EE_Payment_Method $payment_method
1130
+	 * @return EE_Form_Section_Proper
1131
+	 * @throws EE_Error
1132
+	 * @throws InvalidArgumentException
1133
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1134
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1135
+	 */
1136
+	private function _payment_method_billing_info(EE_Payment_Method $payment_method)
1137
+	{
1138
+		$currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug()
1139
+			? true
1140
+			: false;
1141
+		// generate the billing form for payment method
1142
+		$billing_form = $currently_selected
1143
+			? $this->_get_billing_form_for_payment_method($payment_method)
1144
+			: new EE_Form_Section_HTML();
1145
+		$this->checkout->billing_form = $currently_selected
1146
+			? $billing_form
1147
+			: $this->checkout->billing_form;
1148
+		// it's all in the details
1149
+		$info_html = EEH_HTML::h3(
1150
+			esc_html__('Important information regarding your payment', 'event_espresso'),
1151
+			'',
1152
+			'spco-payment-method-hdr'
1153
+		);
1154
+		// add some info regarding the step, either from what's saved in the admin,
1155
+		// or a default string depending on whether the PM has a billing form or not
1156
+		if ($payment_method->description()) {
1157
+			$payment_method_info = $payment_method->description();
1158
+		} elseif ($billing_form instanceof EE_Billing_Info_Form) {
1159
+			$payment_method_info = sprintf(
1160
+				esc_html__(
1161
+					'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
1162
+					'event_espresso'
1163
+				),
1164
+				$this->submit_button_text()
1165
+			);
1166
+		} else {
1167
+			$payment_method_info = sprintf(
1168
+				esc_html__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
1169
+				$this->submit_button_text()
1170
+			);
1171
+		}
1172
+		$info_html .= EEH_HTML::div(
1173
+			apply_filters(
1174
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options___payment_method_billing_info__payment_method_info',
1175
+				$payment_method_info
1176
+			),
1177
+			'',
1178
+			'spco-payment-method-desc ee-attention'
1179
+		);
1180
+		return new EE_Form_Section_Proper(
1181
+			array(
1182
+				'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
1183
+				'html_class'      => 'spco-payment-method-info-dv',
1184
+				// only display the selected or default PM
1185
+				'html_style'      => $currently_selected ? '' : 'display:none;',
1186
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
1187
+				'subsections'     => array(
1188
+					'info'         => new EE_Form_Section_HTML($info_html),
1189
+					'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML(),
1190
+				),
1191
+			)
1192
+		);
1193
+	}
1194
+
1195
+
1196
+	/**
1197
+	 * get_billing_form_html_for_payment_method
1198
+	 *
1199
+	 * @access public
1200
+	 * @return string
1201
+	 * @throws EE_Error
1202
+	 * @throws InvalidArgumentException
1203
+	 * @throws ReflectionException
1204
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1205
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1206
+	 */
1207
+	public function get_billing_form_html_for_payment_method()
1208
+	{
1209
+		// how have they chosen to pay?
1210
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
1211
+		$this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
1212
+		if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
1213
+			return false;
1214
+		}
1215
+		if (apply_filters(
1216
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1217
+			false
1218
+		)) {
1219
+			EE_Error::add_success(
1220
+				apply_filters(
1221
+					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1222
+					sprintf(
1223
+						esc_html__(
1224
+							'You have selected "%s" as your method of payment. Please note the important payment information below.',
1225
+							'event_espresso'
1226
+						),
1227
+						$this->checkout->payment_method->name()
1228
+					)
1229
+				)
1230
+			);
1231
+		}
1232
+		// now generate billing form for selected method of payment
1233
+		$payment_method_billing_form = $this->_get_billing_form_for_payment_method($this->checkout->payment_method);
1234
+		// fill form with attendee info if applicable
1235
+		if ($payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
1236
+			&& $this->checkout->transaction_has_primary_registrant()
1237
+		) {
1238
+			$payment_method_billing_form->populate_from_attendee(
1239
+				$this->checkout->transaction->primary_registration()->attendee()
1240
+			);
1241
+		}
1242
+		// and debug content
1243
+		if ($payment_method_billing_form instanceof EE_Billing_Info_Form
1244
+			&& $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
1245
+		) {
1246
+			$payment_method_billing_form =
1247
+				$this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
1248
+					$payment_method_billing_form
1249
+				);
1250
+		}
1251
+		$billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
1252
+			? $payment_method_billing_form->get_html()
1253
+			: '';
1254
+		$this->checkout->json_response->set_return_data(array('payment_method_info' => $billing_info));
1255
+		// localize validation rules for main form
1256
+		$this->checkout->current_step->reg_form->localize_validation_rules();
1257
+		$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
1258
+		return true;
1259
+	}
1260
+
1261
+
1262
+	/**
1263
+	 * _get_billing_form_for_payment_method
1264
+	 *
1265
+	 * @access private
1266
+	 * @param EE_Payment_Method $payment_method
1267
+	 * @return EE_Billing_Info_Form|EE_Form_Section_HTML
1268
+	 * @throws EE_Error
1269
+	 * @throws InvalidArgumentException
1270
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1271
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1272
+	 */
1273
+	private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method)
1274
+	{
1275
+		$billing_form = $payment_method->type_obj()->billing_form(
1276
+			$this->checkout->transaction,
1277
+			array('amount_owing' => $this->checkout->amount_owing)
1278
+		);
1279
+		if ($billing_form instanceof EE_Billing_Info_Form) {
1280
+			if (apply_filters(
1281
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1282
+				false
1283
+			)
1284
+				&& EE_Registry::instance()->REQ->is_set('payment_method')
1285
+			) {
1286
+				EE_Error::add_success(
1287
+					apply_filters(
1288
+						'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1289
+						sprintf(
1290
+							esc_html__(
1291
+								'You have selected "%s" as your method of payment. Please note the important payment information below.',
1292
+								'event_espresso'
1293
+							),
1294
+							$payment_method->name()
1295
+						)
1296
+					)
1297
+				);
1298
+			}
1299
+			return apply_filters(
1300
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
1301
+				$billing_form,
1302
+				$payment_method
1303
+			);
1304
+		}
1305
+		// no actual billing form, so return empty HTML form section
1306
+		return new EE_Form_Section_HTML();
1307
+	}
1308
+
1309
+
1310
+	/**
1311
+	 * _get_selected_method_of_payment
1312
+	 *
1313
+	 * @access private
1314
+	 * @param boolean $required whether to throw an error if the "selected_method_of_payment"
1315
+	 *                          is not found in the incoming request
1316
+	 * @param string  $request_param
1317
+	 * @return NULL|string
1318
+	 * @throws EE_Error
1319
+	 * @throws InvalidArgumentException
1320
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1321
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1322
+	 */
1323
+	private function _get_selected_method_of_payment(
1324
+		$required = false,
1325
+		$request_param = 'selected_method_of_payment'
1326
+	) {
1327
+		// is selected_method_of_payment set in the request ?
1328
+		$selected_method_of_payment = EE_Registry::instance()->REQ->get($request_param, false);
1329
+		if ($selected_method_of_payment) {
1330
+			// sanitize it
1331
+			$selected_method_of_payment = is_array($selected_method_of_payment)
1332
+				? array_shift($selected_method_of_payment)
1333
+				: $selected_method_of_payment;
1334
+			$selected_method_of_payment = sanitize_text_field($selected_method_of_payment);
1335
+			// store it in the session so that it's available for all subsequent requests including AJAX
1336
+			$this->_save_selected_method_of_payment($selected_method_of_payment);
1337
+		} else {
1338
+			// or is is set in the session ?
1339
+			$selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
1340
+				'selected_method_of_payment'
1341
+			);
1342
+		}
1343
+		// do ya really really gotta have it?
1344
+		if (empty($selected_method_of_payment) && $required) {
1345
+			EE_Error::add_error(
1346
+				sprintf(
1347
+					esc_html__(
1348
+						'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.',
1349
+						'event_espresso'
1350
+					),
1351
+					'<br/>',
1352
+					'<br/>',
1353
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
1354
+				),
1355
+				__FILE__,
1356
+				__FUNCTION__,
1357
+				__LINE__
1358
+			);
1359
+			return null;
1360
+		}
1361
+		return $selected_method_of_payment;
1362
+	}
1363
+
1364
+
1365
+
1366
+
1367
+
1368
+
1369
+	/********************************************************************************************************/
1370
+	/***********************************  SWITCH PAYMENT METHOD  ************************************/
1371
+	/********************************************************************************************************/
1372
+	/**
1373
+	 * switch_payment_method
1374
+	 *
1375
+	 * @access public
1376
+	 * @return string
1377
+	 * @throws EE_Error
1378
+	 * @throws InvalidArgumentException
1379
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1380
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1381
+	 */
1382
+	public function switch_payment_method()
1383
+	{
1384
+		if (! $this->_verify_payment_method_is_set()) {
1385
+			return false;
1386
+		}
1387
+		if (apply_filters(
1388
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1389
+			false
1390
+		)) {
1391
+			EE_Error::add_success(
1392
+				apply_filters(
1393
+					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1394
+					sprintf(
1395
+						esc_html__(
1396
+							'You have selected "%s" as your method of payment. Please note the important payment information below.',
1397
+							'event_espresso'
1398
+						),
1399
+						$this->checkout->payment_method->name()
1400
+					)
1401
+				)
1402
+			);
1403
+		}
1404
+		// generate billing form for selected method of payment if it hasn't been done already
1405
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
1406
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1407
+				$this->checkout->payment_method
1408
+			);
1409
+		}
1410
+		// fill form with attendee info if applicable
1411
+		if (apply_filters(
1412
+			'FHEE__populate_billing_form_fields_from_attendee',
1413
+			(
1414
+				$this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
1415
+				&& $this->checkout->transaction_has_primary_registrant()
1416
+			),
1417
+			$this->checkout->billing_form,
1418
+			$this->checkout->transaction
1419
+		)
1420
+		) {
1421
+			$this->checkout->billing_form->populate_from_attendee(
1422
+				$this->checkout->transaction->primary_registration()->attendee()
1423
+			);
1424
+		}
1425
+		// and debug content
1426
+		if ($this->checkout->billing_form instanceof EE_Billing_Info_Form
1427
+			&& $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
1428
+		) {
1429
+			$this->checkout->billing_form =
1430
+				$this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
1431
+					$this->checkout->billing_form
1432
+				);
1433
+		}
1434
+		// get html and validation rules for form
1435
+		if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
1436
+			$this->checkout->json_response->set_return_data(
1437
+				array('payment_method_info' => $this->checkout->billing_form->get_html())
1438
+			);
1439
+			// localize validation rules for main form
1440
+			$this->checkout->billing_form->localize_validation_rules(true);
1441
+			$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
1442
+		} else {
1443
+			$this->checkout->json_response->set_return_data(array('payment_method_info' => ''));
1444
+		}
1445
+		// prevents advancement to next step
1446
+		$this->checkout->continue_reg = false;
1447
+		return true;
1448
+	}
1449
+
1450
+
1451
+	/**
1452
+	 * _verify_payment_method_is_set
1453
+	 *
1454
+	 * @return bool
1455
+	 * @throws EE_Error
1456
+	 * @throws InvalidArgumentException
1457
+	 * @throws ReflectionException
1458
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1459
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1460
+	 */
1461
+	protected function _verify_payment_method_is_set()
1462
+	{
1463
+		// generate billing form for selected method of payment if it hasn't been done already
1464
+		if (empty($this->checkout->selected_method_of_payment)) {
1465
+			// how have they chosen to pay?
1466
+			$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
1467
+		} else {
1468
+			// choose your own adventure based on method_of_payment
1469
+			switch ($this->checkout->selected_method_of_payment) {
1470
+				case 'events_sold_out':
1471
+					EE_Error::add_attention(
1472
+						apply_filters(
1473
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__sold_out_events_msg',
1474
+							esc_html__(
1475
+								'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.',
1476
+								'event_espresso'
1477
+							)
1478
+						),
1479
+						__FILE__,
1480
+						__FUNCTION__,
1481
+						__LINE__
1482
+					);
1483
+					return false;
1484
+					break;
1485
+				case 'payments_closed':
1486
+					EE_Error::add_attention(
1487
+						apply_filters(
1488
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
1489
+							esc_html__(
1490
+								'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.',
1491
+								'event_espresso'
1492
+							)
1493
+						),
1494
+						__FILE__,
1495
+						__FUNCTION__,
1496
+						__LINE__
1497
+					);
1498
+					return false;
1499
+					break;
1500
+				case 'no_payment_required':
1501
+					EE_Error::add_attention(
1502
+						apply_filters(
1503
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
1504
+							esc_html__(
1505
+								'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.',
1506
+								'event_espresso'
1507
+							)
1508
+						),
1509
+						__FILE__,
1510
+						__FUNCTION__,
1511
+						__LINE__
1512
+					);
1513
+					return false;
1514
+					break;
1515
+				default:
1516
+			}
1517
+		}
1518
+		// verify payment method
1519
+		if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
1520
+			// get payment method for selected method of payment
1521
+			$this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
1522
+		}
1523
+		return $this->checkout->payment_method instanceof EE_Payment_Method ? true : false;
1524
+	}
1525
+
1526
+
1527
+
1528
+	/********************************************************************************************************/
1529
+	/***************************************  SAVE PAYER DETAILS  ****************************************/
1530
+	/********************************************************************************************************/
1531
+	/**
1532
+	 * save_payer_details_via_ajax
1533
+	 *
1534
+	 * @return void
1535
+	 * @throws EE_Error
1536
+	 * @throws InvalidArgumentException
1537
+	 * @throws ReflectionException
1538
+	 * @throws RuntimeException
1539
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1540
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1541
+	 */
1542
+	public function save_payer_details_via_ajax()
1543
+	{
1544
+		if (! $this->_verify_payment_method_is_set()) {
1545
+			return;
1546
+		}
1547
+		// generate billing form for selected method of payment if it hasn't been done already
1548
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
1549
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1550
+				$this->checkout->payment_method
1551
+			);
1552
+		}
1553
+		// generate primary attendee from payer info if applicable
1554
+		if (! $this->checkout->transaction_has_primary_registrant()) {
1555
+			$attendee = $this->_create_attendee_from_request_data();
1556
+			if ($attendee instanceof EE_Attendee) {
1557
+				foreach ($this->checkout->transaction->registrations() as $registration) {
1558
+					if ($registration->is_primary_registrant()) {
1559
+						$this->checkout->primary_attendee_obj = $attendee;
1560
+						$registration->_add_relation_to($attendee, 'Attendee');
1561
+						$registration->set_attendee_id($attendee->ID());
1562
+						$registration->update_cache_after_object_save('Attendee', $attendee);
1563
+					}
1564
+				}
1565
+			}
1566
+		}
1567
+	}
1568
+
1569
+
1570
+	/**
1571
+	 * create_attendee_from_request_data
1572
+	 * uses info from alternate GET or POST data (such as AJAX) to create a new attendee
1573
+	 *
1574
+	 * @return EE_Attendee
1575
+	 * @throws EE_Error
1576
+	 * @throws InvalidArgumentException
1577
+	 * @throws ReflectionException
1578
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1579
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1580
+	 */
1581
+	protected function _create_attendee_from_request_data()
1582
+	{
1583
+		// get State ID
1584
+		$STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['state']) : '';
1585
+		if (! empty($STA_ID)) {
1586
+			// can we get state object from name ?
1587
+			EE_Registry::instance()->load_model('State');
1588
+			$state = EEM_State::instance()->get_col(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
1589
+			$STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
1590
+		}
1591
+		// get Country ISO
1592
+		$CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['country']) : '';
1593
+		if (! empty($CNT_ISO)) {
1594
+			// can we get country object from name ?
1595
+			EE_Registry::instance()->load_model('Country');
1596
+			$country = EEM_Country::instance()->get_col(
1597
+				array(array('CNT_name' => $CNT_ISO), 'limit' => 1),
1598
+				'CNT_ISO'
1599
+			);
1600
+			$CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
1601
+		}
1602
+		// grab attendee data
1603
+		$attendee_data = array(
1604
+			'ATT_fname'    => ! empty($_REQUEST['first_name']) ? sanitize_text_field($_REQUEST['first_name']) : '',
1605
+			'ATT_lname'    => ! empty($_REQUEST['last_name']) ? sanitize_text_field($_REQUEST['last_name']) : '',
1606
+			'ATT_email'    => ! empty($_REQUEST['email']) ? sanitize_email($_REQUEST['email']) : '',
1607
+			'ATT_address'  => ! empty($_REQUEST['address']) ? sanitize_text_field($_REQUEST['address']) : '',
1608
+			'ATT_address2' => ! empty($_REQUEST['address2']) ? sanitize_text_field($_REQUEST['address2']) : '',
1609
+			'ATT_city'     => ! empty($_REQUEST['city']) ? sanitize_text_field($_REQUEST['city']) : '',
1610
+			'STA_ID'       => $STA_ID,
1611
+			'CNT_ISO'      => $CNT_ISO,
1612
+			'ATT_zip'      => ! empty($_REQUEST['zip']) ? sanitize_text_field($_REQUEST['zip']) : '',
1613
+			'ATT_phone'    => ! empty($_REQUEST['phone']) ? sanitize_text_field($_REQUEST['phone']) : '',
1614
+		);
1615
+		// validate the email address since it is the most important piece of info
1616
+		if (empty($attendee_data['ATT_email']) || $attendee_data['ATT_email'] !== $_REQUEST['email']) {
1617
+			EE_Error::add_error(
1618
+				esc_html__('An invalid email address was submitted.', 'event_espresso'),
1619
+				__FILE__,
1620
+				__FUNCTION__,
1621
+				__LINE__
1622
+			);
1623
+		}
1624
+		// does this attendee already exist in the db ? we're searching using a combination of first name, last name,
1625
+		// AND email address
1626
+		if (! empty($attendee_data['ATT_fname'])
1627
+			&& ! empty($attendee_data['ATT_lname'])
1628
+			&& ! empty($attendee_data['ATT_email'])
1629
+		) {
1630
+			$existing_attendee = EE_Registry::instance()->LIB->EEM_Attendee->find_existing_attendee(
1631
+				array(
1632
+					'ATT_fname' => $attendee_data['ATT_fname'],
1633
+					'ATT_lname' => $attendee_data['ATT_lname'],
1634
+					'ATT_email' => $attendee_data['ATT_email'],
1635
+				)
1636
+			);
1637
+			if ($existing_attendee instanceof EE_Attendee) {
1638
+				return $existing_attendee;
1639
+			}
1640
+		}
1641
+		// no existing attendee? kk let's create a new one
1642
+		// kinda lame, but we need a first and last name to create an attendee, so use the email address if those
1643
+		// don't exist
1644
+		$attendee_data['ATT_fname'] = ! empty($attendee_data['ATT_fname'])
1645
+			? $attendee_data['ATT_fname']
1646
+			: $attendee_data['ATT_email'];
1647
+		$attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
1648
+			? $attendee_data['ATT_lname']
1649
+			: $attendee_data['ATT_email'];
1650
+		return EE_Attendee::new_instance($attendee_data);
1651
+	}
1652
+
1653
+
1654
+
1655
+	/********************************************************************************************************/
1656
+	/****************************************  PROCESS REG STEP  *****************************************/
1657
+	/********************************************************************************************************/
1658
+	/**
1659
+	 * process_reg_step
1660
+	 *
1661
+	 * @return bool
1662
+	 * @throws EE_Error
1663
+	 * @throws InvalidArgumentException
1664
+	 * @throws ReflectionException
1665
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
1666
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1667
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1668
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
1669
+	 */
1670
+	public function process_reg_step()
1671
+	{
1672
+		// how have they chosen to pay?
1673
+		$this->checkout->selected_method_of_payment = $this->checkout->transaction->is_free()
1674
+			? 'no_payment_required'
1675
+			: $this->_get_selected_method_of_payment(true);
1676
+		// choose your own adventure based on method_of_payment
1677
+		switch ($this->checkout->selected_method_of_payment) {
1678
+			case 'events_sold_out':
1679
+				$this->checkout->redirect = true;
1680
+				$this->checkout->redirect_url = $this->checkout->cancel_page_url;
1681
+				$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
1682
+				// mark this reg step as completed
1683
+				$this->set_completed();
1684
+				return false;
1685
+				break;
1686
+
1687
+			case 'payments_closed':
1688
+				if (apply_filters(
1689
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
1690
+					false
1691
+				)) {
1692
+					EE_Error::add_success(
1693
+						esc_html__('no payment required at this time.', 'event_espresso'),
1694
+						__FILE__,
1695
+						__FUNCTION__,
1696
+						__LINE__
1697
+					);
1698
+				}
1699
+				// mark this reg step as completed
1700
+				$this->set_completed();
1701
+				return true;
1702
+				break;
1703
+
1704
+			case 'no_payment_required':
1705
+				if (apply_filters(
1706
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
1707
+					false
1708
+				)) {
1709
+					EE_Error::add_success(
1710
+						esc_html__('no payment required.', 'event_espresso'),
1711
+						__FILE__,
1712
+						__FUNCTION__,
1713
+						__LINE__
1714
+					);
1715
+				}
1716
+				// mark this reg step as completed
1717
+				$this->set_completed();
1718
+				return true;
1719
+				break;
1720
+
1721
+			default:
1722
+				$registrations = EE_Registry::instance()->SSN->checkout()->transaction->registrations(
1723
+					EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
1724
+				);
1725
+				$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
1726
+					$registrations,
1727
+					EE_Registry::instance()->SSN->checkout()->revisit
1728
+				);
1729
+				// calculate difference between the two arrays
1730
+				$registrations = array_diff($registrations, $ejected_registrations);
1731
+				if (empty($registrations)) {
1732
+					$this->_redirect_because_event_sold_out();
1733
+					return false;
1734
+				}
1735
+				$payment_successful = $this->_process_payment();
1736
+				if ($payment_successful) {
1737
+					$this->checkout->continue_reg = true;
1738
+					$this->_maybe_set_completed($this->checkout->payment_method);
1739
+				} else {
1740
+					$this->checkout->continue_reg = false;
1741
+				}
1742
+				return $payment_successful;
1743
+		}
1744
+	}
1745
+
1746
+
1747
+	/**
1748
+	 * _redirect_because_event_sold_out
1749
+	 *
1750
+	 * @access protected
1751
+	 * @return void
1752
+	 */
1753
+	protected function _redirect_because_event_sold_out()
1754
+	{
1755
+		$this->checkout->continue_reg = false;
1756
+		// set redirect URL
1757
+		$this->checkout->redirect_url = add_query_arg(
1758
+			array('e_reg_url_link' => $this->checkout->reg_url_link),
1759
+			$this->checkout->current_step->reg_step_url()
1760
+		);
1761
+		$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
1762
+	}
1763
+
1764
+
1765
+	/**
1766
+	 * _maybe_set_completed
1767
+	 *
1768
+	 * @access protected
1769
+	 * @param \EE_Payment_Method $payment_method
1770
+	 * @return void
1771
+	 * @throws \EE_Error
1772
+	 */
1773
+	protected function _maybe_set_completed(EE_Payment_Method $payment_method)
1774
+	{
1775
+		switch ($payment_method->type_obj()->payment_occurs()) {
1776
+			case EE_PMT_Base::offsite:
1777
+				break;
1778
+			case EE_PMT_Base::onsite:
1779
+			case EE_PMT_Base::offline:
1780
+				// mark this reg step as completed
1781
+				$this->set_completed();
1782
+				break;
1783
+		}
1784
+	}
1785
+
1786
+
1787
+	/**
1788
+	 *    update_reg_step
1789
+	 *    this is the final step after a user  revisits the site to retry a payment
1790
+	 *
1791
+	 * @return bool
1792
+	 * @throws EE_Error
1793
+	 * @throws InvalidArgumentException
1794
+	 * @throws ReflectionException
1795
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
1796
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1797
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1798
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
1799
+	 */
1800
+	public function update_reg_step()
1801
+	{
1802
+		$success = true;
1803
+		// if payment required
1804
+		if ($this->checkout->transaction->total() > 0) {
1805
+			do_action(
1806
+				'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
1807
+				$this->checkout->transaction
1808
+			);
1809
+			// attempt payment via payment method
1810
+			$success = $this->process_reg_step();
1811
+		}
1812
+		if ($success && ! $this->checkout->redirect) {
1813
+			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
1814
+				$this->checkout->transaction->ID()
1815
+			);
1816
+			// set return URL
1817
+			$this->checkout->redirect_url = add_query_arg(
1818
+				array('e_reg_url_link' => $this->checkout->reg_url_link),
1819
+				$this->checkout->thank_you_page_url
1820
+			);
1821
+		}
1822
+		return $success;
1823
+	}
1824
+
1825
+
1826
+	/**
1827
+	 *    _process_payment
1828
+	 *
1829
+	 * @access private
1830
+	 * @return bool
1831
+	 * @throws EE_Error
1832
+	 * @throws InvalidArgumentException
1833
+	 * @throws ReflectionException
1834
+	 * @throws RuntimeException
1835
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1836
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1837
+	 */
1838
+	private function _process_payment()
1839
+	{
1840
+		// basically confirm that the event hasn't sold out since they hit the page
1841
+		if (! $this->_last_second_ticket_verifications()) {
1842
+			return false;
1843
+		}
1844
+		// ya gotta make a choice man
1845
+		if (empty($this->checkout->selected_method_of_payment)) {
1846
+			$this->checkout->json_response->set_plz_select_method_of_payment(
1847
+				esc_html__('Please select a method of payment before proceeding.', 'event_espresso')
1848
+			);
1849
+			return false;
1850
+		}
1851
+		// get EE_Payment_Method object
1852
+		if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
1853
+			return false;
1854
+		}
1855
+		// setup billing form
1856
+		if ($this->checkout->payment_method->is_on_site()) {
1857
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1858
+				$this->checkout->payment_method
1859
+			);
1860
+			// bad billing form ?
1861
+			if (! $this->_billing_form_is_valid()) {
1862
+				return false;
1863
+			}
1864
+		}
1865
+		// ensure primary registrant has been fully processed
1866
+		if (! $this->_setup_primary_registrant_prior_to_payment()) {
1867
+			return false;
1868
+		}
1869
+		// if session is close to expiring (under 10 minutes by default)
1870
+		if ((time() - EE_Registry::instance()->SSN->expiration()) < EE_Registry::instance()->SSN->extension()) {
1871
+			// add some time to session expiration so that payment can be completed
1872
+			EE_Registry::instance()->SSN->extend_expiration();
1873
+		}
1874
+		/** @type EE_Transaction_Processor $transaction_processor */
1875
+		// $transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
1876
+		// in case a registrant leaves to an Off-Site Gateway and never returns, we want to approve any registrations
1877
+		// for events with a default reg status of Approved
1878
+		// $transaction_processor->toggle_registration_statuses_for_default_approved_events(
1879
+		//      $this->checkout->transaction, $this->checkout->reg_cache_where_params
1880
+		// );
1881
+		// attempt payment
1882
+		$payment = $this->_attempt_payment($this->checkout->payment_method);
1883
+		// process results
1884
+		$payment = $this->_validate_payment($payment);
1885
+		$payment = $this->_post_payment_processing($payment);
1886
+		// verify payment
1887
+		if ($payment instanceof EE_Payment) {
1888
+			// store that for later
1889
+			$this->checkout->payment = $payment;
1890
+			// we can also consider the TXN to not have been failed, so temporarily upgrade it's status to abandoned
1891
+			$this->checkout->transaction->toggle_failed_transaction_status();
1892
+			$payment_status = $payment->status();
1893
+			if ($payment_status === EEM_Payment::status_id_approved
1894
+				|| $payment_status === EEM_Payment::status_id_pending
1895
+			) {
1896
+				return true;
1897
+			} else {
1898
+				return false;
1899
+			}
1900
+		} elseif ($payment === true) {
1901
+			// please note that offline payment methods will NOT make a payment,
1902
+			// but instead just mark themselves as the PMD_ID on the transaction, and return true
1903
+			$this->checkout->payment = $payment;
1904
+			return true;
1905
+		}
1906
+		// where's my money?
1907
+		return false;
1908
+	}
1909
+
1910
+
1911
+	/**
1912
+	 * _last_second_ticket_verifications
1913
+	 *
1914
+	 * @access public
1915
+	 * @return bool
1916
+	 * @throws EE_Error
1917
+	 */
1918
+	protected function _last_second_ticket_verifications()
1919
+	{
1920
+		// don't bother re-validating if not a return visit
1921
+		if (! $this->checkout->revisit) {
1922
+			return true;
1923
+		}
1924
+		$registrations = $this->checkout->transaction->registrations();
1925
+		if (empty($registrations)) {
1926
+			return false;
1927
+		}
1928
+		foreach ($registrations as $registration) {
1929
+			if ($registration instanceof EE_Registration && ! $registration->is_approved()) {
1930
+				$event = $registration->event_obj();
1931
+				if ($event instanceof EE_Event && $event->is_sold_out(true)) {
1932
+					EE_Error::add_error(
1933
+						apply_filters(
1934
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___last_second_ticket_verifications__sold_out_events_msg',
1935
+							sprintf(
1936
+								esc_html__(
1937
+									'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.',
1938
+									'event_espresso'
1939
+								),
1940
+								$event->name()
1941
+							)
1942
+						),
1943
+						__FILE__,
1944
+						__FUNCTION__,
1945
+						__LINE__
1946
+					);
1947
+					return false;
1948
+				}
1949
+			}
1950
+		}
1951
+		return true;
1952
+	}
1953
+
1954
+
1955
+	/**
1956
+	 * redirect_form
1957
+	 *
1958
+	 * @access public
1959
+	 * @return bool
1960
+	 * @throws EE_Error
1961
+	 * @throws InvalidArgumentException
1962
+	 * @throws ReflectionException
1963
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1964
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1965
+	 */
1966
+	public function redirect_form()
1967
+	{
1968
+		$payment_method_billing_info = $this->_payment_method_billing_info(
1969
+			$this->_get_payment_method_for_selected_method_of_payment()
1970
+		);
1971
+		$html = $payment_method_billing_info->get_html();
1972
+		$html .= $this->checkout->redirect_form;
1973
+		EE_Registry::instance()->REQ->add_output($html);
1974
+		return true;
1975
+	}
1976
+
1977
+
1978
+	/**
1979
+	 * _billing_form_is_valid
1980
+	 *
1981
+	 * @access private
1982
+	 * @return bool
1983
+	 * @throws \EE_Error
1984
+	 */
1985
+	private function _billing_form_is_valid()
1986
+	{
1987
+		if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
1988
+			return true;
1989
+		}
1990
+		if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
1991
+			if ($this->checkout->billing_form->was_submitted()) {
1992
+				$this->checkout->billing_form->receive_form_submission();
1993
+				if ($this->checkout->billing_form->is_valid()) {
1994
+					return true;
1995
+				}
1996
+				$validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
1997
+				$error_strings = array();
1998
+				foreach ($validation_errors as $validation_error) {
1999
+					if ($validation_error instanceof EE_Validation_Error) {
2000
+						$form_section = $validation_error->get_form_section();
2001
+						if ($form_section instanceof EE_Form_Input_Base) {
2002
+							$label = $form_section->html_label_text();
2003
+						} elseif ($form_section instanceof EE_Form_Section_Base) {
2004
+							$label = $form_section->name();
2005
+						} else {
2006
+							$label = esc_html__('Validation Error', 'event_espresso');
2007
+						}
2008
+						$error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
2009
+					}
2010
+				}
2011
+				EE_Error::add_error(
2012
+					sprintf(
2013
+						esc_html__(
2014
+							'One or more billing form inputs are invalid and require correction before proceeding. %1$s %2$s',
2015
+							'event_espresso'
2016
+						),
2017
+						'<br/>',
2018
+						implode('<br/>', $error_strings)
2019
+					),
2020
+					__FILE__,
2021
+					__FUNCTION__,
2022
+					__LINE__
2023
+				);
2024
+			} else {
2025
+				EE_Error::add_error(
2026
+					esc_html__(
2027
+						'The billing form was not submitted or something prevented it\'s submission.',
2028
+						'event_espresso'
2029
+					),
2030
+					__FILE__,
2031
+					__FUNCTION__,
2032
+					__LINE__
2033
+				);
2034
+			}
2035
+		} else {
2036
+			EE_Error::add_error(
2037
+				esc_html__(
2038
+					'The submitted billing form is invalid possibly due to a technical reason.',
2039
+					'event_espresso'
2040
+				),
2041
+				__FILE__,
2042
+				__FUNCTION__,
2043
+				__LINE__
2044
+			);
2045
+		}
2046
+		return false;
2047
+	}
2048
+
2049
+
2050
+	/**
2051
+	 * _setup_primary_registrant_prior_to_payment
2052
+	 * ensures that the primary registrant has a valid attendee object created with the critical details populated
2053
+	 * (first & last name & email) and that both the transaction object and primary registration object have been saved
2054
+	 * plz note that any other registrations will NOT be saved at this point (because they may not have any details
2055
+	 * yet)
2056
+	 *
2057
+	 * @access private
2058
+	 * @return bool
2059
+	 * @throws EE_Error
2060
+	 * @throws InvalidArgumentException
2061
+	 * @throws ReflectionException
2062
+	 * @throws RuntimeException
2063
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2064
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2065
+	 */
2066
+	private function _setup_primary_registrant_prior_to_payment()
2067
+	{
2068
+		// check if transaction has a primary registrant and that it has a related Attendee object
2069
+		// if not, then we need to at least gather some primary registrant data before attempting payment
2070
+		if ($this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
2071
+			&& ! $this->checkout->transaction_has_primary_registrant()
2072
+			&& ! $this->_capture_primary_registration_data_from_billing_form()
2073
+		) {
2074
+			return false;
2075
+		}
2076
+		// because saving an object clears it's cache, we need to do the chevy shuffle
2077
+		// grab the primary_registration object
2078
+		$primary_registration = $this->checkout->transaction->primary_registration();
2079
+		// at this point we'll consider a TXN to not have been failed
2080
+		$this->checkout->transaction->toggle_failed_transaction_status();
2081
+		// save the TXN ( which clears cached copy of primary_registration)
2082
+		$this->checkout->transaction->save();
2083
+		// grab TXN ID and save it to the primary_registration
2084
+		$primary_registration->set_transaction_id($this->checkout->transaction->ID());
2085
+		// save what we have so far
2086
+		$primary_registration->save();
2087
+		return true;
2088
+	}
2089
+
2090
+
2091
+	/**
2092
+	 * _capture_primary_registration_data_from_billing_form
2093
+	 *
2094
+	 * @access private
2095
+	 * @return bool
2096
+	 * @throws EE_Error
2097
+	 * @throws InvalidArgumentException
2098
+	 * @throws ReflectionException
2099
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2100
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2101
+	 */
2102
+	private function _capture_primary_registration_data_from_billing_form()
2103
+	{
2104
+		// convert billing form data into an attendee
2105
+		$this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
2106
+		if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
2107
+			EE_Error::add_error(
2108
+				sprintf(
2109
+					esc_html__(
2110
+						'The billing form details could not be used for attendee details due to a technical issue.%sPlease try again or contact %s for assistance.',
2111
+						'event_espresso'
2112
+					),
2113
+					'<br/>',
2114
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2115
+				),
2116
+				__FILE__,
2117
+				__FUNCTION__,
2118
+				__LINE__
2119
+			);
2120
+			return false;
2121
+		}
2122
+		$primary_registration = $this->checkout->transaction->primary_registration();
2123
+		if (! $primary_registration instanceof EE_Registration) {
2124
+			EE_Error::add_error(
2125
+				sprintf(
2126
+					esc_html__(
2127
+						'The primary registrant for this transaction could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
2128
+						'event_espresso'
2129
+					),
2130
+					'<br/>',
2131
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2132
+				),
2133
+				__FILE__,
2134
+				__FUNCTION__,
2135
+				__LINE__
2136
+			);
2137
+			return false;
2138
+		}
2139
+		if (! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
2140
+			  instanceof
2141
+			  EE_Attendee
2142
+		) {
2143
+			EE_Error::add_error(
2144
+				sprintf(
2145
+					esc_html__(
2146
+						'The primary registrant could not be associated with this transaction due to a technical issue.%sPlease try again or contact %s for assistance.',
2147
+						'event_espresso'
2148
+					),
2149
+					'<br/>',
2150
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2151
+				),
2152
+				__FILE__,
2153
+				__FUNCTION__,
2154
+				__LINE__
2155
+			);
2156
+			return false;
2157
+		}
2158
+		/** @type EE_Registration_Processor $registration_processor */
2159
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
2160
+		// at this point, we should have enough details about the registrant to consider the registration NOT incomplete
2161
+		$registration_processor->toggle_incomplete_registration_status_to_default($primary_registration);
2162
+		return true;
2163
+	}
2164
+
2165
+
2166
+	/**
2167
+	 * _get_payment_method_for_selected_method_of_payment
2168
+	 * retrieves a valid payment method
2169
+	 *
2170
+	 * @access public
2171
+	 * @return EE_Payment_Method
2172
+	 * @throws EE_Error
2173
+	 * @throws InvalidArgumentException
2174
+	 * @throws ReflectionException
2175
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2176
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2177
+	 */
2178
+	private function _get_payment_method_for_selected_method_of_payment()
2179
+	{
2180
+		if ($this->checkout->selected_method_of_payment === 'events_sold_out') {
2181
+			$this->_redirect_because_event_sold_out();
2182
+			return null;
2183
+		}
2184
+		// get EE_Payment_Method object
2185
+		if (isset($this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ])) {
2186
+			$payment_method = $this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ];
2187
+		} else {
2188
+			// load EEM_Payment_Method
2189
+			EE_Registry::instance()->load_model('Payment_Method');
2190
+			/** @type EEM_Payment_Method $EEM_Payment_Method */
2191
+			$EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
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 \EventEspresso\core\exceptions\InvalidDataTypeException
2244
+	 * @throws \EventEspresso\core\exceptions\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
+	 * @access protected
2279
+	 * @param \Exception $e
2280
+	 * @return void
2281
+	 * @throws EE_Error
2282
+	 * @throws InvalidArgumentException
2283
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2284
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2285
+	 */
2286
+	protected function _handle_payment_processor_exception(Exception $e)
2287
+	{
2288
+		EE_Error::add_error(
2289
+			sprintf(
2290
+				esc_html__(
2291
+					'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',
2292
+					'event_espresso'
2293
+				),
2294
+				'<br/>',
2295
+				EE_Registry::instance()->CFG->organization->get_pretty('email'),
2296
+				$e->getMessage(),
2297
+				$e->getFile(),
2298
+				$e->getLine()
2299
+			),
2300
+			__FILE__,
2301
+			__FUNCTION__,
2302
+			__LINE__
2303
+		);
2304
+	}
2305
+
2306
+
2307
+	/**
2308
+	 * _get_return_url
2309
+	 *
2310
+	 * @access protected
2311
+	 * @param \EE_Payment_Method $payment_method
2312
+	 * @return string
2313
+	 * @throws \EE_Error
2314
+	 */
2315
+	protected function _get_return_url(EE_Payment_Method $payment_method)
2316
+	{
2317
+		$return_url = '';
2318
+		switch ($payment_method->type_obj()->payment_occurs()) {
2319
+			case EE_PMT_Base::offsite:
2320
+				$return_url = add_query_arg(
2321
+					array(
2322
+						'action'                     => 'process_gateway_response',
2323
+						'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
2324
+						'spco_txn'                   => $this->checkout->transaction->ID(),
2325
+					),
2326
+					$this->reg_step_url()
2327
+				);
2328
+				break;
2329
+			case EE_PMT_Base::onsite:
2330
+			case EE_PMT_Base::offline:
2331
+				$return_url = $this->checkout->next_step->reg_step_url();
2332
+				break;
2333
+		}
2334
+		return $return_url;
2335
+	}
2336
+
2337
+
2338
+	/**
2339
+	 * _validate_payment
2340
+	 *
2341
+	 * @access private
2342
+	 * @param EE_Payment $payment
2343
+	 * @return EE_Payment|FALSE
2344
+	 * @throws EE_Error
2345
+	 * @throws InvalidArgumentException
2346
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2347
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2348
+	 */
2349
+	private function _validate_payment($payment = null)
2350
+	{
2351
+		if ($this->checkout->payment_method->is_off_line()) {
2352
+			return true;
2353
+		}
2354
+		// verify payment object
2355
+		if (! $payment instanceof EE_Payment) {
2356
+			// not a payment
2357
+			EE_Error::add_error(
2358
+				sprintf(
2359
+					esc_html__(
2360
+						'A valid payment was not generated due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
2361
+						'event_espresso'
2362
+					),
2363
+					'<br/>',
2364
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2365
+				),
2366
+				__FILE__,
2367
+				__FUNCTION__,
2368
+				__LINE__
2369
+			);
2370
+			return false;
2371
+		}
2372
+		return $payment;
2373
+	}
2374
+
2375
+
2376
+	/**
2377
+	 * _post_payment_processing
2378
+	 *
2379
+	 * @access private
2380
+	 * @param EE_Payment|bool $payment
2381
+	 * @return bool
2382
+	 * @throws EE_Error
2383
+	 * @throws InvalidArgumentException
2384
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2385
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2386
+	 */
2387
+	private function _post_payment_processing($payment = null)
2388
+	{
2389
+		// Off-Line payment?
2390
+		if ($payment === true) {
2391
+			// $this->_setup_redirect_for_next_step();
2392
+			return true;
2393
+			// On-Site payment?
2394
+		} elseif ($this->checkout->payment_method->is_on_site()) {
2395
+			if (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
2396
+				// $this->_setup_redirect_for_next_step();
2397
+				$this->checkout->continue_reg = false;
2398
+			}
2399
+			// Off-Site payment?
2400
+		} elseif ($this->checkout->payment_method->is_off_site()) {
2401
+			// if a payment object was made and it specifies a redirect url, then we'll setup that redirect info
2402
+			if ($payment instanceof EE_Payment && $payment->redirect_url()) {
2403
+				do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()');
2404
+				$this->checkout->redirect = true;
2405
+				$this->checkout->redirect_form = $payment->redirect_form();
2406
+				$this->checkout->redirect_url = $this->reg_step_url('redirect_form');
2407
+				// set JSON response
2408
+				$this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
2409
+				// and lastly, let's bump the payment status to pending
2410
+				$payment->set_status(EEM_Payment::status_id_pending);
2411
+				$payment->save();
2412
+			} else {
2413
+				// not a payment
2414
+				$this->checkout->continue_reg = false;
2415
+				EE_Error::add_error(
2416
+					sprintf(
2417
+						esc_html__(
2418
+							'It appears the Off Site Payment Method was not configured properly.%sPlease try again or contact %s for assistance.',
2419
+							'event_espresso'
2420
+						),
2421
+						'<br/>',
2422
+						EE_Registry::instance()->CFG->organization->get_pretty('email')
2423
+					),
2424
+					__FILE__,
2425
+					__FUNCTION__,
2426
+					__LINE__
2427
+				);
2428
+			}
2429
+		} else {
2430
+			// ummm ya... not Off-Line, not On-Site, not off-Site ????
2431
+			$this->checkout->continue_reg = false;
2432
+			return false;
2433
+		}
2434
+		return $payment;
2435
+	}
2436
+
2437
+
2438
+	/**
2439
+	 *    _process_payment_status
2440
+	 *
2441
+	 * @access private
2442
+	 * @type    EE_Payment $payment
2443
+	 * @param string       $payment_occurs
2444
+	 * @return bool
2445
+	 * @throws EE_Error
2446
+	 * @throws InvalidArgumentException
2447
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2448
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2449
+	 */
2450
+	private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline)
2451
+	{
2452
+		// off-line payment? carry on
2453
+		if ($payment_occurs === EE_PMT_Base::offline) {
2454
+			return true;
2455
+		}
2456
+		// verify payment validity
2457
+		if ($payment instanceof EE_Payment) {
2458
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()');
2459
+			$msg = $payment->gateway_response();
2460
+			// check results
2461
+			switch ($payment->status()) {
2462
+				// good payment
2463
+				case EEM_Payment::status_id_approved:
2464
+					EE_Error::add_success(
2465
+						esc_html__('Your payment was processed successfully.', 'event_espresso'),
2466
+						__FILE__,
2467
+						__FUNCTION__,
2468
+						__LINE__
2469
+					);
2470
+					return true;
2471
+					break;
2472
+				// slow payment
2473
+				case EEM_Payment::status_id_pending:
2474
+					if (empty($msg)) {
2475
+						$msg = esc_html__(
2476
+							'Your payment appears to have been processed successfully, but the Instant Payment Notification has not yet been received. It should arrive shortly.',
2477
+							'event_espresso'
2478
+						);
2479
+					}
2480
+					EE_Error::add_success($msg, __FILE__, __FUNCTION__, __LINE__);
2481
+					return true;
2482
+					break;
2483
+				// don't wanna payment
2484
+				case EEM_Payment::status_id_cancelled:
2485
+					if (empty($msg)) {
2486
+						$msg = _n(
2487
+							'Payment cancelled. Please try again.',
2488
+							'Payment cancelled. Please try again or select another method of payment.',
2489
+							count($this->checkout->available_payment_methods),
2490
+							'event_espresso'
2491
+						);
2492
+					}
2493
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
2494
+					return false;
2495
+					break;
2496
+				// not enough payment
2497
+				case EEM_Payment::status_id_declined:
2498
+					if (empty($msg)) {
2499
+						$msg = _n(
2500
+							'We\'re sorry but your payment was declined. Please try again.',
2501
+							'We\'re sorry but your payment was declined. Please try again or select another method of payment.',
2502
+							count($this->checkout->available_payment_methods),
2503
+							'event_espresso'
2504
+						);
2505
+					}
2506
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
2507
+					return false;
2508
+					break;
2509
+				// bad payment
2510
+				case EEM_Payment::status_id_failed:
2511
+					if (! empty($msg)) {
2512
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2513
+						return false;
2514
+					}
2515
+					// default to error below
2516
+					break;
2517
+			}
2518
+		}
2519
+		// off-site payment gateway responses are too unreliable, so let's just assume that
2520
+		// the payment processing is just running slower than the registrant's request
2521
+		if ($payment_occurs === EE_PMT_Base::offsite) {
2522
+			return true;
2523
+		}
2524
+		EE_Error::add_error(
2525
+			sprintf(
2526
+				esc_html__(
2527
+					'Your payment could not be processed successfully due to a technical issue.%sPlease try again or contact %s for assistance.',
2528
+					'event_espresso'
2529
+				),
2530
+				'<br/>',
2531
+				EE_Registry::instance()->CFG->organization->get_pretty('email')
2532
+			),
2533
+			__FILE__,
2534
+			__FUNCTION__,
2535
+			__LINE__
2536
+		);
2537
+		return false;
2538
+	}
2539
+
2540
+
2541
+
2542
+
2543
+
2544
+
2545
+	/********************************************************************************************************/
2546
+	/**********************************  PROCESS GATEWAY RESPONSE  **********************************/
2547
+	/********************************************************************************************************/
2548
+	/**
2549
+	 * process_gateway_response
2550
+	 * this is the return point for Off-Site Payment Methods
2551
+	 * It will attempt to "handle the IPN" if it appears that this has not already occurred,
2552
+	 * otherwise, it will load up the last payment made for the TXN.
2553
+	 * If the payment retrieved looks good, it will then either:
2554
+	 *    complete the current step and allow advancement to the next reg step
2555
+	 *        or present the payment options again
2556
+	 *
2557
+	 * @access private
2558
+	 * @return EE_Payment|FALSE
2559
+	 * @throws EE_Error
2560
+	 * @throws InvalidArgumentException
2561
+	 * @throws ReflectionException
2562
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2563
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2564
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
2565
+	 */
2566
+	public function process_gateway_response()
2567
+	{
2568
+		$payment = null;
2569
+		// how have they chosen to pay?
2570
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
2571
+		// get EE_Payment_Method object
2572
+		if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
2573
+			$this->checkout->continue_reg = false;
2574
+			return false;
2575
+		}
2576
+		if (! $this->checkout->payment_method->is_off_site()) {
2577
+			return false;
2578
+		}
2579
+		$this->_validate_offsite_return();
2580
+		// DEBUG LOG
2581
+		// $this->checkout->log(
2582
+		//     __CLASS__,
2583
+		//     __FUNCTION__,
2584
+		//     __LINE__,
2585
+		//     array(
2586
+		//         'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
2587
+		//         'payment_method'             => $this->checkout->payment_method,
2588
+		//     ),
2589
+		//     true
2590
+		// );
2591
+		// verify TXN
2592
+		if ($this->checkout->transaction instanceof EE_Transaction) {
2593
+			$gateway = $this->checkout->payment_method->type_obj()->get_gateway();
2594
+			if (! $gateway instanceof EE_Offsite_Gateway) {
2595
+				$this->checkout->continue_reg = false;
2596
+				return false;
2597
+			}
2598
+			$payment = $this->_process_off_site_payment($gateway);
2599
+			$payment = $this->_process_cancelled_payments($payment);
2600
+			$payment = $this->_validate_payment($payment);
2601
+			// if payment was not declined by the payment gateway or cancelled by the registrant
2602
+			if ($this->_process_payment_status($payment, EE_PMT_Base::offsite)) {
2603
+				// $this->_setup_redirect_for_next_step();
2604
+				// store that for later
2605
+				$this->checkout->payment = $payment;
2606
+				// mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
2607
+				// because we will complete this step during the IPN processing then
2608
+				if ($gateway instanceof EE_Offsite_Gateway && ! $this->handle_IPN_in_this_request()) {
2609
+					$this->set_completed();
2610
+				}
2611
+				return true;
2612
+			}
2613
+		}
2614
+		// DEBUG LOG
2615
+		// $this->checkout->log(
2616
+		//     __CLASS__,
2617
+		//     __FUNCTION__,
2618
+		//     __LINE__,
2619
+		//     array('payment' => $payment)
2620
+		// );
2621
+		$this->checkout->continue_reg = false;
2622
+		return false;
2623
+	}
2624
+
2625
+
2626
+	/**
2627
+	 * _validate_return
2628
+	 *
2629
+	 * @access private
2630
+	 * @return void
2631
+	 * @throws EE_Error
2632
+	 * @throws InvalidArgumentException
2633
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2634
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2635
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
2636
+	 */
2637
+	private function _validate_offsite_return()
2638
+	{
2639
+		$TXN_ID = (int) EE_Registry::instance()->REQ->get('spco_txn', 0);
2640
+		if ($TXN_ID !== $this->checkout->transaction->ID()) {
2641
+			// Houston... we might have a problem
2642
+			$invalid_TXN = false;
2643
+			// first gather some info
2644
+			$valid_TXN = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
2645
+			$primary_registrant = $valid_TXN instanceof EE_Transaction
2646
+				? $valid_TXN->primary_registration()
2647
+				: null;
2648
+			// let's start by retrieving the cart for this TXN
2649
+			$cart = $this->checkout->get_cart_for_transaction($this->checkout->transaction);
2650
+			if ($cart instanceof EE_Cart) {
2651
+				// verify that the current cart has tickets
2652
+				$tickets = $cart->get_tickets();
2653
+				if (empty($tickets)) {
2654
+					$invalid_TXN = true;
2655
+				}
2656
+			} else {
2657
+				$invalid_TXN = true;
2658
+			}
2659
+			$valid_TXN_SID = $primary_registrant instanceof EE_Registration
2660
+				? $primary_registrant->session_ID()
2661
+				: null;
2662
+			// validate current Session ID and compare against valid TXN session ID
2663
+			if ($invalid_TXN // if this is already true, then skip other checks
2664
+				|| EE_Session::instance()->id() === null
2665
+				|| (
2666
+					// WARNING !!!
2667
+					// this could be PayPal sending back duplicate requests (ya they do that)
2668
+					// or it **could** mean someone is simply registering AGAIN after having just done so
2669
+					// so now we need to determine if this current TXN looks valid or not
2670
+					// and whether this reg step has even been started ?
2671
+					EE_Session::instance()->id() === $valid_TXN_SID
2672
+					// really? you're half way through this reg step, but you never started it ?
2673
+					&& $this->checkout->transaction->reg_step_completed($this->slug()) === false
2674
+				)
2675
+			) {
2676
+				$invalid_TXN = true;
2677
+			}
2678
+			if ($invalid_TXN) {
2679
+				// is the valid TXN completed ?
2680
+				if ($valid_TXN instanceof EE_Transaction) {
2681
+					// has this step even been started ?
2682
+					$reg_step_completed = $valid_TXN->reg_step_completed($this->slug());
2683
+					if ($reg_step_completed !== false && $reg_step_completed !== true) {
2684
+						// so it **looks** like this is a double request from PayPal
2685
+						// so let's try to pick up where we left off
2686
+						$this->checkout->transaction = $valid_TXN;
2687
+						$this->checkout->refresh_all_entities(true);
2688
+						return;
2689
+					}
2690
+				}
2691
+				// you appear to be lost?
2692
+				$this->_redirect_wayward_request($primary_registrant);
2693
+			}
2694
+		}
2695
+	}
2696
+
2697
+
2698
+	/**
2699
+	 * _redirect_wayward_request
2700
+	 *
2701
+	 * @access private
2702
+	 * @param \EE_Registration|null $primary_registrant
2703
+	 * @return bool
2704
+	 * @throws EE_Error
2705
+	 * @throws InvalidArgumentException
2706
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2707
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2708
+	 */
2709
+	private function _redirect_wayward_request(EE_Registration $primary_registrant)
2710
+	{
2711
+		if (! $primary_registrant instanceof EE_Registration) {
2712
+			// try redirecting based on the current TXN
2713
+			$primary_registrant = $this->checkout->transaction instanceof EE_Transaction
2714
+				? $this->checkout->transaction->primary_registration()
2715
+				: null;
2716
+		}
2717
+		if (! $primary_registrant instanceof EE_Registration) {
2718
+			EE_Error::add_error(
2719
+				sprintf(
2720
+					esc_html__(
2721
+						'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.',
2722
+						'event_espresso'
2723
+					),
2724
+					'<br/>',
2725
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2726
+				),
2727
+				__FILE__,
2728
+				__FUNCTION__,
2729
+				__LINE__
2730
+			);
2731
+			return false;
2732
+		}
2733
+		// make sure transaction is not locked
2734
+		$this->checkout->transaction->unlock();
2735
+		wp_safe_redirect(
2736
+			add_query_arg(
2737
+				array(
2738
+					'e_reg_url_link' => $primary_registrant->reg_url_link(),
2739
+				),
2740
+				$this->checkout->thank_you_page_url
2741
+			)
2742
+		);
2743
+		exit();
2744
+	}
2745
+
2746
+
2747
+	/**
2748
+	 * _process_off_site_payment
2749
+	 *
2750
+	 * @access private
2751
+	 * @param \EE_Offsite_Gateway $gateway
2752
+	 * @return EE_Payment
2753
+	 * @throws EE_Error
2754
+	 * @throws InvalidArgumentException
2755
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2756
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2757
+	 */
2758
+	private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
2759
+	{
2760
+		try {
2761
+			$request_data = \EE_Registry::instance()->REQ->params();
2762
+			// if gateway uses_separate_IPN_request, then we don't have to process the IPN manually
2763
+			$this->set_handle_IPN_in_this_request(
2764
+				$gateway->handle_IPN_in_this_request($request_data, false)
2765
+			);
2766
+			if ($this->handle_IPN_in_this_request()) {
2767
+				// get payment details and process results
2768
+				/** @type EE_Payment_Processor $payment_processor */
2769
+				$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
2770
+				$payment = $payment_processor->process_ipn(
2771
+					$request_data,
2772
+					$this->checkout->transaction,
2773
+					$this->checkout->payment_method,
2774
+					true,
2775
+					false
2776
+				);
2777
+				// $payment_source = 'process_ipn';
2778
+			} else {
2779
+				$payment = $this->checkout->transaction->last_payment();
2780
+				// $payment_source = 'last_payment';
2781
+			}
2782
+		} catch (Exception $e) {
2783
+			// let's just eat the exception and try to move on using any previously set payment info
2784
+			$payment = $this->checkout->transaction->last_payment();
2785
+			// $payment_source = 'last_payment after Exception';
2786
+			// but if we STILL don't have a payment object
2787
+			if (! $payment instanceof EE_Payment) {
2788
+				// then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
2789
+				$this->_handle_payment_processor_exception($e);
2790
+			}
2791
+		}
2792
+		// DEBUG LOG
2793
+		// $this->checkout->log(
2794
+		//     __CLASS__,
2795
+		//     __FUNCTION__,
2796
+		//     __LINE__,
2797
+		//     array(
2798
+		//         'process_ipn_payment' => $payment,
2799
+		//         'payment_source'      => $payment_source,
2800
+		//     )
2801
+		// );
2802
+		return $payment;
2803
+	}
2804
+
2805
+
2806
+	/**
2807
+	 * _process_cancelled_payments
2808
+	 * just makes sure that the payment status gets updated correctly
2809
+	 * so tha tan error isn't generated during payment validation
2810
+	 *
2811
+	 * @access private
2812
+	 * @param EE_Payment $payment
2813
+	 * @return EE_Payment | FALSE
2814
+	 * @throws \EE_Error
2815
+	 */
2816
+	private function _process_cancelled_payments($payment = null)
2817
+	{
2818
+		if ($payment instanceof EE_Payment
2819
+			&& isset($_REQUEST['ee_cancel_payment'])
2820
+			&& $payment->status() === EEM_Payment::status_id_failed
2821
+		) {
2822
+			$payment->set_status(EEM_Payment::status_id_cancelled);
2823
+		}
2824
+		return $payment;
2825
+	}
2826
+
2827
+
2828
+	/**
2829
+	 *    get_transaction_details_for_gateways
2830
+	 *
2831
+	 * @access    public
2832
+	 * @return int
2833
+	 * @throws EE_Error
2834
+	 * @throws InvalidArgumentException
2835
+	 * @throws ReflectionException
2836
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2837
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2838
+	 */
2839
+	public function get_transaction_details_for_gateways()
2840
+	{
2841
+		$txn_details = array();
2842
+		// ya gotta make a choice man
2843
+		if (empty($this->checkout->selected_method_of_payment)) {
2844
+			$txn_details = array(
2845
+				'error' => esc_html__('Please select a method of payment before proceeding.', 'event_espresso'),
2846
+			);
2847
+		}
2848
+		// get EE_Payment_Method object
2849
+		if (empty($txn_details)
2850
+			&&
2851
+			! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
2852
+		) {
2853
+			$txn_details = array(
2854
+				'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
2855
+				'error'                      => esc_html__(
2856
+					'A valid Payment Method could not be determined.',
2857
+					'event_espresso'
2858
+				),
2859
+			);
2860
+		}
2861
+		if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
2862
+			$return_url = $this->_get_return_url($this->checkout->payment_method);
2863
+			$txn_details = array(
2864
+				'TXN_ID'         => $this->checkout->transaction->ID(),
2865
+				'TXN_timestamp'  => $this->checkout->transaction->datetime(),
2866
+				'TXN_total'      => $this->checkout->transaction->total(),
2867
+				'TXN_paid'       => $this->checkout->transaction->paid(),
2868
+				'TXN_reg_steps'  => $this->checkout->transaction->reg_steps(),
2869
+				'STS_ID'         => $this->checkout->transaction->status_ID(),
2870
+				'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
2871
+				'payment_amount' => $this->checkout->amount_owing,
2872
+				'return_url'     => $return_url,
2873
+				'cancel_url'     => add_query_arg(array('ee_cancel_payment' => true), $return_url),
2874
+				'notify_url'     => EE_Config::instance()->core->txn_page_url(
2875
+					array(
2876
+						'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
2877
+						'ee_payment_method' => $this->checkout->payment_method->slug(),
2878
+					)
2879
+				),
2880
+			);
2881
+		}
2882
+		echo wp_json_encode($txn_details);
2883
+		exit();
2884
+	}
2885
+
2886
+
2887
+	/**
2888
+	 *    __sleep
2889
+	 * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
2890
+	 * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
2891
+	 * reg form, because if needed, it will be regenerated anyways
2892
+	 *
2893
+	 * @return array
2894
+	 */
2895
+	public function __sleep()
2896
+	{
2897
+		// remove the reg form and the checkout
2898
+		return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout', 'line_item_display'));
2899
+	}
2900 2900
 }
Please login to merge, or discard this patch.
Spacing   +76 added lines, -76 removed lines patch added patch discarded remove patch
@@ -129,7 +129,7 @@  discard block
 block discarded – undo
129 129
     {
130 130
         $this->_slug = 'payment_options';
131 131
         $this->_name = esc_html__('Payment Options', 'event_espresso');
132
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . '/payment_options_main.template.php';
132
+        $this->_template = SPCO_REG_STEPS_PATH.$this->_slug.'/payment_options_main.template.php';
133 133
         $this->checkout = $checkout;
134 134
         $this->_reset_success_message();
135 135
         $this->set_instructions(
@@ -212,7 +212,7 @@  discard block
 block discarded – undo
212 212
     {
213 213
         $transaction = $this->checkout->transaction;
214 214
         // if the transaction isn't set or nothing is owed on it, don't enqueue any JS
215
-        if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
215
+        if ( ! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
216 216
             return;
217 217
         }
218 218
         foreach (EEM_Payment_Method::instance()->get_all_for_transaction(
@@ -304,18 +304,18 @@  discard block
 block discarded – undo
304 304
         foreach ($registrations as $REG_ID => $registration) {
305 305
             /** @var $registration EE_Registration */
306 306
             // has this registration lost it's space ?
307
-            if (isset($ejected_registrations[ $REG_ID ])) {
307
+            if (isset($ejected_registrations[$REG_ID])) {
308 308
                 if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
309
-                    $sold_out_events[ $registration->event()->ID() ] = $registration->event();
309
+                    $sold_out_events[$registration->event()->ID()] = $registration->event();
310 310
                 } else {
311
-                    $insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
311
+                    $insufficient_spaces_available[$registration->event()->ID()] = $registration->event();
312 312
                 }
313 313
                 continue;
314 314
             }
315 315
             // event requires admin approval
316 316
             if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
317 317
                 // add event to list of events with pre-approval reg status
318
-                $registrations_requiring_pre_approval[ $REG_ID ] = $registration;
318
+                $registrations_requiring_pre_approval[$REG_ID] = $registration;
319 319
                 do_action(
320 320
                     'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
321 321
                     $registration->event(),
@@ -331,7 +331,7 @@  discard block
 block discarded – undo
331 331
                 )
332 332
             ) {
333 333
                 // add event to list of events that are sold out
334
-                $sold_out_events[ $registration->event()->ID() ] = $registration->event();
334
+                $sold_out_events[$registration->event()->ID()] = $registration->event();
335 335
                 do_action(
336 336
                     'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
337 337
                     $registration->event(),
@@ -341,38 +341,38 @@  discard block
 block discarded – undo
341 341
             }
342 342
             // are they allowed to pay now and is there monies owing?
343 343
             if ($registration->owes_monies_and_can_pay()) {
344
-                $registrations_requiring_payment[ $REG_ID ] = $registration;
344
+                $registrations_requiring_payment[$REG_ID] = $registration;
345 345
                 do_action(
346 346
                     'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
347 347
                     $registration->event(),
348 348
                     $this
349 349
                 );
350
-            } elseif (! $this->checkout->revisit
350
+            } elseif ( ! $this->checkout->revisit
351 351
                       && $registration->status_ID() !== EEM_Registration::status_id_not_approved
352 352
                       && $registration->ticket()->is_free()
353 353
             ) {
354
-                $registrations_for_free_events[ $registration->ticket()->ID() ] = $registration;
354
+                $registrations_for_free_events[$registration->ticket()->ID()] = $registration;
355 355
             }
356 356
         }
357 357
         $subsections = array();
358 358
         // now decide which template to load
359
-        if (! empty($sold_out_events)) {
359
+        if ( ! empty($sold_out_events)) {
360 360
             $subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
361 361
         }
362
-        if (! empty($insufficient_spaces_available)) {
362
+        if ( ! empty($insufficient_spaces_available)) {
363 363
             $subsections['insufficient_space'] = $this->_insufficient_spaces_available(
364 364
                 $insufficient_spaces_available
365 365
             );
366 366
         }
367
-        if (! empty($registrations_requiring_pre_approval)) {
367
+        if ( ! empty($registrations_requiring_pre_approval)) {
368 368
             $subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
369 369
                 $registrations_requiring_pre_approval
370 370
             );
371 371
         }
372
-        if (! empty($registrations_for_free_events)) {
372
+        if ( ! empty($registrations_for_free_events)) {
373 373
             $subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
374 374
         }
375
-        if (! empty($registrations_requiring_payment)) {
375
+        if ( ! empty($registrations_requiring_payment)) {
376 376
             if ($this->checkout->amount_owing > 0) {
377 377
                 // autoload Line_Item_Display classes
378 378
                 EEH_Autoloader::register_line_item_filter_autoloaders();
@@ -437,13 +437,13 @@  discard block
 block discarded – undo
437 437
      */
438 438
     public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
439 439
     {
440
-        if (! EE_Registry::instance()->SSN instanceof EE_Session) {
440
+        if ( ! EE_Registry::instance()->SSN instanceof EE_Session) {
441 441
             return $line_item_filter_collection;
442 442
         }
443
-        if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
443
+        if ( ! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
444 444
             return $line_item_filter_collection;
445 445
         }
446
-        if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
446
+        if ( ! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
447 447
             return $line_item_filter_collection;
448 448
         }
449 449
         $line_item_filter_collection->add(
@@ -483,8 +483,8 @@  discard block
 block discarded – undo
483 483
         );
484 484
         foreach ($registrations as $REG_ID => $registration) {
485 485
             // has this registration lost it's space ?
486
-            if (isset($ejected_registrations[ $REG_ID ])) {
487
-                unset($registrations[ $REG_ID ]);
486
+            if (isset($ejected_registrations[$REG_ID])) {
487
+                unset($registrations[$REG_ID]);
488 488
                 continue;
489 489
             }
490 490
         }
@@ -534,24 +534,24 @@  discard block
 block discarded – undo
534 534
             }
535 535
             $EVT_ID = $registration->event_ID();
536 536
             $ticket = $registration->ticket();
537
-            if (! isset($tickets_remaining[ $ticket->ID() ])) {
538
-                $tickets_remaining[ $ticket->ID() ] = $ticket->remaining();
537
+            if ( ! isset($tickets_remaining[$ticket->ID()])) {
538
+                $tickets_remaining[$ticket->ID()] = $ticket->remaining();
539 539
             }
540
-            if ($tickets_remaining[ $ticket->ID() ] > 0) {
541
-                if (! isset($event_reg_count[ $EVT_ID ])) {
542
-                    $event_reg_count[ $EVT_ID ] = 0;
540
+            if ($tickets_remaining[$ticket->ID()] > 0) {
541
+                if ( ! isset($event_reg_count[$EVT_ID])) {
542
+                    $event_reg_count[$EVT_ID] = 0;
543 543
                 }
544
-                $event_reg_count[ $EVT_ID ]++;
545
-                if (! isset($event_spaces_remaining[ $EVT_ID ])) {
546
-                    $event_spaces_remaining[ $EVT_ID ] = $registration->event()->spaces_remaining_for_sale();
544
+                $event_reg_count[$EVT_ID]++;
545
+                if ( ! isset($event_spaces_remaining[$EVT_ID])) {
546
+                    $event_spaces_remaining[$EVT_ID] = $registration->event()->spaces_remaining_for_sale();
547 547
                 }
548 548
             }
549 549
             if ($revisit
550
-                && ($tickets_remaining[ $ticket->ID() ] === 0
551
-                    || $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
550
+                && ($tickets_remaining[$ticket->ID()] === 0
551
+                    || $event_reg_count[$EVT_ID] > $event_spaces_remaining[$EVT_ID]
552 552
                 )
553 553
             ) {
554
-                $ejected_registrations[ $REG_ID ] = $registration->event();
554
+                $ejected_registrations[$REG_ID] = $registration->event();
555 555
                 if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
556 556
                     /** @type EE_Registration_Processor $registration_processor */
557 557
                     $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
@@ -611,7 +611,7 @@  discard block
 block discarded – undo
611 611
         foreach ($sold_out_events_array as $sold_out_event) {
612 612
             $sold_out_events .= EEH_HTML::li(
613 613
                 EEH_HTML::span(
614
-                    '  ' . $sold_out_event->name(),
614
+                    '  '.$sold_out_event->name(),
615 615
                     '',
616 616
                     'dashicons dashicons-marker ee-icon-size-16 pink-text'
617 617
                 )
@@ -666,7 +666,7 @@  discard block
 block discarded – undo
666 666
         foreach ($insufficient_spaces_events_array as $event) {
667 667
             if ($event instanceof EE_Event) {
668 668
                 $insufficient_space_events .= EEH_HTML::li(
669
-                    EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
669
+                    EEH_HTML::span(' '.$event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
670 670
                 );
671 671
             }
672 672
         }
@@ -714,7 +714,7 @@  discard block
 block discarded – undo
714 714
         $events_requiring_pre_approval = array();
715 715
         foreach ($registrations_requiring_pre_approval as $registration) {
716 716
             if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
717
-                $events_requiring_pre_approval[ $registration->event()->ID() ] = EEH_HTML::li(
717
+                $events_requiring_pre_approval[$registration->event()->ID()] = EEH_HTML::li(
718 718
                     EEH_HTML::span(
719 719
                         '',
720 720
                         '',
@@ -853,7 +853,7 @@  discard block
 block discarded – undo
853 853
     {
854 854
         return new EE_Form_Section_Proper(
855 855
             array(
856
-                'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
856
+                'html_id'         => 'ee-'.$this->slug().'-extra-hidden-inputs',
857 857
                 'layout_strategy' => new EE_Div_Per_Section_Layout(),
858 858
                 'subsections'     => array(
859 859
                     'spco_no_payment_required' => new EE_Hidden_Input(
@@ -893,7 +893,7 @@  discard block
 block discarded – undo
893 893
                 $payments += $registration->registration_payments();
894 894
             }
895 895
         }
896
-        if (! empty($payments)) {
896
+        if ( ! empty($payments)) {
897 897
             foreach ($payments as $payment) {
898 898
                 if ($payment instanceof EE_Registration_Payment) {
899 899
                     $this->checkout->amount_owing -= $payment->amount();
@@ -1017,23 +1017,23 @@  discard block
 block discarded – undo
1017 1017
                 $payment_method_button = EEH_HTML::img(
1018 1018
                     $payment_method->button_url(),
1019 1019
                     $payment_method->name(),
1020
-                    'spco-payment-method-' . $payment_method->slug() . '-btn-img',
1020
+                    'spco-payment-method-'.$payment_method->slug().'-btn-img',
1021 1021
                     'spco-payment-method-btn-img'
1022 1022
                 );
1023 1023
                 // check if any payment methods are set as default
1024 1024
                 // if payment method is already selected OR nothing is selected and this payment method should be
1025 1025
                 // open_by_default
1026 1026
                 if (($this->checkout->selected_method_of_payment === $payment_method->slug())
1027
-                    || (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
1027
+                    || ( ! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
1028 1028
                 ) {
1029 1029
                     $this->checkout->selected_method_of_payment = $payment_method->slug();
1030 1030
                     $this->_save_selected_method_of_payment();
1031
-                    $default_payment_method_option[ $payment_method->slug() ] = $payment_method_button;
1031
+                    $default_payment_method_option[$payment_method->slug()] = $payment_method_button;
1032 1032
                 } else {
1033
-                    $available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
1033
+                    $available_payment_method_options[$payment_method->slug()] = $payment_method_button;
1034 1034
                 }
1035
-                $payment_methods_billing_info[ $payment_method->slug(
1036
-                ) . '-info' ] = $this->_payment_method_billing_info(
1035
+                $payment_methods_billing_info[$payment_method->slug(
1036
+                ).'-info'] = $this->_payment_method_billing_info(
1037 1037
                     $payment_method
1038 1038
                 );
1039 1039
             }
@@ -1069,7 +1069,7 @@  discard block
 block discarded – undo
1069 1069
      */
1070 1070
     protected function _get_available_payment_methods()
1071 1071
     {
1072
-        if (! empty($this->checkout->available_payment_methods)) {
1072
+        if ( ! empty($this->checkout->available_payment_methods)) {
1073 1073
             return $this->checkout->available_payment_methods;
1074 1074
         }
1075 1075
         $available_payment_methods = array();
@@ -1084,7 +1084,7 @@  discard block
 block discarded – undo
1084 1084
         );
1085 1085
         foreach ($payment_methods as $payment_method) {
1086 1086
             if ($payment_method instanceof EE_Payment_Method) {
1087
-                $available_payment_methods[ $payment_method->slug() ] = $payment_method;
1087
+                $available_payment_methods[$payment_method->slug()] = $payment_method;
1088 1088
             }
1089 1089
         }
1090 1090
         return $available_payment_methods;
@@ -1179,7 +1179,7 @@  discard block
 block discarded – undo
1179 1179
         );
1180 1180
         return new EE_Form_Section_Proper(
1181 1181
             array(
1182
-                'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
1182
+                'html_id'         => 'spco-payment-method-info-'.$payment_method->slug(),
1183 1183
                 'html_class'      => 'spco-payment-method-info-dv',
1184 1184
                 // only display the selected or default PM
1185 1185
                 'html_style'      => $currently_selected ? '' : 'display:none;',
@@ -1209,7 +1209,7 @@  discard block
 block discarded – undo
1209 1209
         // how have they chosen to pay?
1210 1210
         $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
1211 1211
         $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
1212
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
1212
+        if ( ! $this->checkout->payment_method instanceof EE_Payment_Method) {
1213 1213
             return false;
1214 1214
         }
1215 1215
         if (apply_filters(
@@ -1381,7 +1381,7 @@  discard block
 block discarded – undo
1381 1381
      */
1382 1382
     public function switch_payment_method()
1383 1383
     {
1384
-        if (! $this->_verify_payment_method_is_set()) {
1384
+        if ( ! $this->_verify_payment_method_is_set()) {
1385 1385
             return false;
1386 1386
         }
1387 1387
         if (apply_filters(
@@ -1516,7 +1516,7 @@  discard block
 block discarded – undo
1516 1516
             }
1517 1517
         }
1518 1518
         // verify payment method
1519
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
1519
+        if ( ! $this->checkout->payment_method instanceof EE_Payment_Method) {
1520 1520
             // get payment method for selected method of payment
1521 1521
             $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
1522 1522
         }
@@ -1541,7 +1541,7 @@  discard block
 block discarded – undo
1541 1541
      */
1542 1542
     public function save_payer_details_via_ajax()
1543 1543
     {
1544
-        if (! $this->_verify_payment_method_is_set()) {
1544
+        if ( ! $this->_verify_payment_method_is_set()) {
1545 1545
             return;
1546 1546
         }
1547 1547
         // generate billing form for selected method of payment if it hasn't been done already
@@ -1551,7 +1551,7 @@  discard block
 block discarded – undo
1551 1551
             );
1552 1552
         }
1553 1553
         // generate primary attendee from payer info if applicable
1554
-        if (! $this->checkout->transaction_has_primary_registrant()) {
1554
+        if ( ! $this->checkout->transaction_has_primary_registrant()) {
1555 1555
             $attendee = $this->_create_attendee_from_request_data();
1556 1556
             if ($attendee instanceof EE_Attendee) {
1557 1557
                 foreach ($this->checkout->transaction->registrations() as $registration) {
@@ -1582,7 +1582,7 @@  discard block
 block discarded – undo
1582 1582
     {
1583 1583
         // get State ID
1584 1584
         $STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['state']) : '';
1585
-        if (! empty($STA_ID)) {
1585
+        if ( ! empty($STA_ID)) {
1586 1586
             // can we get state object from name ?
1587 1587
             EE_Registry::instance()->load_model('State');
1588 1588
             $state = EEM_State::instance()->get_col(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
@@ -1590,7 +1590,7 @@  discard block
 block discarded – undo
1590 1590
         }
1591 1591
         // get Country ISO
1592 1592
         $CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['country']) : '';
1593
-        if (! empty($CNT_ISO)) {
1593
+        if ( ! empty($CNT_ISO)) {
1594 1594
             // can we get country object from name ?
1595 1595
             EE_Registry::instance()->load_model('Country');
1596 1596
             $country = EEM_Country::instance()->get_col(
@@ -1623,7 +1623,7 @@  discard block
 block discarded – undo
1623 1623
         }
1624 1624
         // does this attendee already exist in the db ? we're searching using a combination of first name, last name,
1625 1625
         // AND email address
1626
-        if (! empty($attendee_data['ATT_fname'])
1626
+        if ( ! empty($attendee_data['ATT_fname'])
1627 1627
             && ! empty($attendee_data['ATT_lname'])
1628 1628
             && ! empty($attendee_data['ATT_email'])
1629 1629
         ) {
@@ -1838,7 +1838,7 @@  discard block
 block discarded – undo
1838 1838
     private function _process_payment()
1839 1839
     {
1840 1840
         // basically confirm that the event hasn't sold out since they hit the page
1841
-        if (! $this->_last_second_ticket_verifications()) {
1841
+        if ( ! $this->_last_second_ticket_verifications()) {
1842 1842
             return false;
1843 1843
         }
1844 1844
         // ya gotta make a choice man
@@ -1849,7 +1849,7 @@  discard block
 block discarded – undo
1849 1849
             return false;
1850 1850
         }
1851 1851
         // get EE_Payment_Method object
1852
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
1852
+        if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
1853 1853
             return false;
1854 1854
         }
1855 1855
         // setup billing form
@@ -1858,12 +1858,12 @@  discard block
 block discarded – undo
1858 1858
                 $this->checkout->payment_method
1859 1859
             );
1860 1860
             // bad billing form ?
1861
-            if (! $this->_billing_form_is_valid()) {
1861
+            if ( ! $this->_billing_form_is_valid()) {
1862 1862
                 return false;
1863 1863
             }
1864 1864
         }
1865 1865
         // ensure primary registrant has been fully processed
1866
-        if (! $this->_setup_primary_registrant_prior_to_payment()) {
1866
+        if ( ! $this->_setup_primary_registrant_prior_to_payment()) {
1867 1867
             return false;
1868 1868
         }
1869 1869
         // if session is close to expiring (under 10 minutes by default)
@@ -1918,7 +1918,7 @@  discard block
 block discarded – undo
1918 1918
     protected function _last_second_ticket_verifications()
1919 1919
     {
1920 1920
         // don't bother re-validating if not a return visit
1921
-        if (! $this->checkout->revisit) {
1921
+        if ( ! $this->checkout->revisit) {
1922 1922
             return true;
1923 1923
         }
1924 1924
         $registrations = $this->checkout->transaction->registrations();
@@ -1984,7 +1984,7 @@  discard block
 block discarded – undo
1984 1984
      */
1985 1985
     private function _billing_form_is_valid()
1986 1986
     {
1987
-        if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
1987
+        if ( ! $this->checkout->payment_method->type_obj()->has_billing_form()) {
1988 1988
             return true;
1989 1989
         }
1990 1990
         if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
@@ -2103,7 +2103,7 @@  discard block
 block discarded – undo
2103 2103
     {
2104 2104
         // convert billing form data into an attendee
2105 2105
         $this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
2106
-        if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
2106
+        if ( ! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
2107 2107
             EE_Error::add_error(
2108 2108
                 sprintf(
2109 2109
                     esc_html__(
@@ -2120,7 +2120,7 @@  discard block
 block discarded – undo
2120 2120
             return false;
2121 2121
         }
2122 2122
         $primary_registration = $this->checkout->transaction->primary_registration();
2123
-        if (! $primary_registration instanceof EE_Registration) {
2123
+        if ( ! $primary_registration instanceof EE_Registration) {
2124 2124
             EE_Error::add_error(
2125 2125
                 sprintf(
2126 2126
                     esc_html__(
@@ -2136,7 +2136,7 @@  discard block
 block discarded – undo
2136 2136
             );
2137 2137
             return false;
2138 2138
         }
2139
-        if (! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
2139
+        if ( ! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
2140 2140
               instanceof
2141 2141
               EE_Attendee
2142 2142
         ) {
@@ -2182,8 +2182,8 @@  discard block
 block discarded – undo
2182 2182
             return null;
2183 2183
         }
2184 2184
         // get EE_Payment_Method object
2185
-        if (isset($this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ])) {
2186
-            $payment_method = $this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ];
2185
+        if (isset($this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment])) {
2186
+            $payment_method = $this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment];
2187 2187
         } else {
2188 2188
             // load EEM_Payment_Method
2189 2189
             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 {
@@ -2352,7 +2352,7 @@  discard block
 block discarded – undo
2352 2352
             return true;
2353 2353
         }
2354 2354
         // verify payment object
2355
-        if (! $payment instanceof EE_Payment) {
2355
+        if ( ! $payment instanceof EE_Payment) {
2356 2356
             // not a payment
2357 2357
             EE_Error::add_error(
2358 2358
                 sprintf(
@@ -2392,7 +2392,7 @@  discard block
 block discarded – undo
2392 2392
             return true;
2393 2393
             // On-Site payment?
2394 2394
         } elseif ($this->checkout->payment_method->is_on_site()) {
2395
-            if (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
2395
+            if ( ! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
2396 2396
                 // $this->_setup_redirect_for_next_step();
2397 2397
                 $this->checkout->continue_reg = false;
2398 2398
             }
@@ -2508,7 +2508,7 @@  discard block
 block discarded – undo
2508 2508
                     break;
2509 2509
                 // bad payment
2510 2510
                 case EEM_Payment::status_id_failed:
2511
-                    if (! empty($msg)) {
2511
+                    if ( ! empty($msg)) {
2512 2512
                         EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2513 2513
                         return false;
2514 2514
                     }
@@ -2569,11 +2569,11 @@  discard block
 block discarded – undo
2569 2569
         // how have they chosen to pay?
2570 2570
         $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
2571 2571
         // get EE_Payment_Method object
2572
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
2572
+        if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
2573 2573
             $this->checkout->continue_reg = false;
2574 2574
             return false;
2575 2575
         }
2576
-        if (! $this->checkout->payment_method->is_off_site()) {
2576
+        if ( ! $this->checkout->payment_method->is_off_site()) {
2577 2577
             return false;
2578 2578
         }
2579 2579
         $this->_validate_offsite_return();
@@ -2591,7 +2591,7 @@  discard block
 block discarded – undo
2591 2591
         // verify TXN
2592 2592
         if ($this->checkout->transaction instanceof EE_Transaction) {
2593 2593
             $gateway = $this->checkout->payment_method->type_obj()->get_gateway();
2594
-            if (! $gateway instanceof EE_Offsite_Gateway) {
2594
+            if ( ! $gateway instanceof EE_Offsite_Gateway) {
2595 2595
                 $this->checkout->continue_reg = false;
2596 2596
                 return false;
2597 2597
             }
@@ -2708,13 +2708,13 @@  discard block
 block discarded – undo
2708 2708
      */
2709 2709
     private function _redirect_wayward_request(EE_Registration $primary_registrant)
2710 2710
     {
2711
-        if (! $primary_registrant instanceof EE_Registration) {
2711
+        if ( ! $primary_registrant instanceof EE_Registration) {
2712 2712
             // try redirecting based on the current TXN
2713 2713
             $primary_registrant = $this->checkout->transaction instanceof EE_Transaction
2714 2714
                 ? $this->checkout->transaction->primary_registration()
2715 2715
                 : null;
2716 2716
         }
2717
-        if (! $primary_registrant instanceof EE_Registration) {
2717
+        if ( ! $primary_registrant instanceof EE_Registration) {
2718 2718
             EE_Error::add_error(
2719 2719
                 sprintf(
2720 2720
                     esc_html__(
@@ -2784,7 +2784,7 @@  discard block
 block discarded – undo
2784 2784
             $payment = $this->checkout->transaction->last_payment();
2785 2785
             // $payment_source = 'last_payment after Exception';
2786 2786
             // but if we STILL don't have a payment object
2787
-            if (! $payment instanceof EE_Payment) {
2787
+            if ( ! $payment instanceof EE_Payment) {
2788 2788
                 // then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
2789 2789
                 $this->_handle_payment_processor_exception($e);
2790 2790
             }
Please login to merge, or discard this patch.
admin_pages/transactions/Transactions_Admin_Page_Init.core.php 2 patches
Indentation   +49 added lines, -49 removed lines patch added patch discarded remove patch
@@ -13,58 +13,58 @@
 block discarded – undo
13 13
 {
14 14
 
15 15
 
16
-    /**
17
-     * @Constructor
18
-     * @access public
19
-     * @return Transactions_Admin_Page_Init
20
-     */
21
-    public function __construct()
22
-    {
16
+	/**
17
+	 * @Constructor
18
+	 * @access public
19
+	 * @return Transactions_Admin_Page_Init
20
+	 */
21
+	public function __construct()
22
+	{
23 23
 
24
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
25
-        if (! defined('TXN_PG_SLUG')) {
26
-            define('TXN_PG_SLUG', 'espresso_transactions');
27
-            define('TXN_PG_NAME', ucwords(str_replace('_', '', TXN_PG_SLUG)));
28
-            define('TXN_ADMIN', EE_ADMIN_PAGES . 'transactions/');
29
-            define('TXN_ADMIN_URL', admin_url('admin.php?page=' . TXN_PG_SLUG));
30
-            define('TXN_ASSETS_PATH', TXN_ADMIN . 'assets/');
31
-            define('TXN_ASSETS_URL', str_replace('\\', '/', EE_ADMIN_PAGES_URL . 'transactions/assets/'));
32
-            define('TXN_TEMPLATE_PATH', TXN_ADMIN . 'templates/');
33
-            define('TXN_TEMPLATE_URL', str_replace('\\', '/', EE_ADMIN_PAGES_URL . 'transactions/templates/'));
34
-        }
35
-        parent::__construct();
36
-    }
24
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
25
+		if (! defined('TXN_PG_SLUG')) {
26
+			define('TXN_PG_SLUG', 'espresso_transactions');
27
+			define('TXN_PG_NAME', ucwords(str_replace('_', '', TXN_PG_SLUG)));
28
+			define('TXN_ADMIN', EE_ADMIN_PAGES . 'transactions/');
29
+			define('TXN_ADMIN_URL', admin_url('admin.php?page=' . TXN_PG_SLUG));
30
+			define('TXN_ASSETS_PATH', TXN_ADMIN . 'assets/');
31
+			define('TXN_ASSETS_URL', str_replace('\\', '/', EE_ADMIN_PAGES_URL . 'transactions/assets/'));
32
+			define('TXN_TEMPLATE_PATH', TXN_ADMIN . 'templates/');
33
+			define('TXN_TEMPLATE_URL', str_replace('\\', '/', EE_ADMIN_PAGES_URL . 'transactions/templates/'));
34
+		}
35
+		parent::__construct();
36
+	}
37 37
 
38 38
 
39
-    /**
40
-     *    _set_init_properties
41
-     *
42
-     * @return void
43
-     */
44
-    protected function _set_init_properties()
45
-    {
46
-        $this->label = __('Transactions Overview', 'event_espresso');
47
-    }
39
+	/**
40
+	 *    _set_init_properties
41
+	 *
42
+	 * @return void
43
+	 */
44
+	protected function _set_init_properties()
45
+	{
46
+		$this->label = __('Transactions Overview', 'event_espresso');
47
+	}
48 48
 
49 49
 
50
-    /**
51
-     *    _set_menu_map
52
-     *
53
-     * @return void
54
-     */
55
-    protected function _set_menu_map()
56
-    {
57
-        $this->_menu_map = new EE_Admin_Page_Sub_Menu(
58
-            array(
59
-                'menu_group'      => 'main',
60
-                'menu_order'      => 50,
61
-                'show_on_menu'    => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
62
-                'parent_slug'     => 'espresso_events',
63
-                'menu_slug'       => TXN_PG_SLUG,
64
-                'menu_label'      => __('Transactions', 'event_espresso'),
65
-                'capability'      => 'ee_read_transactions',
66
-                'admin_init_page' => $this,
67
-            )
68
-        );
69
-    }
50
+	/**
51
+	 *    _set_menu_map
52
+	 *
53
+	 * @return void
54
+	 */
55
+	protected function _set_menu_map()
56
+	{
57
+		$this->_menu_map = new EE_Admin_Page_Sub_Menu(
58
+			array(
59
+				'menu_group'      => 'main',
60
+				'menu_order'      => 50,
61
+				'show_on_menu'    => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
62
+				'parent_slug'     => 'espresso_events',
63
+				'menu_slug'       => TXN_PG_SLUG,
64
+				'menu_label'      => __('Transactions', 'event_espresso'),
65
+				'capability'      => 'ee_read_transactions',
66
+				'admin_init_page' => $this,
67
+			)
68
+		);
69
+	}
70 70
 }
Please login to merge, or discard this patch.
Spacing   +7 added lines, -7 removed lines patch added patch discarded remove patch
@@ -22,15 +22,15 @@
 block discarded – undo
22 22
     {
23 23
 
24 24
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
25
-        if (! defined('TXN_PG_SLUG')) {
25
+        if ( ! defined('TXN_PG_SLUG')) {
26 26
             define('TXN_PG_SLUG', 'espresso_transactions');
27 27
             define('TXN_PG_NAME', ucwords(str_replace('_', '', TXN_PG_SLUG)));
28
-            define('TXN_ADMIN', EE_ADMIN_PAGES . 'transactions/');
29
-            define('TXN_ADMIN_URL', admin_url('admin.php?page=' . TXN_PG_SLUG));
30
-            define('TXN_ASSETS_PATH', TXN_ADMIN . 'assets/');
31
-            define('TXN_ASSETS_URL', str_replace('\\', '/', EE_ADMIN_PAGES_URL . 'transactions/assets/'));
32
-            define('TXN_TEMPLATE_PATH', TXN_ADMIN . 'templates/');
33
-            define('TXN_TEMPLATE_URL', str_replace('\\', '/', EE_ADMIN_PAGES_URL . 'transactions/templates/'));
28
+            define('TXN_ADMIN', EE_ADMIN_PAGES.'transactions/');
29
+            define('TXN_ADMIN_URL', admin_url('admin.php?page='.TXN_PG_SLUG));
30
+            define('TXN_ASSETS_PATH', TXN_ADMIN.'assets/');
31
+            define('TXN_ASSETS_URL', str_replace('\\', '/', EE_ADMIN_PAGES_URL.'transactions/assets/'));
32
+            define('TXN_TEMPLATE_PATH', TXN_ADMIN.'templates/');
33
+            define('TXN_TEMPLATE_URL', str_replace('\\', '/', EE_ADMIN_PAGES_URL.'transactions/templates/'));
34 34
         }
35 35
         parent::__construct();
36 36
     }
Please login to merge, or discard this patch.
admin_pages/payments/Payments_Admin_Page_Init.core.php 2 patches
Indentation   +138 added lines, -138 removed lines patch added patch discarded remove patch
@@ -15,144 +15,144 @@
 block discarded – undo
15 15
 class Payments_Admin_Page_Init extends EE_Admin_Page_Init
16 16
 {
17 17
 
18
-    /**
19
-     * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
20
-     */
21
-    protected $_table_analysis;
22
-
23
-
24
-    /**
25
-     * Payments_Admin_Page_Init constructor.
26
-     */
27
-    public function __construct()
28
-    {
29
-        // define some page related constants
30
-        define('EE_PAYMENTS_PG_SLUG', 'espresso_payment_settings');
31
-        define('EE_PAYMENTS_ADMIN_URL', admin_url('admin.php?page=' . EE_PAYMENTS_PG_SLUG));
32
-        define('EE_PAYMENTS_ADMIN', EE_ADMIN_PAGES . 'payments/');
33
-        define('EE_PAYMENTS_TEMPLATE_PATH', EE_PAYMENTS_ADMIN . 'templates/');
34
-        define('EE_PAYMENTS_ASSETS_URL', EE_ADMIN_PAGES_URL . 'payments/assets/');
35
-        $this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
36
-        // check that there are active gateways on all admin page loads. but dont do it just yet
37
-        add_action('admin_notices', array($this, 'check_payment_gateway_setup'));
38
-
39
-        // Show/hide PP Standard along side PP Express.
40
-        add_filter(
41
-            'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
42
-            array($this, 'unset_pp_standard')
43
-        );
44
-
45
-        parent::__construct();
46
-    }
47
-
48
-    protected function _set_init_properties()
49
-    {
50
-        $this->label = __('Payment Methods', 'event_espresso');
51
-    }
52
-
53
-
54
-    /**
55
-     * _set_menu_map
56
-     *
57
-     * @return void
58
-     */
59
-    protected function _set_menu_map()
60
-    {
61
-        $this->_menu_map = new EE_Admin_Page_Sub_Menu(
62
-            array(
63
-                'menu_group'      => 'settings',
64
-                'menu_order'      => 30,
65
-                'show_on_menu'    => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
66
-                'parent_slug'     => 'espresso_events',
67
-                'menu_slug'       => EE_PAYMENTS_PG_SLUG,
68
-                'menu_label'      => __('Payment Methods', 'event_espresso'),
69
-                'capability'      => 'ee_manage_gateways',
70
-                'admin_init_page' => $this,
71
-            )
72
-        );
73
-    }
74
-
75
-
76
-    /**
77
-     * Checks that there is at least one active gateway. If not, add a notice
78
-     *
79
-     * @throws \EE_Error
80
-     */
81
-    public function check_payment_gateway_setup()
82
-    {
83
-        // ONLY do this check if models can query
84
-        // and avoid a bug where when we nuke EE4's data that this causes a fatal error
85
-        // because the tables are deleted just before this request runs. see https://events.codebasehq.com/projects/event-espresso/tickets/7539
86
-        if (! EE_Maintenance_Mode::instance()->models_can_query()
87
-            || ! $this->_get_table_analysis()->tableExists(EEM_Payment_Method::instance()->table())
88
-        ) {
89
-            return;
90
-        }
91
-
92
-
93
-        // ensure Payment_Method model is loaded
94
-        EE_Registry::instance()->load_model('Payment_Method');
95
-        $actives = EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart);
96
-        if ($actives < 1) {
97
-            $url = EE_Admin_Page::add_query_args_and_nonce(array(), EE_PAYMENTS_ADMIN_URL);
98
-            echo '<div class="error">
18
+	/**
19
+	 * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
20
+	 */
21
+	protected $_table_analysis;
22
+
23
+
24
+	/**
25
+	 * Payments_Admin_Page_Init constructor.
26
+	 */
27
+	public function __construct()
28
+	{
29
+		// define some page related constants
30
+		define('EE_PAYMENTS_PG_SLUG', 'espresso_payment_settings');
31
+		define('EE_PAYMENTS_ADMIN_URL', admin_url('admin.php?page=' . EE_PAYMENTS_PG_SLUG));
32
+		define('EE_PAYMENTS_ADMIN', EE_ADMIN_PAGES . 'payments/');
33
+		define('EE_PAYMENTS_TEMPLATE_PATH', EE_PAYMENTS_ADMIN . 'templates/');
34
+		define('EE_PAYMENTS_ASSETS_URL', EE_ADMIN_PAGES_URL . 'payments/assets/');
35
+		$this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
36
+		// check that there are active gateways on all admin page loads. but dont do it just yet
37
+		add_action('admin_notices', array($this, 'check_payment_gateway_setup'));
38
+
39
+		// Show/hide PP Standard along side PP Express.
40
+		add_filter(
41
+			'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
42
+			array($this, 'unset_pp_standard')
43
+		);
44
+
45
+		parent::__construct();
46
+	}
47
+
48
+	protected function _set_init_properties()
49
+	{
50
+		$this->label = __('Payment Methods', 'event_espresso');
51
+	}
52
+
53
+
54
+	/**
55
+	 * _set_menu_map
56
+	 *
57
+	 * @return void
58
+	 */
59
+	protected function _set_menu_map()
60
+	{
61
+		$this->_menu_map = new EE_Admin_Page_Sub_Menu(
62
+			array(
63
+				'menu_group'      => 'settings',
64
+				'menu_order'      => 30,
65
+				'show_on_menu'    => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
66
+				'parent_slug'     => 'espresso_events',
67
+				'menu_slug'       => EE_PAYMENTS_PG_SLUG,
68
+				'menu_label'      => __('Payment Methods', 'event_espresso'),
69
+				'capability'      => 'ee_manage_gateways',
70
+				'admin_init_page' => $this,
71
+			)
72
+		);
73
+	}
74
+
75
+
76
+	/**
77
+	 * Checks that there is at least one active gateway. If not, add a notice
78
+	 *
79
+	 * @throws \EE_Error
80
+	 */
81
+	public function check_payment_gateway_setup()
82
+	{
83
+		// ONLY do this check if models can query
84
+		// and avoid a bug where when we nuke EE4's data that this causes a fatal error
85
+		// because the tables are deleted just before this request runs. see https://events.codebasehq.com/projects/event-espresso/tickets/7539
86
+		if (! EE_Maintenance_Mode::instance()->models_can_query()
87
+			|| ! $this->_get_table_analysis()->tableExists(EEM_Payment_Method::instance()->table())
88
+		) {
89
+			return;
90
+		}
91
+
92
+
93
+		// ensure Payment_Method model is loaded
94
+		EE_Registry::instance()->load_model('Payment_Method');
95
+		$actives = EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart);
96
+		if ($actives < 1) {
97
+			$url = EE_Admin_Page::add_query_args_and_nonce(array(), EE_PAYMENTS_ADMIN_URL);
98
+			echo '<div class="error">
99 99
 				 <p>'
100
-                 . sprintf(
101
-                     __(
102
-                         "There are no Active Payment Methods setup for Event Espresso. Please %s activate at least one.%s",
103
-                         "event_espresso"
104
-                     ),
105
-                     "<a href='$url'>",
106
-                     "</a>"
107
-                 ) . '</p>
100
+				 . sprintf(
101
+					 __(
102
+						 "There are no Active Payment Methods setup for Event Espresso. Please %s activate at least one.%s",
103
+						 "event_espresso"
104
+					 ),
105
+					 "<a href='$url'>",
106
+					 "</a>"
107
+				 ) . '</p>
108 108
 			 </div>';
109
-        }
110
-    }
111
-
112
-    /**
113
-     * Gets the injected table analyzer, or throws an exception
114
-     *
115
-     * @return TableAnalysis
116
-     * @throws \EE_Error
117
-     */
118
-    protected function _get_table_analysis()
119
-    {
120
-        if ($this->_table_analysis instanceof TableAnalysis) {
121
-            return $this->_table_analysis;
122
-        } else {
123
-            throw new \EE_Error(
124
-                sprintf(
125
-                    __('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
126
-                    get_class($this)
127
-                )
128
-            );
129
-        }
130
-    }
131
-
132
-
133
-    /**
134
-     * Hide PayPal Standard for "new" users.
135
-     */
136
-    public static function unset_pp_standard($payment_method_types)
137
-    {
138
-        $pps = EEM_Payment_Method::instance()->get_one_of_type('Paypal_Standard');
139
-        $ppstandard_active = (! empty($pps)) ? $pps->active() : false;
140
-        $ppstandard_active_before = false;
141
-        if ($pps) {
142
-            // PP Standard used before ?
143
-            $paypal_id = $pps->get_extra_meta('paypal_id', true);
144
-            if ($paypal_id && ! empty($paypal_id)) {
145
-                $ppstandard_active_before = true;
146
-            }
147
-        }
148
-
149
-        // Not using PP Standard? Then display only PayPal Express, do not show PayPal Standard.
150
-        if (apply_filters(
151
-            'FHEE__EE_PMT_Paypal_Express__register_payment_methods__hide_paypal_standard',
152
-            ! $ppstandard_active && ! $ppstandard_active_before
153
-        )) {
154
-            unset($payment_method_types['paypal_standard']);
155
-        }
156
-        return $payment_method_types;
157
-    }
109
+		}
110
+	}
111
+
112
+	/**
113
+	 * Gets the injected table analyzer, or throws an exception
114
+	 *
115
+	 * @return TableAnalysis
116
+	 * @throws \EE_Error
117
+	 */
118
+	protected function _get_table_analysis()
119
+	{
120
+		if ($this->_table_analysis instanceof TableAnalysis) {
121
+			return $this->_table_analysis;
122
+		} else {
123
+			throw new \EE_Error(
124
+				sprintf(
125
+					__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
126
+					get_class($this)
127
+				)
128
+			);
129
+		}
130
+	}
131
+
132
+
133
+	/**
134
+	 * Hide PayPal Standard for "new" users.
135
+	 */
136
+	public static function unset_pp_standard($payment_method_types)
137
+	{
138
+		$pps = EEM_Payment_Method::instance()->get_one_of_type('Paypal_Standard');
139
+		$ppstandard_active = (! empty($pps)) ? $pps->active() : false;
140
+		$ppstandard_active_before = false;
141
+		if ($pps) {
142
+			// PP Standard used before ?
143
+			$paypal_id = $pps->get_extra_meta('paypal_id', true);
144
+			if ($paypal_id && ! empty($paypal_id)) {
145
+				$ppstandard_active_before = true;
146
+			}
147
+		}
148
+
149
+		// Not using PP Standard? Then display only PayPal Express, do not show PayPal Standard.
150
+		if (apply_filters(
151
+			'FHEE__EE_PMT_Paypal_Express__register_payment_methods__hide_paypal_standard',
152
+			! $ppstandard_active && ! $ppstandard_active_before
153
+		)) {
154
+			unset($payment_method_types['paypal_standard']);
155
+		}
156
+		return $payment_method_types;
157
+	}
158 158
 }
Please login to merge, or discard this patch.
Spacing   +7 added lines, -7 removed lines patch added patch discarded remove patch
@@ -28,10 +28,10 @@  discard block
 block discarded – undo
28 28
     {
29 29
         // define some page related constants
30 30
         define('EE_PAYMENTS_PG_SLUG', 'espresso_payment_settings');
31
-        define('EE_PAYMENTS_ADMIN_URL', admin_url('admin.php?page=' . EE_PAYMENTS_PG_SLUG));
32
-        define('EE_PAYMENTS_ADMIN', EE_ADMIN_PAGES . 'payments/');
33
-        define('EE_PAYMENTS_TEMPLATE_PATH', EE_PAYMENTS_ADMIN . 'templates/');
34
-        define('EE_PAYMENTS_ASSETS_URL', EE_ADMIN_PAGES_URL . 'payments/assets/');
31
+        define('EE_PAYMENTS_ADMIN_URL', admin_url('admin.php?page='.EE_PAYMENTS_PG_SLUG));
32
+        define('EE_PAYMENTS_ADMIN', EE_ADMIN_PAGES.'payments/');
33
+        define('EE_PAYMENTS_TEMPLATE_PATH', EE_PAYMENTS_ADMIN.'templates/');
34
+        define('EE_PAYMENTS_ASSETS_URL', EE_ADMIN_PAGES_URL.'payments/assets/');
35 35
         $this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
36 36
         // check that there are active gateways on all admin page loads. but dont do it just yet
37 37
         add_action('admin_notices', array($this, 'check_payment_gateway_setup'));
@@ -83,7 +83,7 @@  discard block
 block discarded – undo
83 83
         // ONLY do this check if models can query
84 84
         // and avoid a bug where when we nuke EE4's data that this causes a fatal error
85 85
         // because the tables are deleted just before this request runs. see https://events.codebasehq.com/projects/event-espresso/tickets/7539
86
-        if (! EE_Maintenance_Mode::instance()->models_can_query()
86
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()
87 87
             || ! $this->_get_table_analysis()->tableExists(EEM_Payment_Method::instance()->table())
88 88
         ) {
89 89
             return;
@@ -104,7 +104,7 @@  discard block
 block discarded – undo
104 104
                      ),
105 105
                      "<a href='$url'>",
106 106
                      "</a>"
107
-                 ) . '</p>
107
+                 ).'</p>
108 108
 			 </div>';
109 109
         }
110 110
     }
@@ -136,7 +136,7 @@  discard block
 block discarded – undo
136 136
     public static function unset_pp_standard($payment_method_types)
137 137
     {
138 138
         $pps = EEM_Payment_Method::instance()->get_one_of_type('Paypal_Standard');
139
-        $ppstandard_active = (! empty($pps)) ? $pps->active() : false;
139
+        $ppstandard_active = ( ! empty($pps)) ? $pps->active() : false;
140 140
         $ppstandard_active_before = false;
141 141
         if ($pps) {
142 142
             // PP Standard used before ?
Please login to merge, or discard this patch.
admin_pages/payments/Payments_Admin_Page.core.php 2 patches
Indentation   +1146 added lines, -1146 removed lines patch added patch discarded remove patch
@@ -16,1150 +16,1150 @@
 block discarded – undo
16 16
 class Payments_Admin_Page extends EE_Admin_Page
17 17
 {
18 18
 
19
-    /**
20
-     * Variables used for when we're re-sorting the logs results, in case
21
-     * we needed to do two queries and we need to resort
22
-     *
23
-     * @var string
24
-     */
25
-    private $_sort_logs_again_direction;
26
-
27
-
28
-    /**
29
-     * @Constructor
30
-     * @access public
31
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
32
-     * @throws EE_Error
33
-     * @throws InvalidArgumentException
34
-     * @throws InvalidDataTypeException
35
-     * @throws InvalidInterfaceException
36
-     * @throws ReflectionException
37
-     */
38
-    public function __construct($routing = true)
39
-    {
40
-        parent::__construct($routing);
41
-    }
42
-
43
-
44
-    protected function _init_page_props()
45
-    {
46
-        $this->page_slug = EE_PAYMENTS_PG_SLUG;
47
-        $this->page_label = __('Payment Methods', 'event_espresso');
48
-        $this->_admin_base_url = EE_PAYMENTS_ADMIN_URL;
49
-        $this->_admin_base_path = EE_PAYMENTS_ADMIN;
50
-    }
51
-
52
-
53
-    protected function _ajax_hooks()
54
-    {
55
-        // todo: all hooks for ajax goes here.
56
-    }
57
-
58
-
59
-    protected function _define_page_props()
60
-    {
61
-        $this->_admin_page_title = $this->page_label;
62
-        $this->_labels = array(
63
-            'publishbox' => __('Update Settings', 'event_espresso'),
64
-        );
65
-    }
66
-
67
-
68
-    protected function _set_page_routes()
69
-    {
70
-        /**
71
-         * note that with payment method capabilities, although we've implemented
72
-         * capability mapping which will be used for accessing payment methods owned by
73
-         * other users.  This is not fully implemented yet in the payment method ui.
74
-         * Currently only the "plural" caps are in active use.
75
-         * When cap mapping is implemented, some routes will need to use the singular form of
76
-         * capability method and also include the $id of the payment method for the route.
77
-         **/
78
-        $this->_page_routes = array(
79
-            'default'                   => array(
80
-                'func'       => '_payment_methods_list',
81
-                'capability' => 'ee_edit_payment_methods',
82
-            ),
83
-            'payment_settings'          => array(
84
-                'func'       => '_payment_settings',
85
-                'capability' => 'ee_manage_gateways',
86
-            ),
87
-            'activate_payment_method'   => array(
88
-                'func'       => '_activate_payment_method',
89
-                'noheader'   => true,
90
-                'capability' => 'ee_edit_payment_methods',
91
-            ),
92
-            'deactivate_payment_method' => array(
93
-                'func'       => '_deactivate_payment_method',
94
-                'noheader'   => true,
95
-                'capability' => 'ee_delete_payment_methods',
96
-            ),
97
-            'update_payment_method'     => array(
98
-                'func'               => '_update_payment_method',
99
-                'noheader'           => true,
100
-                'headers_sent_route' => 'default',
101
-                'capability'         => 'ee_edit_payment_methods',
102
-            ),
103
-            'update_payment_settings'   => array(
104
-                'func'       => '_update_payment_settings',
105
-                'noheader'   => true,
106
-                'capability' => 'ee_manage_gateways',
107
-            ),
108
-            'payment_log'               => array(
109
-                'func'       => '_payment_log_overview_list_table',
110
-                'capability' => 'ee_read_payment_methods',
111
-            ),
112
-            'payment_log_details'       => array(
113
-                'func'       => '_payment_log_details',
114
-                'capability' => 'ee_read_payment_methods',
115
-            ),
116
-        );
117
-    }
118
-
119
-
120
-    protected function _set_page_config()
121
-    {
122
-        $payment_method_list_config = array(
123
-            'nav'           => array(
124
-                'label' => __('Payment Methods', 'event_espresso'),
125
-                'order' => 10,
126
-            ),
127
-            'metaboxes'     => $this->_default_espresso_metaboxes,
128
-            'help_tabs'     => array_merge(
129
-                array(
130
-                    'payment_methods_overview_help_tab' => array(
131
-                        'title'    => __('Payment Methods Overview', 'event_espresso'),
132
-                        'filename' => 'payment_methods_overview',
133
-                    ),
134
-                ),
135
-                $this->_add_payment_method_help_tabs()
136
-            ),
137
-            'help_tour'     => array('Payment_Methods_Selection_Help_Tour'),
138
-            'require_nonce' => false,
139
-        );
140
-        $this->_page_config = array(
141
-            'default'          => $payment_method_list_config,
142
-            'payment_settings' => array(
143
-                'nav'           => array(
144
-                    'label' => __('Settings', 'event_espresso'),
145
-                    'order' => 20,
146
-                ),
147
-                'help_tabs'     => array(
148
-                    'payment_methods_settings_help_tab' => array(
149
-                        'title'    => __('Payment Method Settings', 'event_espresso'),
150
-                        'filename' => 'payment_methods_settings',
151
-                    ),
152
-                ),
153
-                // 'help_tour' => array( 'Payment_Methods_Settings_Help_Tour' ),
154
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
155
-                'require_nonce' => false,
156
-            ),
157
-            'payment_log'      => array(
158
-                'nav'           => array(
159
-                    'label' => __("Logs", 'event_espresso'),
160
-                    'order' => 30,
161
-                ),
162
-                'list_table'    => 'Payment_Log_Admin_List_Table',
163
-                'metaboxes'     => $this->_default_espresso_metaboxes,
164
-                'require_nonce' => false,
165
-            ),
166
-        );
167
-    }
168
-
169
-
170
-    /**
171
-     * @return array
172
-     * @throws DomainException
173
-     * @throws EE_Error
174
-     * @throws InvalidArgumentException
175
-     * @throws InvalidDataTypeException
176
-     * @throws InvalidInterfaceException
177
-     * @throws ReflectionException
178
-     */
179
-    protected function _add_payment_method_help_tabs()
180
-    {
181
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
182
-        $payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
183
-        $all_pmt_help_tabs_config = array();
184
-        foreach ($payment_method_types as $payment_method_type) {
185
-            if (! EE_Registry::instance()->CAP->current_user_can(
186
-                $payment_method_type->cap_name(),
187
-                'specific_payment_method_type_access'
188
-            )
189
-            ) {
190
-                continue;
191
-            }
192
-            foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
193
-                $template_args = isset($config['template_args']) ? $config['template_args'] : array();
194
-                $template_args['admin_page_obj'] = $this;
195
-                $all_pmt_help_tabs_config[ $help_tab_name ] = array(
196
-                    'title'   => $config['title'],
197
-                    'content' => EEH_Template::display_template(
198
-                        $payment_method_type->file_folder() . 'help_tabs/' . $config['filename'] . '.help_tab.php',
199
-                        $template_args,
200
-                        true
201
-                    ),
202
-                );
203
-            }
204
-        }
205
-        return $all_pmt_help_tabs_config;
206
-    }
207
-
208
-
209
-    // none of the below group are currently used for Gateway Settings
210
-    protected function _add_screen_options()
211
-    {
212
-    }
213
-
214
-
215
-    protected function _add_feature_pointers()
216
-    {
217
-    }
218
-
219
-
220
-    public function admin_init()
221
-    {
222
-    }
223
-
224
-
225
-    public function admin_notices()
226
-    {
227
-    }
228
-
229
-
230
-    public function admin_footer_scripts()
231
-    {
232
-    }
233
-
234
-
235
-    public function load_scripts_styles()
236
-    {
237
-        wp_enqueue_script('ee_admin_js');
238
-        wp_enqueue_script('ee-text-links');
239
-        wp_enqueue_script(
240
-            'espresso_payments',
241
-            EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
242
-            array('espresso-ui-theme', 'ee-datepicker'),
243
-            EVENT_ESPRESSO_VERSION,
244
-            true
245
-        );
246
-    }
247
-
248
-
249
-    public function load_scripts_styles_default()
250
-    {
251
-        // styles
252
-        wp_register_style(
253
-            'espresso_payments',
254
-            EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
255
-            array(),
256
-            EVENT_ESPRESSO_VERSION
257
-        );
258
-        wp_enqueue_style('espresso_payments');
259
-        wp_enqueue_style('ee-text-links');
260
-        // scripts
261
-    }
262
-
263
-
264
-    protected function _payment_methods_list()
265
-    {
266
-        /**
267
-         * first let's ensure payment methods have been setup. We do this here because when people activate a
268
-         * payment method for the first time (as an addon), it may not setup its capabilities or get registered
269
-         * correctly due to the loading process.  However, people MUST setup the details for the payment method so its
270
-         * safe to do a recheck here.
271
-         */
272
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
273
-        EEM_Payment_Method::instance()->verify_button_urls();
274
-        // setup tabs, one for each payment method type
275
-        $tabs = array();
276
-        $payment_methods = array();
277
-        foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) {
278
-            // we don't want to show admin-only PMTs for now
279
-            if ($pmt_obj instanceof EE_PMT_Admin_Only) {
280
-                continue;
281
-            }
282
-            // check access
283
-            if (! EE_Registry::instance()->CAP->current_user_can(
284
-                $pmt_obj->cap_name(),
285
-                'specific_payment_method_type_access'
286
-            )
287
-            ) {
288
-                continue;
289
-            }
290
-            // check for any active pms of that type
291
-            $payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
292
-            if (! $payment_method instanceof EE_Payment_Method) {
293
-                $payment_method = EE_Payment_Method::new_instance(
294
-                    array(
295
-                        'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
296
-                        'PMD_type'       => $pmt_obj->system_name(),
297
-                        'PMD_name'       => $pmt_obj->pretty_name(),
298
-                        'PMD_admin_name' => $pmt_obj->pretty_name(),
299
-                    )
300
-                );
301
-            }
302
-            $payment_methods[ $payment_method->slug() ] = $payment_method;
303
-        }
304
-        $payment_methods = apply_filters(
305
-            'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
306
-            $payment_methods
307
-        );
308
-        foreach ($payment_methods as $payment_method) {
309
-            if ($payment_method instanceof EE_Payment_Method) {
310
-                add_meta_box(
311
-                    // html id
312
-                    'espresso_' . $payment_method->slug() . '_payment_settings',
313
-                    // title
314
-                    sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
315
-                    // callback
316
-                    array($this, 'payment_method_settings_meta_box'),
317
-                    // post type
318
-                    null,
319
-                    // context
320
-                    'normal',
321
-                    // priority
322
-                    'default',
323
-                    // callback args
324
-                    array('payment_method' => $payment_method)
325
-                );
326
-                // setup for tabbed content
327
-                $tabs[ $payment_method->slug() ] = array(
328
-                    'label' => $payment_method->admin_name(),
329
-                    'class' => $payment_method->active() ? 'gateway-active' : '',
330
-                    'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
331
-                    'title' => __('Modify this Payment Method', 'event_espresso'),
332
-                    'slug'  => $payment_method->slug(),
333
-                );
334
-            }
335
-        }
336
-        $this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
337
-            $tabs,
338
-            'payment_method_links',
339
-            '|',
340
-            $this->_get_active_payment_method_slug()
341
-        );
342
-        $this->display_admin_page_with_sidebar();
343
-    }
344
-
345
-
346
-    /**
347
-     *   _get_active_payment_method_slug
348
-     *
349
-     * @return string
350
-     */
351
-    protected function _get_active_payment_method_slug()
352
-    {
353
-        $payment_method_slug = false;
354
-        // decide which payment method tab to open first, as dictated by the request's 'payment_method'
355
-        if (isset($this->_req_data['payment_method'])) {
356
-            // if they provided the current payment method, use it
357
-            $payment_method_slug = sanitize_key($this->_req_data['payment_method']);
358
-        }
359
-        $payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
360
-        // if that didn't work or wasn't provided, find another way to select the current pm
361
-        if (! $this->_verify_payment_method($payment_method)) {
362
-            // like, looking for an active one
363
-            $payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
364
-            // test that one as well
365
-            if ($this->_verify_payment_method($payment_method)) {
366
-                $payment_method_slug = $payment_method->slug();
367
-            } else {
368
-                $payment_method_slug = 'paypal_standard';
369
-            }
370
-        }
371
-        return $payment_method_slug;
372
-    }
373
-
374
-
375
-    /**
376
-     *    payment_method_settings_meta_box
377
-     *    returns TRUE if the passed payment method is properly constructed and the logged in user has the correct
378
-     *    capabilities to access it
379
-     *
380
-     * @param EE_Payment_Method $payment_method
381
-     * @return boolean
382
-     */
383
-    protected function _verify_payment_method($payment_method)
384
-    {
385
-        if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base
386
-            && EE_Registry::instance()->CAP->current_user_can(
387
-                $payment_method->type_obj()->cap_name(),
388
-                'specific_payment_method_type_access'
389
-            )
390
-        ) {
391
-            return true;
392
-        }
393
-        return false;
394
-    }
395
-
396
-
397
-    /**
398
-     *    payment_method_settings_meta_box
399
-     *
400
-     * @param NULL  $post_obj_which_is_null is an object containing the current post (as a $post object)
401
-     * @param array $metabox                is an array with metabox id, title, callback, and args elements. the value
402
-     *                                      at 'args' has key 'payment_method', as set within _payment_methods_list
403
-     * @return string
404
-     * @throws EE_Error
405
-     */
406
-    public function payment_method_settings_meta_box($post_obj_which_is_null, $metabox)
407
-    {
408
-        $payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
409
-            ? $metabox['args']['payment_method'] : null;
410
-        if (! $payment_method instanceof EE_Payment_Method) {
411
-            throw new EE_Error(
412
-                sprintf(
413
-                    __(
414
-                        'Payment method metabox setup incorrectly. No Payment method object was supplied',
415
-                        'event_espresso'
416
-                    )
417
-                )
418
-            );
419
-        }
420
-        $payment_method_scopes = $payment_method->active();
421
-        // if the payment method really exists show its form, otherwise the activation template
422
-        if ($payment_method->ID() && ! empty($payment_method_scopes)) {
423
-            $form = $this->_generate_payment_method_settings_form($payment_method);
424
-            if ($form->form_data_present_in($this->_req_data)) {
425
-                $form->receive_form_submission($this->_req_data);
426
-            }
427
-            echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
428
-        } else {
429
-            echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
430
-        }
431
-    }
432
-
433
-
434
-    /**
435
-     * Gets the form for all the settings related to this payment method type
436
-     *
437
-     * @access protected
438
-     * @param EE_Payment_Method $payment_method
439
-     * @return EE_Form_Section_Proper
440
-     */
441
-    protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
442
-    {
443
-        if (! $payment_method instanceof EE_Payment_Method) {
444
-            return new EE_Form_Section_Proper();
445
-        }
446
-        return new EE_Form_Section_Proper(
447
-            array(
448
-                'name'            => $payment_method->slug() . '_settings_form',
449
-                'html_id'         => $payment_method->slug() . '_settings_form',
450
-                'action'          => EE_Admin_Page::add_query_args_and_nonce(
451
-                    array(
452
-                        'action'         => 'update_payment_method',
453
-                        'payment_method' => $payment_method->slug(),
454
-                    ),
455
-                    EE_PAYMENTS_ADMIN_URL
456
-                ),
457
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
458
-                'subsections'     => apply_filters(
459
-                    'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
460
-                    array(
461
-                        'pci_dss_compliance'      => $this->_pci_dss_compliance($payment_method),
462
-                        'currency_support'        => $this->_currency_support($payment_method),
463
-                        'payment_method_settings' => $this->_payment_method_settings($payment_method),
464
-                        'update'                  => $this->_update_payment_method_button($payment_method),
465
-                        'deactivate'              => $this->_deactivate_payment_method_button($payment_method),
466
-                        'fine_print'              => $this->_fine_print(),
467
-                    ),
468
-                    $payment_method
469
-                ),
470
-            )
471
-        );
472
-    }
473
-
474
-
475
-    /**
476
-     * _pci_dss_compliance
477
-     *
478
-     * @access protected
479
-     * @param EE_Payment_Method $payment_method
480
-     * @return EE_Form_Section_Proper
481
-     */
482
-    protected function _pci_dss_compliance(EE_Payment_Method $payment_method)
483
-    {
484
-        if ($payment_method->type_obj()->requires_https()) {
485
-            return new EE_Form_Section_HTML(
486
-                EEH_HTML::table(
487
-                    EEH_HTML::tr(
488
-                        EEH_HTML::th(
489
-                            EEH_HTML::label(
490
-                                EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
491
-                            )
492
-                        ) .
493
-                        EEH_HTML::td(
494
-                            EEH_HTML::strong(
495
-                                __(
496
-                                    'You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
497
-                                    'event_espresso'
498
-                                )
499
-                            )
500
-                            .
501
-                            EEH_HTML::br()
502
-                            .
503
-                            __('Learn more about ', 'event_espresso')
504
-                            . EEH_HTML::link(
505
-                                'https://www.pcisecuritystandards.org/merchants/index.php',
506
-                                __('PCI DSS compliance', 'event_espresso')
507
-                            )
508
-                        )
509
-                    )
510
-                )
511
-            );
512
-        } else {
513
-            return new EE_Form_Section_HTML('');
514
-        }
515
-    }
516
-
517
-
518
-    /**
519
-     * _currency_support
520
-     *
521
-     * @access protected
522
-     * @param EE_Payment_Method $payment_method
523
-     * @return EE_Form_Section_Proper
524
-     */
525
-    protected function _currency_support(EE_Payment_Method $payment_method)
526
-    {
527
-        if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
528
-            return new EE_Form_Section_HTML(
529
-                EEH_HTML::table(
530
-                    EEH_HTML::tr(
531
-                        EEH_HTML::th(
532
-                            EEH_HTML::label(
533
-                                EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
534
-                            )
535
-                        ) .
536
-                        EEH_HTML::td(
537
-                            EEH_HTML::strong(
538
-                                sprintf(
539
-                                    __(
540
-                                        'This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.',
541
-                                        'event_espresso'
542
-                                    ),
543
-                                    EE_Config::instance()->currency->code
544
-                                )
545
-                            )
546
-                        )
547
-                    )
548
-                )
549
-            );
550
-        } else {
551
-            return new EE_Form_Section_HTML('');
552
-        }
553
-    }
554
-
555
-
556
-    /**
557
-     * _update_payment_method_button
558
-     *
559
-     * @access protected
560
-     * @param EE_Payment_Method $payment_method
561
-     * @return EE_Payment_Method_Form
562
-     */
563
-    protected function _payment_method_settings(EE_Payment_Method $payment_method)
564
-    {
565
-        // modify the form so we only have/show fields that will be implemented for this version
566
-        return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name());
567
-    }
568
-
569
-
570
-    /**
571
-     * Simplifies the form to merely reproduce 4.1's gateway settings functionality
572
-     *
573
-     * @param EE_Form_Section_Proper $form_section
574
-     * @param string                 $payment_method_name
575
-     * @return EE_Payment_Method_Form
576
-     * @throws EE_Error
577
-     */
578
-    protected function _simplify_form($form_section, $payment_method_name = '')
579
-    {
580
-        if ($form_section instanceof EE_Payment_Method_Form) {
581
-            $form_section->exclude(
582
-                array(
583
-                    'PMD_type', // dont want them changing the type
584
-                    'PMD_slug', // or the slug (probably never)
585
-                    'PMD_wp_user', // or the user's ID
586
-                    'Currency' // or the currency, until the rest of EE supports simultaneous currencies
587
-                )
588
-            );
589
-            return $form_section;
590
-        } else {
591
-            throw new EE_Error(
592
-                sprintf(
593
-                    __(
594
-                        'The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.',
595
-                        'event_espresso'
596
-                    ),
597
-                    $payment_method_name
598
-                )
599
-            );
600
-        }
601
-    }
602
-
603
-
604
-    /**
605
-     * _update_payment_method_button
606
-     *
607
-     * @access protected
608
-     * @param EE_Payment_Method $payment_method
609
-     * @return EE_Form_Section_HTML
610
-     */
611
-    protected function _update_payment_method_button(EE_Payment_Method $payment_method)
612
-    {
613
-        $update_button = new EE_Submit_Input(
614
-            array(
615
-                'name'       => 'submit',
616
-                'html_id'    => 'save_' . $payment_method->slug() . '_settings',
617
-                'default'    => sprintf(
618
-                    __('Update %s Payment Settings', 'event_espresso'),
619
-                    $payment_method->admin_name()
620
-                ),
621
-                'html_label' => EEH_HTML::nbsp(),
622
-            )
623
-        );
624
-        return new EE_Form_Section_HTML(
625
-            EEH_HTML::table(
626
-                EEH_HTML::no_row(EEH_HTML::br(2)) .
627
-                EEH_HTML::tr(
628
-                    EEH_HTML::th(__('Update Settings', 'event_espresso')) .
629
-                    EEH_HTML::td(
630
-                        $update_button->get_html_for_input()
631
-                    )
632
-                )
633
-            )
634
-        );
635
-    }
636
-
637
-
638
-    /**
639
-     * _deactivate_payment_method_button
640
-     *
641
-     * @access protected
642
-     * @param EE_Payment_Method $payment_method
643
-     * @return EE_Form_Section_Proper
644
-     */
645
-    protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
646
-    {
647
-        $link_text_and_title = sprintf(
648
-            __('Deactivate %1$s Payments?', 'event_espresso'),
649
-            $payment_method->admin_name()
650
-        );
651
-        return new EE_Form_Section_HTML(
652
-            EEH_HTML::table(
653
-                EEH_HTML::tr(
654
-                    EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
655
-                    EEH_HTML::td(
656
-                        EEH_HTML::link(
657
-                            EE_Admin_Page::add_query_args_and_nonce(
658
-                                array(
659
-                                    'action'         => 'deactivate_payment_method',
660
-                                    'payment_method' => $payment_method->slug(),
661
-                                ),
662
-                                EE_PAYMENTS_ADMIN_URL
663
-                            ),
664
-                            $link_text_and_title,
665
-                            $link_text_and_title,
666
-                            'deactivate_' . $payment_method->slug(),
667
-                            'espresso-button button-secondary'
668
-                        )
669
-                    )
670
-                )
671
-            )
672
-        );
673
-    }
674
-
675
-
676
-    /**
677
-     * _activate_payment_method_button
678
-     *
679
-     * @access protected
680
-     * @param EE_Payment_Method $payment_method
681
-     * @return EE_Form_Section_Proper
682
-     */
683
-    protected function _activate_payment_method_button(EE_Payment_Method $payment_method)
684
-    {
685
-        $link_text_and_title = sprintf(
686
-            __('Activate %1$s Payment Method?', 'event_espresso'),
687
-            $payment_method->admin_name()
688
-        );
689
-        return new EE_Form_Section_Proper(
690
-            array(
691
-                'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
692
-                'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
693
-                'action'          => '#',
694
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
695
-                'subsections'     => apply_filters(
696
-                    'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections',
697
-                    array(
698
-                        new EE_Form_Section_HTML(
699
-                            EEH_HTML::table(
700
-                                EEH_HTML::tr(
701
-                                    EEH_HTML::td(
702
-                                        $payment_method->type_obj()->introductory_html(),
703
-                                        '',
704
-                                        '',
705
-                                        '',
706
-                                        'colspan="2"'
707
-                                    )
708
-                                ) .
709
-                                EEH_HTML::tr(
710
-                                    EEH_HTML::th(
711
-                                        EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
712
-                                    ) .
713
-                                    EEH_HTML::td(
714
-                                        EEH_HTML::link(
715
-                                            EE_Admin_Page::add_query_args_and_nonce(
716
-                                                array(
717
-                                                    'action'              => 'activate_payment_method',
718
-                                                    'payment_method_type' => $payment_method->type(),
719
-                                                ),
720
-                                                EE_PAYMENTS_ADMIN_URL
721
-                                            ),
722
-                                            $link_text_and_title,
723
-                                            $link_text_and_title,
724
-                                            'activate_' . $payment_method->slug(),
725
-                                            'espresso-button-green button-primary'
726
-                                        )
727
-                                    )
728
-                                )
729
-                            )
730
-                        ),
731
-                    ),
732
-                    $payment_method
733
-                ),
734
-            )
735
-        );
736
-    }
737
-
738
-
739
-    /**
740
-     * _fine_print
741
-     *
742
-     * @access protected
743
-     * @return EE_Form_Section_HTML
744
-     */
745
-    protected function _fine_print()
746
-    {
747
-        return new EE_Form_Section_HTML(
748
-            EEH_HTML::table(
749
-                EEH_HTML::tr(
750
-                    EEH_HTML::th() .
751
-                    EEH_HTML::td(
752
-                        EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
753
-                    )
754
-                )
755
-            )
756
-        );
757
-    }
758
-
759
-
760
-    /**
761
-     * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far)
762
-     *
763
-     * @global WP_User $current_user
764
-     */
765
-    protected function _activate_payment_method()
766
-    {
767
-        if (isset($this->_req_data['payment_method_type'])) {
768
-            $payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']);
769
-            // see if one exists
770
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
771
-            $payment_method = EE_Payment_Method_Manager::instance()
772
-                                                       ->activate_a_payment_method_of_type($payment_method_type);
773
-            $this->_redirect_after_action(
774
-                1,
775
-                'Payment Method',
776
-                'activated',
777
-                array('action' => 'default', 'payment_method' => $payment_method->slug())
778
-            );
779
-        } else {
780
-            $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
781
-        }
782
-    }
783
-
784
-
785
-    /**
786
-     * Deactivates the payment method with the specified slug, and redirects.
787
-     */
788
-    protected function _deactivate_payment_method()
789
-    {
790
-        if (isset($this->_req_data['payment_method'])) {
791
-            $payment_method_slug = sanitize_key($this->_req_data['payment_method']);
792
-            // deactivate it
793
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
794
-            $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug);
795
-            $this->_redirect_after_action(
796
-                $count_updated,
797
-                'Payment Method',
798
-                'deactivated',
799
-                array('action' => 'default', 'payment_method' => $payment_method_slug)
800
-            );
801
-        } else {
802
-            $this->_redirect_after_action(false, 'Payment Method', 'deactivated', array('action' => 'default'));
803
-        }
804
-    }
805
-
806
-
807
-    /**
808
-     * Processes the payment method form that was submitted. This is slightly trickier than usual form
809
-     * processing because we first need to identify WHICH form was processed and which payment method
810
-     * it corresponds to. Once we have done that, we see if the form is valid. If it is, the
811
-     * form's data is saved and we redirect to the default payment methods page, setting the updated payment method
812
-     * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the
813
-     * subsequently called 'headers_sent_func' which is _payment_methods_list)
814
-     *
815
-     * @return void
816
-     */
817
-    protected function _update_payment_method()
818
-    {
819
-        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
820
-            // ok let's find which gateway form to use based on the form input
821
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
822
-            /** @var $correct_pmt_form_to_use EE_Payment_Method_Form */
823
-            $correct_pmt_form_to_use = null;
824
-            $payment_method = null;
825
-            foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) {
826
-                // get the form and simplify it, like what we do when we display it
827
-                $pmt_form = $this->_generate_payment_method_settings_form($payment_method);
828
-                if ($pmt_form->form_data_present_in($this->_req_data)) {
829
-                    $correct_pmt_form_to_use = $pmt_form;
830
-                    break;
831
-                }
832
-            }
833
-            // if we couldn't find the correct payment method type...
834
-            if (! $correct_pmt_form_to_use) {
835
-                EE_Error::add_error(
836
-                    __(
837
-                        "We could not find which payment method type your form submission related to. Please contact support",
838
-                        'event_espresso'
839
-                    ),
840
-                    __FILE__,
841
-                    __FUNCTION__,
842
-                    __LINE__
843
-                );
844
-                $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
845
-            }
846
-            $correct_pmt_form_to_use->receive_form_submission($this->_req_data);
847
-            if ($correct_pmt_form_to_use->is_valid()) {
848
-                $payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
849
-                if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
850
-                    throw new EE_Error(
851
-                        sprintf(
852
-                            __(
853
-                                'The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
854
-                                'event_espresso'
855
-                            ),
856
-                            'payment_method_settings'
857
-                        )
858
-                    );
859
-                }
860
-                $payment_settings_subform->save();
861
-                /** @var $pm EE_Payment_Method */
862
-                $this->_redirect_after_action(
863
-                    true,
864
-                    'Payment Method',
865
-                    'updated',
866
-                    array('action' => 'default', 'payment_method' => $payment_method->slug())
867
-                );
868
-            } else {
869
-                EE_Error::add_error(
870
-                    sprintf(
871
-                        __(
872
-                            'Payment method of type %s was not saved because there were validation errors. They have been marked in the form',
873
-                            'event_espresso'
874
-                        ),
875
-                        $payment_method instanceof EE_Payment_Method ? $payment_method->type_obj()->pretty_name()
876
-                            : __('"(unknown)"', 'event_espresso')
877
-                    ),
878
-                    __FILE__,
879
-                    __FUNCTION__,
880
-                    __LINE__
881
-                );
882
-            }
883
-        }
884
-        return;
885
-    }
886
-
887
-
888
-    /**
889
-     * Displays payment settings (not payment METHOD settings, that's _payment_method_settings)
890
-     * @throws DomainException
891
-     * @throws EE_Error
892
-     * @throws InvalidArgumentException
893
-     * @throws InvalidDataTypeException
894
-     * @throws InvalidInterfaceException
895
-     */
896
-    protected function _payment_settings()
897
-    {
898
-        $form = $this->getPaymentSettingsForm();
899
-        $this->_set_add_edit_form_tags('update_payment_settings');
900
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
901
-        $this->_template_args['admin_page_content'] =  $form->get_html_and_js();
902
-        $this->display_admin_page_with_sidebar();
903
-    }
904
-
905
-
906
-    /**
907
-     *        _update_payment_settings
908
-     *
909
-     * @access protected
910
-     * @return void
911
-     * @throws EE_Error
912
-     * @throws InvalidArgumentException
913
-     * @throws InvalidDataTypeException
914
-     * @throws InvalidInterfaceException
915
-     */
916
-    protected function _update_payment_settings()
917
-    {
918
-        $form = $this->getPaymentSettingsForm();
919
-        if ($form->was_submitted($this->_req_data)) {
920
-            $form->receive_form_submission($this->_req_data);
921
-            if ($form->is_valid()) {
922
-                /**
923
-                 * @var $reg_config EE_Registration_Config
924
-                 */
925
-                $loader = LoaderFactory::getLoader();
926
-                $reg_config = $loader->getShared('EE_Registration_Config');
927
-                $valid_data = $form->valid_data();
928
-                $reg_config->show_pending_payment_options = $valid_data['show_pending_payment_options'];
929
-                $reg_config->gateway_log_lifespan = $valid_data['gateway_log_lifespan'];
930
-            }
931
-        }
932
-        EE_Registry::instance()->CFG = apply_filters(
933
-            'FHEE__Payments_Admin_Page___update_payment_settings__CFG',
934
-            EE_Registry::instance()->CFG
935
-        );
936
-
937
-        $cfg =  EE_Registry::instance()->CFG ;
938
-
939
-        $what = __('Payment Settings', 'event_espresso');
940
-        $success = $this->_update_espresso_configuration(
941
-            $what,
942
-            EE_Registry::instance()->CFG,
943
-            __FILE__,
944
-            __FUNCTION__,
945
-            __LINE__
946
-        );
947
-        $this->_redirect_after_action(
948
-            $success,
949
-            $what,
950
-            __('updated', 'event_espresso'),
951
-            array('action' => 'payment_settings')
952
-        );
953
-    }
954
-
955
-
956
-    /**
957
-     * Gets the form used for updating payment settings
958
-     *
959
-     * @return EE_Form_Section_Proper
960
-     * @throws EE_Error
961
-     * @throws InvalidArgumentException
962
-     * @throws InvalidDataTypeException
963
-     * @throws InvalidInterfaceException
964
-     */
965
-    protected function getPaymentSettingsForm()
966
-    {
967
-        /**
968
-         * @var $reg_config EE_Registration_Config
969
-         */
970
-        $reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
971
-        return new EE_Form_Section_Proper(
972
-            array(
973
-                'name' => 'payment-settings',
974
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
975
-                'subsections' => array(
976
-                    'show_pending_payment_options' => new EE_Yes_No_Input(
977
-                        array(
978
-                            'html_name' => 'show_pending_payment_options',
979
-                            'default' => $reg_config->show_pending_payment_options,
980
-                            'html_help_text' => esc_html__(
981
-                                "If a payment is marked as 'Pending Payment', or if payment is deferred (ie, an offline gateway like Check, Bank, or Invoice is used), then give registrants the option to retry payment. ",
982
-                                'event_espresso'
983
-                            )
984
-                        )
985
-                    ),
986
-                    'gateway_log_lifespan' => new EE_Select_Input(
987
-                        $reg_config->gatewayLogLifespanOptions(),
988
-                        array(
989
-                            'html_label_text' => esc_html__('Gateway Logs Lifespan', 'event_espresso'),
990
-                            'html_help_text' => esc_html__('If issues arise with payments being made through a payment gateway, it\'s helpful to log non-sensitive communications with the payment gateway. But it\'s a security responsibility, so it\'s a good idea to not keep them for any longer than necessary.', 'event_espresso'),
991
-                            'default' => $reg_config->gateway_log_lifespan,
992
-                        )
993
-                    )
994
-                )
995
-            )
996
-        );
997
-    }
998
-
999
-
1000
-    protected function _payment_log_overview_list_table()
1001
-    {
1002
-        $this->display_admin_list_table_page_with_sidebar();
1003
-    }
1004
-
1005
-
1006
-    protected function _set_list_table_views_payment_log()
1007
-    {
1008
-        $this->_views = array(
1009
-            'all' => array(
1010
-                'slug'  => 'all',
1011
-                'label' => __('View All Logs', 'event_espresso'),
1012
-                'count' => 0,
1013
-            ),
1014
-        );
1015
-    }
1016
-
1017
-
1018
-    /**
1019
-     * @param int  $per_page
1020
-     * @param int  $current_page
1021
-     * @param bool $count
1022
-     * @return array
1023
-     */
1024
-    public function get_payment_logs($per_page = 50, $current_page = 0, $count = false)
1025
-    {
1026
-        EE_Registry::instance()->load_model('Change_Log');
1027
-        // we may need to do multiple queries (joining differently), so we actually wan tan array of query params
1028
-        $query_params = array(array('LOG_type' => EEM_Change_Log::type_gateway));
1029
-        // check if they've selected a specific payment method
1030
-        if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') {
1031
-            $query_params[0]['OR*pm_or_pay_pm'] = array(
1032
-                'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'],
1033
-                'Payment_Method.PMD_ID'         => $this->_req_data['_payment_method'],
1034
-            );
1035
-        }
1036
-        // take into account search
1037
-        if (isset($this->_req_data['s']) && $this->_req_data['s']) {
1038
-            $similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
1039
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
1040
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
1041
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
1042
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_name'] = $similarity_string;
1043
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name'] = $similarity_string;
1044
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_type'] = $similarity_string;
1045
-            $query_params[0]['OR*s']['LOG_message'] = $similarity_string;
1046
-            $query_params[0]['OR*s']['Payment_Method.PMD_name'] = $similarity_string;
1047
-            $query_params[0]['OR*s']['Payment_Method.PMD_admin_name'] = $similarity_string;
1048
-            $query_params[0]['OR*s']['Payment_Method.PMD_type'] = $similarity_string;
1049
-            $query_params[0]['OR*s']['LOG_message'] = $similarity_string;
1050
-        }
1051
-        if (isset($this->_req_data['payment-filter-start-date'])
1052
-            && isset($this->_req_data['payment-filter-end-date'])
1053
-        ) {
1054
-            // add date
1055
-            $start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
1056
-            $end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
1057
-            // make sure our timestamps start and end right at the boundaries for each day
1058
-            $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
1059
-            $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
1060
-            // convert to timestamps
1061
-            $start_date = strtotime($start_date);
1062
-            $end_date = strtotime($end_date);
1063
-            // makes sure start date is the lowest value and vice versa
1064
-            $start_date = min($start_date, $end_date);
1065
-            $end_date = max($start_date, $end_date);
1066
-            // convert for query
1067
-            $start_date = EEM_Change_Log::instance()
1068
-                                        ->convert_datetime_for_query(
1069
-                                            'LOG_time',
1070
-                                            date('Y-m-d H:i:s', $start_date),
1071
-                                            'Y-m-d H:i:s'
1072
-                                        );
1073
-            $end_date = EEM_Change_Log::instance()
1074
-                                      ->convert_datetime_for_query(
1075
-                                          'LOG_time',
1076
-                                          date('Y-m-d H:i:s', $end_date),
1077
-                                          'Y-m-d H:i:s'
1078
-                                      );
1079
-            $query_params[0]['LOG_time'] = array('BETWEEN', array($start_date, $end_date));
1080
-        }
1081
-        if ($count) {
1082
-            return EEM_Change_Log::instance()->count($query_params);
1083
-        }
1084
-        if (isset($this->_req_data['order'])) {
1085
-            $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
1086
-                : 'DESC';
1087
-            $query_params['order_by'] = array('LOG_time' => $sort);
1088
-        } else {
1089
-            $query_params['order_by'] = array('LOG_time' => 'DESC');
1090
-        }
1091
-        $offset = ($current_page - 1) * $per_page;
1092
-        if (! isset($this->_req_data['download_results'])) {
1093
-            $query_params['limit'] = array($offset, $per_page);
1094
-        }
1095
-        // now they've requested to instead just download the file instead of viewing it.
1096
-        if (isset($this->_req_data['download_results'])) {
1097
-            $wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
1098
-            header('Content-Disposition: attachment');
1099
-            header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
1100
-            echo "<h1>Payment Logs for " . site_url() . "</h1>";
1101
-            echo "<h3>Query:</h3>";
1102
-            var_dump($query_params);
1103
-            echo "<h3>Results:</h3>";
1104
-            var_dump($wpdb_results);
1105
-            die;
1106
-        }
1107
-        $results = EEM_Change_Log::instance()->get_all($query_params);
1108
-        return $results;
1109
-    }
1110
-
1111
-
1112
-    /**
1113
-     * Used by usort to RE-sort log query results, because we lose the ordering
1114
-     * because we're possibly combining the results from two queries
1115
-     *
1116
-     * @param EE_Change_Log $logA
1117
-     * @param EE_Change_Log $logB
1118
-     * @return int
1119
-     */
1120
-    protected function _sort_logs_again($logA, $logB)
1121
-    {
1122
-        $timeA = $logA->get_raw('LOG_time');
1123
-        $timeB = $logB->get_raw('LOG_time');
1124
-        if ($timeA == $timeB) {
1125
-            return 0;
1126
-        }
1127
-        $comparison = $timeA < $timeB ? -1 : 1;
1128
-        if (strtoupper($this->_sort_logs_again_direction) == 'DESC') {
1129
-            return $comparison * -1;
1130
-        } else {
1131
-            return $comparison;
1132
-        }
1133
-    }
1134
-
1135
-
1136
-    protected function _payment_log_details()
1137
-    {
1138
-        EE_Registry::instance()->load_model('Change_Log');
1139
-        /** @var $payment_log EE_Change_Log */
1140
-        $payment_log = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']);
1141
-        $payment_method = null;
1142
-        $transaction = null;
1143
-        if ($payment_log instanceof EE_Change_Log) {
1144
-            if ($payment_log->object() instanceof EE_Payment) {
1145
-                $payment_method = $payment_log->object()->payment_method();
1146
-                $transaction = $payment_log->object()->transaction();
1147
-            } elseif ($payment_log->object() instanceof EE_Payment_Method) {
1148
-                $payment_method = $payment_log->object();
1149
-            } elseif ($payment_log->object() instanceof EE_Transaction) {
1150
-                $transaction = $payment_log->object();
1151
-                $payment_method = $transaction->payment_method();
1152
-            }
1153
-        }
1154
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
1155
-            EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
1156
-            array(
1157
-                'payment_log'    => $payment_log,
1158
-                'payment_method' => $payment_method,
1159
-                'transaction'    => $transaction,
1160
-            ),
1161
-            true
1162
-        );
1163
-        $this->display_admin_page_with_sidebar();
1164
-    }
19
+	/**
20
+	 * Variables used for when we're re-sorting the logs results, in case
21
+	 * we needed to do two queries and we need to resort
22
+	 *
23
+	 * @var string
24
+	 */
25
+	private $_sort_logs_again_direction;
26
+
27
+
28
+	/**
29
+	 * @Constructor
30
+	 * @access public
31
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
32
+	 * @throws EE_Error
33
+	 * @throws InvalidArgumentException
34
+	 * @throws InvalidDataTypeException
35
+	 * @throws InvalidInterfaceException
36
+	 * @throws ReflectionException
37
+	 */
38
+	public function __construct($routing = true)
39
+	{
40
+		parent::__construct($routing);
41
+	}
42
+
43
+
44
+	protected function _init_page_props()
45
+	{
46
+		$this->page_slug = EE_PAYMENTS_PG_SLUG;
47
+		$this->page_label = __('Payment Methods', 'event_espresso');
48
+		$this->_admin_base_url = EE_PAYMENTS_ADMIN_URL;
49
+		$this->_admin_base_path = EE_PAYMENTS_ADMIN;
50
+	}
51
+
52
+
53
+	protected function _ajax_hooks()
54
+	{
55
+		// todo: all hooks for ajax goes here.
56
+	}
57
+
58
+
59
+	protected function _define_page_props()
60
+	{
61
+		$this->_admin_page_title = $this->page_label;
62
+		$this->_labels = array(
63
+			'publishbox' => __('Update Settings', 'event_espresso'),
64
+		);
65
+	}
66
+
67
+
68
+	protected function _set_page_routes()
69
+	{
70
+		/**
71
+		 * note that with payment method capabilities, although we've implemented
72
+		 * capability mapping which will be used for accessing payment methods owned by
73
+		 * other users.  This is not fully implemented yet in the payment method ui.
74
+		 * Currently only the "plural" caps are in active use.
75
+		 * When cap mapping is implemented, some routes will need to use the singular form of
76
+		 * capability method and also include the $id of the payment method for the route.
77
+		 **/
78
+		$this->_page_routes = array(
79
+			'default'                   => array(
80
+				'func'       => '_payment_methods_list',
81
+				'capability' => 'ee_edit_payment_methods',
82
+			),
83
+			'payment_settings'          => array(
84
+				'func'       => '_payment_settings',
85
+				'capability' => 'ee_manage_gateways',
86
+			),
87
+			'activate_payment_method'   => array(
88
+				'func'       => '_activate_payment_method',
89
+				'noheader'   => true,
90
+				'capability' => 'ee_edit_payment_methods',
91
+			),
92
+			'deactivate_payment_method' => array(
93
+				'func'       => '_deactivate_payment_method',
94
+				'noheader'   => true,
95
+				'capability' => 'ee_delete_payment_methods',
96
+			),
97
+			'update_payment_method'     => array(
98
+				'func'               => '_update_payment_method',
99
+				'noheader'           => true,
100
+				'headers_sent_route' => 'default',
101
+				'capability'         => 'ee_edit_payment_methods',
102
+			),
103
+			'update_payment_settings'   => array(
104
+				'func'       => '_update_payment_settings',
105
+				'noheader'   => true,
106
+				'capability' => 'ee_manage_gateways',
107
+			),
108
+			'payment_log'               => array(
109
+				'func'       => '_payment_log_overview_list_table',
110
+				'capability' => 'ee_read_payment_methods',
111
+			),
112
+			'payment_log_details'       => array(
113
+				'func'       => '_payment_log_details',
114
+				'capability' => 'ee_read_payment_methods',
115
+			),
116
+		);
117
+	}
118
+
119
+
120
+	protected function _set_page_config()
121
+	{
122
+		$payment_method_list_config = array(
123
+			'nav'           => array(
124
+				'label' => __('Payment Methods', 'event_espresso'),
125
+				'order' => 10,
126
+			),
127
+			'metaboxes'     => $this->_default_espresso_metaboxes,
128
+			'help_tabs'     => array_merge(
129
+				array(
130
+					'payment_methods_overview_help_tab' => array(
131
+						'title'    => __('Payment Methods Overview', 'event_espresso'),
132
+						'filename' => 'payment_methods_overview',
133
+					),
134
+				),
135
+				$this->_add_payment_method_help_tabs()
136
+			),
137
+			'help_tour'     => array('Payment_Methods_Selection_Help_Tour'),
138
+			'require_nonce' => false,
139
+		);
140
+		$this->_page_config = array(
141
+			'default'          => $payment_method_list_config,
142
+			'payment_settings' => array(
143
+				'nav'           => array(
144
+					'label' => __('Settings', 'event_espresso'),
145
+					'order' => 20,
146
+				),
147
+				'help_tabs'     => array(
148
+					'payment_methods_settings_help_tab' => array(
149
+						'title'    => __('Payment Method Settings', 'event_espresso'),
150
+						'filename' => 'payment_methods_settings',
151
+					),
152
+				),
153
+				// 'help_tour' => array( 'Payment_Methods_Settings_Help_Tour' ),
154
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
155
+				'require_nonce' => false,
156
+			),
157
+			'payment_log'      => array(
158
+				'nav'           => array(
159
+					'label' => __("Logs", 'event_espresso'),
160
+					'order' => 30,
161
+				),
162
+				'list_table'    => 'Payment_Log_Admin_List_Table',
163
+				'metaboxes'     => $this->_default_espresso_metaboxes,
164
+				'require_nonce' => false,
165
+			),
166
+		);
167
+	}
168
+
169
+
170
+	/**
171
+	 * @return array
172
+	 * @throws DomainException
173
+	 * @throws EE_Error
174
+	 * @throws InvalidArgumentException
175
+	 * @throws InvalidDataTypeException
176
+	 * @throws InvalidInterfaceException
177
+	 * @throws ReflectionException
178
+	 */
179
+	protected function _add_payment_method_help_tabs()
180
+	{
181
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
182
+		$payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
183
+		$all_pmt_help_tabs_config = array();
184
+		foreach ($payment_method_types as $payment_method_type) {
185
+			if (! EE_Registry::instance()->CAP->current_user_can(
186
+				$payment_method_type->cap_name(),
187
+				'specific_payment_method_type_access'
188
+			)
189
+			) {
190
+				continue;
191
+			}
192
+			foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
193
+				$template_args = isset($config['template_args']) ? $config['template_args'] : array();
194
+				$template_args['admin_page_obj'] = $this;
195
+				$all_pmt_help_tabs_config[ $help_tab_name ] = array(
196
+					'title'   => $config['title'],
197
+					'content' => EEH_Template::display_template(
198
+						$payment_method_type->file_folder() . 'help_tabs/' . $config['filename'] . '.help_tab.php',
199
+						$template_args,
200
+						true
201
+					),
202
+				);
203
+			}
204
+		}
205
+		return $all_pmt_help_tabs_config;
206
+	}
207
+
208
+
209
+	// none of the below group are currently used for Gateway Settings
210
+	protected function _add_screen_options()
211
+	{
212
+	}
213
+
214
+
215
+	protected function _add_feature_pointers()
216
+	{
217
+	}
218
+
219
+
220
+	public function admin_init()
221
+	{
222
+	}
223
+
224
+
225
+	public function admin_notices()
226
+	{
227
+	}
228
+
229
+
230
+	public function admin_footer_scripts()
231
+	{
232
+	}
233
+
234
+
235
+	public function load_scripts_styles()
236
+	{
237
+		wp_enqueue_script('ee_admin_js');
238
+		wp_enqueue_script('ee-text-links');
239
+		wp_enqueue_script(
240
+			'espresso_payments',
241
+			EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
242
+			array('espresso-ui-theme', 'ee-datepicker'),
243
+			EVENT_ESPRESSO_VERSION,
244
+			true
245
+		);
246
+	}
247
+
248
+
249
+	public function load_scripts_styles_default()
250
+	{
251
+		// styles
252
+		wp_register_style(
253
+			'espresso_payments',
254
+			EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
255
+			array(),
256
+			EVENT_ESPRESSO_VERSION
257
+		);
258
+		wp_enqueue_style('espresso_payments');
259
+		wp_enqueue_style('ee-text-links');
260
+		// scripts
261
+	}
262
+
263
+
264
+	protected function _payment_methods_list()
265
+	{
266
+		/**
267
+		 * first let's ensure payment methods have been setup. We do this here because when people activate a
268
+		 * payment method for the first time (as an addon), it may not setup its capabilities or get registered
269
+		 * correctly due to the loading process.  However, people MUST setup the details for the payment method so its
270
+		 * safe to do a recheck here.
271
+		 */
272
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
273
+		EEM_Payment_Method::instance()->verify_button_urls();
274
+		// setup tabs, one for each payment method type
275
+		$tabs = array();
276
+		$payment_methods = array();
277
+		foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) {
278
+			// we don't want to show admin-only PMTs for now
279
+			if ($pmt_obj instanceof EE_PMT_Admin_Only) {
280
+				continue;
281
+			}
282
+			// check access
283
+			if (! EE_Registry::instance()->CAP->current_user_can(
284
+				$pmt_obj->cap_name(),
285
+				'specific_payment_method_type_access'
286
+			)
287
+			) {
288
+				continue;
289
+			}
290
+			// check for any active pms of that type
291
+			$payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
292
+			if (! $payment_method instanceof EE_Payment_Method) {
293
+				$payment_method = EE_Payment_Method::new_instance(
294
+					array(
295
+						'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
296
+						'PMD_type'       => $pmt_obj->system_name(),
297
+						'PMD_name'       => $pmt_obj->pretty_name(),
298
+						'PMD_admin_name' => $pmt_obj->pretty_name(),
299
+					)
300
+				);
301
+			}
302
+			$payment_methods[ $payment_method->slug() ] = $payment_method;
303
+		}
304
+		$payment_methods = apply_filters(
305
+			'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
306
+			$payment_methods
307
+		);
308
+		foreach ($payment_methods as $payment_method) {
309
+			if ($payment_method instanceof EE_Payment_Method) {
310
+				add_meta_box(
311
+					// html id
312
+					'espresso_' . $payment_method->slug() . '_payment_settings',
313
+					// title
314
+					sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
315
+					// callback
316
+					array($this, 'payment_method_settings_meta_box'),
317
+					// post type
318
+					null,
319
+					// context
320
+					'normal',
321
+					// priority
322
+					'default',
323
+					// callback args
324
+					array('payment_method' => $payment_method)
325
+				);
326
+				// setup for tabbed content
327
+				$tabs[ $payment_method->slug() ] = array(
328
+					'label' => $payment_method->admin_name(),
329
+					'class' => $payment_method->active() ? 'gateway-active' : '',
330
+					'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
331
+					'title' => __('Modify this Payment Method', 'event_espresso'),
332
+					'slug'  => $payment_method->slug(),
333
+				);
334
+			}
335
+		}
336
+		$this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
337
+			$tabs,
338
+			'payment_method_links',
339
+			'|',
340
+			$this->_get_active_payment_method_slug()
341
+		);
342
+		$this->display_admin_page_with_sidebar();
343
+	}
344
+
345
+
346
+	/**
347
+	 *   _get_active_payment_method_slug
348
+	 *
349
+	 * @return string
350
+	 */
351
+	protected function _get_active_payment_method_slug()
352
+	{
353
+		$payment_method_slug = false;
354
+		// decide which payment method tab to open first, as dictated by the request's 'payment_method'
355
+		if (isset($this->_req_data['payment_method'])) {
356
+			// if they provided the current payment method, use it
357
+			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
358
+		}
359
+		$payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
360
+		// if that didn't work or wasn't provided, find another way to select the current pm
361
+		if (! $this->_verify_payment_method($payment_method)) {
362
+			// like, looking for an active one
363
+			$payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
364
+			// test that one as well
365
+			if ($this->_verify_payment_method($payment_method)) {
366
+				$payment_method_slug = $payment_method->slug();
367
+			} else {
368
+				$payment_method_slug = 'paypal_standard';
369
+			}
370
+		}
371
+		return $payment_method_slug;
372
+	}
373
+
374
+
375
+	/**
376
+	 *    payment_method_settings_meta_box
377
+	 *    returns TRUE if the passed payment method is properly constructed and the logged in user has the correct
378
+	 *    capabilities to access it
379
+	 *
380
+	 * @param EE_Payment_Method $payment_method
381
+	 * @return boolean
382
+	 */
383
+	protected function _verify_payment_method($payment_method)
384
+	{
385
+		if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base
386
+			&& EE_Registry::instance()->CAP->current_user_can(
387
+				$payment_method->type_obj()->cap_name(),
388
+				'specific_payment_method_type_access'
389
+			)
390
+		) {
391
+			return true;
392
+		}
393
+		return false;
394
+	}
395
+
396
+
397
+	/**
398
+	 *    payment_method_settings_meta_box
399
+	 *
400
+	 * @param NULL  $post_obj_which_is_null is an object containing the current post (as a $post object)
401
+	 * @param array $metabox                is an array with metabox id, title, callback, and args elements. the value
402
+	 *                                      at 'args' has key 'payment_method', as set within _payment_methods_list
403
+	 * @return string
404
+	 * @throws EE_Error
405
+	 */
406
+	public function payment_method_settings_meta_box($post_obj_which_is_null, $metabox)
407
+	{
408
+		$payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
409
+			? $metabox['args']['payment_method'] : null;
410
+		if (! $payment_method instanceof EE_Payment_Method) {
411
+			throw new EE_Error(
412
+				sprintf(
413
+					__(
414
+						'Payment method metabox setup incorrectly. No Payment method object was supplied',
415
+						'event_espresso'
416
+					)
417
+				)
418
+			);
419
+		}
420
+		$payment_method_scopes = $payment_method->active();
421
+		// if the payment method really exists show its form, otherwise the activation template
422
+		if ($payment_method->ID() && ! empty($payment_method_scopes)) {
423
+			$form = $this->_generate_payment_method_settings_form($payment_method);
424
+			if ($form->form_data_present_in($this->_req_data)) {
425
+				$form->receive_form_submission($this->_req_data);
426
+			}
427
+			echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
428
+		} else {
429
+			echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
430
+		}
431
+	}
432
+
433
+
434
+	/**
435
+	 * Gets the form for all the settings related to this payment method type
436
+	 *
437
+	 * @access protected
438
+	 * @param EE_Payment_Method $payment_method
439
+	 * @return EE_Form_Section_Proper
440
+	 */
441
+	protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
442
+	{
443
+		if (! $payment_method instanceof EE_Payment_Method) {
444
+			return new EE_Form_Section_Proper();
445
+		}
446
+		return new EE_Form_Section_Proper(
447
+			array(
448
+				'name'            => $payment_method->slug() . '_settings_form',
449
+				'html_id'         => $payment_method->slug() . '_settings_form',
450
+				'action'          => EE_Admin_Page::add_query_args_and_nonce(
451
+					array(
452
+						'action'         => 'update_payment_method',
453
+						'payment_method' => $payment_method->slug(),
454
+					),
455
+					EE_PAYMENTS_ADMIN_URL
456
+				),
457
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
458
+				'subsections'     => apply_filters(
459
+					'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
460
+					array(
461
+						'pci_dss_compliance'      => $this->_pci_dss_compliance($payment_method),
462
+						'currency_support'        => $this->_currency_support($payment_method),
463
+						'payment_method_settings' => $this->_payment_method_settings($payment_method),
464
+						'update'                  => $this->_update_payment_method_button($payment_method),
465
+						'deactivate'              => $this->_deactivate_payment_method_button($payment_method),
466
+						'fine_print'              => $this->_fine_print(),
467
+					),
468
+					$payment_method
469
+				),
470
+			)
471
+		);
472
+	}
473
+
474
+
475
+	/**
476
+	 * _pci_dss_compliance
477
+	 *
478
+	 * @access protected
479
+	 * @param EE_Payment_Method $payment_method
480
+	 * @return EE_Form_Section_Proper
481
+	 */
482
+	protected function _pci_dss_compliance(EE_Payment_Method $payment_method)
483
+	{
484
+		if ($payment_method->type_obj()->requires_https()) {
485
+			return new EE_Form_Section_HTML(
486
+				EEH_HTML::table(
487
+					EEH_HTML::tr(
488
+						EEH_HTML::th(
489
+							EEH_HTML::label(
490
+								EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
491
+							)
492
+						) .
493
+						EEH_HTML::td(
494
+							EEH_HTML::strong(
495
+								__(
496
+									'You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
497
+									'event_espresso'
498
+								)
499
+							)
500
+							.
501
+							EEH_HTML::br()
502
+							.
503
+							__('Learn more about ', 'event_espresso')
504
+							. EEH_HTML::link(
505
+								'https://www.pcisecuritystandards.org/merchants/index.php',
506
+								__('PCI DSS compliance', 'event_espresso')
507
+							)
508
+						)
509
+					)
510
+				)
511
+			);
512
+		} else {
513
+			return new EE_Form_Section_HTML('');
514
+		}
515
+	}
516
+
517
+
518
+	/**
519
+	 * _currency_support
520
+	 *
521
+	 * @access protected
522
+	 * @param EE_Payment_Method $payment_method
523
+	 * @return EE_Form_Section_Proper
524
+	 */
525
+	protected function _currency_support(EE_Payment_Method $payment_method)
526
+	{
527
+		if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
528
+			return new EE_Form_Section_HTML(
529
+				EEH_HTML::table(
530
+					EEH_HTML::tr(
531
+						EEH_HTML::th(
532
+							EEH_HTML::label(
533
+								EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
534
+							)
535
+						) .
536
+						EEH_HTML::td(
537
+							EEH_HTML::strong(
538
+								sprintf(
539
+									__(
540
+										'This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.',
541
+										'event_espresso'
542
+									),
543
+									EE_Config::instance()->currency->code
544
+								)
545
+							)
546
+						)
547
+					)
548
+				)
549
+			);
550
+		} else {
551
+			return new EE_Form_Section_HTML('');
552
+		}
553
+	}
554
+
555
+
556
+	/**
557
+	 * _update_payment_method_button
558
+	 *
559
+	 * @access protected
560
+	 * @param EE_Payment_Method $payment_method
561
+	 * @return EE_Payment_Method_Form
562
+	 */
563
+	protected function _payment_method_settings(EE_Payment_Method $payment_method)
564
+	{
565
+		// modify the form so we only have/show fields that will be implemented for this version
566
+		return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name());
567
+	}
568
+
569
+
570
+	/**
571
+	 * Simplifies the form to merely reproduce 4.1's gateway settings functionality
572
+	 *
573
+	 * @param EE_Form_Section_Proper $form_section
574
+	 * @param string                 $payment_method_name
575
+	 * @return EE_Payment_Method_Form
576
+	 * @throws EE_Error
577
+	 */
578
+	protected function _simplify_form($form_section, $payment_method_name = '')
579
+	{
580
+		if ($form_section instanceof EE_Payment_Method_Form) {
581
+			$form_section->exclude(
582
+				array(
583
+					'PMD_type', // dont want them changing the type
584
+					'PMD_slug', // or the slug (probably never)
585
+					'PMD_wp_user', // or the user's ID
586
+					'Currency' // or the currency, until the rest of EE supports simultaneous currencies
587
+				)
588
+			);
589
+			return $form_section;
590
+		} else {
591
+			throw new EE_Error(
592
+				sprintf(
593
+					__(
594
+						'The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.',
595
+						'event_espresso'
596
+					),
597
+					$payment_method_name
598
+				)
599
+			);
600
+		}
601
+	}
602
+
603
+
604
+	/**
605
+	 * _update_payment_method_button
606
+	 *
607
+	 * @access protected
608
+	 * @param EE_Payment_Method $payment_method
609
+	 * @return EE_Form_Section_HTML
610
+	 */
611
+	protected function _update_payment_method_button(EE_Payment_Method $payment_method)
612
+	{
613
+		$update_button = new EE_Submit_Input(
614
+			array(
615
+				'name'       => 'submit',
616
+				'html_id'    => 'save_' . $payment_method->slug() . '_settings',
617
+				'default'    => sprintf(
618
+					__('Update %s Payment Settings', 'event_espresso'),
619
+					$payment_method->admin_name()
620
+				),
621
+				'html_label' => EEH_HTML::nbsp(),
622
+			)
623
+		);
624
+		return new EE_Form_Section_HTML(
625
+			EEH_HTML::table(
626
+				EEH_HTML::no_row(EEH_HTML::br(2)) .
627
+				EEH_HTML::tr(
628
+					EEH_HTML::th(__('Update Settings', 'event_espresso')) .
629
+					EEH_HTML::td(
630
+						$update_button->get_html_for_input()
631
+					)
632
+				)
633
+			)
634
+		);
635
+	}
636
+
637
+
638
+	/**
639
+	 * _deactivate_payment_method_button
640
+	 *
641
+	 * @access protected
642
+	 * @param EE_Payment_Method $payment_method
643
+	 * @return EE_Form_Section_Proper
644
+	 */
645
+	protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
646
+	{
647
+		$link_text_and_title = sprintf(
648
+			__('Deactivate %1$s Payments?', 'event_espresso'),
649
+			$payment_method->admin_name()
650
+		);
651
+		return new EE_Form_Section_HTML(
652
+			EEH_HTML::table(
653
+				EEH_HTML::tr(
654
+					EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
655
+					EEH_HTML::td(
656
+						EEH_HTML::link(
657
+							EE_Admin_Page::add_query_args_and_nonce(
658
+								array(
659
+									'action'         => 'deactivate_payment_method',
660
+									'payment_method' => $payment_method->slug(),
661
+								),
662
+								EE_PAYMENTS_ADMIN_URL
663
+							),
664
+							$link_text_and_title,
665
+							$link_text_and_title,
666
+							'deactivate_' . $payment_method->slug(),
667
+							'espresso-button button-secondary'
668
+						)
669
+					)
670
+				)
671
+			)
672
+		);
673
+	}
674
+
675
+
676
+	/**
677
+	 * _activate_payment_method_button
678
+	 *
679
+	 * @access protected
680
+	 * @param EE_Payment_Method $payment_method
681
+	 * @return EE_Form_Section_Proper
682
+	 */
683
+	protected function _activate_payment_method_button(EE_Payment_Method $payment_method)
684
+	{
685
+		$link_text_and_title = sprintf(
686
+			__('Activate %1$s Payment Method?', 'event_espresso'),
687
+			$payment_method->admin_name()
688
+		);
689
+		return new EE_Form_Section_Proper(
690
+			array(
691
+				'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
692
+				'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
693
+				'action'          => '#',
694
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
695
+				'subsections'     => apply_filters(
696
+					'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections',
697
+					array(
698
+						new EE_Form_Section_HTML(
699
+							EEH_HTML::table(
700
+								EEH_HTML::tr(
701
+									EEH_HTML::td(
702
+										$payment_method->type_obj()->introductory_html(),
703
+										'',
704
+										'',
705
+										'',
706
+										'colspan="2"'
707
+									)
708
+								) .
709
+								EEH_HTML::tr(
710
+									EEH_HTML::th(
711
+										EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
712
+									) .
713
+									EEH_HTML::td(
714
+										EEH_HTML::link(
715
+											EE_Admin_Page::add_query_args_and_nonce(
716
+												array(
717
+													'action'              => 'activate_payment_method',
718
+													'payment_method_type' => $payment_method->type(),
719
+												),
720
+												EE_PAYMENTS_ADMIN_URL
721
+											),
722
+											$link_text_and_title,
723
+											$link_text_and_title,
724
+											'activate_' . $payment_method->slug(),
725
+											'espresso-button-green button-primary'
726
+										)
727
+									)
728
+								)
729
+							)
730
+						),
731
+					),
732
+					$payment_method
733
+				),
734
+			)
735
+		);
736
+	}
737
+
738
+
739
+	/**
740
+	 * _fine_print
741
+	 *
742
+	 * @access protected
743
+	 * @return EE_Form_Section_HTML
744
+	 */
745
+	protected function _fine_print()
746
+	{
747
+		return new EE_Form_Section_HTML(
748
+			EEH_HTML::table(
749
+				EEH_HTML::tr(
750
+					EEH_HTML::th() .
751
+					EEH_HTML::td(
752
+						EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
753
+					)
754
+				)
755
+			)
756
+		);
757
+	}
758
+
759
+
760
+	/**
761
+	 * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far)
762
+	 *
763
+	 * @global WP_User $current_user
764
+	 */
765
+	protected function _activate_payment_method()
766
+	{
767
+		if (isset($this->_req_data['payment_method_type'])) {
768
+			$payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']);
769
+			// see if one exists
770
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
771
+			$payment_method = EE_Payment_Method_Manager::instance()
772
+													   ->activate_a_payment_method_of_type($payment_method_type);
773
+			$this->_redirect_after_action(
774
+				1,
775
+				'Payment Method',
776
+				'activated',
777
+				array('action' => 'default', 'payment_method' => $payment_method->slug())
778
+			);
779
+		} else {
780
+			$this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
781
+		}
782
+	}
783
+
784
+
785
+	/**
786
+	 * Deactivates the payment method with the specified slug, and redirects.
787
+	 */
788
+	protected function _deactivate_payment_method()
789
+	{
790
+		if (isset($this->_req_data['payment_method'])) {
791
+			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
792
+			// deactivate it
793
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
794
+			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug);
795
+			$this->_redirect_after_action(
796
+				$count_updated,
797
+				'Payment Method',
798
+				'deactivated',
799
+				array('action' => 'default', 'payment_method' => $payment_method_slug)
800
+			);
801
+		} else {
802
+			$this->_redirect_after_action(false, 'Payment Method', 'deactivated', array('action' => 'default'));
803
+		}
804
+	}
805
+
806
+
807
+	/**
808
+	 * Processes the payment method form that was submitted. This is slightly trickier than usual form
809
+	 * processing because we first need to identify WHICH form was processed and which payment method
810
+	 * it corresponds to. Once we have done that, we see if the form is valid. If it is, the
811
+	 * form's data is saved and we redirect to the default payment methods page, setting the updated payment method
812
+	 * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the
813
+	 * subsequently called 'headers_sent_func' which is _payment_methods_list)
814
+	 *
815
+	 * @return void
816
+	 */
817
+	protected function _update_payment_method()
818
+	{
819
+		if ($_SERVER['REQUEST_METHOD'] == 'POST') {
820
+			// ok let's find which gateway form to use based on the form input
821
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
822
+			/** @var $correct_pmt_form_to_use EE_Payment_Method_Form */
823
+			$correct_pmt_form_to_use = null;
824
+			$payment_method = null;
825
+			foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) {
826
+				// get the form and simplify it, like what we do when we display it
827
+				$pmt_form = $this->_generate_payment_method_settings_form($payment_method);
828
+				if ($pmt_form->form_data_present_in($this->_req_data)) {
829
+					$correct_pmt_form_to_use = $pmt_form;
830
+					break;
831
+				}
832
+			}
833
+			// if we couldn't find the correct payment method type...
834
+			if (! $correct_pmt_form_to_use) {
835
+				EE_Error::add_error(
836
+					__(
837
+						"We could not find which payment method type your form submission related to. Please contact support",
838
+						'event_espresso'
839
+					),
840
+					__FILE__,
841
+					__FUNCTION__,
842
+					__LINE__
843
+				);
844
+				$this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
845
+			}
846
+			$correct_pmt_form_to_use->receive_form_submission($this->_req_data);
847
+			if ($correct_pmt_form_to_use->is_valid()) {
848
+				$payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
849
+				if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
850
+					throw new EE_Error(
851
+						sprintf(
852
+							__(
853
+								'The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
854
+								'event_espresso'
855
+							),
856
+							'payment_method_settings'
857
+						)
858
+					);
859
+				}
860
+				$payment_settings_subform->save();
861
+				/** @var $pm EE_Payment_Method */
862
+				$this->_redirect_after_action(
863
+					true,
864
+					'Payment Method',
865
+					'updated',
866
+					array('action' => 'default', 'payment_method' => $payment_method->slug())
867
+				);
868
+			} else {
869
+				EE_Error::add_error(
870
+					sprintf(
871
+						__(
872
+							'Payment method of type %s was not saved because there were validation errors. They have been marked in the form',
873
+							'event_espresso'
874
+						),
875
+						$payment_method instanceof EE_Payment_Method ? $payment_method->type_obj()->pretty_name()
876
+							: __('"(unknown)"', 'event_espresso')
877
+					),
878
+					__FILE__,
879
+					__FUNCTION__,
880
+					__LINE__
881
+				);
882
+			}
883
+		}
884
+		return;
885
+	}
886
+
887
+
888
+	/**
889
+	 * Displays payment settings (not payment METHOD settings, that's _payment_method_settings)
890
+	 * @throws DomainException
891
+	 * @throws EE_Error
892
+	 * @throws InvalidArgumentException
893
+	 * @throws InvalidDataTypeException
894
+	 * @throws InvalidInterfaceException
895
+	 */
896
+	protected function _payment_settings()
897
+	{
898
+		$form = $this->getPaymentSettingsForm();
899
+		$this->_set_add_edit_form_tags('update_payment_settings');
900
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
901
+		$this->_template_args['admin_page_content'] =  $form->get_html_and_js();
902
+		$this->display_admin_page_with_sidebar();
903
+	}
904
+
905
+
906
+	/**
907
+	 *        _update_payment_settings
908
+	 *
909
+	 * @access protected
910
+	 * @return void
911
+	 * @throws EE_Error
912
+	 * @throws InvalidArgumentException
913
+	 * @throws InvalidDataTypeException
914
+	 * @throws InvalidInterfaceException
915
+	 */
916
+	protected function _update_payment_settings()
917
+	{
918
+		$form = $this->getPaymentSettingsForm();
919
+		if ($form->was_submitted($this->_req_data)) {
920
+			$form->receive_form_submission($this->_req_data);
921
+			if ($form->is_valid()) {
922
+				/**
923
+				 * @var $reg_config EE_Registration_Config
924
+				 */
925
+				$loader = LoaderFactory::getLoader();
926
+				$reg_config = $loader->getShared('EE_Registration_Config');
927
+				$valid_data = $form->valid_data();
928
+				$reg_config->show_pending_payment_options = $valid_data['show_pending_payment_options'];
929
+				$reg_config->gateway_log_lifespan = $valid_data['gateway_log_lifespan'];
930
+			}
931
+		}
932
+		EE_Registry::instance()->CFG = apply_filters(
933
+			'FHEE__Payments_Admin_Page___update_payment_settings__CFG',
934
+			EE_Registry::instance()->CFG
935
+		);
936
+
937
+		$cfg =  EE_Registry::instance()->CFG ;
938
+
939
+		$what = __('Payment Settings', 'event_espresso');
940
+		$success = $this->_update_espresso_configuration(
941
+			$what,
942
+			EE_Registry::instance()->CFG,
943
+			__FILE__,
944
+			__FUNCTION__,
945
+			__LINE__
946
+		);
947
+		$this->_redirect_after_action(
948
+			$success,
949
+			$what,
950
+			__('updated', 'event_espresso'),
951
+			array('action' => 'payment_settings')
952
+		);
953
+	}
954
+
955
+
956
+	/**
957
+	 * Gets the form used for updating payment settings
958
+	 *
959
+	 * @return EE_Form_Section_Proper
960
+	 * @throws EE_Error
961
+	 * @throws InvalidArgumentException
962
+	 * @throws InvalidDataTypeException
963
+	 * @throws InvalidInterfaceException
964
+	 */
965
+	protected function getPaymentSettingsForm()
966
+	{
967
+		/**
968
+		 * @var $reg_config EE_Registration_Config
969
+		 */
970
+		$reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
971
+		return new EE_Form_Section_Proper(
972
+			array(
973
+				'name' => 'payment-settings',
974
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
975
+				'subsections' => array(
976
+					'show_pending_payment_options' => new EE_Yes_No_Input(
977
+						array(
978
+							'html_name' => 'show_pending_payment_options',
979
+							'default' => $reg_config->show_pending_payment_options,
980
+							'html_help_text' => esc_html__(
981
+								"If a payment is marked as 'Pending Payment', or if payment is deferred (ie, an offline gateway like Check, Bank, or Invoice is used), then give registrants the option to retry payment. ",
982
+								'event_espresso'
983
+							)
984
+						)
985
+					),
986
+					'gateway_log_lifespan' => new EE_Select_Input(
987
+						$reg_config->gatewayLogLifespanOptions(),
988
+						array(
989
+							'html_label_text' => esc_html__('Gateway Logs Lifespan', 'event_espresso'),
990
+							'html_help_text' => esc_html__('If issues arise with payments being made through a payment gateway, it\'s helpful to log non-sensitive communications with the payment gateway. But it\'s a security responsibility, so it\'s a good idea to not keep them for any longer than necessary.', 'event_espresso'),
991
+							'default' => $reg_config->gateway_log_lifespan,
992
+						)
993
+					)
994
+				)
995
+			)
996
+		);
997
+	}
998
+
999
+
1000
+	protected function _payment_log_overview_list_table()
1001
+	{
1002
+		$this->display_admin_list_table_page_with_sidebar();
1003
+	}
1004
+
1005
+
1006
+	protected function _set_list_table_views_payment_log()
1007
+	{
1008
+		$this->_views = array(
1009
+			'all' => array(
1010
+				'slug'  => 'all',
1011
+				'label' => __('View All Logs', 'event_espresso'),
1012
+				'count' => 0,
1013
+			),
1014
+		);
1015
+	}
1016
+
1017
+
1018
+	/**
1019
+	 * @param int  $per_page
1020
+	 * @param int  $current_page
1021
+	 * @param bool $count
1022
+	 * @return array
1023
+	 */
1024
+	public function get_payment_logs($per_page = 50, $current_page = 0, $count = false)
1025
+	{
1026
+		EE_Registry::instance()->load_model('Change_Log');
1027
+		// we may need to do multiple queries (joining differently), so we actually wan tan array of query params
1028
+		$query_params = array(array('LOG_type' => EEM_Change_Log::type_gateway));
1029
+		// check if they've selected a specific payment method
1030
+		if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') {
1031
+			$query_params[0]['OR*pm_or_pay_pm'] = array(
1032
+				'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'],
1033
+				'Payment_Method.PMD_ID'         => $this->_req_data['_payment_method'],
1034
+			);
1035
+		}
1036
+		// take into account search
1037
+		if (isset($this->_req_data['s']) && $this->_req_data['s']) {
1038
+			$similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
1039
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
1040
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
1041
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
1042
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_name'] = $similarity_string;
1043
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name'] = $similarity_string;
1044
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_type'] = $similarity_string;
1045
+			$query_params[0]['OR*s']['LOG_message'] = $similarity_string;
1046
+			$query_params[0]['OR*s']['Payment_Method.PMD_name'] = $similarity_string;
1047
+			$query_params[0]['OR*s']['Payment_Method.PMD_admin_name'] = $similarity_string;
1048
+			$query_params[0]['OR*s']['Payment_Method.PMD_type'] = $similarity_string;
1049
+			$query_params[0]['OR*s']['LOG_message'] = $similarity_string;
1050
+		}
1051
+		if (isset($this->_req_data['payment-filter-start-date'])
1052
+			&& isset($this->_req_data['payment-filter-end-date'])
1053
+		) {
1054
+			// add date
1055
+			$start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
1056
+			$end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
1057
+			// make sure our timestamps start and end right at the boundaries for each day
1058
+			$start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
1059
+			$end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
1060
+			// convert to timestamps
1061
+			$start_date = strtotime($start_date);
1062
+			$end_date = strtotime($end_date);
1063
+			// makes sure start date is the lowest value and vice versa
1064
+			$start_date = min($start_date, $end_date);
1065
+			$end_date = max($start_date, $end_date);
1066
+			// convert for query
1067
+			$start_date = EEM_Change_Log::instance()
1068
+										->convert_datetime_for_query(
1069
+											'LOG_time',
1070
+											date('Y-m-d H:i:s', $start_date),
1071
+											'Y-m-d H:i:s'
1072
+										);
1073
+			$end_date = EEM_Change_Log::instance()
1074
+									  ->convert_datetime_for_query(
1075
+										  'LOG_time',
1076
+										  date('Y-m-d H:i:s', $end_date),
1077
+										  'Y-m-d H:i:s'
1078
+									  );
1079
+			$query_params[0]['LOG_time'] = array('BETWEEN', array($start_date, $end_date));
1080
+		}
1081
+		if ($count) {
1082
+			return EEM_Change_Log::instance()->count($query_params);
1083
+		}
1084
+		if (isset($this->_req_data['order'])) {
1085
+			$sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
1086
+				: 'DESC';
1087
+			$query_params['order_by'] = array('LOG_time' => $sort);
1088
+		} else {
1089
+			$query_params['order_by'] = array('LOG_time' => 'DESC');
1090
+		}
1091
+		$offset = ($current_page - 1) * $per_page;
1092
+		if (! isset($this->_req_data['download_results'])) {
1093
+			$query_params['limit'] = array($offset, $per_page);
1094
+		}
1095
+		// now they've requested to instead just download the file instead of viewing it.
1096
+		if (isset($this->_req_data['download_results'])) {
1097
+			$wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
1098
+			header('Content-Disposition: attachment');
1099
+			header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
1100
+			echo "<h1>Payment Logs for " . site_url() . "</h1>";
1101
+			echo "<h3>Query:</h3>";
1102
+			var_dump($query_params);
1103
+			echo "<h3>Results:</h3>";
1104
+			var_dump($wpdb_results);
1105
+			die;
1106
+		}
1107
+		$results = EEM_Change_Log::instance()->get_all($query_params);
1108
+		return $results;
1109
+	}
1110
+
1111
+
1112
+	/**
1113
+	 * Used by usort to RE-sort log query results, because we lose the ordering
1114
+	 * because we're possibly combining the results from two queries
1115
+	 *
1116
+	 * @param EE_Change_Log $logA
1117
+	 * @param EE_Change_Log $logB
1118
+	 * @return int
1119
+	 */
1120
+	protected function _sort_logs_again($logA, $logB)
1121
+	{
1122
+		$timeA = $logA->get_raw('LOG_time');
1123
+		$timeB = $logB->get_raw('LOG_time');
1124
+		if ($timeA == $timeB) {
1125
+			return 0;
1126
+		}
1127
+		$comparison = $timeA < $timeB ? -1 : 1;
1128
+		if (strtoupper($this->_sort_logs_again_direction) == 'DESC') {
1129
+			return $comparison * -1;
1130
+		} else {
1131
+			return $comparison;
1132
+		}
1133
+	}
1134
+
1135
+
1136
+	protected function _payment_log_details()
1137
+	{
1138
+		EE_Registry::instance()->load_model('Change_Log');
1139
+		/** @var $payment_log EE_Change_Log */
1140
+		$payment_log = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']);
1141
+		$payment_method = null;
1142
+		$transaction = null;
1143
+		if ($payment_log instanceof EE_Change_Log) {
1144
+			if ($payment_log->object() instanceof EE_Payment) {
1145
+				$payment_method = $payment_log->object()->payment_method();
1146
+				$transaction = $payment_log->object()->transaction();
1147
+			} elseif ($payment_log->object() instanceof EE_Payment_Method) {
1148
+				$payment_method = $payment_log->object();
1149
+			} elseif ($payment_log->object() instanceof EE_Transaction) {
1150
+				$transaction = $payment_log->object();
1151
+				$payment_method = $transaction->payment_method();
1152
+			}
1153
+		}
1154
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
1155
+			EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
1156
+			array(
1157
+				'payment_log'    => $payment_log,
1158
+				'payment_method' => $payment_method,
1159
+				'transaction'    => $transaction,
1160
+			),
1161
+			true
1162
+		);
1163
+		$this->display_admin_page_with_sidebar();
1164
+	}
1165 1165
 }
Please login to merge, or discard this patch.
Spacing   +42 added lines, -42 removed lines patch added patch discarded remove patch
@@ -182,7 +182,7 @@  discard block
 block discarded – undo
182 182
         $payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
183 183
         $all_pmt_help_tabs_config = array();
184 184
         foreach ($payment_method_types as $payment_method_type) {
185
-            if (! EE_Registry::instance()->CAP->current_user_can(
185
+            if ( ! EE_Registry::instance()->CAP->current_user_can(
186 186
                 $payment_method_type->cap_name(),
187 187
                 'specific_payment_method_type_access'
188 188
             )
@@ -192,10 +192,10 @@  discard block
 block discarded – undo
192 192
             foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
193 193
                 $template_args = isset($config['template_args']) ? $config['template_args'] : array();
194 194
                 $template_args['admin_page_obj'] = $this;
195
-                $all_pmt_help_tabs_config[ $help_tab_name ] = array(
195
+                $all_pmt_help_tabs_config[$help_tab_name] = array(
196 196
                     'title'   => $config['title'],
197 197
                     'content' => EEH_Template::display_template(
198
-                        $payment_method_type->file_folder() . 'help_tabs/' . $config['filename'] . '.help_tab.php',
198
+                        $payment_method_type->file_folder().'help_tabs/'.$config['filename'].'.help_tab.php',
199 199
                         $template_args,
200 200
                         true
201 201
                     ),
@@ -238,7 +238,7 @@  discard block
 block discarded – undo
238 238
         wp_enqueue_script('ee-text-links');
239 239
         wp_enqueue_script(
240 240
             'espresso_payments',
241
-            EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
241
+            EE_PAYMENTS_ASSETS_URL.'espresso_payments_admin.js',
242 242
             array('espresso-ui-theme', 'ee-datepicker'),
243 243
             EVENT_ESPRESSO_VERSION,
244 244
             true
@@ -251,7 +251,7 @@  discard block
 block discarded – undo
251 251
         // styles
252 252
         wp_register_style(
253 253
             'espresso_payments',
254
-            EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
254
+            EE_PAYMENTS_ASSETS_URL.'ee-payments.css',
255 255
             array(),
256 256
             EVENT_ESPRESSO_VERSION
257 257
         );
@@ -280,7 +280,7 @@  discard block
 block discarded – undo
280 280
                 continue;
281 281
             }
282 282
             // check access
283
-            if (! EE_Registry::instance()->CAP->current_user_can(
283
+            if ( ! EE_Registry::instance()->CAP->current_user_can(
284 284
                 $pmt_obj->cap_name(),
285 285
                 'specific_payment_method_type_access'
286 286
             )
@@ -289,7 +289,7 @@  discard block
 block discarded – undo
289 289
             }
290 290
             // check for any active pms of that type
291 291
             $payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
292
-            if (! $payment_method instanceof EE_Payment_Method) {
292
+            if ( ! $payment_method instanceof EE_Payment_Method) {
293 293
                 $payment_method = EE_Payment_Method::new_instance(
294 294
                     array(
295 295
                         'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
@@ -299,7 +299,7 @@  discard block
 block discarded – undo
299 299
                     )
300 300
                 );
301 301
             }
302
-            $payment_methods[ $payment_method->slug() ] = $payment_method;
302
+            $payment_methods[$payment_method->slug()] = $payment_method;
303 303
         }
304 304
         $payment_methods = apply_filters(
305 305
             'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
@@ -309,7 +309,7 @@  discard block
 block discarded – undo
309 309
             if ($payment_method instanceof EE_Payment_Method) {
310 310
                 add_meta_box(
311 311
                     // html id
312
-                    'espresso_' . $payment_method->slug() . '_payment_settings',
312
+                    'espresso_'.$payment_method->slug().'_payment_settings',
313 313
                     // title
314 314
                     sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
315 315
                     // callback
@@ -324,10 +324,10 @@  discard block
 block discarded – undo
324 324
                     array('payment_method' => $payment_method)
325 325
                 );
326 326
                 // setup for tabbed content
327
-                $tabs[ $payment_method->slug() ] = array(
327
+                $tabs[$payment_method->slug()] = array(
328 328
                     'label' => $payment_method->admin_name(),
329 329
                     'class' => $payment_method->active() ? 'gateway-active' : '',
330
-                    'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
330
+                    'href'  => 'espresso_'.$payment_method->slug().'_payment_settings',
331 331
                     'title' => __('Modify this Payment Method', 'event_espresso'),
332 332
                     'slug'  => $payment_method->slug(),
333 333
                 );
@@ -358,7 +358,7 @@  discard block
 block discarded – undo
358 358
         }
359 359
         $payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
360 360
         // if that didn't work or wasn't provided, find another way to select the current pm
361
-        if (! $this->_verify_payment_method($payment_method)) {
361
+        if ( ! $this->_verify_payment_method($payment_method)) {
362 362
             // like, looking for an active one
363 363
             $payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
364 364
             // test that one as well
@@ -407,7 +407,7 @@  discard block
 block discarded – undo
407 407
     {
408 408
         $payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
409 409
             ? $metabox['args']['payment_method'] : null;
410
-        if (! $payment_method instanceof EE_Payment_Method) {
410
+        if ( ! $payment_method instanceof EE_Payment_Method) {
411 411
             throw new EE_Error(
412 412
                 sprintf(
413 413
                     __(
@@ -424,7 +424,7 @@  discard block
 block discarded – undo
424 424
             if ($form->form_data_present_in($this->_req_data)) {
425 425
                 $form->receive_form_submission($this->_req_data);
426 426
             }
427
-            echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
427
+            echo $form->form_open().$form->get_html_and_js().$form->form_close();
428 428
         } else {
429 429
             echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
430 430
         }
@@ -440,13 +440,13 @@  discard block
 block discarded – undo
440 440
      */
441 441
     protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
442 442
     {
443
-        if (! $payment_method instanceof EE_Payment_Method) {
443
+        if ( ! $payment_method instanceof EE_Payment_Method) {
444 444
             return new EE_Form_Section_Proper();
445 445
         }
446 446
         return new EE_Form_Section_Proper(
447 447
             array(
448
-                'name'            => $payment_method->slug() . '_settings_form',
449
-                'html_id'         => $payment_method->slug() . '_settings_form',
448
+                'name'            => $payment_method->slug().'_settings_form',
449
+                'html_id'         => $payment_method->slug().'_settings_form',
450 450
                 'action'          => EE_Admin_Page::add_query_args_and_nonce(
451 451
                     array(
452 452
                         'action'         => 'update_payment_method',
@@ -489,7 +489,7 @@  discard block
 block discarded – undo
489 489
                             EEH_HTML::label(
490 490
                                 EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
491 491
                             )
492
-                        ) .
492
+                        ).
493 493
                         EEH_HTML::td(
494 494
                             EEH_HTML::strong(
495 495
                                 __(
@@ -524,7 +524,7 @@  discard block
 block discarded – undo
524 524
      */
525 525
     protected function _currency_support(EE_Payment_Method $payment_method)
526 526
     {
527
-        if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
527
+        if ( ! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
528 528
             return new EE_Form_Section_HTML(
529 529
                 EEH_HTML::table(
530 530
                     EEH_HTML::tr(
@@ -532,7 +532,7 @@  discard block
 block discarded – undo
532 532
                             EEH_HTML::label(
533 533
                                 EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
534 534
                             )
535
-                        ) .
535
+                        ).
536 536
                         EEH_HTML::td(
537 537
                             EEH_HTML::strong(
538 538
                                 sprintf(
@@ -613,7 +613,7 @@  discard block
 block discarded – undo
613 613
         $update_button = new EE_Submit_Input(
614 614
             array(
615 615
                 'name'       => 'submit',
616
-                'html_id'    => 'save_' . $payment_method->slug() . '_settings',
616
+                'html_id'    => 'save_'.$payment_method->slug().'_settings',
617 617
                 'default'    => sprintf(
618 618
                     __('Update %s Payment Settings', 'event_espresso'),
619 619
                     $payment_method->admin_name()
@@ -623,9 +623,9 @@  discard block
 block discarded – undo
623 623
         );
624 624
         return new EE_Form_Section_HTML(
625 625
             EEH_HTML::table(
626
-                EEH_HTML::no_row(EEH_HTML::br(2)) .
626
+                EEH_HTML::no_row(EEH_HTML::br(2)).
627 627
                 EEH_HTML::tr(
628
-                    EEH_HTML::th(__('Update Settings', 'event_espresso')) .
628
+                    EEH_HTML::th(__('Update Settings', 'event_espresso')).
629 629
                     EEH_HTML::td(
630 630
                         $update_button->get_html_for_input()
631 631
                     )
@@ -651,7 +651,7 @@  discard block
 block discarded – undo
651 651
         return new EE_Form_Section_HTML(
652 652
             EEH_HTML::table(
653 653
                 EEH_HTML::tr(
654
-                    EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
654
+                    EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')).
655 655
                     EEH_HTML::td(
656 656
                         EEH_HTML::link(
657 657
                             EE_Admin_Page::add_query_args_and_nonce(
@@ -663,7 +663,7 @@  discard block
 block discarded – undo
663 663
                             ),
664 664
                             $link_text_and_title,
665 665
                             $link_text_and_title,
666
-                            'deactivate_' . $payment_method->slug(),
666
+                            'deactivate_'.$payment_method->slug(),
667 667
                             'espresso-button button-secondary'
668 668
                         )
669 669
                     )
@@ -688,8 +688,8 @@  discard block
 block discarded – undo
688 688
         );
689 689
         return new EE_Form_Section_Proper(
690 690
             array(
691
-                'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
692
-                'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
691
+                'name'            => 'activate_'.$payment_method->slug().'_settings_form',
692
+                'html_id'         => 'activate_'.$payment_method->slug().'_settings_form',
693 693
                 'action'          => '#',
694 694
                 'layout_strategy' => new EE_Admin_Two_Column_Layout(),
695 695
                 'subsections'     => apply_filters(
@@ -705,11 +705,11 @@  discard block
 block discarded – undo
705 705
                                         '',
706 706
                                         'colspan="2"'
707 707
                                     )
708
-                                ) .
708
+                                ).
709 709
                                 EEH_HTML::tr(
710 710
                                     EEH_HTML::th(
711 711
                                         EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
712
-                                    ) .
712
+                                    ).
713 713
                                     EEH_HTML::td(
714 714
                                         EEH_HTML::link(
715 715
                                             EE_Admin_Page::add_query_args_and_nonce(
@@ -721,7 +721,7 @@  discard block
 block discarded – undo
721 721
                                             ),
722 722
                                             $link_text_and_title,
723 723
                                             $link_text_and_title,
724
-                                            'activate_' . $payment_method->slug(),
724
+                                            'activate_'.$payment_method->slug(),
725 725
                                             'espresso-button-green button-primary'
726 726
                                         )
727 727
                                     )
@@ -747,7 +747,7 @@  discard block
 block discarded – undo
747 747
         return new EE_Form_Section_HTML(
748 748
             EEH_HTML::table(
749 749
                 EEH_HTML::tr(
750
-                    EEH_HTML::th() .
750
+                    EEH_HTML::th().
751 751
                     EEH_HTML::td(
752 752
                         EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
753 753
                     )
@@ -831,7 +831,7 @@  discard block
 block discarded – undo
831 831
                 }
832 832
             }
833 833
             // if we couldn't find the correct payment method type...
834
-            if (! $correct_pmt_form_to_use) {
834
+            if ( ! $correct_pmt_form_to_use) {
835 835
                 EE_Error::add_error(
836 836
                     __(
837 837
                         "We could not find which payment method type your form submission related to. Please contact support",
@@ -846,7 +846,7 @@  discard block
 block discarded – undo
846 846
             $correct_pmt_form_to_use->receive_form_submission($this->_req_data);
847 847
             if ($correct_pmt_form_to_use->is_valid()) {
848 848
                 $payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
849
-                if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
849
+                if ( ! $payment_settings_subform instanceof EE_Payment_Method_Form) {
850 850
                     throw new EE_Error(
851 851
                         sprintf(
852 852
                             __(
@@ -898,7 +898,7 @@  discard block
 block discarded – undo
898 898
         $form = $this->getPaymentSettingsForm();
899 899
         $this->_set_add_edit_form_tags('update_payment_settings');
900 900
         $this->_set_publish_post_box_vars(null, false, false, null, false);
901
-        $this->_template_args['admin_page_content'] =  $form->get_html_and_js();
901
+        $this->_template_args['admin_page_content'] = $form->get_html_and_js();
902 902
         $this->display_admin_page_with_sidebar();
903 903
     }
904 904
 
@@ -934,7 +934,7 @@  discard block
 block discarded – undo
934 934
             EE_Registry::instance()->CFG
935 935
         );
936 936
 
937
-        $cfg =  EE_Registry::instance()->CFG ;
937
+        $cfg = EE_Registry::instance()->CFG;
938 938
 
939 939
         $what = __('Payment Settings', 'event_espresso');
940 940
         $success = $this->_update_espresso_configuration(
@@ -1035,7 +1035,7 @@  discard block
 block discarded – undo
1035 1035
         }
1036 1036
         // take into account search
1037 1037
         if (isset($this->_req_data['s']) && $this->_req_data['s']) {
1038
-            $similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
1038
+            $similarity_string = array('LIKE', '%'.str_replace("", "%", $this->_req_data['s']).'%');
1039 1039
             $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
1040 1040
             $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
1041 1041
             $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
@@ -1055,8 +1055,8 @@  discard block
 block discarded – undo
1055 1055
             $start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
1056 1056
             $end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
1057 1057
             // make sure our timestamps start and end right at the boundaries for each day
1058
-            $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
1059
-            $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
1058
+            $start_date = date('Y-m-d', strtotime($start_date)).' 00:00:00';
1059
+            $end_date = date('Y-m-d', strtotime($end_date)).' 23:59:59';
1060 1060
             // convert to timestamps
1061 1061
             $start_date = strtotime($start_date);
1062 1062
             $end_date = strtotime($end_date);
@@ -1089,15 +1089,15 @@  discard block
 block discarded – undo
1089 1089
             $query_params['order_by'] = array('LOG_time' => 'DESC');
1090 1090
         }
1091 1091
         $offset = ($current_page - 1) * $per_page;
1092
-        if (! isset($this->_req_data['download_results'])) {
1092
+        if ( ! isset($this->_req_data['download_results'])) {
1093 1093
             $query_params['limit'] = array($offset, $per_page);
1094 1094
         }
1095 1095
         // now they've requested to instead just download the file instead of viewing it.
1096 1096
         if (isset($this->_req_data['download_results'])) {
1097 1097
             $wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
1098 1098
             header('Content-Disposition: attachment');
1099
-            header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
1100
-            echo "<h1>Payment Logs for " . site_url() . "</h1>";
1099
+            header("Content-Disposition: attachment; filename=ee_payment_logs_for_".sanitize_key(site_url()));
1100
+            echo "<h1>Payment Logs for ".site_url()."</h1>";
1101 1101
             echo "<h3>Query:</h3>";
1102 1102
             var_dump($query_params);
1103 1103
             echo "<h3>Results:</h3>";
@@ -1152,7 +1152,7 @@  discard block
 block discarded – undo
1152 1152
             }
1153 1153
         }
1154 1154
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
1155
-            EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
1155
+            EE_PAYMENTS_TEMPLATE_PATH.'payment_log_details.template.php',
1156 1156
             array(
1157 1157
                 'payment_log'    => $payment_log,
1158 1158
                 'payment_method' => $payment_method,
Please login to merge, or discard this patch.
admin_pages/general_settings/General_Settings_Admin_Page_Init.core.php 2 patches
Indentation   +30 added lines, -30 removed lines patch added patch discarded remove patch
@@ -18,37 +18,37 @@
 block discarded – undo
18 18
 class General_Settings_Admin_Page_Init extends EE_Admin_Page_Init
19 19
 {
20 20
 
21
-    public function __construct()
22
-    {
23
-        // define some constants
24
-        define('GEN_SET_PG_SLUG', 'espresso_general_settings');
25
-        define('GEN_SET_LABEL', __('General Settings', 'event_espresso'));
26
-        define('GEN_SET_ADMIN', EE_ADMIN_PAGES . 'general_settings/');
27
-        define('GEN_SET_ADMIN_URL', admin_url('admin.php?page=' . GEN_SET_PG_SLUG));
28
-        define('GEN_SET_TEMPLATE_PATH', GEN_SET_ADMIN . 'templates/');
29
-        define('GEN_SET_ASSETS_URL', EE_ADMIN_PAGES_URL . 'general_settings/assets/');
21
+	public function __construct()
22
+	{
23
+		// define some constants
24
+		define('GEN_SET_PG_SLUG', 'espresso_general_settings');
25
+		define('GEN_SET_LABEL', __('General Settings', 'event_espresso'));
26
+		define('GEN_SET_ADMIN', EE_ADMIN_PAGES . 'general_settings/');
27
+		define('GEN_SET_ADMIN_URL', admin_url('admin.php?page=' . GEN_SET_PG_SLUG));
28
+		define('GEN_SET_TEMPLATE_PATH', GEN_SET_ADMIN . 'templates/');
29
+		define('GEN_SET_ASSETS_URL', EE_ADMIN_PAGES_URL . 'general_settings/assets/');
30 30
 
31
-        parent::__construct();
32
-    }
31
+		parent::__construct();
32
+	}
33 33
 
34
-    protected function _set_init_properties()
35
-    {
36
-        $this->label = GEN_SET_LABEL;
37
-    }
34
+	protected function _set_init_properties()
35
+	{
36
+		$this->label = GEN_SET_LABEL;
37
+	}
38 38
 
39
-    protected function _set_menu_map()
40
-    {
41
-        $this->_menu_map = new EE_Admin_Page_Sub_Menu(
42
-            array(
43
-                'menu_group'      => 'settings',
44
-                'menu_order'      => 20,
45
-                'show_on_menu'    => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
46
-                'parent_slug'     => 'espresso_events',
47
-                'menu_slug'       => GEN_SET_PG_SLUG,
48
-                'menu_label'      => GEN_SET_LABEL,
49
-                'capability'      => 'manage_options',
50
-                'admin_init_page' => $this,
51
-            )
52
-        );
53
-    }
39
+	protected function _set_menu_map()
40
+	{
41
+		$this->_menu_map = new EE_Admin_Page_Sub_Menu(
42
+			array(
43
+				'menu_group'      => 'settings',
44
+				'menu_order'      => 20,
45
+				'show_on_menu'    => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
46
+				'parent_slug'     => 'espresso_events',
47
+				'menu_slug'       => GEN_SET_PG_SLUG,
48
+				'menu_label'      => GEN_SET_LABEL,
49
+				'capability'      => 'manage_options',
50
+				'admin_init_page' => $this,
51
+			)
52
+		);
53
+	}
54 54
 }
Please login to merge, or discard this patch.
Spacing   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -23,10 +23,10 @@
 block discarded – undo
23 23
         // define some constants
24 24
         define('GEN_SET_PG_SLUG', 'espresso_general_settings');
25 25
         define('GEN_SET_LABEL', __('General Settings', 'event_espresso'));
26
-        define('GEN_SET_ADMIN', EE_ADMIN_PAGES . 'general_settings/');
27
-        define('GEN_SET_ADMIN_URL', admin_url('admin.php?page=' . GEN_SET_PG_SLUG));
28
-        define('GEN_SET_TEMPLATE_PATH', GEN_SET_ADMIN . 'templates/');
29
-        define('GEN_SET_ASSETS_URL', EE_ADMIN_PAGES_URL . 'general_settings/assets/');
26
+        define('GEN_SET_ADMIN', EE_ADMIN_PAGES.'general_settings/');
27
+        define('GEN_SET_ADMIN_URL', admin_url('admin.php?page='.GEN_SET_PG_SLUG));
28
+        define('GEN_SET_TEMPLATE_PATH', GEN_SET_ADMIN.'templates/');
29
+        define('GEN_SET_ASSETS_URL', EE_ADMIN_PAGES_URL.'general_settings/assets/');
30 30
 
31 31
         parent::__construct();
32 32
     }
Please login to merge, or discard this patch.
admin_pages/maintenance/Maintenance_Admin_Page_Init.core.php 2 patches
Indentation   +87 added lines, -87 removed lines patch added patch discarded remove patch
@@ -24,102 +24,102 @@
 block discarded – undo
24 24
 {
25 25
 
26 26
 
27
-    public function __construct()
28
-    {
29
-        // define some page related constants
30
-        define('EE_MAINTENANCE_LABEL', __('Maintenance', 'event_espresso'));
31
-        define('EE_MAINTENANCE_PG_SLUG', 'espresso_maintenance_settings');
32
-        define('EE_MAINTENANCE_ADMIN_URL', admin_url('admin.php?page=' . EE_MAINTENANCE_PG_SLUG));
33
-        define('EE_MAINTENANCE_ADMIN', EE_ADMIN_PAGES . 'maintenance/');
34
-        define('EE_MAINTENANCE_TEMPLATE_PATH', EE_MAINTENANCE_ADMIN . 'templates/');
35
-        define('EE_MAINTENANCE_ASSETS_URL', EE_ADMIN_PAGES_URL . 'maintenance/assets/');
36
-        // check that if we're in maintenance mode that we tell the admin that
37
-        add_action('admin_notices', array($this, 'check_maintenance_mode'));
38
-        parent::__construct();
39
-    }
27
+	public function __construct()
28
+	{
29
+		// define some page related constants
30
+		define('EE_MAINTENANCE_LABEL', __('Maintenance', 'event_espresso'));
31
+		define('EE_MAINTENANCE_PG_SLUG', 'espresso_maintenance_settings');
32
+		define('EE_MAINTENANCE_ADMIN_URL', admin_url('admin.php?page=' . EE_MAINTENANCE_PG_SLUG));
33
+		define('EE_MAINTENANCE_ADMIN', EE_ADMIN_PAGES . 'maintenance/');
34
+		define('EE_MAINTENANCE_TEMPLATE_PATH', EE_MAINTENANCE_ADMIN . 'templates/');
35
+		define('EE_MAINTENANCE_ASSETS_URL', EE_ADMIN_PAGES_URL . 'maintenance/assets/');
36
+		// check that if we're in maintenance mode that we tell the admin that
37
+		add_action('admin_notices', array($this, 'check_maintenance_mode'));
38
+		parent::__construct();
39
+	}
40 40
 
41 41
 
42
-    protected function _set_init_properties()
43
-    {
44
-        $this->label = EE_MAINTENANCE_LABEL;
45
-    }
42
+	protected function _set_init_properties()
43
+	{
44
+		$this->label = EE_MAINTENANCE_LABEL;
45
+	}
46 46
 
47 47
 
48
-    protected function _set_menu_map()
49
-    {
50
-        $menu_map = $this->_menu_map();
51
-        $this->_menu_map = EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
52
-            ? new EE_Admin_Page_Main_Menu($menu_map) : new EE_Admin_Page_Sub_Menu($menu_map);
53
-    }
48
+	protected function _set_menu_map()
49
+	{
50
+		$menu_map = $this->_menu_map();
51
+		$this->_menu_map = EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
52
+			? new EE_Admin_Page_Main_Menu($menu_map) : new EE_Admin_Page_Sub_Menu($menu_map);
53
+	}
54 54
 
55 55
 
56
-    protected function _menu_map()
57
-    {
58
-        $map = array(
59
-            'menu_group'              => 'extras',
60
-            'menu_order'              => 30,
61
-            'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
62
-            'parent_slug'             => 'espresso_events',
63
-            'menu_slug'               => EE_MAINTENANCE_PG_SLUG,
64
-            'menu_label'              => EE_MAINTENANCE_LABEL,
65
-            'capability'              => 'manage_options',
66
-            'maintenance_mode_parent' => EE_MAINTENANCE_PG_SLUG,
67
-            'admin_init_page'         => $this,
68
-        );
69
-        if (EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance) {
70
-            $map['menu_group'] = 'main';
71
-            $map['subtitle'] = EE_MAINTENANCE_LABEL;
72
-            $map['menu_label'] = __('Event Espresso', 'event_espresso');
73
-        }
74
-        return $map;
75
-    }
56
+	protected function _menu_map()
57
+	{
58
+		$map = array(
59
+			'menu_group'              => 'extras',
60
+			'menu_order'              => 30,
61
+			'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
62
+			'parent_slug'             => 'espresso_events',
63
+			'menu_slug'               => EE_MAINTENANCE_PG_SLUG,
64
+			'menu_label'              => EE_MAINTENANCE_LABEL,
65
+			'capability'              => 'manage_options',
66
+			'maintenance_mode_parent' => EE_MAINTENANCE_PG_SLUG,
67
+			'admin_init_page'         => $this,
68
+		);
69
+		if (EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance) {
70
+			$map['menu_group'] = 'main';
71
+			$map['subtitle'] = EE_MAINTENANCE_LABEL;
72
+			$map['menu_label'] = __('Event Espresso', 'event_espresso');
73
+		}
74
+		return $map;
75
+	}
76 76
 
77 77
 
78
-    /**
79
-     * Checks if we're in maintenance mode, and if so we notify the admin adn tell them how to take the site OUT of
80
-     * maintenance mode
81
-     */
82
-    public function check_maintenance_mode()
83
-    {
84
-        $notice = '';
85
-        $maintenance_page_url = '';
86
-        if (EE_Maintenance_Mode::instance()->level()) {
87
-            $maintenance_page_url = EE_Admin_Page::add_query_args_and_nonce(array(), EE_MAINTENANCE_ADMIN_URL);
88
-            switch (EE_Maintenance_Mode::instance()->level()) {
89
-                case EE_Maintenance_Mode::level_1_frontend_only_maintenance:
90
-                    $notice = '<div class="update-nag">
78
+	/**
79
+	 * Checks if we're in maintenance mode, and if so we notify the admin adn tell them how to take the site OUT of
80
+	 * maintenance mode
81
+	 */
82
+	public function check_maintenance_mode()
83
+	{
84
+		$notice = '';
85
+		$maintenance_page_url = '';
86
+		if (EE_Maintenance_Mode::instance()->level()) {
87
+			$maintenance_page_url = EE_Admin_Page::add_query_args_and_nonce(array(), EE_MAINTENANCE_ADMIN_URL);
88
+			switch (EE_Maintenance_Mode::instance()->level()) {
89
+				case EE_Maintenance_Mode::level_1_frontend_only_maintenance:
90
+					$notice = '<div class="update-nag">
91 91
 						'
92
-                              . sprintf(
93
-                                  __(
94
-                                      "Event Espresso is in Frontend-Only MAINTENANCE MODE. This means the front-end (ie, non-wp-admin pages) is disabled for ALL users except site admins. Visit the %s Maintenance Page %s to disable maintenance mode.",
95
-                                      "event_espresso"
96
-                                  ),
97
-                                  "<a href='$maintenance_page_url'>",
98
-                                  "</a>"
99
-                              )
100
-                              .
101
-                              '</div>';
102
-                    break;
103
-                case EE_Maintenance_Mode::level_2_complete_maintenance:
104
-                    $notice = '<div class="error">
92
+							  . sprintf(
93
+								  __(
94
+									  "Event Espresso is in Frontend-Only MAINTENANCE MODE. This means the front-end (ie, non-wp-admin pages) is disabled for ALL users except site admins. Visit the %s Maintenance Page %s to disable maintenance mode.",
95
+									  "event_espresso"
96
+								  ),
97
+								  "<a href='$maintenance_page_url'>",
98
+								  "</a>"
99
+							  )
100
+							  .
101
+							  '</div>';
102
+					break;
103
+				case EE_Maintenance_Mode::level_2_complete_maintenance:
104
+					$notice = '<div class="error">
105 105
 						<p>'
106
-                              . sprintf(
107
-                                  __(
108
-                                      "As part of the process for updating Event Espresso, your database also
106
+							  . sprintf(
107
+								  __(
108
+									  "As part of the process for updating Event Espresso, your database also
109 109
 needs to be updated. Event Espresso is in COMPLETE MAINTENANCE MODE (both WordPress admin pages and front-end event registration pages are disabled) until you run the database update script. %s Visit the Maintenance Page to get started,%s it only takes a moment.",
110
-                                      "event_espresso"
111
-                                  ),
112
-                                  "<a href='$maintenance_page_url'>",
113
-                                  "</a>"
114
-                              ) .
115
-                              '</div>';
116
-                    break;
117
-            }
118
-        }
119
-        echo apply_filters(
120
-            'FHEE__Maintenance_Admin_Page_Init__check_maintenance_mode__notice',
121
-            $notice,
122
-            $maintenance_page_url
123
-        );
124
-    }
110
+									  "event_espresso"
111
+								  ),
112
+								  "<a href='$maintenance_page_url'>",
113
+								  "</a>"
114
+							  ) .
115
+							  '</div>';
116
+					break;
117
+			}
118
+		}
119
+		echo apply_filters(
120
+			'FHEE__Maintenance_Admin_Page_Init__check_maintenance_mode__notice',
121
+			$notice,
122
+			$maintenance_page_url
123
+		);
124
+	}
125 125
 }
Please login to merge, or discard this patch.
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -29,10 +29,10 @@  discard block
 block discarded – undo
29 29
         // define some page related constants
30 30
         define('EE_MAINTENANCE_LABEL', __('Maintenance', 'event_espresso'));
31 31
         define('EE_MAINTENANCE_PG_SLUG', 'espresso_maintenance_settings');
32
-        define('EE_MAINTENANCE_ADMIN_URL', admin_url('admin.php?page=' . EE_MAINTENANCE_PG_SLUG));
33
-        define('EE_MAINTENANCE_ADMIN', EE_ADMIN_PAGES . 'maintenance/');
34
-        define('EE_MAINTENANCE_TEMPLATE_PATH', EE_MAINTENANCE_ADMIN . 'templates/');
35
-        define('EE_MAINTENANCE_ASSETS_URL', EE_ADMIN_PAGES_URL . 'maintenance/assets/');
32
+        define('EE_MAINTENANCE_ADMIN_URL', admin_url('admin.php?page='.EE_MAINTENANCE_PG_SLUG));
33
+        define('EE_MAINTENANCE_ADMIN', EE_ADMIN_PAGES.'maintenance/');
34
+        define('EE_MAINTENANCE_TEMPLATE_PATH', EE_MAINTENANCE_ADMIN.'templates/');
35
+        define('EE_MAINTENANCE_ASSETS_URL', EE_ADMIN_PAGES_URL.'maintenance/assets/');
36 36
         // check that if we're in maintenance mode that we tell the admin that
37 37
         add_action('admin_notices', array($this, 'check_maintenance_mode'));
38 38
         parent::__construct();
@@ -111,7 +111,7 @@  discard block
 block discarded – undo
111 111
                                   ),
112 112
                                   "<a href='$maintenance_page_url'>",
113 113
                                   "</a>"
114
-                              ) .
114
+                              ).
115 115
                               '</div>';
116 116
                     break;
117 117
             }
Please login to merge, or discard this patch.
admin_pages/events/Events_Admin_Page_Init.core.php 2 patches
Indentation   +36 added lines, -36 removed lines patch added patch discarded remove patch
@@ -14,42 +14,42 @@
 block discarded – undo
14 14
 class Events_Admin_Page_Init extends EE_Admin_Page_CPT_Init
15 15
 {
16 16
 
17
-    public function __construct()
18
-    {
19
-        /**
20
-         * define some events related constants but only if not defined (need to check because unit tests
21
-         *  may load)
22
-         */
23
-        if (! defined('EVENTS_PG_SLUG')) {
24
-            define('EVENTS_PG_SLUG', 'espresso_events');
25
-            define('EVENTS_LABEL', __('Events', 'event_espresso'));
26
-            define('EVENTS_ADMIN', EE_ADMIN_PAGES . 'events/');
27
-            define('EVENTS_ADMIN_URL', admin_url('admin.php?page=' . EVENTS_PG_SLUG));
28
-            define('EVENTS_TEMPLATE_PATH', EVENTS_ADMIN . 'templates/');
29
-            define('EVENTS_ASSETS_URL', EE_ADMIN_PAGES_URL . 'events/assets/');
30
-        }
31
-        parent::__construct();
32
-    }
17
+	public function __construct()
18
+	{
19
+		/**
20
+		 * define some events related constants but only if not defined (need to check because unit tests
21
+		 *  may load)
22
+		 */
23
+		if (! defined('EVENTS_PG_SLUG')) {
24
+			define('EVENTS_PG_SLUG', 'espresso_events');
25
+			define('EVENTS_LABEL', __('Events', 'event_espresso'));
26
+			define('EVENTS_ADMIN', EE_ADMIN_PAGES . 'events/');
27
+			define('EVENTS_ADMIN_URL', admin_url('admin.php?page=' . EVENTS_PG_SLUG));
28
+			define('EVENTS_TEMPLATE_PATH', EVENTS_ADMIN . 'templates/');
29
+			define('EVENTS_ASSETS_URL', EE_ADMIN_PAGES_URL . 'events/assets/');
30
+		}
31
+		parent::__construct();
32
+	}
33 33
 
34
-    protected function _set_init_properties()
35
-    {
36
-        $this->label = __('Event Espresso - Event Details', 'event_espresso');
37
-    }
34
+	protected function _set_init_properties()
35
+	{
36
+		$this->label = __('Event Espresso - Event Details', 'event_espresso');
37
+	}
38 38
 
39
-    protected function _set_menu_map()
40
-    {
41
-        $this->_menu_map = new EE_Admin_Page_Main_Menu(
42
-            array(
43
-                'menu_group'      => 'main',
44
-                'menu_order'      => 10,
45
-                'subtitle'        => __('Events', 'event_espresso'),
46
-                'show_on_menu'    => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
47
-                'parent_slug'     => 'espresso_events',
48
-                'menu_slug'       => 'espresso_events',
49
-                'menu_label'      => __('Event Espresso', 'event_espresso'),
50
-                'capability'      => 'ee_read_events',
51
-                'admin_init_page' => $this,
52
-            )
53
-        );
54
-    }
39
+	protected function _set_menu_map()
40
+	{
41
+		$this->_menu_map = new EE_Admin_Page_Main_Menu(
42
+			array(
43
+				'menu_group'      => 'main',
44
+				'menu_order'      => 10,
45
+				'subtitle'        => __('Events', 'event_espresso'),
46
+				'show_on_menu'    => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
47
+				'parent_slug'     => 'espresso_events',
48
+				'menu_slug'       => 'espresso_events',
49
+				'menu_label'      => __('Event Espresso', 'event_espresso'),
50
+				'capability'      => 'ee_read_events',
51
+				'admin_init_page' => $this,
52
+			)
53
+		);
54
+	}
55 55
 }
Please login to merge, or discard this patch.
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -20,13 +20,13 @@
 block discarded – undo
20 20
          * define some events related constants but only if not defined (need to check because unit tests
21 21
          *  may load)
22 22
          */
23
-        if (! defined('EVENTS_PG_SLUG')) {
23
+        if ( ! defined('EVENTS_PG_SLUG')) {
24 24
             define('EVENTS_PG_SLUG', 'espresso_events');
25 25
             define('EVENTS_LABEL', __('Events', 'event_espresso'));
26
-            define('EVENTS_ADMIN', EE_ADMIN_PAGES . 'events/');
27
-            define('EVENTS_ADMIN_URL', admin_url('admin.php?page=' . EVENTS_PG_SLUG));
28
-            define('EVENTS_TEMPLATE_PATH', EVENTS_ADMIN . 'templates/');
29
-            define('EVENTS_ASSETS_URL', EE_ADMIN_PAGES_URL . 'events/assets/');
26
+            define('EVENTS_ADMIN', EE_ADMIN_PAGES.'events/');
27
+            define('EVENTS_ADMIN_URL', admin_url('admin.php?page='.EVENTS_PG_SLUG));
28
+            define('EVENTS_TEMPLATE_PATH', EVENTS_ADMIN.'templates/');
29
+            define('EVENTS_ASSETS_URL', EE_ADMIN_PAGES_URL.'events/assets/');
30 30
         }
31 31
         parent::__construct();
32 32
     }
Please login to merge, or discard this patch.
admin_pages/events/Events_Admin_Page.core.php 1 patch
Indentation   +2665 added lines, -2665 removed lines patch added patch discarded remove patch
@@ -12,2669 +12,2669 @@
 block discarded – undo
12 12
 class Events_Admin_Page extends EE_Admin_Page_CPT
13 13
 {
14 14
 
15
-    /**
16
-     * This will hold the event object for event_details screen.
17
-     *
18
-     * @access protected
19
-     * @var EE_Event $_event
20
-     */
21
-    protected $_event;
22
-
23
-
24
-    /**
25
-     * This will hold the category object for category_details screen.
26
-     *
27
-     * @var stdClass $_category
28
-     */
29
-    protected $_category;
30
-
31
-
32
-    /**
33
-     * This will hold the event model instance
34
-     *
35
-     * @var EEM_Event $_event_model
36
-     */
37
-    protected $_event_model;
38
-
39
-
40
-    /**
41
-     * @var EE_Event
42
-     */
43
-    protected $_cpt_model_obj = false;
44
-
45
-
46
-    /**
47
-     * Initialize page props for this admin page group.
48
-     */
49
-    protected function _init_page_props()
50
-    {
51
-        $this->page_slug = EVENTS_PG_SLUG;
52
-        $this->page_label = EVENTS_LABEL;
53
-        $this->_admin_base_url = EVENTS_ADMIN_URL;
54
-        $this->_admin_base_path = EVENTS_ADMIN;
55
-        $this->_cpt_model_names = array(
56
-            'create_new' => 'EEM_Event',
57
-            'edit'       => 'EEM_Event',
58
-        );
59
-        $this->_cpt_edit_routes = array(
60
-            'espresso_events' => 'edit',
61
-        );
62
-        add_action(
63
-            'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
64
-            array($this, 'verify_event_edit'),
65
-            10,
66
-            2
67
-        );
68
-    }
69
-
70
-
71
-    /**
72
-     * Sets the ajax hooks used for this admin page group.
73
-     */
74
-    protected function _ajax_hooks()
75
-    {
76
-        add_action('wp_ajax_ee_save_timezone_setting', array($this, 'save_timezonestring_setting'));
77
-    }
78
-
79
-
80
-    /**
81
-     * Sets the page properties for this admin page group.
82
-     */
83
-    protected function _define_page_props()
84
-    {
85
-        $this->_admin_page_title = EVENTS_LABEL;
86
-        $this->_labels = array(
87
-            'buttons'      => array(
88
-                'add'             => esc_html__('Add New Event', 'event_espresso'),
89
-                'edit'            => esc_html__('Edit Event', 'event_espresso'),
90
-                'delete'          => esc_html__('Delete Event', 'event_espresso'),
91
-                'add_category'    => esc_html__('Add New Category', 'event_espresso'),
92
-                'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
93
-                'delete_category' => esc_html__('Delete Category', 'event_espresso'),
94
-            ),
95
-            'editor_title' => array(
96
-                'espresso_events' => esc_html__('Enter event title here', 'event_espresso'),
97
-            ),
98
-            'publishbox'   => array(
99
-                'create_new'        => esc_html__('Save New Event', 'event_espresso'),
100
-                'edit'              => esc_html__('Update Event', 'event_espresso'),
101
-                'add_category'      => esc_html__('Save New Category', 'event_espresso'),
102
-                'edit_category'     => esc_html__('Update Category', 'event_espresso'),
103
-                'template_settings' => esc_html__('Update Settings', 'event_espresso'),
104
-            ),
105
-        );
106
-    }
107
-
108
-
109
-    /**
110
-     * Sets the page routes property for this admin page group.
111
-     */
112
-    protected function _set_page_routes()
113
-    {
114
-        // load formatter helper
115
-        // load field generator helper
116
-        // is there a evt_id in the request?
117
-        $evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID'])
118
-            ? $this->_req_data['EVT_ID']
119
-            : 0;
120
-        $evt_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $evt_id;
121
-        $this->_page_routes = array(
122
-            'default'                       => array(
123
-                'func'       => '_events_overview_list_table',
124
-                'capability' => 'ee_read_events',
125
-            ),
126
-            'create_new'                    => array(
127
-                'func'       => '_create_new_cpt_item',
128
-                'capability' => 'ee_edit_events',
129
-            ),
130
-            'edit'                          => array(
131
-                'func'       => '_edit_cpt_item',
132
-                'capability' => 'ee_edit_event',
133
-                'obj_id'     => $evt_id,
134
-            ),
135
-            'copy_event'                    => array(
136
-                'func'       => '_copy_events',
137
-                'capability' => 'ee_edit_event',
138
-                'obj_id'     => $evt_id,
139
-                'noheader'   => true,
140
-            ),
141
-            'trash_event'                   => array(
142
-                'func'       => '_trash_or_restore_event',
143
-                'args'       => array('event_status' => 'trash'),
144
-                'capability' => 'ee_delete_event',
145
-                'obj_id'     => $evt_id,
146
-                'noheader'   => true,
147
-            ),
148
-            'trash_events'                  => array(
149
-                'func'       => '_trash_or_restore_events',
150
-                'args'       => array('event_status' => 'trash'),
151
-                'capability' => 'ee_delete_events',
152
-                'noheader'   => true,
153
-            ),
154
-            'restore_event'                 => array(
155
-                'func'       => '_trash_or_restore_event',
156
-                'args'       => array('event_status' => 'draft'),
157
-                'capability' => 'ee_delete_event',
158
-                'obj_id'     => $evt_id,
159
-                'noheader'   => true,
160
-            ),
161
-            'restore_events'                => array(
162
-                'func'       => '_trash_or_restore_events',
163
-                'args'       => array('event_status' => 'draft'),
164
-                'capability' => 'ee_delete_events',
165
-                'noheader'   => true,
166
-            ),
167
-            'delete_event'                  => array(
168
-                'func'       => '_delete_event',
169
-                'capability' => 'ee_delete_event',
170
-                'obj_id'     => $evt_id,
171
-                'noheader'   => true,
172
-            ),
173
-            'delete_events'                 => array(
174
-                'func'       => '_delete_events',
175
-                'capability' => 'ee_delete_events',
176
-                'noheader'   => true,
177
-            ),
178
-            'view_report'                   => array(
179
-                'func'      => '_view_report',
180
-                'capablity' => 'ee_edit_events',
181
-            ),
182
-            'default_event_settings'        => array(
183
-                'func'       => '_default_event_settings',
184
-                'capability' => 'manage_options',
185
-            ),
186
-            'update_default_event_settings' => array(
187
-                'func'       => '_update_default_event_settings',
188
-                'capability' => 'manage_options',
189
-                'noheader'   => true,
190
-            ),
191
-            'template_settings'             => array(
192
-                'func'       => '_template_settings',
193
-                'capability' => 'manage_options',
194
-            ),
195
-            // event category tab related
196
-            'add_category'                  => array(
197
-                'func'       => '_category_details',
198
-                'capability' => 'ee_edit_event_category',
199
-                'args'       => array('add'),
200
-            ),
201
-            'edit_category'                 => array(
202
-                'func'       => '_category_details',
203
-                'capability' => 'ee_edit_event_category',
204
-                'args'       => array('edit'),
205
-            ),
206
-            'delete_categories'             => array(
207
-                'func'       => '_delete_categories',
208
-                'capability' => 'ee_delete_event_category',
209
-                'noheader'   => true,
210
-            ),
211
-            'delete_category'               => array(
212
-                'func'       => '_delete_categories',
213
-                'capability' => 'ee_delete_event_category',
214
-                'noheader'   => true,
215
-            ),
216
-            'insert_category'               => array(
217
-                'func'       => '_insert_or_update_category',
218
-                'args'       => array('new_category' => true),
219
-                'capability' => 'ee_edit_event_category',
220
-                'noheader'   => true,
221
-            ),
222
-            'update_category'               => array(
223
-                'func'       => '_insert_or_update_category',
224
-                'args'       => array('new_category' => false),
225
-                'capability' => 'ee_edit_event_category',
226
-                'noheader'   => true,
227
-            ),
228
-            'category_list'                 => array(
229
-                'func'       => '_category_list_table',
230
-                'capability' => 'ee_manage_event_categories',
231
-            ),
232
-        );
233
-    }
234
-
235
-
236
-    /**
237
-     * Set the _page_config property for this admin page group.
238
-     */
239
-    protected function _set_page_config()
240
-    {
241
-        $this->_page_config = array(
242
-            'default'                => array(
243
-                'nav'           => array(
244
-                    'label' => esc_html__('Overview', 'event_espresso'),
245
-                    'order' => 10,
246
-                ),
247
-                'list_table'    => 'Events_Admin_List_Table',
248
-                'help_tabs'     => array(
249
-                    'events_overview_help_tab'                       => array(
250
-                        'title'    => esc_html__('Events Overview', 'event_espresso'),
251
-                        'filename' => 'events_overview',
252
-                    ),
253
-                    'events_overview_table_column_headings_help_tab' => array(
254
-                        'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
255
-                        'filename' => 'events_overview_table_column_headings',
256
-                    ),
257
-                    'events_overview_filters_help_tab'               => array(
258
-                        'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
259
-                        'filename' => 'events_overview_filters',
260
-                    ),
261
-                    'events_overview_view_help_tab'                  => array(
262
-                        'title'    => esc_html__('Events Overview Views', 'event_espresso'),
263
-                        'filename' => 'events_overview_views',
264
-                    ),
265
-                    'events_overview_other_help_tab'                 => array(
266
-                        'title'    => esc_html__('Events Overview Other', 'event_espresso'),
267
-                        'filename' => 'events_overview_other',
268
-                    ),
269
-                ),
270
-                'help_tour'     => array(
271
-                    'Event_Overview_Help_Tour',
272
-                    // 'New_Features_Test_Help_Tour' for testing multiple help tour
273
-                ),
274
-                'qtips'         => array(
275
-                    'EE_Event_List_Table_Tips',
276
-                ),
277
-                'require_nonce' => false,
278
-            ),
279
-            'create_new'             => array(
280
-                'nav'           => array(
281
-                    'label'      => esc_html__('Add Event', 'event_espresso'),
282
-                    'order'      => 5,
283
-                    'persistent' => false,
284
-                ),
285
-                'metaboxes'     => array('_register_event_editor_meta_boxes'),
286
-                'help_tabs'     => array(
287
-                    'event_editor_help_tab'                            => array(
288
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
289
-                        'filename' => 'event_editor',
290
-                    ),
291
-                    'event_editor_title_richtexteditor_help_tab'       => array(
292
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
293
-                        'filename' => 'event_editor_title_richtexteditor',
294
-                    ),
295
-                    'event_editor_venue_details_help_tab'              => array(
296
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
297
-                        'filename' => 'event_editor_venue_details',
298
-                    ),
299
-                    'event_editor_event_datetimes_help_tab'            => array(
300
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
301
-                        'filename' => 'event_editor_event_datetimes',
302
-                    ),
303
-                    'event_editor_event_tickets_help_tab'              => array(
304
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
305
-                        'filename' => 'event_editor_event_tickets',
306
-                    ),
307
-                    'event_editor_event_registration_options_help_tab' => array(
308
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
309
-                        'filename' => 'event_editor_event_registration_options',
310
-                    ),
311
-                    'event_editor_tags_categories_help_tab'            => array(
312
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
313
-                        'filename' => 'event_editor_tags_categories',
314
-                    ),
315
-                    'event_editor_questions_registrants_help_tab'      => array(
316
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
317
-                        'filename' => 'event_editor_questions_registrants',
318
-                    ),
319
-                    'event_editor_save_new_event_help_tab'             => array(
320
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
321
-                        'filename' => 'event_editor_save_new_event',
322
-                    ),
323
-                    'event_editor_other_help_tab'                      => array(
324
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
325
-                        'filename' => 'event_editor_other',
326
-                    ),
327
-                ),
328
-                'help_tour'     => array(
329
-                    'Event_Editor_Help_Tour',
330
-                ),
331
-                'qtips'         => array('EE_Event_Editor_Decaf_Tips'),
332
-                'require_nonce' => false,
333
-            ),
334
-            'edit'                   => array(
335
-                'nav'           => array(
336
-                    'label'      => esc_html__('Edit Event', 'event_espresso'),
337
-                    'order'      => 5,
338
-                    'persistent' => false,
339
-                    'url'        => isset($this->_req_data['post'])
340
-                        ? EE_Admin_Page::add_query_args_and_nonce(
341
-                            array('post' => $this->_req_data['post'], 'action' => 'edit'),
342
-                            $this->_current_page_view_url
343
-                        )
344
-                        : $this->_admin_base_url,
345
-                ),
346
-                'metaboxes'     => array('_register_event_editor_meta_boxes'),
347
-                'help_tabs'     => array(
348
-                    'event_editor_help_tab'                            => array(
349
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
350
-                        'filename' => 'event_editor',
351
-                    ),
352
-                    'event_editor_title_richtexteditor_help_tab'       => array(
353
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
354
-                        'filename' => 'event_editor_title_richtexteditor',
355
-                    ),
356
-                    'event_editor_venue_details_help_tab'              => array(
357
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
358
-                        'filename' => 'event_editor_venue_details',
359
-                    ),
360
-                    'event_editor_event_datetimes_help_tab'            => array(
361
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
362
-                        'filename' => 'event_editor_event_datetimes',
363
-                    ),
364
-                    'event_editor_event_tickets_help_tab'              => array(
365
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
366
-                        'filename' => 'event_editor_event_tickets',
367
-                    ),
368
-                    'event_editor_event_registration_options_help_tab' => array(
369
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
370
-                        'filename' => 'event_editor_event_registration_options',
371
-                    ),
372
-                    'event_editor_tags_categories_help_tab'            => array(
373
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
374
-                        'filename' => 'event_editor_tags_categories',
375
-                    ),
376
-                    'event_editor_questions_registrants_help_tab'      => array(
377
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
378
-                        'filename' => 'event_editor_questions_registrants',
379
-                    ),
380
-                    'event_editor_save_new_event_help_tab'             => array(
381
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
382
-                        'filename' => 'event_editor_save_new_event',
383
-                    ),
384
-                    'event_editor_other_help_tab'                      => array(
385
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
386
-                        'filename' => 'event_editor_other',
387
-                    ),
388
-                ),
389
-                'qtips'         => array('EE_Event_Editor_Decaf_Tips'),
390
-                'require_nonce' => false,
391
-            ),
392
-            'default_event_settings' => array(
393
-                'nav'           => array(
394
-                    'label' => esc_html__('Default Settings', 'event_espresso'),
395
-                    'order' => 40,
396
-                ),
397
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
398
-                'labels'        => array(
399
-                    'publishbox' => esc_html__('Update Settings', 'event_espresso'),
400
-                ),
401
-                'help_tabs'     => array(
402
-                    'default_settings_help_tab'        => array(
403
-                        'title'    => esc_html__('Default Event Settings', 'event_espresso'),
404
-                        'filename' => 'events_default_settings',
405
-                    ),
406
-                    'default_settings_status_help_tab' => array(
407
-                        'title'    => esc_html__('Default Registration Status', 'event_espresso'),
408
-                        'filename' => 'events_default_settings_status',
409
-                    ),
410
-                    'default_maximum_tickets_help_tab' => array(
411
-                        'title'    => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
412
-                        'filename' => 'events_default_settings_max_tickets',
413
-                    ),
414
-                ),
415
-                'help_tour'     => array('Event_Default_Settings_Help_Tour'),
416
-                'require_nonce' => false,
417
-            ),
418
-            // template settings
419
-            'template_settings'      => array(
420
-                'nav'           => array(
421
-                    'label' => esc_html__('Templates', 'event_espresso'),
422
-                    'order' => 30,
423
-                ),
424
-                'metaboxes'     => $this->_default_espresso_metaboxes,
425
-                'help_tabs'     => array(
426
-                    'general_settings_templates_help_tab' => array(
427
-                        'title'    => esc_html__('Templates', 'event_espresso'),
428
-                        'filename' => 'general_settings_templates',
429
-                    ),
430
-                ),
431
-                'help_tour'     => array('Templates_Help_Tour'),
432
-                'require_nonce' => false,
433
-            ),
434
-            // event category stuff
435
-            'add_category'           => array(
436
-                'nav'           => array(
437
-                    'label'      => esc_html__('Add Category', 'event_espresso'),
438
-                    'order'      => 15,
439
-                    'persistent' => false,
440
-                ),
441
-                'help_tabs'     => array(
442
-                    'add_category_help_tab' => array(
443
-                        'title'    => esc_html__('Add New Event Category', 'event_espresso'),
444
-                        'filename' => 'events_add_category',
445
-                    ),
446
-                ),
447
-                'help_tour'     => array('Event_Add_Category_Help_Tour'),
448
-                'metaboxes'     => array('_publish_post_box'),
449
-                'require_nonce' => false,
450
-            ),
451
-            'edit_category'          => array(
452
-                'nav'           => array(
453
-                    'label'      => esc_html__('Edit Category', 'event_espresso'),
454
-                    'order'      => 15,
455
-                    'persistent' => false,
456
-                    'url'        => isset($this->_req_data['EVT_CAT_ID'])
457
-                        ? add_query_arg(
458
-                            array('EVT_CAT_ID' => $this->_req_data['EVT_CAT_ID']),
459
-                            $this->_current_page_view_url
460
-                        )
461
-                        : $this->_admin_base_url,
462
-                ),
463
-                'help_tabs'     => array(
464
-                    'edit_category_help_tab' => array(
465
-                        'title'    => esc_html__('Edit Event Category', 'event_espresso'),
466
-                        'filename' => 'events_edit_category',
467
-                    ),
468
-                ),
469
-                /*'help_tour' => array('Event_Edit_Category_Help_Tour'),*/
470
-                'metaboxes'     => array('_publish_post_box'),
471
-                'require_nonce' => false,
472
-            ),
473
-            'category_list'          => array(
474
-                'nav'           => array(
475
-                    'label' => esc_html__('Categories', 'event_espresso'),
476
-                    'order' => 20,
477
-                ),
478
-                'list_table'    => 'Event_Categories_Admin_List_Table',
479
-                'help_tabs'     => array(
480
-                    'events_categories_help_tab'                       => array(
481
-                        'title'    => esc_html__('Event Categories', 'event_espresso'),
482
-                        'filename' => 'events_categories',
483
-                    ),
484
-                    'events_categories_table_column_headings_help_tab' => array(
485
-                        'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
486
-                        'filename' => 'events_categories_table_column_headings',
487
-                    ),
488
-                    'events_categories_view_help_tab'                  => array(
489
-                        'title'    => esc_html__('Event Categories Views', 'event_espresso'),
490
-                        'filename' => 'events_categories_views',
491
-                    ),
492
-                    'events_categories_other_help_tab'                 => array(
493
-                        'title'    => esc_html__('Event Categories Other', 'event_espresso'),
494
-                        'filename' => 'events_categories_other',
495
-                    ),
496
-                ),
497
-                'help_tour'     => array(
498
-                    'Event_Categories_Help_Tour',
499
-                ),
500
-                'metaboxes'     => $this->_default_espresso_metaboxes,
501
-                'require_nonce' => false,
502
-            ),
503
-        );
504
-    }
505
-
506
-
507
-    /**
508
-     * Used to register any global screen options if necessary for every route in this admin page group.
509
-     */
510
-    protected function _add_screen_options()
511
-    {
512
-    }
513
-
514
-
515
-    /**
516
-     * Implementing the screen options for the 'default' route.
517
-     */
518
-    protected function _add_screen_options_default()
519
-    {
520
-        $this->_per_page_screen_option();
521
-    }
522
-
523
-
524
-    /**
525
-     * Implementing screen options for the category list route.
526
-     */
527
-    protected function _add_screen_options_category_list()
528
-    {
529
-        $page_title = $this->_admin_page_title;
530
-        $this->_admin_page_title = esc_html__('Categories', 'event_espresso');
531
-        $this->_per_page_screen_option();
532
-        $this->_admin_page_title = $page_title;
533
-    }
534
-
535
-
536
-    /**
537
-     * Used to register any global feature pointers for the admin page group.
538
-     */
539
-    protected function _add_feature_pointers()
540
-    {
541
-    }
542
-
543
-
544
-    /**
545
-     * Registers and enqueues any global scripts and styles for the entire admin page group.
546
-     */
547
-    public function load_scripts_styles()
548
-    {
549
-        wp_register_style(
550
-            'events-admin-css',
551
-            EVENTS_ASSETS_URL . 'events-admin-page.css',
552
-            array(),
553
-            EVENT_ESPRESSO_VERSION
554
-        );
555
-        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION);
556
-        wp_enqueue_style('events-admin-css');
557
-        wp_enqueue_style('ee-cat-admin');
558
-        // todo note: we also need to load_scripts_styles per view (i.e. default/view_report/event_details
559
-        // registers for all views
560
-        // scripts
561
-        wp_register_script(
562
-            'event_editor_js',
563
-            EVENTS_ASSETS_URL . 'event_editor.js',
564
-            array('ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'),
565
-            EVENT_ESPRESSO_VERSION,
566
-            true
567
-        );
568
-    }
569
-
570
-
571
-    /**
572
-     * Enqueuing scripts and styles specific to this view
573
-     */
574
-    public function load_scripts_styles_create_new()
575
-    {
576
-        $this->load_scripts_styles_edit();
577
-    }
578
-
579
-
580
-    /**
581
-     * Enqueuing scripts and styles specific to this view
582
-     */
583
-    public function load_scripts_styles_edit()
584
-    {
585
-        // styles
586
-        wp_enqueue_style('espresso-ui-theme');
587
-        wp_register_style(
588
-            'event-editor-css',
589
-            EVENTS_ASSETS_URL . 'event-editor.css',
590
-            array('ee-admin-css'),
591
-            EVENT_ESPRESSO_VERSION
592
-        );
593
-        wp_enqueue_style('event-editor-css');
594
-        // scripts
595
-        wp_register_script(
596
-            'event-datetime-metabox',
597
-            EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
598
-            array('event_editor_js', 'ee-datepicker'),
599
-            EVENT_ESPRESSO_VERSION
600
-        );
601
-        wp_enqueue_script('event-datetime-metabox');
602
-    }
603
-
604
-
605
-    /**
606
-     * Populating the _views property for the category list table view.
607
-     */
608
-    protected function _set_list_table_views_category_list()
609
-    {
610
-        $this->_views = array(
611
-            'all' => array(
612
-                'slug'        => 'all',
613
-                'label'       => esc_html__('All', 'event_espresso'),
614
-                'count'       => 0,
615
-                'bulk_action' => array(
616
-                    'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
617
-                ),
618
-            ),
619
-        );
620
-    }
621
-
622
-
623
-    /**
624
-     * For adding anything that fires on the admin_init hook for any route within this admin page group.
625
-     */
626
-    public function admin_init()
627
-    {
628
-        EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__(
629
-            'Do you really want to delete this image? Please remember to update your event to complete the removal.',
630
-            'event_espresso'
631
-        );
632
-    }
633
-
634
-
635
-    /**
636
-     * For adding anything that should be triggered on the admin_notices hook for any route within this admin page
637
-     * group.
638
-     */
639
-    public function admin_notices()
640
-    {
641
-    }
642
-
643
-
644
-    /**
645
-     * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
646
-     * this admin page group.
647
-     */
648
-    public function admin_footer_scripts()
649
-    {
650
-    }
651
-
652
-
653
-    /**
654
-     * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
655
-     * warning (via EE_Error::add_error());
656
-     *
657
-     * @param  EE_Event $event Event object
658
-     * @param string    $req_type
659
-     * @return void
660
-     * @throws EE_Error
661
-     * @access public
662
-     */
663
-    public function verify_event_edit($event = null, $req_type = '')
664
-    {
665
-        // don't need to do this when processing
666
-        if (! empty($req_type)) {
667
-            return;
668
-        }
669
-        // no event?
670
-        if (empty($event)) {
671
-            // set event
672
-            $event = $this->_cpt_model_obj;
673
-        }
674
-        // STILL no event?
675
-        if (! $event instanceof EE_Event) {
676
-            return;
677
-        }
678
-        $orig_status = $event->status();
679
-        // first check if event is active.
680
-        if ($orig_status === EEM_Event::cancelled
681
-            || $orig_status === EEM_Event::postponed
682
-            || $event->is_expired()
683
-            || $event->is_inactive()
684
-        ) {
685
-            return;
686
-        }
687
-        // made it here so it IS active... next check that any of the tickets are sold.
688
-        if ($event->is_sold_out(true)) {
689
-            if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
690
-                EE_Error::add_attention(
691
-                    sprintf(
692
-                        esc_html__(
693
-                            'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event.  However, this change is not permanent until you update the event.  You can change the status back to something else before updating if you wish.',
694
-                            'event_espresso'
695
-                        ),
696
-                        EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
697
-                    )
698
-                );
699
-            }
700
-            return;
701
-        } elseif ($orig_status === EEM_Event::sold_out) {
702
-            EE_Error::add_attention(
703
-                sprintf(
704
-                    esc_html__(
705
-                        'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets.  However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.',
706
-                        'event_espresso'
707
-                    ),
708
-                    EEH_Template::pretty_status($event->status(), false, 'sentence')
709
-                )
710
-            );
711
-        }
712
-        // now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
713
-        if (! $event->tickets_on_sale()) {
714
-            return;
715
-        }
716
-        // made it here so show warning
717
-        $this->_edit_event_warning();
718
-    }
719
-
720
-
721
-    /**
722
-     * This is the text used for when an event is being edited that is public and has tickets for sale.
723
-     * When needed, hook this into a EE_Error::add_error() notice.
724
-     *
725
-     * @access protected
726
-     * @return void
727
-     */
728
-    protected function _edit_event_warning()
729
-    {
730
-        // we don't want to add warnings during these requests
731
-        if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'editpost') {
732
-            return;
733
-        }
734
-        EE_Error::add_attention(
735
-            sprintf(
736
-                esc_html__(
737
-                    'Your event is open for registration. Making changes may disrupt any transactions in progress. %sLearn more%s',
738
-                    'event_espresso'
739
-                ),
740
-                '<a class="espresso-help-tab-lnk">',
741
-                '</a>'
742
-            )
743
-        );
744
-    }
745
-
746
-
747
-    /**
748
-     * When a user is creating a new event, notify them if they haven't set their timezone.
749
-     * Otherwise, do the normal logic
750
-     *
751
-     * @return string
752
-     * @throws \EE_Error
753
-     */
754
-    protected function _create_new_cpt_item()
755
-    {
756
-        $has_timezone_string = get_option('timezone_string');
757
-        // only nag them about setting their timezone if it's their first event, and they haven't already done it
758
-        if (! $has_timezone_string && ! EEM_Event::instance()->exists(array())) {
759
-            EE_Error::add_attention(
760
-                sprintf(
761
-                    __(
762
-                        'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s',
763
-                        'event_espresso'
764
-                    ),
765
-                    '<br>',
766
-                    '<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
767
-                    . EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
768
-                    . '</select>',
769
-                    '<button class="button button-secondary timezone-submit">',
770
-                    '</button><span class="spinner"></span>'
771
-                ),
772
-                __FILE__,
773
-                __FUNCTION__,
774
-                __LINE__
775
-            );
776
-        }
777
-        return parent::_create_new_cpt_item();
778
-    }
779
-
780
-
781
-    /**
782
-     * Sets the _views property for the default route in this admin page group.
783
-     */
784
-    protected function _set_list_table_views_default()
785
-    {
786
-        $this->_views = array(
787
-            'all'   => array(
788
-                'slug'        => 'all',
789
-                'label'       => esc_html__('View All Events', 'event_espresso'),
790
-                'count'       => 0,
791
-                'bulk_action' => array(
792
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
793
-                ),
794
-            ),
795
-            'draft' => array(
796
-                'slug'        => 'draft',
797
-                'label'       => esc_html__('Draft', 'event_espresso'),
798
-                'count'       => 0,
799
-                'bulk_action' => array(
800
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
801
-                ),
802
-            ),
803
-        );
804
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
805
-            $this->_views['trash'] = array(
806
-                'slug'        => 'trash',
807
-                'label'       => esc_html__('Trash', 'event_espresso'),
808
-                'count'       => 0,
809
-                'bulk_action' => array(
810
-                    'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
811
-                    'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
812
-                ),
813
-            );
814
-        }
815
-    }
816
-
817
-
818
-    /**
819
-     * Provides the legend item array for the default list table view.
820
-     *
821
-     * @return array
822
-     */
823
-    protected function _event_legend_items()
824
-    {
825
-        $items = array(
826
-            'view_details'   => array(
827
-                'class' => 'dashicons dashicons-search',
828
-                'desc'  => esc_html__('View Event', 'event_espresso'),
829
-            ),
830
-            'edit_event'     => array(
831
-                'class' => 'ee-icon ee-icon-calendar-edit',
832
-                'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
833
-            ),
834
-            'view_attendees' => array(
835
-                'class' => 'dashicons dashicons-groups',
836
-                'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
837
-            ),
838
-        );
839
-        $items = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
840
-        $statuses = array(
841
-            'sold_out_status'  => array(
842
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::sold_out,
843
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
844
-            ),
845
-            'active_status'    => array(
846
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::active,
847
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
848
-            ),
849
-            'upcoming_status'  => array(
850
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::upcoming,
851
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
852
-            ),
853
-            'postponed_status' => array(
854
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::postponed,
855
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
856
-            ),
857
-            'cancelled_status' => array(
858
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::cancelled,
859
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
860
-            ),
861
-            'expired_status'   => array(
862
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::expired,
863
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
864
-            ),
865
-            'inactive_status'  => array(
866
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::inactive,
867
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
868
-            ),
869
-        );
870
-        $statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
871
-        return array_merge($items, $statuses);
872
-    }
873
-
874
-
875
-    /**
876
-     * @return EEM_Event
877
-     */
878
-    private function _event_model()
879
-    {
880
-        if (! $this->_event_model instanceof EEM_Event) {
881
-            $this->_event_model = EE_Registry::instance()->load_model('Event');
882
-        }
883
-        return $this->_event_model;
884
-    }
885
-
886
-
887
-    /**
888
-     * Adds extra buttons to the WP CPT permalink field row.
889
-     * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
890
-     *
891
-     * @param  string $return    the current html
892
-     * @param  int    $id        the post id for the page
893
-     * @param  string $new_title What the title is
894
-     * @param  string $new_slug  what the slug is
895
-     * @return string            The new html string for the permalink area
896
-     */
897
-    public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
898
-    {
899
-        // make sure this is only when editing
900
-        if (! empty($id)) {
901
-            $post = get_post($id);
902
-            $return .= '<a class="button button-small" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#"  tabindex="-1">'
903
-                       . esc_html__('Shortcode', 'event_espresso')
904
-                       . '</a> ';
905
-            $return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id='
906
-                       . $post->ID
907
-                       . ']">';
908
-        }
909
-        return $return;
910
-    }
911
-
912
-
913
-    /**
914
-     * _events_overview_list_table
915
-     * This contains the logic for showing the events_overview list
916
-     *
917
-     * @access protected
918
-     * @return void
919
-     * @throws \EE_Error
920
-     */
921
-    protected function _events_overview_list_table()
922
-    {
923
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
924
-        $this->_template_args['after_list_table'] = ! empty($this->_template_args['after_list_table'])
925
-            ? (array) $this->_template_args['after_list_table']
926
-            : array();
927
-        $this->_template_args['after_list_table']['view_event_list_button'] = EEH_HTML::br()
928
-                . EEH_Template::get_button_or_link(
929
-                    get_post_type_archive_link('espresso_events'),
930
-                    esc_html__("View Event Archive Page", "event_espresso"),
931
-                    'button'
932
-                );
933
-        $this->_template_args['after_list_table']['legend'] = $this->_display_legend($this->_event_legend_items());
934
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
935
-            'create_new',
936
-            'add',
937
-            array(),
938
-            'add-new-h2'
939
-        );
940
-        $this->display_admin_list_table_page_with_no_sidebar();
941
-    }
942
-
943
-
944
-    /**
945
-     * this allows for extra misc actions in the default WP publish box
946
-     *
947
-     * @return void
948
-     */
949
-    public function extra_misc_actions_publish_box()
950
-    {
951
-        $this->_generate_publish_box_extra_content();
952
-    }
953
-
954
-
955
-    /**
956
-     * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
957
-     * saved.
958
-     * Typically you would use this to save any additional data.
959
-     * Keep in mind also that "save_post" runs on EVERY post update to the database.
960
-     * ALSO very important.  When a post transitions from scheduled to published,
961
-     * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from
962
-     * other meta saves. So MAKE sure that you handle this accordingly.
963
-     *
964
-     * @access protected
965
-     * @abstract
966
-     * @param  string $post_id The ID of the cpt that was saved (so you can link relationally)
967
-     * @param  object $post    The post object of the cpt that was saved.
968
-     * @return void
969
-     * @throws \EE_Error
970
-     */
971
-    protected function _insert_update_cpt_item($post_id, $post)
972
-    {
973
-        if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
974
-            // get out we're not processing an event save.
975
-            return;
976
-        }
977
-        $event_values = array(
978
-            'EVT_display_desc'                => ! empty($this->_req_data['display_desc']) ? 1 : 0,
979
-            'EVT_display_ticket_selector'     => ! empty($this->_req_data['display_ticket_selector']) ? 1 : 0,
980
-            'EVT_additional_limit'            => min(
981
-                apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
982
-                ! empty($this->_req_data['additional_limit']) ? $this->_req_data['additional_limit'] : null
983
-            ),
984
-            'EVT_default_registration_status' => ! empty($this->_req_data['EVT_default_registration_status'])
985
-                ? $this->_req_data['EVT_default_registration_status']
986
-                : EE_Registry::instance()->CFG->registration->default_STS_ID,
987
-            'EVT_member_only'                 => ! empty($this->_req_data['member_only']) ? 1 : 0,
988
-            'EVT_allow_overflow'              => ! empty($this->_req_data['EVT_allow_overflow']) ? 1 : 0,
989
-            'EVT_timezone_string'             => ! empty($this->_req_data['timezone_string'])
990
-                ? $this->_req_data['timezone_string'] : null,
991
-            'EVT_external_URL'                => ! empty($this->_req_data['externalURL'])
992
-                ? $this->_req_data['externalURL'] : null,
993
-            'EVT_phone'                       => ! empty($this->_req_data['event_phone'])
994
-                ? $this->_req_data['event_phone'] : null,
995
-        );
996
-        // update event
997
-        $success = $this->_event_model()->update_by_ID($event_values, $post_id);
998
-        // get event_object for other metaboxes... though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
999
-        $get_one_where = array(
1000
-            $this->_event_model()->primary_key_name() => $post_id,
1001
-            'OR'                                      => array(
1002
-                'status'   => $post->post_status,
1003
-                // if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
1004
-                // but the returned object here has a status of "publish", so use the original post status as well
1005
-                'status*1' => $this->_req_data['original_post_status'],
1006
-            ),
1007
-        );
1008
-        $event = $this->_event_model()->get_one(array($get_one_where));
1009
-        // the following are default callbacks for event attachment updates that can be overridden by caffeinated functionality and/or addons.
1010
-        $event_update_callbacks = apply_filters(
1011
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
1012
-            array(
1013
-                array($this, '_default_venue_update'),
1014
-                array($this, '_default_tickets_update'),
1015
-            )
1016
-        );
1017
-        $att_success = true;
1018
-        foreach ($event_update_callbacks as $e_callback) {
1019
-            $_success = is_callable($e_callback)
1020
-                ? call_user_func($e_callback, $event, $this->_req_data)
1021
-                : false;
1022
-            // if ANY of these updates fail then we want the appropriate global error message
1023
-            $att_success = ! $att_success ? $att_success : $_success;
1024
-        }
1025
-        // any errors?
1026
-        if ($success && false === $att_success) {
1027
-            EE_Error::add_error(
1028
-                esc_html__(
1029
-                    'Event Details saved successfully but something went wrong with saving attachments.',
1030
-                    'event_espresso'
1031
-                ),
1032
-                __FILE__,
1033
-                __FUNCTION__,
1034
-                __LINE__
1035
-            );
1036
-        } elseif ($success === false) {
1037
-            EE_Error::add_error(
1038
-                esc_html__('Event Details did not save successfully.', 'event_espresso'),
1039
-                __FILE__,
1040
-                __FUNCTION__,
1041
-                __LINE__
1042
-            );
1043
-        }
1044
-    }
1045
-
1046
-
1047
-    /**
1048
-     * @see parent::restore_item()
1049
-     * @param int $post_id
1050
-     * @param int $revision_id
1051
-     */
1052
-    protected function _restore_cpt_item($post_id, $revision_id)
1053
-    {
1054
-        // copy existing event meta to new post
1055
-        $post_evt = $this->_event_model()->get_one_by_ID($post_id);
1056
-        if ($post_evt instanceof EE_Event) {
1057
-            // meta revision restore
1058
-            $post_evt->restore_revision($revision_id);
1059
-            // related objs restore
1060
-            $post_evt->restore_revision($revision_id, array('Venue', 'Datetime', 'Price'));
1061
-        }
1062
-    }
1063
-
1064
-
1065
-    /**
1066
-     * Attach the venue to the Event
1067
-     *
1068
-     * @param  \EE_Event $evtobj Event Object to add the venue to
1069
-     * @param  array     $data   The request data from the form
1070
-     * @return bool           Success or fail.
1071
-     */
1072
-    protected function _default_venue_update(\EE_Event $evtobj, $data)
1073
-    {
1074
-        require_once(EE_MODELS . 'EEM_Venue.model.php');
1075
-        $venue_model = EE_Registry::instance()->load_model('Venue');
1076
-        $rows_affected = null;
1077
-        $venue_id = ! empty($data['venue_id']) ? $data['venue_id'] : null;
1078
-        // very important.  If we don't have a venue name...
1079
-        // then we'll get out because not necessary to create empty venue
1080
-        if (empty($data['venue_title'])) {
1081
-            return false;
1082
-        }
1083
-        $venue_array = array(
1084
-            'VNU_wp_user'         => $evtobj->get('EVT_wp_user'),
1085
-            'VNU_name'            => ! empty($data['venue_title']) ? $data['venue_title'] : null,
1086
-            'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
1087
-            'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
1088
-            'VNU_short_desc'      => ! empty($data['venue_short_description']) ? $data['venue_short_description']
1089
-                : null,
1090
-            'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
1091
-            'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
1092
-            'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
1093
-            'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
1094
-            'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
1095
-            'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
1096
-            'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
1097
-            'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
1098
-            'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
1099
-            'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
1100
-            'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
1101
-            'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
1102
-            'status'              => 'publish',
1103
-        );
1104
-        // if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
1105
-        if (! empty($venue_id)) {
1106
-            $update_where = array($venue_model->primary_key_name() => $venue_id);
1107
-            $rows_affected = $venue_model->update($venue_array, array($update_where));
1108
-            // we've gotta make sure that the venue is always attached to a revision.. add_relation_to should take care of making sure that the relation is already present.
1109
-            $evtobj->_add_relation_to($venue_id, 'Venue');
1110
-            return $rows_affected > 0 ? true : false;
1111
-        } else {
1112
-            // we insert the venue
1113
-            $venue_id = $venue_model->insert($venue_array);
1114
-            $evtobj->_add_relation_to($venue_id, 'Venue');
1115
-            return ! empty($venue_id) ? true : false;
1116
-        }
1117
-        // when we have the ancestor come in it's already been handled by the revision save.
1118
-    }
1119
-
1120
-
1121
-    /**
1122
-     * Handles saving everything related to Tickets (datetimes, tickets, prices)
1123
-     *
1124
-     * @param  EE_Event $evtobj The Event object we're attaching data to
1125
-     * @param  array    $data   The request data from the form
1126
-     * @return array
1127
-     */
1128
-    protected function _default_tickets_update(EE_Event $evtobj, $data)
1129
-    {
1130
-        $success = true;
1131
-        $saved_dtt = null;
1132
-        $saved_tickets = array();
1133
-        $incoming_date_formats = array('Y-m-d', 'h:i a');
1134
-        foreach ($data['edit_event_datetimes'] as $row => $dtt) {
1135
-            // trim all values to ensure any excess whitespace is removed.
1136
-            $dtt = array_map('trim', $dtt);
1137
-            $dtt['DTT_EVT_end'] = isset($dtt['DTT_EVT_end']) && ! empty($dtt['DTT_EVT_end']) ? $dtt['DTT_EVT_end']
1138
-                : $dtt['DTT_EVT_start'];
1139
-            $datetime_values = array(
1140
-                'DTT_ID'        => ! empty($dtt['DTT_ID']) ? $dtt['DTT_ID'] : null,
1141
-                'DTT_EVT_start' => $dtt['DTT_EVT_start'],
1142
-                'DTT_EVT_end'   => $dtt['DTT_EVT_end'],
1143
-                'DTT_reg_limit' => empty($dtt['DTT_reg_limit']) ? EE_INF : $dtt['DTT_reg_limit'],
1144
-                'DTT_order'     => $row,
1145
-            );
1146
-            // if we have an id then let's get existing object first and then set the new values.  Otherwise we instantiate a new object for save.
1147
-            if (! empty($dtt['DTT_ID'])) {
1148
-                $DTM = EE_Registry::instance()
1149
-                                  ->load_model('Datetime', array($evtobj->get_timezone()))
1150
-                                  ->get_one_by_ID($dtt['DTT_ID']);
1151
-                $DTM->set_date_format($incoming_date_formats[0]);
1152
-                $DTM->set_time_format($incoming_date_formats[1]);
1153
-                foreach ($datetime_values as $field => $value) {
1154
-                    $DTM->set($field, $value);
1155
-                }
1156
-                // make sure the $dtt_id here is saved just in case after the add_relation_to() the autosave replaces it.  We need to do this so we dont' TRASH the parent DTT.
1157
-                $saved_dtts[ $DTM->ID() ] = $DTM;
1158
-            } else {
1159
-                $DTM = EE_Registry::instance()->load_class(
1160
-                    'Datetime',
1161
-                    array($datetime_values, $evtobj->get_timezone(), $incoming_date_formats),
1162
-                    false,
1163
-                    false
1164
-                );
1165
-                foreach ($datetime_values as $field => $value) {
1166
-                    $DTM->set($field, $value);
1167
-                }
1168
-            }
1169
-            $DTM->save();
1170
-            $DTT = $evtobj->_add_relation_to($DTM, 'Datetime');
1171
-            // load DTT helper
1172
-            // before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
1173
-            if ($DTT->get_raw('DTT_EVT_start') > $DTT->get_raw('DTT_EVT_end')) {
1174
-                $DTT->set('DTT_EVT_end', $DTT->get('DTT_EVT_start'));
1175
-                $DTT = EEH_DTT_Helper::date_time_add($DTT, 'DTT_EVT_end', 'days');
1176
-                $DTT->save();
1177
-            }
1178
-            // now we got to make sure we add the new DTT_ID to the $saved_dtts array  because it is possible there was a new one created for the autosave.
1179
-            $saved_dtt = $DTT;
1180
-            $success = ! $success ? $success : $DTT;
1181
-            // if ANY of these updates fail then we want the appropriate global error message.
1182
-            // //todo this is actually sucky we need a better error message but this is what it is for now.
1183
-        }
1184
-        // no dtts get deleted so we don't do any of that logic here.
1185
-        // update tickets next
1186
-        $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array();
1187
-        foreach ($data['edit_tickets'] as $row => $tkt) {
1188
-            $incoming_date_formats = array('Y-m-d', 'h:i a');
1189
-            $update_prices = false;
1190
-            $ticket_price = isset($data['edit_prices'][ $row ][1]['PRC_amount'])
1191
-                ? $data['edit_prices'][ $row ][1]['PRC_amount'] : 0;
1192
-            // trim inputs to ensure any excess whitespace is removed.
1193
-            $tkt = array_map('trim', $tkt);
1194
-            if (empty($tkt['TKT_start_date'])) {
1195
-                // let's use now in the set timezone.
1196
-                $now = new DateTime('now', new DateTimeZone($evtobj->get_timezone()));
1197
-                $tkt['TKT_start_date'] = $now->format($incoming_date_formats[0] . ' ' . $incoming_date_formats[1]);
1198
-            }
1199
-            if (empty($tkt['TKT_end_date'])) {
1200
-                // use the start date of the first datetime
1201
-                $dtt = $evtobj->first_datetime();
1202
-                $tkt['TKT_end_date'] = $dtt->start_date_and_time(
1203
-                    $incoming_date_formats[0],
1204
-                    $incoming_date_formats[1]
1205
-                );
1206
-            }
1207
-            $TKT_values = array(
1208
-                'TKT_ID'          => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null,
1209
-                'TTM_ID'          => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0,
1210
-                'TKT_name'        => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '',
1211
-                'TKT_description' => ! empty($tkt['TKT_description']) ? $tkt['TKT_description'] : '',
1212
-                'TKT_start_date'  => $tkt['TKT_start_date'],
1213
-                'TKT_end_date'    => $tkt['TKT_end_date'],
1214
-                'TKT_qty'         => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' ? EE_INF : $tkt['TKT_qty'],
1215
-                'TKT_uses'        => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' ? EE_INF : $tkt['TKT_uses'],
1216
-                'TKT_min'         => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'],
1217
-                'TKT_max'         => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'],
1218
-                'TKT_row'         => $row,
1219
-                'TKT_order'       => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : $row,
1220
-                'TKT_price'       => $ticket_price,
1221
-            );
1222
-            // if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, which means in turn that the prices will become new prices as well.
1223
-            if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) {
1224
-                $TKT_values['TKT_ID'] = 0;
1225
-                $TKT_values['TKT_is_default'] = 0;
1226
-                $TKT_values['TKT_price'] = $ticket_price;
1227
-                $update_prices = true;
1228
-            }
1229
-            // if we have a TKT_ID then we need to get that existing TKT_obj and update it
1230
-            // we actually do our saves a head of doing any add_relations to because its entirely possible that this ticket didn't removed or added to any datetime in the session but DID have it's items modified.
1231
-            // keep in mind that if the TKT has been sold (and we have changed pricing information), then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
1232
-            if (! empty($tkt['TKT_ID'])) {
1233
-                $TKT = EE_Registry::instance()
1234
-                                  ->load_model('Ticket', array($evtobj->get_timezone()))
1235
-                                  ->get_one_by_ID($tkt['TKT_ID']);
1236
-                if ($TKT instanceof EE_Ticket) {
1237
-                    $ticket_sold = $TKT->count_related(
1238
-                        'Registration',
1239
-                        array(
1240
-                            array(
1241
-                                'STS_ID' => array(
1242
-                                    'NOT IN',
1243
-                                    array(EEM_Registration::status_id_incomplete),
1244
-                                ),
1245
-                            ),
1246
-                        )
1247
-                    ) > 0 ? true : false;
1248
-                    // let's just check the total price for the existing ticket and determine if it matches the new total price.  if they are different then we create a new ticket (if tkts sold) if they aren't different then we go ahead and modify existing ticket.
1249
-                    $create_new_TKT = $ticket_sold && $ticket_price != $TKT->get('TKT_price')
1250
-                                      && ! $TKT->get('TKT_deleted');
1251
-                    $TKT->set_date_format($incoming_date_formats[0]);
1252
-                    $TKT->set_time_format($incoming_date_formats[1]);
1253
-                    // set new values
1254
-                    foreach ($TKT_values as $field => $value) {
1255
-                        if ($field == 'TKT_qty') {
1256
-                            $TKT->set_qty($value);
1257
-                        } else {
1258
-                            $TKT->set($field, $value);
1259
-                        }
1260
-                    }
1261
-                    // if $create_new_TKT is false then we can safely update the existing ticket.  Otherwise we have to create a new ticket.
1262
-                    if ($create_new_TKT) {
1263
-                        // archive the old ticket first
1264
-                        $TKT->set('TKT_deleted', 1);
1265
-                        $TKT->save();
1266
-                        // make sure this ticket is still recorded in our saved_tkts so we don't run it through the regular trash routine.
1267
-                        $saved_tickets[ $TKT->ID() ] = $TKT;
1268
-                        // create new ticket that's a copy of the existing except a new id of course (and not archived) AND has the new TKT_price associated with it.
1269
-                        $TKT = clone $TKT;
1270
-                        $TKT->set('TKT_ID', 0);
1271
-                        $TKT->set('TKT_deleted', 0);
1272
-                        $TKT->set('TKT_price', $ticket_price);
1273
-                        $TKT->set('TKT_sold', 0);
1274
-                        // now we need to make sure that $new prices are created as well and attached to new ticket.
1275
-                        $update_prices = true;
1276
-                    }
1277
-                    // make sure price is set if it hasn't been already
1278
-                    $TKT->set('TKT_price', $ticket_price);
1279
-                }
1280
-            } else {
1281
-                // no TKT_id so a new TKT
1282
-                $TKT_values['TKT_price'] = $ticket_price;
1283
-                $TKT = EE_Registry::instance()->load_class('Ticket', array($TKT_values), false, false);
1284
-                if ($TKT instanceof EE_Ticket) {
1285
-                    // need to reset values to properly account for the date formats
1286
-                    $TKT->set_date_format($incoming_date_formats[0]);
1287
-                    $TKT->set_time_format($incoming_date_formats[1]);
1288
-                    $TKT->set_timezone($evtobj->get_timezone());
1289
-                    // set new values
1290
-                    foreach ($TKT_values as $field => $value) {
1291
-                        if ($field == 'TKT_qty') {
1292
-                            $TKT->set_qty($value);
1293
-                        } else {
1294
-                            $TKT->set($field, $value);
1295
-                        }
1296
-                    }
1297
-                    $update_prices = true;
1298
-                }
1299
-            }
1300
-            // cap ticket qty by datetime reg limits
1301
-            $TKT->set_qty(min($TKT->qty(), $TKT->qty('reg_limit')));
1302
-            // update ticket.
1303
-            $TKT->save();
1304
-            // before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
1305
-            if ($TKT->get_raw('TKT_start_date') > $TKT->get_raw('TKT_end_date')) {
1306
-                $TKT->set('TKT_end_date', $TKT->get('TKT_start_date'));
1307
-                $TKT = EEH_DTT_Helper::date_time_add($TKT, 'TKT_end_date', 'days');
1308
-                $TKT->save();
1309
-            }
1310
-            // initially let's add the ticket to the dtt
1311
-            $saved_dtt->_add_relation_to($TKT, 'Ticket');
1312
-            $saved_tickets[ $TKT->ID() ] = $TKT;
1313
-            // add prices to ticket
1314
-            $this->_add_prices_to_ticket($data['edit_prices'][ $row ], $TKT, $update_prices);
1315
-        }
1316
-        // however now we need to handle permanently deleting tickets via the ui.  Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold.  However, it does allow for deleting tickets that have no tickets sold, in which case we want to get rid of permanently because there is no need to save in db.
1317
-        $old_tickets = isset($old_tickets[0]) && $old_tickets[0] == '' ? array() : $old_tickets;
1318
-        $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
1319
-        foreach ($tickets_removed as $id) {
1320
-            $id = absint($id);
1321
-            // get the ticket for this id
1322
-            $tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id);
1323
-            // need to get all the related datetimes on this ticket and remove from every single one of them (remember this process can ONLY kick off if there are NO tkts_sold)
1324
-            $dtts = $tkt_to_remove->get_many_related('Datetime');
1325
-            foreach ($dtts as $dtt) {
1326
-                $tkt_to_remove->_remove_relation_to($dtt, 'Datetime');
1327
-            }
1328
-            // need to do the same for prices (except these prices can also be deleted because again, tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
1329
-            $tkt_to_remove->delete_related_permanently('Price');
1330
-            // finally let's delete this ticket (which should not be blocked at this point b/c we've removed all our relationships)
1331
-            $tkt_to_remove->delete_permanently();
1332
-        }
1333
-        return array($saved_dtt, $saved_tickets);
1334
-    }
1335
-
1336
-
1337
-    /**
1338
-     * This attaches a list of given prices to a ticket.
1339
-     * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
1340
-     * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
1341
-     * price info and prices are automatically "archived" via the ticket.
1342
-     *
1343
-     * @access  private
1344
-     * @param array     $prices     Array of prices from the form.
1345
-     * @param EE_Ticket $ticket     EE_Ticket object that prices are being attached to.
1346
-     * @param bool      $new_prices Whether attach existing incoming prices or create new ones.
1347
-     * @return  void
1348
-     */
1349
-    private function _add_prices_to_ticket($prices, EE_Ticket $ticket, $new_prices = false)
1350
-    {
1351
-        foreach ($prices as $row => $prc) {
1352
-            $PRC_values = array(
1353
-                'PRC_ID'         => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null,
1354
-                'PRT_ID'         => ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null,
1355
-                'PRC_amount'     => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0,
1356
-                'PRC_name'       => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '',
1357
-                'PRC_desc'       => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '',
1358
-                'PRC_is_default' => 0, // make sure prices are NOT set as default from this context
1359
-                'PRC_order'      => $row,
1360
-            );
1361
-            if ($new_prices || empty($PRC_values['PRC_ID'])) {
1362
-                $PRC_values['PRC_ID'] = 0;
1363
-                $PRC = EE_Registry::instance()->load_class('Price', array($PRC_values), false, false);
1364
-            } else {
1365
-                $PRC = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']);
1366
-                // update this price with new values
1367
-                foreach ($PRC_values as $field => $newprc) {
1368
-                    $PRC->set($field, $newprc);
1369
-                }
1370
-                $PRC->save();
1371
-            }
1372
-            $ticket->_add_relation_to($PRC, 'Price');
1373
-        }
1374
-    }
1375
-
1376
-
1377
-    /**
1378
-     * Add in our autosave ajax handlers
1379
-     *
1380
-     */
1381
-    protected function _ee_autosave_create_new()
1382
-    {
1383
-    }
1384
-
1385
-
1386
-    /**
1387
-     * More autosave handlers.
1388
-     */
1389
-    protected function _ee_autosave_edit()
1390
-    {
1391
-        return; // TEMPORARILY EXITING CAUSE THIS IS A TODO
1392
-    }
1393
-
1394
-
1395
-    /**
1396
-     *    _generate_publish_box_extra_content
1397
-     */
1398
-    private function _generate_publish_box_extra_content()
1399
-    {
1400
-        // load formatter helper
1401
-        // args for getting related registrations
1402
-        $approved_query_args = array(
1403
-            array(
1404
-                'REG_deleted' => 0,
1405
-                'STS_ID'      => EEM_Registration::status_id_approved,
1406
-            ),
1407
-        );
1408
-        $not_approved_query_args = array(
1409
-            array(
1410
-                'REG_deleted' => 0,
1411
-                'STS_ID'      => EEM_Registration::status_id_not_approved,
1412
-            ),
1413
-        );
1414
-        $pending_payment_query_args = array(
1415
-            array(
1416
-                'REG_deleted' => 0,
1417
-                'STS_ID'      => EEM_Registration::status_id_pending_payment,
1418
-            ),
1419
-        );
1420
-        // publish box
1421
-        $publish_box_extra_args = array(
1422
-            'view_approved_reg_url'        => add_query_arg(
1423
-                array(
1424
-                    'action'      => 'default',
1425
-                    'event_id'    => $this->_cpt_model_obj->ID(),
1426
-                    '_reg_status' => EEM_Registration::status_id_approved,
1427
-                ),
1428
-                REG_ADMIN_URL
1429
-            ),
1430
-            'view_not_approved_reg_url'    => add_query_arg(
1431
-                array(
1432
-                    'action'      => 'default',
1433
-                    'event_id'    => $this->_cpt_model_obj->ID(),
1434
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
1435
-                ),
1436
-                REG_ADMIN_URL
1437
-            ),
1438
-            'view_pending_payment_reg_url' => add_query_arg(
1439
-                array(
1440
-                    'action'      => 'default',
1441
-                    'event_id'    => $this->_cpt_model_obj->ID(),
1442
-                    '_reg_status' => EEM_Registration::status_id_pending_payment,
1443
-                ),
1444
-                REG_ADMIN_URL
1445
-            ),
1446
-            'approved_regs'                => $this->_cpt_model_obj->count_related(
1447
-                'Registration',
1448
-                $approved_query_args
1449
-            ),
1450
-            'not_approved_regs'            => $this->_cpt_model_obj->count_related(
1451
-                'Registration',
1452
-                $not_approved_query_args
1453
-            ),
1454
-            'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
1455
-                'Registration',
1456
-                $pending_payment_query_args
1457
-            ),
1458
-            'misc_pub_section_class'       => apply_filters(
1459
-                'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
1460
-                'misc-pub-section'
1461
-            ),
1462
-        );
1463
-        ob_start();
1464
-        do_action(
1465
-            'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
1466
-            $this->_cpt_model_obj
1467
-        );
1468
-        $publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
1469
-        // load template
1470
-        EEH_Template::display_template(
1471
-            EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
1472
-            $publish_box_extra_args
1473
-        );
1474
-    }
1475
-
1476
-
1477
-    /**
1478
-     * @return EE_Event
1479
-     */
1480
-    public function get_event_object()
1481
-    {
1482
-        return $this->_cpt_model_obj;
1483
-    }
1484
-
1485
-
1486
-
1487
-
1488
-    /** METABOXES * */
1489
-    /**
1490
-     * _register_event_editor_meta_boxes
1491
-     * add all metaboxes related to the event_editor
1492
-     *
1493
-     * @return void
1494
-     */
1495
-    protected function _register_event_editor_meta_boxes()
1496
-    {
1497
-        $this->verify_cpt_object();
1498
-        add_meta_box(
1499
-            'espresso_event_editor_tickets',
1500
-            esc_html__('Event Datetime & Ticket', 'event_espresso'),
1501
-            array($this, 'ticket_metabox'),
1502
-            $this->page_slug,
1503
-            'normal',
1504
-            'high'
1505
-        );
1506
-        add_meta_box(
1507
-            'espresso_event_editor_event_options',
1508
-            esc_html__('Event Registration Options', 'event_espresso'),
1509
-            array($this, 'registration_options_meta_box'),
1510
-            $this->page_slug,
1511
-            'side',
1512
-            'default'
1513
-        );
1514
-        // NOTE: if you're looking for other metaboxes in here,
1515
-        // where a metabox has a related management page in the admin
1516
-        // you will find it setup in the related management page's "_Hooks" file.
1517
-        // i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
1518
-    }
1519
-
1520
-
1521
-    /**
1522
-     * @throws DomainException
1523
-     * @throws EE_Error
1524
-     */
1525
-    public function ticket_metabox()
1526
-    {
1527
-        $existing_datetime_ids = $existing_ticket_ids = array();
1528
-        // defaults for template args
1529
-        $template_args = array(
1530
-            'existing_datetime_ids'    => '',
1531
-            'event_datetime_help_link' => '',
1532
-            'ticket_options_help_link' => '',
1533
-            'time'                     => null,
1534
-            'ticket_rows'              => '',
1535
-            'existing_ticket_ids'      => '',
1536
-            'total_ticket_rows'        => 1,
1537
-            'ticket_js_structure'      => '',
1538
-            'trash_icon'               => 'ee-lock-icon',
1539
-            'disabled'                 => '',
1540
-        );
1541
-        $event_id = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
1542
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1543
-        /**
1544
-         * 1. Start with retrieving Datetimes
1545
-         * 2. Fore each datetime get related tickets
1546
-         * 3. For each ticket get related prices
1547
-         */
1548
-        $times = EE_Registry::instance()->load_model('Datetime')->get_all_event_dates($event_id);
1549
-        /** @type EE_Datetime $first_datetime */
1550
-        $first_datetime = reset($times);
1551
-        // do we get related tickets?
1552
-        if ($first_datetime instanceof EE_Datetime
1553
-            && $first_datetime->ID() !== 0
1554
-        ) {
1555
-            $existing_datetime_ids[] = $first_datetime->get('DTT_ID');
1556
-            $template_args['time'] = $first_datetime;
1557
-            $related_tickets = $first_datetime->tickets(
1558
-                array(
1559
-                    array('OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0)),
1560
-                    'default_where_conditions' => 'none',
1561
-                )
1562
-            );
1563
-            if (! empty($related_tickets)) {
1564
-                $template_args['total_ticket_rows'] = count($related_tickets);
1565
-                $row = 0;
1566
-                foreach ($related_tickets as $ticket) {
1567
-                    $existing_ticket_ids[] = $ticket->get('TKT_ID');
1568
-                    $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
1569
-                    $row++;
1570
-                }
1571
-            } else {
1572
-                $template_args['total_ticket_rows'] = 1;
1573
-                /** @type EE_Ticket $ticket */
1574
-                $ticket = EE_Registry::instance()->load_model('Ticket')->create_default_object();
1575
-                $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
1576
-            }
1577
-        } else {
1578
-            $template_args['time'] = $times[0];
1579
-            /** @type EE_Ticket $ticket */
1580
-            $ticket = EE_Registry::instance()->load_model('Ticket')->get_all_default_tickets();
1581
-            $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket[1]);
1582
-            // NOTE: we're just sending the first default row
1583
-            // (decaf can't manage default tickets so this should be sufficient);
1584
-        }
1585
-        $template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
1586
-            'event_editor_event_datetimes_help_tab'
1587
-        );
1588
-        $template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
1589
-        $template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids);
1590
-        $template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids);
1591
-        $template_args['ticket_js_structure'] = $this->_get_ticket_row(
1592
-            EE_Registry::instance()->load_model('Ticket')->create_default_object(),
1593
-            true
1594
-        );
1595
-        $template = apply_filters(
1596
-            'FHEE__Events_Admin_Page__ticket_metabox__template',
1597
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
1598
-        );
1599
-        EEH_Template::display_template($template, $template_args);
1600
-    }
1601
-
1602
-
1603
-    /**
1604
-     * Setup an individual ticket form for the decaf event editor page
1605
-     *
1606
-     * @access private
1607
-     * @param  EE_Ticket $ticket   the ticket object
1608
-     * @param  boolean   $skeleton whether we're generating a skeleton for js manipulation
1609
-     * @param int        $row
1610
-     * @return string generated html for the ticket row.
1611
-     */
1612
-    private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
1613
-    {
1614
-        $template_args = array(
1615
-            'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
1616
-            'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
1617
-                : '',
1618
-            'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
1619
-            'TKT_ID'              => $ticket->get('TKT_ID'),
1620
-            'TKT_name'            => $ticket->get('TKT_name'),
1621
-            'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
1622
-            'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
1623
-            'TKT_is_default'      => $ticket->get('TKT_is_default'),
1624
-            'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
1625
-            'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
1626
-            'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
1627
-            'trash_icon'          => ($skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')))
1628
-                                     && (! empty($ticket) && $ticket->get('TKT_sold') === 0)
1629
-                ? 'trash-icon dashicons dashicons-post-trash clickable' : 'ee-lock-icon',
1630
-            'disabled'            => $skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
1631
-                : ' disabled=disabled',
1632
-        );
1633
-        $price = $ticket->ID() !== 0
1634
-            ? $ticket->get_first_related('Price', array('default_where_conditions' => 'none'))
1635
-            : EE_Registry::instance()->load_model('Price')->create_default_object();
1636
-        $price_args = array(
1637
-            'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
1638
-            'PRC_amount'            => $price->get('PRC_amount'),
1639
-            'PRT_ID'                => $price->get('PRT_ID'),
1640
-            'PRC_ID'                => $price->get('PRC_ID'),
1641
-            'PRC_is_default'        => $price->get('PRC_is_default'),
1642
-        );
1643
-        // make sure we have default start and end dates if skeleton
1644
-        // handle rows that should NOT be empty
1645
-        if (empty($template_args['TKT_start_date'])) {
1646
-            // if empty then the start date will be now.
1647
-            $template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
1648
-        }
1649
-        if (empty($template_args['TKT_end_date'])) {
1650
-            // get the earliest datetime (if present);
1651
-            $earliest_dtt = $this->_cpt_model_obj->ID() > 0
1652
-                ? $this->_cpt_model_obj->get_first_related(
1653
-                    'Datetime',
1654
-                    array('order_by' => array('DTT_EVT_start' => 'ASC'))
1655
-                )
1656
-                : null;
1657
-            if (! empty($earliest_dtt)) {
1658
-                $template_args['TKT_end_date'] = $earliest_dtt->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a');
1659
-            } else {
1660
-                $template_args['TKT_end_date'] = date(
1661
-                    'Y-m-d h:i a',
1662
-                    mktime(0, 0, 0, date("m"), date("d") + 7, date("Y"))
1663
-                );
1664
-            }
1665
-        }
1666
-        $template_args = array_merge($template_args, $price_args);
1667
-        $template = apply_filters(
1668
-            'FHEE__Events_Admin_Page__get_ticket_row__template',
1669
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
1670
-            $ticket
1671
-        );
1672
-        return EEH_Template::display_template($template, $template_args, true);
1673
-    }
1674
-
1675
-
1676
-    /**
1677
-     * @throws DomainException
1678
-     */
1679
-    public function registration_options_meta_box()
1680
-    {
1681
-        $yes_no_values = array(
1682
-            array('id' => true, 'text' => esc_html__('Yes', 'event_espresso')),
1683
-            array('id' => false, 'text' => esc_html__('No', 'event_espresso')),
1684
-        );
1685
-        $default_reg_status_values = EEM_Registration::reg_status_array(
1686
-            array(
1687
-                EEM_Registration::status_id_cancelled,
1688
-                EEM_Registration::status_id_declined,
1689
-                EEM_Registration::status_id_incomplete,
1690
-            ),
1691
-            true
1692
-        );
1693
-        // $template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
1694
-        $template_args['_event'] = $this->_cpt_model_obj;
1695
-        $template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false);
1696
-        $template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit();
1697
-        $template_args['default_registration_status'] = EEH_Form_Fields::select_input(
1698
-            'default_reg_status',
1699
-            $default_reg_status_values,
1700
-            $this->_cpt_model_obj->default_registration_status()
1701
-        );
1702
-        $template_args['display_description'] = EEH_Form_Fields::select_input(
1703
-            'display_desc',
1704
-            $yes_no_values,
1705
-            $this->_cpt_model_obj->display_description()
1706
-        );
1707
-        $template_args['display_ticket_selector'] = EEH_Form_Fields::select_input(
1708
-            'display_ticket_selector',
1709
-            $yes_no_values,
1710
-            $this->_cpt_model_obj->display_ticket_selector(),
1711
-            '',
1712
-            '',
1713
-            false
1714
-        );
1715
-        $template_args['additional_registration_options'] = apply_filters(
1716
-            'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
1717
-            '',
1718
-            $template_args,
1719
-            $yes_no_values,
1720
-            $default_reg_status_values
1721
-        );
1722
-        EEH_Template::display_template(
1723
-            EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php',
1724
-            $template_args
1725
-        );
1726
-    }
1727
-
1728
-
1729
-    /**
1730
-     * _get_events()
1731
-     * This method simply returns all the events (for the given _view and paging)
1732
-     *
1733
-     * @access public
1734
-     * @param int  $per_page     count of items per page (20 default);
1735
-     * @param int  $current_page what is the current page being viewed.
1736
-     * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
1737
-     *                           If FALSE then we return an array of event objects
1738
-     *                           that match the given _view and paging parameters.
1739
-     * @return array an array of event objects.
1740
-     */
1741
-    public function get_events($per_page = 10, $current_page = 1, $count = false)
1742
-    {
1743
-        $EEME = $this->_event_model();
1744
-        $offset = ($current_page - 1) * $per_page;
1745
-        $limit = $count ? null : $offset . ',' . $per_page;
1746
-        $orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'EVT_ID';
1747
-        $order = isset($this->_req_data['order']) ? $this->_req_data['order'] : "DESC";
1748
-        if (isset($this->_req_data['month_range'])) {
1749
-            $pieces = explode(' ', $this->_req_data['month_range'], 3);
1750
-            // simulate the FIRST day of the month, that fixes issues for months like February
1751
-            // where PHP doesn't know what to assume for date.
1752
-            // @see https://events.codebasehq.com/projects/event-espresso/tickets/10437
1753
-            $month_r = ! empty($pieces[0]) ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
1754
-            $year_r = ! empty($pieces[1]) ? $pieces[1] : '';
1755
-        }
1756
-        $where = array();
1757
-        $status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
1758
-        // determine what post_status our condition will have for the query.
1759
-        switch ($status) {
1760
-            case 'month':
1761
-            case 'today':
1762
-            case null:
1763
-            case 'all':
1764
-                break;
1765
-            case 'draft':
1766
-                $where['status'] = array('IN', array('draft', 'auto-draft'));
1767
-                break;
1768
-            default:
1769
-                $where['status'] = $status;
1770
-        }
1771
-        // categories?
1772
-        $category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0
1773
-            ? $this->_req_data['EVT_CAT'] : null;
1774
-        if (! empty($category)) {
1775
-            $where['Term_Taxonomy.taxonomy'] = EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY;
1776
-            $where['Term_Taxonomy.term_id'] = $category;
1777
-        }
1778
-        // date where conditions
1779
-        $start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
1780
-        if (isset($this->_req_data['month_range']) && $this->_req_data['month_range'] != '') {
1781
-            $DateTime = new DateTime(
1782
-                $year_r . '-' . $month_r . '-01 00:00:00',
1783
-                new DateTimeZone(EEM_Datetime::instance()->get_timezone())
1784
-            );
1785
-            $start = $DateTime->format(implode(' ', $start_formats));
1786
-            $end = $DateTime->setDate(
1787
-                $year_r,
1788
-                $month_r,
1789
-                $DateTime
1790
-                    ->format('t')
1791
-            )->setTime(23, 59, 59)
1792
-                            ->format(implode(' ', $start_formats));
1793
-            $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
1794
-        } elseif (isset($this->_req_data['status']) && $this->_req_data['status'] == 'today') {
1795
-            $DateTime = new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
1796
-            $start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
1797
-            $end = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
1798
-            $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
1799
-        } elseif (isset($this->_req_data['status']) && $this->_req_data['status'] == 'month') {
1800
-            $now = date('Y-m-01');
1801
-            $DateTime = new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
1802
-            $start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
1803
-            $end = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
1804
-                            ->setTime(23, 59, 59)
1805
-                            ->format(implode(' ', $start_formats));
1806
-            $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
1807
-        }
1808
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
1809
-            $where['EVT_wp_user'] = get_current_user_id();
1810
-        } else {
1811
-            if (! isset($where['status'])) {
1812
-                if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
1813
-                    $where['OR'] = array(
1814
-                        'status*restrict_private' => array('!=', 'private'),
1815
-                        'AND'                     => array(
1816
-                            'status*inclusive' => array('=', 'private'),
1817
-                            'EVT_wp_user'      => get_current_user_id(),
1818
-                        ),
1819
-                    );
1820
-                }
1821
-            }
1822
-        }
1823
-        if (isset($this->_req_data['EVT_wp_user'])) {
1824
-            if ($this->_req_data['EVT_wp_user'] != get_current_user_id()
1825
-                && EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
1826
-            ) {
1827
-                $where['EVT_wp_user'] = $this->_req_data['EVT_wp_user'];
1828
-            }
1829
-        }
1830
-        // search query handling
1831
-        if (isset($this->_req_data['s'])) {
1832
-            $search_string = '%' . $this->_req_data['s'] . '%';
1833
-            $where['OR'] = array(
1834
-                'EVT_name'       => array('LIKE', $search_string),
1835
-                'EVT_desc'       => array('LIKE', $search_string),
1836
-                'EVT_short_desc' => array('LIKE', $search_string),
1837
-            );
1838
-        }
1839
-        $where = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $this->_req_data);
1840
-        $query_params = apply_filters(
1841
-            'FHEE__Events_Admin_Page__get_events__query_params',
1842
-            array(
1843
-                $where,
1844
-                'limit'    => $limit,
1845
-                'order_by' => $orderby,
1846
-                'order'    => $order,
1847
-                'group_by' => 'EVT_ID',
1848
-            ),
1849
-            $this->_req_data
1850
-        );
1851
-        // let's first check if we have special requests coming in.
1852
-        if (isset($this->_req_data['active_status'])) {
1853
-            switch ($this->_req_data['active_status']) {
1854
-                case 'upcoming':
1855
-                    return $EEME->get_upcoming_events($query_params, $count);
1856
-                    break;
1857
-                case 'expired':
1858
-                    return $EEME->get_expired_events($query_params, $count);
1859
-                    break;
1860
-                case 'active':
1861
-                    return $EEME->get_active_events($query_params, $count);
1862
-                    break;
1863
-                case 'inactive':
1864
-                    return $EEME->get_inactive_events($query_params, $count);
1865
-                    break;
1866
-            }
1867
-        }
1868
-        $events = $count ? $EEME->count(array($where), 'EVT_ID', true) : $EEME->get_all($query_params);
1869
-        return $events;
1870
-    }
1871
-
1872
-
1873
-    /**
1874
-     * handling for WordPress CPT actions (trash, restore, delete)
1875
-     *
1876
-     * @param string $post_id
1877
-     */
1878
-    public function trash_cpt_item($post_id)
1879
-    {
1880
-        $this->_req_data['EVT_ID'] = $post_id;
1881
-        $this->_trash_or_restore_event('trash', false);
1882
-    }
1883
-
1884
-
1885
-    /**
1886
-     * @param string $post_id
1887
-     */
1888
-    public function restore_cpt_item($post_id)
1889
-    {
1890
-        $this->_req_data['EVT_ID'] = $post_id;
1891
-        $this->_trash_or_restore_event('draft', false);
1892
-    }
1893
-
1894
-
1895
-    /**
1896
-     * @param string $post_id
1897
-     */
1898
-    public function delete_cpt_item($post_id)
1899
-    {
1900
-        $this->_req_data['EVT_ID'] = $post_id;
1901
-        $this->_delete_event(false);
1902
-    }
1903
-
1904
-
1905
-    /**
1906
-     * _trash_or_restore_event
1907
-     *
1908
-     * @access protected
1909
-     * @param  string $event_status
1910
-     * @param bool    $redirect_after
1911
-     */
1912
-    protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true)
1913
-    {
1914
-        // determine the event id and set to array.
1915
-        $EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : false;
1916
-        // loop thru events
1917
-        if ($EVT_ID) {
1918
-            // clean status
1919
-            $event_status = sanitize_key($event_status);
1920
-            // grab status
1921
-            if (! empty($event_status)) {
1922
-                $success = $this->_change_event_status($EVT_ID, $event_status);
1923
-            } else {
1924
-                $success = false;
1925
-                $msg = esc_html__(
1926
-                    'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
1927
-                    'event_espresso'
1928
-                );
1929
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
1930
-            }
1931
-        } else {
1932
-            $success = false;
1933
-            $msg = esc_html__(
1934
-                'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
1935
-                'event_espresso'
1936
-            );
1937
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
1938
-        }
1939
-        $action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
1940
-        if ($redirect_after) {
1941
-            $this->_redirect_after_action($success, 'Event', $action, array('action' => 'default'));
1942
-        }
1943
-    }
1944
-
1945
-
1946
-    /**
1947
-     * _trash_or_restore_events
1948
-     *
1949
-     * @access protected
1950
-     * @param  string $event_status
1951
-     * @return void
1952
-     */
1953
-    protected function _trash_or_restore_events($event_status = 'trash')
1954
-    {
1955
-        // clean status
1956
-        $event_status = sanitize_key($event_status);
1957
-        // grab status
1958
-        if (! empty($event_status)) {
1959
-            $success = true;
1960
-            // determine the event id and set to array.
1961
-            $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array) $this->_req_data['EVT_IDs'] : array();
1962
-            // loop thru events
1963
-            foreach ($EVT_IDs as $EVT_ID) {
1964
-                if ($EVT_ID = absint($EVT_ID)) {
1965
-                    $results = $this->_change_event_status($EVT_ID, $event_status);
1966
-                    $success = $results !== false ? $success : false;
1967
-                } else {
1968
-                    $msg = sprintf(
1969
-                        esc_html__(
1970
-                            'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
1971
-                            'event_espresso'
1972
-                        ),
1973
-                        $EVT_ID
1974
-                    );
1975
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
1976
-                    $success = false;
1977
-                }
1978
-            }
1979
-        } else {
1980
-            $success = false;
1981
-            $msg = esc_html__(
1982
-                'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
1983
-                'event_espresso'
1984
-            );
1985
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
1986
-        }
1987
-        // in order to force a pluralized result message we need to send back a success status greater than 1
1988
-        $success = $success ? 2 : false;
1989
-        $action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
1990
-        $this->_redirect_after_action($success, 'Events', $action, array('action' => 'default'));
1991
-    }
1992
-
1993
-
1994
-    /**
1995
-     * _trash_or_restore_events
1996
-     *
1997
-     * @access  private
1998
-     * @param  int    $EVT_ID
1999
-     * @param  string $event_status
2000
-     * @return bool
2001
-     */
2002
-    private function _change_event_status($EVT_ID = 0, $event_status = '')
2003
-    {
2004
-        // grab event id
2005
-        if (! $EVT_ID) {
2006
-            $msg = esc_html__(
2007
-                'An error occurred. No Event ID or an invalid Event ID was received.',
2008
-                'event_espresso'
2009
-            );
2010
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2011
-            return false;
2012
-        }
2013
-        $this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
2014
-        // clean status
2015
-        $event_status = sanitize_key($event_status);
2016
-        // grab status
2017
-        if (empty($event_status)) {
2018
-            $msg = esc_html__(
2019
-                'An error occurred. No Event Status or an invalid Event Status was received.',
2020
-                'event_espresso'
2021
-            );
2022
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2023
-            return false;
2024
-        }
2025
-        // was event trashed or restored ?
2026
-        switch ($event_status) {
2027
-            case 'draft':
2028
-                $action = 'restored from the trash';
2029
-                $hook = 'AHEE_event_restored_from_trash';
2030
-                break;
2031
-            case 'trash':
2032
-                $action = 'moved to the trash';
2033
-                $hook = 'AHEE_event_moved_to_trash';
2034
-                break;
2035
-            default:
2036
-                $action = 'updated';
2037
-                $hook = false;
2038
-        }
2039
-        // use class to change status
2040
-        $this->_cpt_model_obj->set_status($event_status);
2041
-        $success = $this->_cpt_model_obj->save();
2042
-        if ($success === false) {
2043
-            $msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
2044
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2045
-            return false;
2046
-        }
2047
-        if ($hook) {
2048
-            do_action($hook);
2049
-        }
2050
-        return true;
2051
-    }
2052
-
2053
-
2054
-    /**
2055
-     * _delete_event
2056
-     *
2057
-     * @access protected
2058
-     * @param bool $redirect_after
2059
-     */
2060
-    protected function _delete_event($redirect_after = true)
2061
-    {
2062
-        // determine the event id and set to array.
2063
-        $EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : null;
2064
-        $EVT_ID = isset($this->_req_data['post']) ? absint($this->_req_data['post']) : $EVT_ID;
2065
-        // loop thru events
2066
-        if ($EVT_ID) {
2067
-            $success = $this->_permanently_delete_event($EVT_ID);
2068
-            // get list of events with no prices
2069
-            $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
2070
-            // remove this event from the list of events with no prices
2071
-            if (isset($espresso_no_ticket_prices[ $EVT_ID ])) {
2072
-                unset($espresso_no_ticket_prices[ $EVT_ID ]);
2073
-            }
2074
-            update_option('ee_no_ticket_prices', $espresso_no_ticket_prices);
2075
-        } else {
2076
-            $success = false;
2077
-            $msg = esc_html__(
2078
-                'An error occurred. An event could not be deleted because a valid event ID was not not supplied.',
2079
-                'event_espresso'
2080
-            );
2081
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2082
-        }
2083
-        if ($redirect_after) {
2084
-            $this->_redirect_after_action(
2085
-                $success,
2086
-                'Event',
2087
-                'deleted',
2088
-                array('action' => 'default', 'status' => 'trash')
2089
-            );
2090
-        }
2091
-    }
2092
-
2093
-
2094
-    /**
2095
-     * _delete_events
2096
-     *
2097
-     * @access protected
2098
-     * @return void
2099
-     */
2100
-    protected function _delete_events()
2101
-    {
2102
-        $success = true;
2103
-        // get list of events with no prices
2104
-        $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
2105
-        // determine the event id and set to array.
2106
-        $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array) $this->_req_data['EVT_IDs'] : array();
2107
-        // loop thru events
2108
-        foreach ($EVT_IDs as $EVT_ID) {
2109
-            $EVT_ID = absint($EVT_ID);
2110
-            if ($EVT_ID) {
2111
-                $results = $this->_permanently_delete_event($EVT_ID);
2112
-                $success = $results !== false ? $success : false;
2113
-                // remove this event from the list of events with no prices
2114
-                unset($espresso_no_ticket_prices[ $EVT_ID ]);
2115
-            } else {
2116
-                $success = false;
2117
-                $msg = esc_html__(
2118
-                    'An error occurred. An event could not be deleted because a valid event ID was not not supplied.',
2119
-                    'event_espresso'
2120
-                );
2121
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2122
-            }
2123
-        }
2124
-        update_option('ee_no_ticket_prices', $espresso_no_ticket_prices);
2125
-        // in order to force a pluralized result message we need to send back a success status greater than 1
2126
-        $success = $success ? 2 : false;
2127
-        $this->_redirect_after_action($success, 'Events', 'deleted', array('action' => 'default'));
2128
-    }
2129
-
2130
-
2131
-    /**
2132
-     * _permanently_delete_event
2133
-     *
2134
-     * @access  private
2135
-     * @param  int $EVT_ID
2136
-     * @return bool
2137
-     */
2138
-    private function _permanently_delete_event($EVT_ID = 0)
2139
-    {
2140
-        // grab event id
2141
-        if (! $EVT_ID) {
2142
-            $msg = esc_html__(
2143
-                'An error occurred. No Event ID or an invalid Event ID was received.',
2144
-                'event_espresso'
2145
-            );
2146
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2147
-            return false;
2148
-        }
2149
-        if (! $this->_cpt_model_obj instanceof EE_Event
2150
-            || $this->_cpt_model_obj->ID() !== $EVT_ID
2151
-        ) {
2152
-            $this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
2153
-        }
2154
-        if (! $this->_cpt_model_obj instanceof EE_Event) {
2155
-            return false;
2156
-        }
2157
-        // need to delete related tickets and prices first.
2158
-        $datetimes = $this->_cpt_model_obj->get_many_related('Datetime');
2159
-        foreach ($datetimes as $datetime) {
2160
-            $this->_cpt_model_obj->_remove_relation_to($datetime, 'Datetime');
2161
-            $tickets = $datetime->get_many_related('Ticket');
2162
-            foreach ($tickets as $ticket) {
2163
-                $ticket->_remove_relation_to($datetime, 'Datetime');
2164
-                $ticket->delete_related_permanently('Price');
2165
-                $ticket->delete_permanently();
2166
-            }
2167
-            $datetime->delete();
2168
-        }
2169
-        // what about related venues or terms?
2170
-        $venues = $this->_cpt_model_obj->get_many_related('Venue');
2171
-        foreach ($venues as $venue) {
2172
-            $this->_cpt_model_obj->_remove_relation_to($venue, 'Venue');
2173
-        }
2174
-        // any attached question groups?
2175
-        $question_groups = $this->_cpt_model_obj->get_many_related('Question_Group');
2176
-        if (! empty($question_groups)) {
2177
-            foreach ($question_groups as $question_group) {
2178
-                $this->_cpt_model_obj->_remove_relation_to($question_group, 'Question_Group');
2179
-            }
2180
-        }
2181
-        // Message Template Groups
2182
-        $this->_cpt_model_obj->_remove_relations('Message_Template_Group');
2183
-        /** @type EE_Term_Taxonomy[] $term_taxonomies */
2184
-        $term_taxonomies = $this->_cpt_model_obj->term_taxonomies();
2185
-        foreach ($term_taxonomies as $term_taxonomy) {
2186
-            $this->_cpt_model_obj->remove_relation_to_term_taxonomy($term_taxonomy);
2187
-        }
2188
-        $success = $this->_cpt_model_obj->delete_permanently();
2189
-        // did it all go as planned ?
2190
-        if ($success) {
2191
-            $msg = sprintf(esc_html__('Event ID # %d has been deleted.', 'event_espresso'), $EVT_ID);
2192
-            EE_Error::add_success($msg);
2193
-        } else {
2194
-            $msg = sprintf(
2195
-                esc_html__('An error occurred. Event ID # %d could not be deleted.', 'event_espresso'),
2196
-                $EVT_ID
2197
-            );
2198
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2199
-            return false;
2200
-        }
2201
-        do_action('AHEE__Events_Admin_Page___permanently_delete_event__after_event_deleted', $EVT_ID);
2202
-        return true;
2203
-    }
2204
-
2205
-
2206
-    /**
2207
-     * get total number of events
2208
-     *
2209
-     * @access public
2210
-     * @return int
2211
-     */
2212
-    public function total_events()
2213
-    {
2214
-        $count = EEM_Event::instance()->count(array('caps' => 'read_admin'), 'EVT_ID', true);
2215
-        return $count;
2216
-    }
2217
-
2218
-
2219
-    /**
2220
-     * get total number of draft events
2221
-     *
2222
-     * @access public
2223
-     * @return int
2224
-     */
2225
-    public function total_events_draft()
2226
-    {
2227
-        $where = array(
2228
-            'status' => array('IN', array('draft', 'auto-draft')),
2229
-        );
2230
-        $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
2231
-        return $count;
2232
-    }
2233
-
2234
-
2235
-    /**
2236
-     * get total number of trashed events
2237
-     *
2238
-     * @access public
2239
-     * @return int
2240
-     */
2241
-    public function total_trashed_events()
2242
-    {
2243
-        $where = array(
2244
-            'status' => 'trash',
2245
-        );
2246
-        $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
2247
-        return $count;
2248
-    }
2249
-
2250
-
2251
-    /**
2252
-     *    _default_event_settings
2253
-     *    This generates the Default Settings Tab
2254
-     *
2255
-     * @return void
2256
-     * @throws EE_Error
2257
-     */
2258
-    protected function _default_event_settings()
2259
-    {
2260
-        $this->_set_add_edit_form_tags('update_default_event_settings');
2261
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
2262
-        $this->_template_args['admin_page_content'] = $this->_default_event_settings_form()->get_html();
2263
-        $this->display_admin_page_with_sidebar();
2264
-    }
2265
-
2266
-
2267
-    /**
2268
-     * Return the form for event settings.
2269
-     *
2270
-     * @return EE_Form_Section_Proper
2271
-     * @throws EE_Error
2272
-     */
2273
-    protected function _default_event_settings_form()
2274
-    {
2275
-        $registration_config = EE_Registry::instance()->CFG->registration;
2276
-        $registration_stati_for_selection = EEM_Registration::reg_status_array(
2277
-            // exclude
2278
-            array(
2279
-                EEM_Registration::status_id_cancelled,
2280
-                EEM_Registration::status_id_declined,
2281
-                EEM_Registration::status_id_incomplete,
2282
-                EEM_Registration::status_id_wait_list,
2283
-            ),
2284
-            true
2285
-        );
2286
-        return new EE_Form_Section_Proper(
2287
-            array(
2288
-                'name'            => 'update_default_event_settings',
2289
-                'html_id'         => 'update_default_event_settings',
2290
-                'html_class'      => 'form-table',
2291
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
2292
-                'subsections'     => apply_filters(
2293
-                    'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
2294
-                    array(
2295
-                        'default_reg_status'  => new EE_Select_Input(
2296
-                            $registration_stati_for_selection,
2297
-                            array(
2298
-                                'default'         => isset($registration_config->default_STS_ID)
2299
-                                                     && array_key_exists(
2300
-                                                         $registration_config->default_STS_ID,
2301
-                                                         $registration_stati_for_selection
2302
-                                                     )
2303
-                                    ? sanitize_text_field($registration_config->default_STS_ID)
2304
-                                    : EEM_Registration::status_id_pending_payment,
2305
-                                'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
2306
-                                                     . EEH_Template::get_help_tab_link(
2307
-                                                         'default_settings_status_help_tab'
2308
-                                                     ),
2309
-                                'html_help_text'  => esc_html__(
2310
-                                    'This setting allows you to preselect what the default registration status setting is when creating an event.  Note that changing this setting does NOT retroactively apply it to existing events.',
2311
-                                    'event_espresso'
2312
-                                ),
2313
-                            )
2314
-                        ),
2315
-                        'default_max_tickets' => new EE_Integer_Input(
2316
-                            array(
2317
-                                'default'         => isset($registration_config->default_maximum_number_of_tickets)
2318
-                                    ? $registration_config->default_maximum_number_of_tickets
2319
-                                    : EEM_Event::get_default_additional_limit(),
2320
-                                'html_label_text' => esc_html__(
2321
-                                    'Default Maximum Tickets Allowed Per Order:',
2322
-                                    'event_espresso'
2323
-                                )
2324
-                                                     . EEH_Template::get_help_tab_link(
2325
-                                                         'default_maximum_tickets_help_tab"'
2326
-                                                     ),
2327
-                                'html_help_text'  => esc_html__(
2328
-                                    'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
2329
-                                    'event_espresso'
2330
-                                ),
2331
-                            )
2332
-                        ),
2333
-                    )
2334
-                ),
2335
-            )
2336
-        );
2337
-    }
2338
-
2339
-
2340
-    /**
2341
-     * _update_default_event_settings
2342
-     *
2343
-     * @access protected
2344
-     * @return void
2345
-     * @throws EE_Error
2346
-     */
2347
-    protected function _update_default_event_settings()
2348
-    {
2349
-        $registration_config = EE_Registry::instance()->CFG->registration;
2350
-        $form = $this->_default_event_settings_form();
2351
-        if ($form->was_submitted()) {
2352
-            $form->receive_form_submission();
2353
-            if ($form->is_valid()) {
2354
-                $valid_data = $form->valid_data();
2355
-                if (isset($valid_data['default_reg_status'])) {
2356
-                    $registration_config->default_STS_ID = $valid_data['default_reg_status'];
2357
-                }
2358
-                if (isset($valid_data['default_max_tickets'])) {
2359
-                    $registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
2360
-                }
2361
-                // update because data was valid!
2362
-                EE_Registry::instance()->CFG->update_espresso_config();
2363
-                EE_Error::overwrite_success();
2364
-                EE_Error::add_success(
2365
-                    __('Default Event Settings were updated', 'event_espresso')
2366
-                );
2367
-            }
2368
-        }
2369
-        $this->_redirect_after_action(0, '', '', array('action' => 'default_event_settings'), true);
2370
-    }
2371
-
2372
-
2373
-    /*************        Templates        *************/
2374
-    protected function _template_settings()
2375
-    {
2376
-        $this->_admin_page_title = esc_html__('Template Settings (Preview)', 'event_espresso');
2377
-        $this->_template_args['preview_img'] = '<img src="'
2378
-                                               . EVENTS_ASSETS_URL
2379
-                                               . '/images/'
2380
-                                               . 'caffeinated_template_features.jpg" alt="'
2381
-                                               . esc_attr__('Template Settings Preview screenshot', 'event_espresso')
2382
-                                               . '" />';
2383
-        $this->_template_args['preview_text'] = '<strong>'
2384
-                                                . esc_html__(
2385
-                                                    'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
2386
-                                                    'event_espresso'
2387
-                                                ) . '</strong>';
2388
-        $this->display_admin_caf_preview_page('template_settings_tab');
2389
-    }
2390
-
2391
-
2392
-    /** Event Category Stuff **/
2393
-    /**
2394
-     * set the _category property with the category object for the loaded page.
2395
-     *
2396
-     * @access private
2397
-     * @return void
2398
-     */
2399
-    private function _set_category_object()
2400
-    {
2401
-        if (isset($this->_category->id) && ! empty($this->_category->id)) {
2402
-            return;
2403
-        } //already have the category object so get out.
2404
-        // set default category object
2405
-        $this->_set_empty_category_object();
2406
-        // only set if we've got an id
2407
-        if (! isset($this->_req_data['EVT_CAT_ID'])) {
2408
-            return;
2409
-        }
2410
-        $category_id = absint($this->_req_data['EVT_CAT_ID']);
2411
-        $term = get_term($category_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
2412
-        if (! empty($term)) {
2413
-            $this->_category->category_name = $term->name;
2414
-            $this->_category->category_identifier = $term->slug;
2415
-            $this->_category->category_desc = $term->description;
2416
-            $this->_category->id = $term->term_id;
2417
-            $this->_category->parent = $term->parent;
2418
-        }
2419
-    }
2420
-
2421
-
2422
-    /**
2423
-     * Clears out category properties.
2424
-     */
2425
-    private function _set_empty_category_object()
2426
-    {
2427
-        $this->_category = new stdClass();
2428
-        $this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
2429
-        $this->_category->id = $this->_category->parent = 0;
2430
-    }
2431
-
2432
-
2433
-    /**
2434
-     * @throws EE_Error
2435
-     */
2436
-    protected function _category_list_table()
2437
-    {
2438
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2439
-        $this->_search_btn_label = esc_html__('Categories', 'event_espresso');
2440
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
2441
-            'add_category',
2442
-            'add_category',
2443
-            array(),
2444
-            'add-new-h2'
2445
-        );
2446
-        $this->display_admin_list_table_page_with_sidebar();
2447
-    }
2448
-
2449
-
2450
-    /**
2451
-     * Output category details view.
2452
-     */
2453
-    protected function _category_details($view)
2454
-    {
2455
-        // load formatter helper
2456
-        // load field generator helper
2457
-        $route = $view == 'edit' ? 'update_category' : 'insert_category';
2458
-        $this->_set_add_edit_form_tags($route);
2459
-        $this->_set_category_object();
2460
-        $id = ! empty($this->_category->id) ? $this->_category->id : '';
2461
-        $delete_action = 'delete_category';
2462
-        // custom redirect
2463
-        $redirect = EE_Admin_Page::add_query_args_and_nonce(
2464
-            array('action' => 'category_list'),
2465
-            $this->_admin_base_url
2466
-        );
2467
-        $this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect);
2468
-        // take care of contents
2469
-        $this->_template_args['admin_page_content'] = $this->_category_details_content();
2470
-        $this->display_admin_page_with_sidebar();
2471
-    }
2472
-
2473
-
2474
-    /**
2475
-     * Output category details content.
2476
-     */
2477
-    protected function _category_details_content()
2478
-    {
2479
-        $editor_args['category_desc'] = array(
2480
-            'type'          => 'wp_editor',
2481
-            'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
2482
-            'class'         => 'my_editor_custom',
2483
-            'wpeditor_args' => array('media_buttons' => false),
2484
-        );
2485
-        $_wp_editor = $this->_generate_admin_form_fields($editor_args, 'array');
2486
-        $all_terms = get_terms(
2487
-            array(EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY),
2488
-            array('hide_empty' => 0, 'exclude' => array($this->_category->id))
2489
-        );
2490
-        // setup category select for term parents.
2491
-        $category_select_values[] = array(
2492
-            'text' => esc_html__('No Parent', 'event_espresso'),
2493
-            'id'   => 0,
2494
-        );
2495
-        foreach ($all_terms as $term) {
2496
-            $category_select_values[] = array(
2497
-                'text' => $term->name,
2498
-                'id'   => $term->term_id,
2499
-            );
2500
-        }
2501
-        $category_select = EEH_Form_Fields::select_input(
2502
-            'category_parent',
2503
-            $category_select_values,
2504
-            $this->_category->parent
2505
-        );
2506
-        $template_args = array(
2507
-            'category'                 => $this->_category,
2508
-            'category_select'          => $category_select,
2509
-            'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
2510
-            'category_desc_editor'     => $_wp_editor['category_desc']['field'],
2511
-            'disable'                  => '',
2512
-            'disabled_message'         => false,
2513
-        );
2514
-        $template = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
2515
-        return EEH_Template::display_template($template, $template_args, true);
2516
-    }
2517
-
2518
-
2519
-    /**
2520
-     * Handles deleting categories.
2521
-     */
2522
-    protected function _delete_categories()
2523
-    {
2524
-        $cat_ids = isset($this->_req_data['EVT_CAT_ID']) ? (array) $this->_req_data['EVT_CAT_ID']
2525
-            : (array) $this->_req_data['category_id'];
2526
-        foreach ($cat_ids as $cat_id) {
2527
-            $this->_delete_category($cat_id);
2528
-        }
2529
-        // doesn't matter what page we're coming from... we're going to the same place after delete.
2530
-        $query_args = array(
2531
-            'action' => 'category_list',
2532
-        );
2533
-        $this->_redirect_after_action(0, '', '', $query_args);
2534
-    }
2535
-
2536
-
2537
-    /**
2538
-     * Handles deleting specific category.
2539
-     *
2540
-     * @param int $cat_id
2541
-     */
2542
-    protected function _delete_category($cat_id)
2543
-    {
2544
-        $cat_id = absint($cat_id);
2545
-        wp_delete_term($cat_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
2546
-    }
2547
-
2548
-
2549
-    /**
2550
-     * Handles triggering the update or insertion of a new category.
2551
-     *
2552
-     * @param bool $new_category true means we're triggering the insert of a new category.
2553
-     */
2554
-    protected function _insert_or_update_category($new_category)
2555
-    {
2556
-        $cat_id = $new_category ? $this->_insert_category() : $this->_insert_category(true);
2557
-        $success = 0; // we already have a success message so lets not send another.
2558
-        if ($cat_id) {
2559
-            $query_args = array(
2560
-                'action'     => 'edit_category',
2561
-                'EVT_CAT_ID' => $cat_id,
2562
-            );
2563
-        } else {
2564
-            $query_args = array('action' => 'add_category');
2565
-        }
2566
-        $this->_redirect_after_action($success, '', '', $query_args, true);
2567
-    }
2568
-
2569
-
2570
-    /**
2571
-     * Inserts or updates category
2572
-     *
2573
-     * @param bool $update (true indicates we're updating a category).
2574
-     * @return bool|mixed|string
2575
-     */
2576
-    private function _insert_category($update = false)
2577
-    {
2578
-        $cat_id = $update ? $this->_req_data['EVT_CAT_ID'] : '';
2579
-        $category_name = isset($this->_req_data['category_name']) ? $this->_req_data['category_name'] : '';
2580
-        $category_desc = isset($this->_req_data['category_desc']) ? $this->_req_data['category_desc'] : '';
2581
-        $category_parent = isset($this->_req_data['category_parent']) ? $this->_req_data['category_parent'] : 0;
2582
-        if (empty($category_name)) {
2583
-            $msg = esc_html__('You must add a name for the category.', 'event_espresso');
2584
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2585
-            return false;
2586
-        }
2587
-        $term_args = array(
2588
-            'name'        => $category_name,
2589
-            'description' => $category_desc,
2590
-            'parent'      => $category_parent,
2591
-        );
2592
-        // was the category_identifier input disabled?
2593
-        if (isset($this->_req_data['category_identifier'])) {
2594
-            $term_args['slug'] = $this->_req_data['category_identifier'];
2595
-        }
2596
-        $insert_ids = $update
2597
-            ? wp_update_term($cat_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args)
2598
-            : wp_insert_term($category_name, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args);
2599
-        if (! is_array($insert_ids)) {
2600
-            $msg = esc_html__(
2601
-                'An error occurred and the category has not been saved to the database.',
2602
-                'event_espresso'
2603
-            );
2604
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2605
-        } else {
2606
-            $cat_id = $insert_ids['term_id'];
2607
-            $msg = sprintf(esc_html__('The category %s was successfully saved', 'event_espresso'), $category_name);
2608
-            EE_Error::add_success($msg);
2609
-        }
2610
-        return $cat_id;
2611
-    }
2612
-
2613
-
2614
-    /**
2615
-     * Gets categories or count of categories matching the arguments in the request.
2616
-     *
2617
-     * @param int  $per_page
2618
-     * @param int  $current_page
2619
-     * @param bool $count
2620
-     * @return EE_Base_Class[]|EE_Term_Taxonomy[]|int
2621
-     */
2622
-    public function get_categories($per_page = 10, $current_page = 1, $count = false)
2623
-    {
2624
-        // testing term stuff
2625
-        $orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'Term.term_id';
2626
-        $order = isset($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
2627
-        $limit = ($current_page - 1) * $per_page;
2628
-        $where = array('taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
2629
-        if (isset($this->_req_data['s'])) {
2630
-            $sstr = '%' . $this->_req_data['s'] . '%';
2631
-            $where['OR'] = array(
2632
-                'Term.name'   => array('LIKE', $sstr),
2633
-                'description' => array('LIKE', $sstr),
2634
-            );
2635
-        }
2636
-        $query_params = array(
2637
-            $where,
2638
-            'order_by'   => array($orderby => $order),
2639
-            'limit'      => $limit . ',' . $per_page,
2640
-            'force_join' => array('Term'),
2641
-        );
2642
-        $categories = $count
2643
-            ? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
2644
-            : EEM_Term_Taxonomy::instance()->get_all($query_params);
2645
-        return $categories;
2646
-    }
2647
-
2648
-    /* end category stuff */
2649
-    /**************/
2650
-
2651
-
2652
-    /**
2653
-     * Callback for the `ee_save_timezone_setting` ajax action.
2654
-     *
2655
-     * @throws EE_Error
2656
-     */
2657
-    public function save_timezonestring_setting()
2658
-    {
2659
-        $timezone_string = isset($this->_req_data['timezone_selected'])
2660
-            ? $this->_req_data['timezone_selected']
2661
-            : '';
2662
-        if (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false)) {
2663
-            EE_Error::add_error(
2664
-                esc_html__('An invalid timezone string submitted.', 'event_espresso'),
2665
-                __FILE__,
2666
-                __FUNCTION__,
2667
-                __LINE__
2668
-            );
2669
-            $this->_template_args['error'] = true;
2670
-            $this->_return_json();
2671
-        }
2672
-
2673
-        update_option('timezone_string', $timezone_string);
2674
-        EE_Error::add_success(
2675
-            esc_html__('Your timezone string was updated.', 'event_espresso')
2676
-        );
2677
-        $this->_template_args['success'] = true;
2678
-        $this->_return_json(true, array('action' => 'create_new'));
2679
-    }
15
+	/**
16
+	 * This will hold the event object for event_details screen.
17
+	 *
18
+	 * @access protected
19
+	 * @var EE_Event $_event
20
+	 */
21
+	protected $_event;
22
+
23
+
24
+	/**
25
+	 * This will hold the category object for category_details screen.
26
+	 *
27
+	 * @var stdClass $_category
28
+	 */
29
+	protected $_category;
30
+
31
+
32
+	/**
33
+	 * This will hold the event model instance
34
+	 *
35
+	 * @var EEM_Event $_event_model
36
+	 */
37
+	protected $_event_model;
38
+
39
+
40
+	/**
41
+	 * @var EE_Event
42
+	 */
43
+	protected $_cpt_model_obj = false;
44
+
45
+
46
+	/**
47
+	 * Initialize page props for this admin page group.
48
+	 */
49
+	protected function _init_page_props()
50
+	{
51
+		$this->page_slug = EVENTS_PG_SLUG;
52
+		$this->page_label = EVENTS_LABEL;
53
+		$this->_admin_base_url = EVENTS_ADMIN_URL;
54
+		$this->_admin_base_path = EVENTS_ADMIN;
55
+		$this->_cpt_model_names = array(
56
+			'create_new' => 'EEM_Event',
57
+			'edit'       => 'EEM_Event',
58
+		);
59
+		$this->_cpt_edit_routes = array(
60
+			'espresso_events' => 'edit',
61
+		);
62
+		add_action(
63
+			'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
64
+			array($this, 'verify_event_edit'),
65
+			10,
66
+			2
67
+		);
68
+	}
69
+
70
+
71
+	/**
72
+	 * Sets the ajax hooks used for this admin page group.
73
+	 */
74
+	protected function _ajax_hooks()
75
+	{
76
+		add_action('wp_ajax_ee_save_timezone_setting', array($this, 'save_timezonestring_setting'));
77
+	}
78
+
79
+
80
+	/**
81
+	 * Sets the page properties for this admin page group.
82
+	 */
83
+	protected function _define_page_props()
84
+	{
85
+		$this->_admin_page_title = EVENTS_LABEL;
86
+		$this->_labels = array(
87
+			'buttons'      => array(
88
+				'add'             => esc_html__('Add New Event', 'event_espresso'),
89
+				'edit'            => esc_html__('Edit Event', 'event_espresso'),
90
+				'delete'          => esc_html__('Delete Event', 'event_espresso'),
91
+				'add_category'    => esc_html__('Add New Category', 'event_espresso'),
92
+				'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
93
+				'delete_category' => esc_html__('Delete Category', 'event_espresso'),
94
+			),
95
+			'editor_title' => array(
96
+				'espresso_events' => esc_html__('Enter event title here', 'event_espresso'),
97
+			),
98
+			'publishbox'   => array(
99
+				'create_new'        => esc_html__('Save New Event', 'event_espresso'),
100
+				'edit'              => esc_html__('Update Event', 'event_espresso'),
101
+				'add_category'      => esc_html__('Save New Category', 'event_espresso'),
102
+				'edit_category'     => esc_html__('Update Category', 'event_espresso'),
103
+				'template_settings' => esc_html__('Update Settings', 'event_espresso'),
104
+			),
105
+		);
106
+	}
107
+
108
+
109
+	/**
110
+	 * Sets the page routes property for this admin page group.
111
+	 */
112
+	protected function _set_page_routes()
113
+	{
114
+		// load formatter helper
115
+		// load field generator helper
116
+		// is there a evt_id in the request?
117
+		$evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID'])
118
+			? $this->_req_data['EVT_ID']
119
+			: 0;
120
+		$evt_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $evt_id;
121
+		$this->_page_routes = array(
122
+			'default'                       => array(
123
+				'func'       => '_events_overview_list_table',
124
+				'capability' => 'ee_read_events',
125
+			),
126
+			'create_new'                    => array(
127
+				'func'       => '_create_new_cpt_item',
128
+				'capability' => 'ee_edit_events',
129
+			),
130
+			'edit'                          => array(
131
+				'func'       => '_edit_cpt_item',
132
+				'capability' => 'ee_edit_event',
133
+				'obj_id'     => $evt_id,
134
+			),
135
+			'copy_event'                    => array(
136
+				'func'       => '_copy_events',
137
+				'capability' => 'ee_edit_event',
138
+				'obj_id'     => $evt_id,
139
+				'noheader'   => true,
140
+			),
141
+			'trash_event'                   => array(
142
+				'func'       => '_trash_or_restore_event',
143
+				'args'       => array('event_status' => 'trash'),
144
+				'capability' => 'ee_delete_event',
145
+				'obj_id'     => $evt_id,
146
+				'noheader'   => true,
147
+			),
148
+			'trash_events'                  => array(
149
+				'func'       => '_trash_or_restore_events',
150
+				'args'       => array('event_status' => 'trash'),
151
+				'capability' => 'ee_delete_events',
152
+				'noheader'   => true,
153
+			),
154
+			'restore_event'                 => array(
155
+				'func'       => '_trash_or_restore_event',
156
+				'args'       => array('event_status' => 'draft'),
157
+				'capability' => 'ee_delete_event',
158
+				'obj_id'     => $evt_id,
159
+				'noheader'   => true,
160
+			),
161
+			'restore_events'                => array(
162
+				'func'       => '_trash_or_restore_events',
163
+				'args'       => array('event_status' => 'draft'),
164
+				'capability' => 'ee_delete_events',
165
+				'noheader'   => true,
166
+			),
167
+			'delete_event'                  => array(
168
+				'func'       => '_delete_event',
169
+				'capability' => 'ee_delete_event',
170
+				'obj_id'     => $evt_id,
171
+				'noheader'   => true,
172
+			),
173
+			'delete_events'                 => array(
174
+				'func'       => '_delete_events',
175
+				'capability' => 'ee_delete_events',
176
+				'noheader'   => true,
177
+			),
178
+			'view_report'                   => array(
179
+				'func'      => '_view_report',
180
+				'capablity' => 'ee_edit_events',
181
+			),
182
+			'default_event_settings'        => array(
183
+				'func'       => '_default_event_settings',
184
+				'capability' => 'manage_options',
185
+			),
186
+			'update_default_event_settings' => array(
187
+				'func'       => '_update_default_event_settings',
188
+				'capability' => 'manage_options',
189
+				'noheader'   => true,
190
+			),
191
+			'template_settings'             => array(
192
+				'func'       => '_template_settings',
193
+				'capability' => 'manage_options',
194
+			),
195
+			// event category tab related
196
+			'add_category'                  => array(
197
+				'func'       => '_category_details',
198
+				'capability' => 'ee_edit_event_category',
199
+				'args'       => array('add'),
200
+			),
201
+			'edit_category'                 => array(
202
+				'func'       => '_category_details',
203
+				'capability' => 'ee_edit_event_category',
204
+				'args'       => array('edit'),
205
+			),
206
+			'delete_categories'             => array(
207
+				'func'       => '_delete_categories',
208
+				'capability' => 'ee_delete_event_category',
209
+				'noheader'   => true,
210
+			),
211
+			'delete_category'               => array(
212
+				'func'       => '_delete_categories',
213
+				'capability' => 'ee_delete_event_category',
214
+				'noheader'   => true,
215
+			),
216
+			'insert_category'               => array(
217
+				'func'       => '_insert_or_update_category',
218
+				'args'       => array('new_category' => true),
219
+				'capability' => 'ee_edit_event_category',
220
+				'noheader'   => true,
221
+			),
222
+			'update_category'               => array(
223
+				'func'       => '_insert_or_update_category',
224
+				'args'       => array('new_category' => false),
225
+				'capability' => 'ee_edit_event_category',
226
+				'noheader'   => true,
227
+			),
228
+			'category_list'                 => array(
229
+				'func'       => '_category_list_table',
230
+				'capability' => 'ee_manage_event_categories',
231
+			),
232
+		);
233
+	}
234
+
235
+
236
+	/**
237
+	 * Set the _page_config property for this admin page group.
238
+	 */
239
+	protected function _set_page_config()
240
+	{
241
+		$this->_page_config = array(
242
+			'default'                => array(
243
+				'nav'           => array(
244
+					'label' => esc_html__('Overview', 'event_espresso'),
245
+					'order' => 10,
246
+				),
247
+				'list_table'    => 'Events_Admin_List_Table',
248
+				'help_tabs'     => array(
249
+					'events_overview_help_tab'                       => array(
250
+						'title'    => esc_html__('Events Overview', 'event_espresso'),
251
+						'filename' => 'events_overview',
252
+					),
253
+					'events_overview_table_column_headings_help_tab' => array(
254
+						'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
255
+						'filename' => 'events_overview_table_column_headings',
256
+					),
257
+					'events_overview_filters_help_tab'               => array(
258
+						'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
259
+						'filename' => 'events_overview_filters',
260
+					),
261
+					'events_overview_view_help_tab'                  => array(
262
+						'title'    => esc_html__('Events Overview Views', 'event_espresso'),
263
+						'filename' => 'events_overview_views',
264
+					),
265
+					'events_overview_other_help_tab'                 => array(
266
+						'title'    => esc_html__('Events Overview Other', 'event_espresso'),
267
+						'filename' => 'events_overview_other',
268
+					),
269
+				),
270
+				'help_tour'     => array(
271
+					'Event_Overview_Help_Tour',
272
+					// 'New_Features_Test_Help_Tour' for testing multiple help tour
273
+				),
274
+				'qtips'         => array(
275
+					'EE_Event_List_Table_Tips',
276
+				),
277
+				'require_nonce' => false,
278
+			),
279
+			'create_new'             => array(
280
+				'nav'           => array(
281
+					'label'      => esc_html__('Add Event', 'event_espresso'),
282
+					'order'      => 5,
283
+					'persistent' => false,
284
+				),
285
+				'metaboxes'     => array('_register_event_editor_meta_boxes'),
286
+				'help_tabs'     => array(
287
+					'event_editor_help_tab'                            => array(
288
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
289
+						'filename' => 'event_editor',
290
+					),
291
+					'event_editor_title_richtexteditor_help_tab'       => array(
292
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
293
+						'filename' => 'event_editor_title_richtexteditor',
294
+					),
295
+					'event_editor_venue_details_help_tab'              => array(
296
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
297
+						'filename' => 'event_editor_venue_details',
298
+					),
299
+					'event_editor_event_datetimes_help_tab'            => array(
300
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
301
+						'filename' => 'event_editor_event_datetimes',
302
+					),
303
+					'event_editor_event_tickets_help_tab'              => array(
304
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
305
+						'filename' => 'event_editor_event_tickets',
306
+					),
307
+					'event_editor_event_registration_options_help_tab' => array(
308
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
309
+						'filename' => 'event_editor_event_registration_options',
310
+					),
311
+					'event_editor_tags_categories_help_tab'            => array(
312
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
313
+						'filename' => 'event_editor_tags_categories',
314
+					),
315
+					'event_editor_questions_registrants_help_tab'      => array(
316
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
317
+						'filename' => 'event_editor_questions_registrants',
318
+					),
319
+					'event_editor_save_new_event_help_tab'             => array(
320
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
321
+						'filename' => 'event_editor_save_new_event',
322
+					),
323
+					'event_editor_other_help_tab'                      => array(
324
+						'title'    => esc_html__('Event Other', 'event_espresso'),
325
+						'filename' => 'event_editor_other',
326
+					),
327
+				),
328
+				'help_tour'     => array(
329
+					'Event_Editor_Help_Tour',
330
+				),
331
+				'qtips'         => array('EE_Event_Editor_Decaf_Tips'),
332
+				'require_nonce' => false,
333
+			),
334
+			'edit'                   => array(
335
+				'nav'           => array(
336
+					'label'      => esc_html__('Edit Event', 'event_espresso'),
337
+					'order'      => 5,
338
+					'persistent' => false,
339
+					'url'        => isset($this->_req_data['post'])
340
+						? EE_Admin_Page::add_query_args_and_nonce(
341
+							array('post' => $this->_req_data['post'], 'action' => 'edit'),
342
+							$this->_current_page_view_url
343
+						)
344
+						: $this->_admin_base_url,
345
+				),
346
+				'metaboxes'     => array('_register_event_editor_meta_boxes'),
347
+				'help_tabs'     => array(
348
+					'event_editor_help_tab'                            => array(
349
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
350
+						'filename' => 'event_editor',
351
+					),
352
+					'event_editor_title_richtexteditor_help_tab'       => array(
353
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
354
+						'filename' => 'event_editor_title_richtexteditor',
355
+					),
356
+					'event_editor_venue_details_help_tab'              => array(
357
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
358
+						'filename' => 'event_editor_venue_details',
359
+					),
360
+					'event_editor_event_datetimes_help_tab'            => array(
361
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
362
+						'filename' => 'event_editor_event_datetimes',
363
+					),
364
+					'event_editor_event_tickets_help_tab'              => array(
365
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
366
+						'filename' => 'event_editor_event_tickets',
367
+					),
368
+					'event_editor_event_registration_options_help_tab' => array(
369
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
370
+						'filename' => 'event_editor_event_registration_options',
371
+					),
372
+					'event_editor_tags_categories_help_tab'            => array(
373
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
374
+						'filename' => 'event_editor_tags_categories',
375
+					),
376
+					'event_editor_questions_registrants_help_tab'      => array(
377
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
378
+						'filename' => 'event_editor_questions_registrants',
379
+					),
380
+					'event_editor_save_new_event_help_tab'             => array(
381
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
382
+						'filename' => 'event_editor_save_new_event',
383
+					),
384
+					'event_editor_other_help_tab'                      => array(
385
+						'title'    => esc_html__('Event Other', 'event_espresso'),
386
+						'filename' => 'event_editor_other',
387
+					),
388
+				),
389
+				'qtips'         => array('EE_Event_Editor_Decaf_Tips'),
390
+				'require_nonce' => false,
391
+			),
392
+			'default_event_settings' => array(
393
+				'nav'           => array(
394
+					'label' => esc_html__('Default Settings', 'event_espresso'),
395
+					'order' => 40,
396
+				),
397
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
398
+				'labels'        => array(
399
+					'publishbox' => esc_html__('Update Settings', 'event_espresso'),
400
+				),
401
+				'help_tabs'     => array(
402
+					'default_settings_help_tab'        => array(
403
+						'title'    => esc_html__('Default Event Settings', 'event_espresso'),
404
+						'filename' => 'events_default_settings',
405
+					),
406
+					'default_settings_status_help_tab' => array(
407
+						'title'    => esc_html__('Default Registration Status', 'event_espresso'),
408
+						'filename' => 'events_default_settings_status',
409
+					),
410
+					'default_maximum_tickets_help_tab' => array(
411
+						'title'    => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
412
+						'filename' => 'events_default_settings_max_tickets',
413
+					),
414
+				),
415
+				'help_tour'     => array('Event_Default_Settings_Help_Tour'),
416
+				'require_nonce' => false,
417
+			),
418
+			// template settings
419
+			'template_settings'      => array(
420
+				'nav'           => array(
421
+					'label' => esc_html__('Templates', 'event_espresso'),
422
+					'order' => 30,
423
+				),
424
+				'metaboxes'     => $this->_default_espresso_metaboxes,
425
+				'help_tabs'     => array(
426
+					'general_settings_templates_help_tab' => array(
427
+						'title'    => esc_html__('Templates', 'event_espresso'),
428
+						'filename' => 'general_settings_templates',
429
+					),
430
+				),
431
+				'help_tour'     => array('Templates_Help_Tour'),
432
+				'require_nonce' => false,
433
+			),
434
+			// event category stuff
435
+			'add_category'           => array(
436
+				'nav'           => array(
437
+					'label'      => esc_html__('Add Category', 'event_espresso'),
438
+					'order'      => 15,
439
+					'persistent' => false,
440
+				),
441
+				'help_tabs'     => array(
442
+					'add_category_help_tab' => array(
443
+						'title'    => esc_html__('Add New Event Category', 'event_espresso'),
444
+						'filename' => 'events_add_category',
445
+					),
446
+				),
447
+				'help_tour'     => array('Event_Add_Category_Help_Tour'),
448
+				'metaboxes'     => array('_publish_post_box'),
449
+				'require_nonce' => false,
450
+			),
451
+			'edit_category'          => array(
452
+				'nav'           => array(
453
+					'label'      => esc_html__('Edit Category', 'event_espresso'),
454
+					'order'      => 15,
455
+					'persistent' => false,
456
+					'url'        => isset($this->_req_data['EVT_CAT_ID'])
457
+						? add_query_arg(
458
+							array('EVT_CAT_ID' => $this->_req_data['EVT_CAT_ID']),
459
+							$this->_current_page_view_url
460
+						)
461
+						: $this->_admin_base_url,
462
+				),
463
+				'help_tabs'     => array(
464
+					'edit_category_help_tab' => array(
465
+						'title'    => esc_html__('Edit Event Category', 'event_espresso'),
466
+						'filename' => 'events_edit_category',
467
+					),
468
+				),
469
+				/*'help_tour' => array('Event_Edit_Category_Help_Tour'),*/
470
+				'metaboxes'     => array('_publish_post_box'),
471
+				'require_nonce' => false,
472
+			),
473
+			'category_list'          => array(
474
+				'nav'           => array(
475
+					'label' => esc_html__('Categories', 'event_espresso'),
476
+					'order' => 20,
477
+				),
478
+				'list_table'    => 'Event_Categories_Admin_List_Table',
479
+				'help_tabs'     => array(
480
+					'events_categories_help_tab'                       => array(
481
+						'title'    => esc_html__('Event Categories', 'event_espresso'),
482
+						'filename' => 'events_categories',
483
+					),
484
+					'events_categories_table_column_headings_help_tab' => array(
485
+						'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
486
+						'filename' => 'events_categories_table_column_headings',
487
+					),
488
+					'events_categories_view_help_tab'                  => array(
489
+						'title'    => esc_html__('Event Categories Views', 'event_espresso'),
490
+						'filename' => 'events_categories_views',
491
+					),
492
+					'events_categories_other_help_tab'                 => array(
493
+						'title'    => esc_html__('Event Categories Other', 'event_espresso'),
494
+						'filename' => 'events_categories_other',
495
+					),
496
+				),
497
+				'help_tour'     => array(
498
+					'Event_Categories_Help_Tour',
499
+				),
500
+				'metaboxes'     => $this->_default_espresso_metaboxes,
501
+				'require_nonce' => false,
502
+			),
503
+		);
504
+	}
505
+
506
+
507
+	/**
508
+	 * Used to register any global screen options if necessary for every route in this admin page group.
509
+	 */
510
+	protected function _add_screen_options()
511
+	{
512
+	}
513
+
514
+
515
+	/**
516
+	 * Implementing the screen options for the 'default' route.
517
+	 */
518
+	protected function _add_screen_options_default()
519
+	{
520
+		$this->_per_page_screen_option();
521
+	}
522
+
523
+
524
+	/**
525
+	 * Implementing screen options for the category list route.
526
+	 */
527
+	protected function _add_screen_options_category_list()
528
+	{
529
+		$page_title = $this->_admin_page_title;
530
+		$this->_admin_page_title = esc_html__('Categories', 'event_espresso');
531
+		$this->_per_page_screen_option();
532
+		$this->_admin_page_title = $page_title;
533
+	}
534
+
535
+
536
+	/**
537
+	 * Used to register any global feature pointers for the admin page group.
538
+	 */
539
+	protected function _add_feature_pointers()
540
+	{
541
+	}
542
+
543
+
544
+	/**
545
+	 * Registers and enqueues any global scripts and styles for the entire admin page group.
546
+	 */
547
+	public function load_scripts_styles()
548
+	{
549
+		wp_register_style(
550
+			'events-admin-css',
551
+			EVENTS_ASSETS_URL . 'events-admin-page.css',
552
+			array(),
553
+			EVENT_ESPRESSO_VERSION
554
+		);
555
+		wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION);
556
+		wp_enqueue_style('events-admin-css');
557
+		wp_enqueue_style('ee-cat-admin');
558
+		// todo note: we also need to load_scripts_styles per view (i.e. default/view_report/event_details
559
+		// registers for all views
560
+		// scripts
561
+		wp_register_script(
562
+			'event_editor_js',
563
+			EVENTS_ASSETS_URL . 'event_editor.js',
564
+			array('ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'),
565
+			EVENT_ESPRESSO_VERSION,
566
+			true
567
+		);
568
+	}
569
+
570
+
571
+	/**
572
+	 * Enqueuing scripts and styles specific to this view
573
+	 */
574
+	public function load_scripts_styles_create_new()
575
+	{
576
+		$this->load_scripts_styles_edit();
577
+	}
578
+
579
+
580
+	/**
581
+	 * Enqueuing scripts and styles specific to this view
582
+	 */
583
+	public function load_scripts_styles_edit()
584
+	{
585
+		// styles
586
+		wp_enqueue_style('espresso-ui-theme');
587
+		wp_register_style(
588
+			'event-editor-css',
589
+			EVENTS_ASSETS_URL . 'event-editor.css',
590
+			array('ee-admin-css'),
591
+			EVENT_ESPRESSO_VERSION
592
+		);
593
+		wp_enqueue_style('event-editor-css');
594
+		// scripts
595
+		wp_register_script(
596
+			'event-datetime-metabox',
597
+			EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
598
+			array('event_editor_js', 'ee-datepicker'),
599
+			EVENT_ESPRESSO_VERSION
600
+		);
601
+		wp_enqueue_script('event-datetime-metabox');
602
+	}
603
+
604
+
605
+	/**
606
+	 * Populating the _views property for the category list table view.
607
+	 */
608
+	protected function _set_list_table_views_category_list()
609
+	{
610
+		$this->_views = array(
611
+			'all' => array(
612
+				'slug'        => 'all',
613
+				'label'       => esc_html__('All', 'event_espresso'),
614
+				'count'       => 0,
615
+				'bulk_action' => array(
616
+					'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
617
+				),
618
+			),
619
+		);
620
+	}
621
+
622
+
623
+	/**
624
+	 * For adding anything that fires on the admin_init hook for any route within this admin page group.
625
+	 */
626
+	public function admin_init()
627
+	{
628
+		EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__(
629
+			'Do you really want to delete this image? Please remember to update your event to complete the removal.',
630
+			'event_espresso'
631
+		);
632
+	}
633
+
634
+
635
+	/**
636
+	 * For adding anything that should be triggered on the admin_notices hook for any route within this admin page
637
+	 * group.
638
+	 */
639
+	public function admin_notices()
640
+	{
641
+	}
642
+
643
+
644
+	/**
645
+	 * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
646
+	 * this admin page group.
647
+	 */
648
+	public function admin_footer_scripts()
649
+	{
650
+	}
651
+
652
+
653
+	/**
654
+	 * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
655
+	 * warning (via EE_Error::add_error());
656
+	 *
657
+	 * @param  EE_Event $event Event object
658
+	 * @param string    $req_type
659
+	 * @return void
660
+	 * @throws EE_Error
661
+	 * @access public
662
+	 */
663
+	public function verify_event_edit($event = null, $req_type = '')
664
+	{
665
+		// don't need to do this when processing
666
+		if (! empty($req_type)) {
667
+			return;
668
+		}
669
+		// no event?
670
+		if (empty($event)) {
671
+			// set event
672
+			$event = $this->_cpt_model_obj;
673
+		}
674
+		// STILL no event?
675
+		if (! $event instanceof EE_Event) {
676
+			return;
677
+		}
678
+		$orig_status = $event->status();
679
+		// first check if event is active.
680
+		if ($orig_status === EEM_Event::cancelled
681
+			|| $orig_status === EEM_Event::postponed
682
+			|| $event->is_expired()
683
+			|| $event->is_inactive()
684
+		) {
685
+			return;
686
+		}
687
+		// made it here so it IS active... next check that any of the tickets are sold.
688
+		if ($event->is_sold_out(true)) {
689
+			if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
690
+				EE_Error::add_attention(
691
+					sprintf(
692
+						esc_html__(
693
+							'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event.  However, this change is not permanent until you update the event.  You can change the status back to something else before updating if you wish.',
694
+							'event_espresso'
695
+						),
696
+						EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
697
+					)
698
+				);
699
+			}
700
+			return;
701
+		} elseif ($orig_status === EEM_Event::sold_out) {
702
+			EE_Error::add_attention(
703
+				sprintf(
704
+					esc_html__(
705
+						'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets.  However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.',
706
+						'event_espresso'
707
+					),
708
+					EEH_Template::pretty_status($event->status(), false, 'sentence')
709
+				)
710
+			);
711
+		}
712
+		// now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
713
+		if (! $event->tickets_on_sale()) {
714
+			return;
715
+		}
716
+		// made it here so show warning
717
+		$this->_edit_event_warning();
718
+	}
719
+
720
+
721
+	/**
722
+	 * This is the text used for when an event is being edited that is public and has tickets for sale.
723
+	 * When needed, hook this into a EE_Error::add_error() notice.
724
+	 *
725
+	 * @access protected
726
+	 * @return void
727
+	 */
728
+	protected function _edit_event_warning()
729
+	{
730
+		// we don't want to add warnings during these requests
731
+		if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'editpost') {
732
+			return;
733
+		}
734
+		EE_Error::add_attention(
735
+			sprintf(
736
+				esc_html__(
737
+					'Your event is open for registration. Making changes may disrupt any transactions in progress. %sLearn more%s',
738
+					'event_espresso'
739
+				),
740
+				'<a class="espresso-help-tab-lnk">',
741
+				'</a>'
742
+			)
743
+		);
744
+	}
745
+
746
+
747
+	/**
748
+	 * When a user is creating a new event, notify them if they haven't set their timezone.
749
+	 * Otherwise, do the normal logic
750
+	 *
751
+	 * @return string
752
+	 * @throws \EE_Error
753
+	 */
754
+	protected function _create_new_cpt_item()
755
+	{
756
+		$has_timezone_string = get_option('timezone_string');
757
+		// only nag them about setting their timezone if it's their first event, and they haven't already done it
758
+		if (! $has_timezone_string && ! EEM_Event::instance()->exists(array())) {
759
+			EE_Error::add_attention(
760
+				sprintf(
761
+					__(
762
+						'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s',
763
+						'event_espresso'
764
+					),
765
+					'<br>',
766
+					'<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
767
+					. EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
768
+					. '</select>',
769
+					'<button class="button button-secondary timezone-submit">',
770
+					'</button><span class="spinner"></span>'
771
+				),
772
+				__FILE__,
773
+				__FUNCTION__,
774
+				__LINE__
775
+			);
776
+		}
777
+		return parent::_create_new_cpt_item();
778
+	}
779
+
780
+
781
+	/**
782
+	 * Sets the _views property for the default route in this admin page group.
783
+	 */
784
+	protected function _set_list_table_views_default()
785
+	{
786
+		$this->_views = array(
787
+			'all'   => array(
788
+				'slug'        => 'all',
789
+				'label'       => esc_html__('View All Events', 'event_espresso'),
790
+				'count'       => 0,
791
+				'bulk_action' => array(
792
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
793
+				),
794
+			),
795
+			'draft' => array(
796
+				'slug'        => 'draft',
797
+				'label'       => esc_html__('Draft', 'event_espresso'),
798
+				'count'       => 0,
799
+				'bulk_action' => array(
800
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
801
+				),
802
+			),
803
+		);
804
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
805
+			$this->_views['trash'] = array(
806
+				'slug'        => 'trash',
807
+				'label'       => esc_html__('Trash', 'event_espresso'),
808
+				'count'       => 0,
809
+				'bulk_action' => array(
810
+					'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
811
+					'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
812
+				),
813
+			);
814
+		}
815
+	}
816
+
817
+
818
+	/**
819
+	 * Provides the legend item array for the default list table view.
820
+	 *
821
+	 * @return array
822
+	 */
823
+	protected function _event_legend_items()
824
+	{
825
+		$items = array(
826
+			'view_details'   => array(
827
+				'class' => 'dashicons dashicons-search',
828
+				'desc'  => esc_html__('View Event', 'event_espresso'),
829
+			),
830
+			'edit_event'     => array(
831
+				'class' => 'ee-icon ee-icon-calendar-edit',
832
+				'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
833
+			),
834
+			'view_attendees' => array(
835
+				'class' => 'dashicons dashicons-groups',
836
+				'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
837
+			),
838
+		);
839
+		$items = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
840
+		$statuses = array(
841
+			'sold_out_status'  => array(
842
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::sold_out,
843
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
844
+			),
845
+			'active_status'    => array(
846
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::active,
847
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
848
+			),
849
+			'upcoming_status'  => array(
850
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::upcoming,
851
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
852
+			),
853
+			'postponed_status' => array(
854
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::postponed,
855
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
856
+			),
857
+			'cancelled_status' => array(
858
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::cancelled,
859
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
860
+			),
861
+			'expired_status'   => array(
862
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::expired,
863
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
864
+			),
865
+			'inactive_status'  => array(
866
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::inactive,
867
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
868
+			),
869
+		);
870
+		$statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
871
+		return array_merge($items, $statuses);
872
+	}
873
+
874
+
875
+	/**
876
+	 * @return EEM_Event
877
+	 */
878
+	private function _event_model()
879
+	{
880
+		if (! $this->_event_model instanceof EEM_Event) {
881
+			$this->_event_model = EE_Registry::instance()->load_model('Event');
882
+		}
883
+		return $this->_event_model;
884
+	}
885
+
886
+
887
+	/**
888
+	 * Adds extra buttons to the WP CPT permalink field row.
889
+	 * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
890
+	 *
891
+	 * @param  string $return    the current html
892
+	 * @param  int    $id        the post id for the page
893
+	 * @param  string $new_title What the title is
894
+	 * @param  string $new_slug  what the slug is
895
+	 * @return string            The new html string for the permalink area
896
+	 */
897
+	public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
898
+	{
899
+		// make sure this is only when editing
900
+		if (! empty($id)) {
901
+			$post = get_post($id);
902
+			$return .= '<a class="button button-small" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#"  tabindex="-1">'
903
+					   . esc_html__('Shortcode', 'event_espresso')
904
+					   . '</a> ';
905
+			$return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id='
906
+					   . $post->ID
907
+					   . ']">';
908
+		}
909
+		return $return;
910
+	}
911
+
912
+
913
+	/**
914
+	 * _events_overview_list_table
915
+	 * This contains the logic for showing the events_overview list
916
+	 *
917
+	 * @access protected
918
+	 * @return void
919
+	 * @throws \EE_Error
920
+	 */
921
+	protected function _events_overview_list_table()
922
+	{
923
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
924
+		$this->_template_args['after_list_table'] = ! empty($this->_template_args['after_list_table'])
925
+			? (array) $this->_template_args['after_list_table']
926
+			: array();
927
+		$this->_template_args['after_list_table']['view_event_list_button'] = EEH_HTML::br()
928
+				. EEH_Template::get_button_or_link(
929
+					get_post_type_archive_link('espresso_events'),
930
+					esc_html__("View Event Archive Page", "event_espresso"),
931
+					'button'
932
+				);
933
+		$this->_template_args['after_list_table']['legend'] = $this->_display_legend($this->_event_legend_items());
934
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
935
+			'create_new',
936
+			'add',
937
+			array(),
938
+			'add-new-h2'
939
+		);
940
+		$this->display_admin_list_table_page_with_no_sidebar();
941
+	}
942
+
943
+
944
+	/**
945
+	 * this allows for extra misc actions in the default WP publish box
946
+	 *
947
+	 * @return void
948
+	 */
949
+	public function extra_misc_actions_publish_box()
950
+	{
951
+		$this->_generate_publish_box_extra_content();
952
+	}
953
+
954
+
955
+	/**
956
+	 * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
957
+	 * saved.
958
+	 * Typically you would use this to save any additional data.
959
+	 * Keep in mind also that "save_post" runs on EVERY post update to the database.
960
+	 * ALSO very important.  When a post transitions from scheduled to published,
961
+	 * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from
962
+	 * other meta saves. So MAKE sure that you handle this accordingly.
963
+	 *
964
+	 * @access protected
965
+	 * @abstract
966
+	 * @param  string $post_id The ID of the cpt that was saved (so you can link relationally)
967
+	 * @param  object $post    The post object of the cpt that was saved.
968
+	 * @return void
969
+	 * @throws \EE_Error
970
+	 */
971
+	protected function _insert_update_cpt_item($post_id, $post)
972
+	{
973
+		if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
974
+			// get out we're not processing an event save.
975
+			return;
976
+		}
977
+		$event_values = array(
978
+			'EVT_display_desc'                => ! empty($this->_req_data['display_desc']) ? 1 : 0,
979
+			'EVT_display_ticket_selector'     => ! empty($this->_req_data['display_ticket_selector']) ? 1 : 0,
980
+			'EVT_additional_limit'            => min(
981
+				apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
982
+				! empty($this->_req_data['additional_limit']) ? $this->_req_data['additional_limit'] : null
983
+			),
984
+			'EVT_default_registration_status' => ! empty($this->_req_data['EVT_default_registration_status'])
985
+				? $this->_req_data['EVT_default_registration_status']
986
+				: EE_Registry::instance()->CFG->registration->default_STS_ID,
987
+			'EVT_member_only'                 => ! empty($this->_req_data['member_only']) ? 1 : 0,
988
+			'EVT_allow_overflow'              => ! empty($this->_req_data['EVT_allow_overflow']) ? 1 : 0,
989
+			'EVT_timezone_string'             => ! empty($this->_req_data['timezone_string'])
990
+				? $this->_req_data['timezone_string'] : null,
991
+			'EVT_external_URL'                => ! empty($this->_req_data['externalURL'])
992
+				? $this->_req_data['externalURL'] : null,
993
+			'EVT_phone'                       => ! empty($this->_req_data['event_phone'])
994
+				? $this->_req_data['event_phone'] : null,
995
+		);
996
+		// update event
997
+		$success = $this->_event_model()->update_by_ID($event_values, $post_id);
998
+		// get event_object for other metaboxes... though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
999
+		$get_one_where = array(
1000
+			$this->_event_model()->primary_key_name() => $post_id,
1001
+			'OR'                                      => array(
1002
+				'status'   => $post->post_status,
1003
+				// if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
1004
+				// but the returned object here has a status of "publish", so use the original post status as well
1005
+				'status*1' => $this->_req_data['original_post_status'],
1006
+			),
1007
+		);
1008
+		$event = $this->_event_model()->get_one(array($get_one_where));
1009
+		// the following are default callbacks for event attachment updates that can be overridden by caffeinated functionality and/or addons.
1010
+		$event_update_callbacks = apply_filters(
1011
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
1012
+			array(
1013
+				array($this, '_default_venue_update'),
1014
+				array($this, '_default_tickets_update'),
1015
+			)
1016
+		);
1017
+		$att_success = true;
1018
+		foreach ($event_update_callbacks as $e_callback) {
1019
+			$_success = is_callable($e_callback)
1020
+				? call_user_func($e_callback, $event, $this->_req_data)
1021
+				: false;
1022
+			// if ANY of these updates fail then we want the appropriate global error message
1023
+			$att_success = ! $att_success ? $att_success : $_success;
1024
+		}
1025
+		// any errors?
1026
+		if ($success && false === $att_success) {
1027
+			EE_Error::add_error(
1028
+				esc_html__(
1029
+					'Event Details saved successfully but something went wrong with saving attachments.',
1030
+					'event_espresso'
1031
+				),
1032
+				__FILE__,
1033
+				__FUNCTION__,
1034
+				__LINE__
1035
+			);
1036
+		} elseif ($success === false) {
1037
+			EE_Error::add_error(
1038
+				esc_html__('Event Details did not save successfully.', 'event_espresso'),
1039
+				__FILE__,
1040
+				__FUNCTION__,
1041
+				__LINE__
1042
+			);
1043
+		}
1044
+	}
1045
+
1046
+
1047
+	/**
1048
+	 * @see parent::restore_item()
1049
+	 * @param int $post_id
1050
+	 * @param int $revision_id
1051
+	 */
1052
+	protected function _restore_cpt_item($post_id, $revision_id)
1053
+	{
1054
+		// copy existing event meta to new post
1055
+		$post_evt = $this->_event_model()->get_one_by_ID($post_id);
1056
+		if ($post_evt instanceof EE_Event) {
1057
+			// meta revision restore
1058
+			$post_evt->restore_revision($revision_id);
1059
+			// related objs restore
1060
+			$post_evt->restore_revision($revision_id, array('Venue', 'Datetime', 'Price'));
1061
+		}
1062
+	}
1063
+
1064
+
1065
+	/**
1066
+	 * Attach the venue to the Event
1067
+	 *
1068
+	 * @param  \EE_Event $evtobj Event Object to add the venue to
1069
+	 * @param  array     $data   The request data from the form
1070
+	 * @return bool           Success or fail.
1071
+	 */
1072
+	protected function _default_venue_update(\EE_Event $evtobj, $data)
1073
+	{
1074
+		require_once(EE_MODELS . 'EEM_Venue.model.php');
1075
+		$venue_model = EE_Registry::instance()->load_model('Venue');
1076
+		$rows_affected = null;
1077
+		$venue_id = ! empty($data['venue_id']) ? $data['venue_id'] : null;
1078
+		// very important.  If we don't have a venue name...
1079
+		// then we'll get out because not necessary to create empty venue
1080
+		if (empty($data['venue_title'])) {
1081
+			return false;
1082
+		}
1083
+		$venue_array = array(
1084
+			'VNU_wp_user'         => $evtobj->get('EVT_wp_user'),
1085
+			'VNU_name'            => ! empty($data['venue_title']) ? $data['venue_title'] : null,
1086
+			'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
1087
+			'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
1088
+			'VNU_short_desc'      => ! empty($data['venue_short_description']) ? $data['venue_short_description']
1089
+				: null,
1090
+			'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
1091
+			'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
1092
+			'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
1093
+			'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
1094
+			'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
1095
+			'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
1096
+			'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
1097
+			'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
1098
+			'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
1099
+			'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
1100
+			'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
1101
+			'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
1102
+			'status'              => 'publish',
1103
+		);
1104
+		// if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
1105
+		if (! empty($venue_id)) {
1106
+			$update_where = array($venue_model->primary_key_name() => $venue_id);
1107
+			$rows_affected = $venue_model->update($venue_array, array($update_where));
1108
+			// we've gotta make sure that the venue is always attached to a revision.. add_relation_to should take care of making sure that the relation is already present.
1109
+			$evtobj->_add_relation_to($venue_id, 'Venue');
1110
+			return $rows_affected > 0 ? true : false;
1111
+		} else {
1112
+			// we insert the venue
1113
+			$venue_id = $venue_model->insert($venue_array);
1114
+			$evtobj->_add_relation_to($venue_id, 'Venue');
1115
+			return ! empty($venue_id) ? true : false;
1116
+		}
1117
+		// when we have the ancestor come in it's already been handled by the revision save.
1118
+	}
1119
+
1120
+
1121
+	/**
1122
+	 * Handles saving everything related to Tickets (datetimes, tickets, prices)
1123
+	 *
1124
+	 * @param  EE_Event $evtobj The Event object we're attaching data to
1125
+	 * @param  array    $data   The request data from the form
1126
+	 * @return array
1127
+	 */
1128
+	protected function _default_tickets_update(EE_Event $evtobj, $data)
1129
+	{
1130
+		$success = true;
1131
+		$saved_dtt = null;
1132
+		$saved_tickets = array();
1133
+		$incoming_date_formats = array('Y-m-d', 'h:i a');
1134
+		foreach ($data['edit_event_datetimes'] as $row => $dtt) {
1135
+			// trim all values to ensure any excess whitespace is removed.
1136
+			$dtt = array_map('trim', $dtt);
1137
+			$dtt['DTT_EVT_end'] = isset($dtt['DTT_EVT_end']) && ! empty($dtt['DTT_EVT_end']) ? $dtt['DTT_EVT_end']
1138
+				: $dtt['DTT_EVT_start'];
1139
+			$datetime_values = array(
1140
+				'DTT_ID'        => ! empty($dtt['DTT_ID']) ? $dtt['DTT_ID'] : null,
1141
+				'DTT_EVT_start' => $dtt['DTT_EVT_start'],
1142
+				'DTT_EVT_end'   => $dtt['DTT_EVT_end'],
1143
+				'DTT_reg_limit' => empty($dtt['DTT_reg_limit']) ? EE_INF : $dtt['DTT_reg_limit'],
1144
+				'DTT_order'     => $row,
1145
+			);
1146
+			// if we have an id then let's get existing object first and then set the new values.  Otherwise we instantiate a new object for save.
1147
+			if (! empty($dtt['DTT_ID'])) {
1148
+				$DTM = EE_Registry::instance()
1149
+								  ->load_model('Datetime', array($evtobj->get_timezone()))
1150
+								  ->get_one_by_ID($dtt['DTT_ID']);
1151
+				$DTM->set_date_format($incoming_date_formats[0]);
1152
+				$DTM->set_time_format($incoming_date_formats[1]);
1153
+				foreach ($datetime_values as $field => $value) {
1154
+					$DTM->set($field, $value);
1155
+				}
1156
+				// make sure the $dtt_id here is saved just in case after the add_relation_to() the autosave replaces it.  We need to do this so we dont' TRASH the parent DTT.
1157
+				$saved_dtts[ $DTM->ID() ] = $DTM;
1158
+			} else {
1159
+				$DTM = EE_Registry::instance()->load_class(
1160
+					'Datetime',
1161
+					array($datetime_values, $evtobj->get_timezone(), $incoming_date_formats),
1162
+					false,
1163
+					false
1164
+				);
1165
+				foreach ($datetime_values as $field => $value) {
1166
+					$DTM->set($field, $value);
1167
+				}
1168
+			}
1169
+			$DTM->save();
1170
+			$DTT = $evtobj->_add_relation_to($DTM, 'Datetime');
1171
+			// load DTT helper
1172
+			// before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
1173
+			if ($DTT->get_raw('DTT_EVT_start') > $DTT->get_raw('DTT_EVT_end')) {
1174
+				$DTT->set('DTT_EVT_end', $DTT->get('DTT_EVT_start'));
1175
+				$DTT = EEH_DTT_Helper::date_time_add($DTT, 'DTT_EVT_end', 'days');
1176
+				$DTT->save();
1177
+			}
1178
+			// now we got to make sure we add the new DTT_ID to the $saved_dtts array  because it is possible there was a new one created for the autosave.
1179
+			$saved_dtt = $DTT;
1180
+			$success = ! $success ? $success : $DTT;
1181
+			// if ANY of these updates fail then we want the appropriate global error message.
1182
+			// //todo this is actually sucky we need a better error message but this is what it is for now.
1183
+		}
1184
+		// no dtts get deleted so we don't do any of that logic here.
1185
+		// update tickets next
1186
+		$old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array();
1187
+		foreach ($data['edit_tickets'] as $row => $tkt) {
1188
+			$incoming_date_formats = array('Y-m-d', 'h:i a');
1189
+			$update_prices = false;
1190
+			$ticket_price = isset($data['edit_prices'][ $row ][1]['PRC_amount'])
1191
+				? $data['edit_prices'][ $row ][1]['PRC_amount'] : 0;
1192
+			// trim inputs to ensure any excess whitespace is removed.
1193
+			$tkt = array_map('trim', $tkt);
1194
+			if (empty($tkt['TKT_start_date'])) {
1195
+				// let's use now in the set timezone.
1196
+				$now = new DateTime('now', new DateTimeZone($evtobj->get_timezone()));
1197
+				$tkt['TKT_start_date'] = $now->format($incoming_date_formats[0] . ' ' . $incoming_date_formats[1]);
1198
+			}
1199
+			if (empty($tkt['TKT_end_date'])) {
1200
+				// use the start date of the first datetime
1201
+				$dtt = $evtobj->first_datetime();
1202
+				$tkt['TKT_end_date'] = $dtt->start_date_and_time(
1203
+					$incoming_date_formats[0],
1204
+					$incoming_date_formats[1]
1205
+				);
1206
+			}
1207
+			$TKT_values = array(
1208
+				'TKT_ID'          => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null,
1209
+				'TTM_ID'          => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0,
1210
+				'TKT_name'        => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '',
1211
+				'TKT_description' => ! empty($tkt['TKT_description']) ? $tkt['TKT_description'] : '',
1212
+				'TKT_start_date'  => $tkt['TKT_start_date'],
1213
+				'TKT_end_date'    => $tkt['TKT_end_date'],
1214
+				'TKT_qty'         => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' ? EE_INF : $tkt['TKT_qty'],
1215
+				'TKT_uses'        => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' ? EE_INF : $tkt['TKT_uses'],
1216
+				'TKT_min'         => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'],
1217
+				'TKT_max'         => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'],
1218
+				'TKT_row'         => $row,
1219
+				'TKT_order'       => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : $row,
1220
+				'TKT_price'       => $ticket_price,
1221
+			);
1222
+			// if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, which means in turn that the prices will become new prices as well.
1223
+			if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) {
1224
+				$TKT_values['TKT_ID'] = 0;
1225
+				$TKT_values['TKT_is_default'] = 0;
1226
+				$TKT_values['TKT_price'] = $ticket_price;
1227
+				$update_prices = true;
1228
+			}
1229
+			// if we have a TKT_ID then we need to get that existing TKT_obj and update it
1230
+			// we actually do our saves a head of doing any add_relations to because its entirely possible that this ticket didn't removed or added to any datetime in the session but DID have it's items modified.
1231
+			// keep in mind that if the TKT has been sold (and we have changed pricing information), then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
1232
+			if (! empty($tkt['TKT_ID'])) {
1233
+				$TKT = EE_Registry::instance()
1234
+								  ->load_model('Ticket', array($evtobj->get_timezone()))
1235
+								  ->get_one_by_ID($tkt['TKT_ID']);
1236
+				if ($TKT instanceof EE_Ticket) {
1237
+					$ticket_sold = $TKT->count_related(
1238
+						'Registration',
1239
+						array(
1240
+							array(
1241
+								'STS_ID' => array(
1242
+									'NOT IN',
1243
+									array(EEM_Registration::status_id_incomplete),
1244
+								),
1245
+							),
1246
+						)
1247
+					) > 0 ? true : false;
1248
+					// let's just check the total price for the existing ticket and determine if it matches the new total price.  if they are different then we create a new ticket (if tkts sold) if they aren't different then we go ahead and modify existing ticket.
1249
+					$create_new_TKT = $ticket_sold && $ticket_price != $TKT->get('TKT_price')
1250
+									  && ! $TKT->get('TKT_deleted');
1251
+					$TKT->set_date_format($incoming_date_formats[0]);
1252
+					$TKT->set_time_format($incoming_date_formats[1]);
1253
+					// set new values
1254
+					foreach ($TKT_values as $field => $value) {
1255
+						if ($field == 'TKT_qty') {
1256
+							$TKT->set_qty($value);
1257
+						} else {
1258
+							$TKT->set($field, $value);
1259
+						}
1260
+					}
1261
+					// if $create_new_TKT is false then we can safely update the existing ticket.  Otherwise we have to create a new ticket.
1262
+					if ($create_new_TKT) {
1263
+						// archive the old ticket first
1264
+						$TKT->set('TKT_deleted', 1);
1265
+						$TKT->save();
1266
+						// make sure this ticket is still recorded in our saved_tkts so we don't run it through the regular trash routine.
1267
+						$saved_tickets[ $TKT->ID() ] = $TKT;
1268
+						// create new ticket that's a copy of the existing except a new id of course (and not archived) AND has the new TKT_price associated with it.
1269
+						$TKT = clone $TKT;
1270
+						$TKT->set('TKT_ID', 0);
1271
+						$TKT->set('TKT_deleted', 0);
1272
+						$TKT->set('TKT_price', $ticket_price);
1273
+						$TKT->set('TKT_sold', 0);
1274
+						// now we need to make sure that $new prices are created as well and attached to new ticket.
1275
+						$update_prices = true;
1276
+					}
1277
+					// make sure price is set if it hasn't been already
1278
+					$TKT->set('TKT_price', $ticket_price);
1279
+				}
1280
+			} else {
1281
+				// no TKT_id so a new TKT
1282
+				$TKT_values['TKT_price'] = $ticket_price;
1283
+				$TKT = EE_Registry::instance()->load_class('Ticket', array($TKT_values), false, false);
1284
+				if ($TKT instanceof EE_Ticket) {
1285
+					// need to reset values to properly account for the date formats
1286
+					$TKT->set_date_format($incoming_date_formats[0]);
1287
+					$TKT->set_time_format($incoming_date_formats[1]);
1288
+					$TKT->set_timezone($evtobj->get_timezone());
1289
+					// set new values
1290
+					foreach ($TKT_values as $field => $value) {
1291
+						if ($field == 'TKT_qty') {
1292
+							$TKT->set_qty($value);
1293
+						} else {
1294
+							$TKT->set($field, $value);
1295
+						}
1296
+					}
1297
+					$update_prices = true;
1298
+				}
1299
+			}
1300
+			// cap ticket qty by datetime reg limits
1301
+			$TKT->set_qty(min($TKT->qty(), $TKT->qty('reg_limit')));
1302
+			// update ticket.
1303
+			$TKT->save();
1304
+			// before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
1305
+			if ($TKT->get_raw('TKT_start_date') > $TKT->get_raw('TKT_end_date')) {
1306
+				$TKT->set('TKT_end_date', $TKT->get('TKT_start_date'));
1307
+				$TKT = EEH_DTT_Helper::date_time_add($TKT, 'TKT_end_date', 'days');
1308
+				$TKT->save();
1309
+			}
1310
+			// initially let's add the ticket to the dtt
1311
+			$saved_dtt->_add_relation_to($TKT, 'Ticket');
1312
+			$saved_tickets[ $TKT->ID() ] = $TKT;
1313
+			// add prices to ticket
1314
+			$this->_add_prices_to_ticket($data['edit_prices'][ $row ], $TKT, $update_prices);
1315
+		}
1316
+		// however now we need to handle permanently deleting tickets via the ui.  Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold.  However, it does allow for deleting tickets that have no tickets sold, in which case we want to get rid of permanently because there is no need to save in db.
1317
+		$old_tickets = isset($old_tickets[0]) && $old_tickets[0] == '' ? array() : $old_tickets;
1318
+		$tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
1319
+		foreach ($tickets_removed as $id) {
1320
+			$id = absint($id);
1321
+			// get the ticket for this id
1322
+			$tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id);
1323
+			// need to get all the related datetimes on this ticket and remove from every single one of them (remember this process can ONLY kick off if there are NO tkts_sold)
1324
+			$dtts = $tkt_to_remove->get_many_related('Datetime');
1325
+			foreach ($dtts as $dtt) {
1326
+				$tkt_to_remove->_remove_relation_to($dtt, 'Datetime');
1327
+			}
1328
+			// need to do the same for prices (except these prices can also be deleted because again, tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
1329
+			$tkt_to_remove->delete_related_permanently('Price');
1330
+			// finally let's delete this ticket (which should not be blocked at this point b/c we've removed all our relationships)
1331
+			$tkt_to_remove->delete_permanently();
1332
+		}
1333
+		return array($saved_dtt, $saved_tickets);
1334
+	}
1335
+
1336
+
1337
+	/**
1338
+	 * This attaches a list of given prices to a ticket.
1339
+	 * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
1340
+	 * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
1341
+	 * price info and prices are automatically "archived" via the ticket.
1342
+	 *
1343
+	 * @access  private
1344
+	 * @param array     $prices     Array of prices from the form.
1345
+	 * @param EE_Ticket $ticket     EE_Ticket object that prices are being attached to.
1346
+	 * @param bool      $new_prices Whether attach existing incoming prices or create new ones.
1347
+	 * @return  void
1348
+	 */
1349
+	private function _add_prices_to_ticket($prices, EE_Ticket $ticket, $new_prices = false)
1350
+	{
1351
+		foreach ($prices as $row => $prc) {
1352
+			$PRC_values = array(
1353
+				'PRC_ID'         => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null,
1354
+				'PRT_ID'         => ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null,
1355
+				'PRC_amount'     => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0,
1356
+				'PRC_name'       => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '',
1357
+				'PRC_desc'       => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '',
1358
+				'PRC_is_default' => 0, // make sure prices are NOT set as default from this context
1359
+				'PRC_order'      => $row,
1360
+			);
1361
+			if ($new_prices || empty($PRC_values['PRC_ID'])) {
1362
+				$PRC_values['PRC_ID'] = 0;
1363
+				$PRC = EE_Registry::instance()->load_class('Price', array($PRC_values), false, false);
1364
+			} else {
1365
+				$PRC = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']);
1366
+				// update this price with new values
1367
+				foreach ($PRC_values as $field => $newprc) {
1368
+					$PRC->set($field, $newprc);
1369
+				}
1370
+				$PRC->save();
1371
+			}
1372
+			$ticket->_add_relation_to($PRC, 'Price');
1373
+		}
1374
+	}
1375
+
1376
+
1377
+	/**
1378
+	 * Add in our autosave ajax handlers
1379
+	 *
1380
+	 */
1381
+	protected function _ee_autosave_create_new()
1382
+	{
1383
+	}
1384
+
1385
+
1386
+	/**
1387
+	 * More autosave handlers.
1388
+	 */
1389
+	protected function _ee_autosave_edit()
1390
+	{
1391
+		return; // TEMPORARILY EXITING CAUSE THIS IS A TODO
1392
+	}
1393
+
1394
+
1395
+	/**
1396
+	 *    _generate_publish_box_extra_content
1397
+	 */
1398
+	private function _generate_publish_box_extra_content()
1399
+	{
1400
+		// load formatter helper
1401
+		// args for getting related registrations
1402
+		$approved_query_args = array(
1403
+			array(
1404
+				'REG_deleted' => 0,
1405
+				'STS_ID'      => EEM_Registration::status_id_approved,
1406
+			),
1407
+		);
1408
+		$not_approved_query_args = array(
1409
+			array(
1410
+				'REG_deleted' => 0,
1411
+				'STS_ID'      => EEM_Registration::status_id_not_approved,
1412
+			),
1413
+		);
1414
+		$pending_payment_query_args = array(
1415
+			array(
1416
+				'REG_deleted' => 0,
1417
+				'STS_ID'      => EEM_Registration::status_id_pending_payment,
1418
+			),
1419
+		);
1420
+		// publish box
1421
+		$publish_box_extra_args = array(
1422
+			'view_approved_reg_url'        => add_query_arg(
1423
+				array(
1424
+					'action'      => 'default',
1425
+					'event_id'    => $this->_cpt_model_obj->ID(),
1426
+					'_reg_status' => EEM_Registration::status_id_approved,
1427
+				),
1428
+				REG_ADMIN_URL
1429
+			),
1430
+			'view_not_approved_reg_url'    => add_query_arg(
1431
+				array(
1432
+					'action'      => 'default',
1433
+					'event_id'    => $this->_cpt_model_obj->ID(),
1434
+					'_reg_status' => EEM_Registration::status_id_not_approved,
1435
+				),
1436
+				REG_ADMIN_URL
1437
+			),
1438
+			'view_pending_payment_reg_url' => add_query_arg(
1439
+				array(
1440
+					'action'      => 'default',
1441
+					'event_id'    => $this->_cpt_model_obj->ID(),
1442
+					'_reg_status' => EEM_Registration::status_id_pending_payment,
1443
+				),
1444
+				REG_ADMIN_URL
1445
+			),
1446
+			'approved_regs'                => $this->_cpt_model_obj->count_related(
1447
+				'Registration',
1448
+				$approved_query_args
1449
+			),
1450
+			'not_approved_regs'            => $this->_cpt_model_obj->count_related(
1451
+				'Registration',
1452
+				$not_approved_query_args
1453
+			),
1454
+			'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
1455
+				'Registration',
1456
+				$pending_payment_query_args
1457
+			),
1458
+			'misc_pub_section_class'       => apply_filters(
1459
+				'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
1460
+				'misc-pub-section'
1461
+			),
1462
+		);
1463
+		ob_start();
1464
+		do_action(
1465
+			'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
1466
+			$this->_cpt_model_obj
1467
+		);
1468
+		$publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
1469
+		// load template
1470
+		EEH_Template::display_template(
1471
+			EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
1472
+			$publish_box_extra_args
1473
+		);
1474
+	}
1475
+
1476
+
1477
+	/**
1478
+	 * @return EE_Event
1479
+	 */
1480
+	public function get_event_object()
1481
+	{
1482
+		return $this->_cpt_model_obj;
1483
+	}
1484
+
1485
+
1486
+
1487
+
1488
+	/** METABOXES * */
1489
+	/**
1490
+	 * _register_event_editor_meta_boxes
1491
+	 * add all metaboxes related to the event_editor
1492
+	 *
1493
+	 * @return void
1494
+	 */
1495
+	protected function _register_event_editor_meta_boxes()
1496
+	{
1497
+		$this->verify_cpt_object();
1498
+		add_meta_box(
1499
+			'espresso_event_editor_tickets',
1500
+			esc_html__('Event Datetime & Ticket', 'event_espresso'),
1501
+			array($this, 'ticket_metabox'),
1502
+			$this->page_slug,
1503
+			'normal',
1504
+			'high'
1505
+		);
1506
+		add_meta_box(
1507
+			'espresso_event_editor_event_options',
1508
+			esc_html__('Event Registration Options', 'event_espresso'),
1509
+			array($this, 'registration_options_meta_box'),
1510
+			$this->page_slug,
1511
+			'side',
1512
+			'default'
1513
+		);
1514
+		// NOTE: if you're looking for other metaboxes in here,
1515
+		// where a metabox has a related management page in the admin
1516
+		// you will find it setup in the related management page's "_Hooks" file.
1517
+		// i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
1518
+	}
1519
+
1520
+
1521
+	/**
1522
+	 * @throws DomainException
1523
+	 * @throws EE_Error
1524
+	 */
1525
+	public function ticket_metabox()
1526
+	{
1527
+		$existing_datetime_ids = $existing_ticket_ids = array();
1528
+		// defaults for template args
1529
+		$template_args = array(
1530
+			'existing_datetime_ids'    => '',
1531
+			'event_datetime_help_link' => '',
1532
+			'ticket_options_help_link' => '',
1533
+			'time'                     => null,
1534
+			'ticket_rows'              => '',
1535
+			'existing_ticket_ids'      => '',
1536
+			'total_ticket_rows'        => 1,
1537
+			'ticket_js_structure'      => '',
1538
+			'trash_icon'               => 'ee-lock-icon',
1539
+			'disabled'                 => '',
1540
+		);
1541
+		$event_id = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
1542
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1543
+		/**
1544
+		 * 1. Start with retrieving Datetimes
1545
+		 * 2. Fore each datetime get related tickets
1546
+		 * 3. For each ticket get related prices
1547
+		 */
1548
+		$times = EE_Registry::instance()->load_model('Datetime')->get_all_event_dates($event_id);
1549
+		/** @type EE_Datetime $first_datetime */
1550
+		$first_datetime = reset($times);
1551
+		// do we get related tickets?
1552
+		if ($first_datetime instanceof EE_Datetime
1553
+			&& $first_datetime->ID() !== 0
1554
+		) {
1555
+			$existing_datetime_ids[] = $first_datetime->get('DTT_ID');
1556
+			$template_args['time'] = $first_datetime;
1557
+			$related_tickets = $first_datetime->tickets(
1558
+				array(
1559
+					array('OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0)),
1560
+					'default_where_conditions' => 'none',
1561
+				)
1562
+			);
1563
+			if (! empty($related_tickets)) {
1564
+				$template_args['total_ticket_rows'] = count($related_tickets);
1565
+				$row = 0;
1566
+				foreach ($related_tickets as $ticket) {
1567
+					$existing_ticket_ids[] = $ticket->get('TKT_ID');
1568
+					$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
1569
+					$row++;
1570
+				}
1571
+			} else {
1572
+				$template_args['total_ticket_rows'] = 1;
1573
+				/** @type EE_Ticket $ticket */
1574
+				$ticket = EE_Registry::instance()->load_model('Ticket')->create_default_object();
1575
+				$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
1576
+			}
1577
+		} else {
1578
+			$template_args['time'] = $times[0];
1579
+			/** @type EE_Ticket $ticket */
1580
+			$ticket = EE_Registry::instance()->load_model('Ticket')->get_all_default_tickets();
1581
+			$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket[1]);
1582
+			// NOTE: we're just sending the first default row
1583
+			// (decaf can't manage default tickets so this should be sufficient);
1584
+		}
1585
+		$template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
1586
+			'event_editor_event_datetimes_help_tab'
1587
+		);
1588
+		$template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
1589
+		$template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids);
1590
+		$template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids);
1591
+		$template_args['ticket_js_structure'] = $this->_get_ticket_row(
1592
+			EE_Registry::instance()->load_model('Ticket')->create_default_object(),
1593
+			true
1594
+		);
1595
+		$template = apply_filters(
1596
+			'FHEE__Events_Admin_Page__ticket_metabox__template',
1597
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
1598
+		);
1599
+		EEH_Template::display_template($template, $template_args);
1600
+	}
1601
+
1602
+
1603
+	/**
1604
+	 * Setup an individual ticket form for the decaf event editor page
1605
+	 *
1606
+	 * @access private
1607
+	 * @param  EE_Ticket $ticket   the ticket object
1608
+	 * @param  boolean   $skeleton whether we're generating a skeleton for js manipulation
1609
+	 * @param int        $row
1610
+	 * @return string generated html for the ticket row.
1611
+	 */
1612
+	private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
1613
+	{
1614
+		$template_args = array(
1615
+			'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
1616
+			'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
1617
+				: '',
1618
+			'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
1619
+			'TKT_ID'              => $ticket->get('TKT_ID'),
1620
+			'TKT_name'            => $ticket->get('TKT_name'),
1621
+			'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
1622
+			'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
1623
+			'TKT_is_default'      => $ticket->get('TKT_is_default'),
1624
+			'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
1625
+			'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
1626
+			'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
1627
+			'trash_icon'          => ($skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')))
1628
+									 && (! empty($ticket) && $ticket->get('TKT_sold') === 0)
1629
+				? 'trash-icon dashicons dashicons-post-trash clickable' : 'ee-lock-icon',
1630
+			'disabled'            => $skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
1631
+				: ' disabled=disabled',
1632
+		);
1633
+		$price = $ticket->ID() !== 0
1634
+			? $ticket->get_first_related('Price', array('default_where_conditions' => 'none'))
1635
+			: EE_Registry::instance()->load_model('Price')->create_default_object();
1636
+		$price_args = array(
1637
+			'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
1638
+			'PRC_amount'            => $price->get('PRC_amount'),
1639
+			'PRT_ID'                => $price->get('PRT_ID'),
1640
+			'PRC_ID'                => $price->get('PRC_ID'),
1641
+			'PRC_is_default'        => $price->get('PRC_is_default'),
1642
+		);
1643
+		// make sure we have default start and end dates if skeleton
1644
+		// handle rows that should NOT be empty
1645
+		if (empty($template_args['TKT_start_date'])) {
1646
+			// if empty then the start date will be now.
1647
+			$template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
1648
+		}
1649
+		if (empty($template_args['TKT_end_date'])) {
1650
+			// get the earliest datetime (if present);
1651
+			$earliest_dtt = $this->_cpt_model_obj->ID() > 0
1652
+				? $this->_cpt_model_obj->get_first_related(
1653
+					'Datetime',
1654
+					array('order_by' => array('DTT_EVT_start' => 'ASC'))
1655
+				)
1656
+				: null;
1657
+			if (! empty($earliest_dtt)) {
1658
+				$template_args['TKT_end_date'] = $earliest_dtt->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a');
1659
+			} else {
1660
+				$template_args['TKT_end_date'] = date(
1661
+					'Y-m-d h:i a',
1662
+					mktime(0, 0, 0, date("m"), date("d") + 7, date("Y"))
1663
+				);
1664
+			}
1665
+		}
1666
+		$template_args = array_merge($template_args, $price_args);
1667
+		$template = apply_filters(
1668
+			'FHEE__Events_Admin_Page__get_ticket_row__template',
1669
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
1670
+			$ticket
1671
+		);
1672
+		return EEH_Template::display_template($template, $template_args, true);
1673
+	}
1674
+
1675
+
1676
+	/**
1677
+	 * @throws DomainException
1678
+	 */
1679
+	public function registration_options_meta_box()
1680
+	{
1681
+		$yes_no_values = array(
1682
+			array('id' => true, 'text' => esc_html__('Yes', 'event_espresso')),
1683
+			array('id' => false, 'text' => esc_html__('No', 'event_espresso')),
1684
+		);
1685
+		$default_reg_status_values = EEM_Registration::reg_status_array(
1686
+			array(
1687
+				EEM_Registration::status_id_cancelled,
1688
+				EEM_Registration::status_id_declined,
1689
+				EEM_Registration::status_id_incomplete,
1690
+			),
1691
+			true
1692
+		);
1693
+		// $template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
1694
+		$template_args['_event'] = $this->_cpt_model_obj;
1695
+		$template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false);
1696
+		$template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit();
1697
+		$template_args['default_registration_status'] = EEH_Form_Fields::select_input(
1698
+			'default_reg_status',
1699
+			$default_reg_status_values,
1700
+			$this->_cpt_model_obj->default_registration_status()
1701
+		);
1702
+		$template_args['display_description'] = EEH_Form_Fields::select_input(
1703
+			'display_desc',
1704
+			$yes_no_values,
1705
+			$this->_cpt_model_obj->display_description()
1706
+		);
1707
+		$template_args['display_ticket_selector'] = EEH_Form_Fields::select_input(
1708
+			'display_ticket_selector',
1709
+			$yes_no_values,
1710
+			$this->_cpt_model_obj->display_ticket_selector(),
1711
+			'',
1712
+			'',
1713
+			false
1714
+		);
1715
+		$template_args['additional_registration_options'] = apply_filters(
1716
+			'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
1717
+			'',
1718
+			$template_args,
1719
+			$yes_no_values,
1720
+			$default_reg_status_values
1721
+		);
1722
+		EEH_Template::display_template(
1723
+			EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php',
1724
+			$template_args
1725
+		);
1726
+	}
1727
+
1728
+
1729
+	/**
1730
+	 * _get_events()
1731
+	 * This method simply returns all the events (for the given _view and paging)
1732
+	 *
1733
+	 * @access public
1734
+	 * @param int  $per_page     count of items per page (20 default);
1735
+	 * @param int  $current_page what is the current page being viewed.
1736
+	 * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
1737
+	 *                           If FALSE then we return an array of event objects
1738
+	 *                           that match the given _view and paging parameters.
1739
+	 * @return array an array of event objects.
1740
+	 */
1741
+	public function get_events($per_page = 10, $current_page = 1, $count = false)
1742
+	{
1743
+		$EEME = $this->_event_model();
1744
+		$offset = ($current_page - 1) * $per_page;
1745
+		$limit = $count ? null : $offset . ',' . $per_page;
1746
+		$orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'EVT_ID';
1747
+		$order = isset($this->_req_data['order']) ? $this->_req_data['order'] : "DESC";
1748
+		if (isset($this->_req_data['month_range'])) {
1749
+			$pieces = explode(' ', $this->_req_data['month_range'], 3);
1750
+			// simulate the FIRST day of the month, that fixes issues for months like February
1751
+			// where PHP doesn't know what to assume for date.
1752
+			// @see https://events.codebasehq.com/projects/event-espresso/tickets/10437
1753
+			$month_r = ! empty($pieces[0]) ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
1754
+			$year_r = ! empty($pieces[1]) ? $pieces[1] : '';
1755
+		}
1756
+		$where = array();
1757
+		$status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
1758
+		// determine what post_status our condition will have for the query.
1759
+		switch ($status) {
1760
+			case 'month':
1761
+			case 'today':
1762
+			case null:
1763
+			case 'all':
1764
+				break;
1765
+			case 'draft':
1766
+				$where['status'] = array('IN', array('draft', 'auto-draft'));
1767
+				break;
1768
+			default:
1769
+				$where['status'] = $status;
1770
+		}
1771
+		// categories?
1772
+		$category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0
1773
+			? $this->_req_data['EVT_CAT'] : null;
1774
+		if (! empty($category)) {
1775
+			$where['Term_Taxonomy.taxonomy'] = EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY;
1776
+			$where['Term_Taxonomy.term_id'] = $category;
1777
+		}
1778
+		// date where conditions
1779
+		$start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
1780
+		if (isset($this->_req_data['month_range']) && $this->_req_data['month_range'] != '') {
1781
+			$DateTime = new DateTime(
1782
+				$year_r . '-' . $month_r . '-01 00:00:00',
1783
+				new DateTimeZone(EEM_Datetime::instance()->get_timezone())
1784
+			);
1785
+			$start = $DateTime->format(implode(' ', $start_formats));
1786
+			$end = $DateTime->setDate(
1787
+				$year_r,
1788
+				$month_r,
1789
+				$DateTime
1790
+					->format('t')
1791
+			)->setTime(23, 59, 59)
1792
+							->format(implode(' ', $start_formats));
1793
+			$where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
1794
+		} elseif (isset($this->_req_data['status']) && $this->_req_data['status'] == 'today') {
1795
+			$DateTime = new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
1796
+			$start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
1797
+			$end = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
1798
+			$where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
1799
+		} elseif (isset($this->_req_data['status']) && $this->_req_data['status'] == 'month') {
1800
+			$now = date('Y-m-01');
1801
+			$DateTime = new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
1802
+			$start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
1803
+			$end = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
1804
+							->setTime(23, 59, 59)
1805
+							->format(implode(' ', $start_formats));
1806
+			$where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
1807
+		}
1808
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
1809
+			$where['EVT_wp_user'] = get_current_user_id();
1810
+		} else {
1811
+			if (! isset($where['status'])) {
1812
+				if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
1813
+					$where['OR'] = array(
1814
+						'status*restrict_private' => array('!=', 'private'),
1815
+						'AND'                     => array(
1816
+							'status*inclusive' => array('=', 'private'),
1817
+							'EVT_wp_user'      => get_current_user_id(),
1818
+						),
1819
+					);
1820
+				}
1821
+			}
1822
+		}
1823
+		if (isset($this->_req_data['EVT_wp_user'])) {
1824
+			if ($this->_req_data['EVT_wp_user'] != get_current_user_id()
1825
+				&& EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
1826
+			) {
1827
+				$where['EVT_wp_user'] = $this->_req_data['EVT_wp_user'];
1828
+			}
1829
+		}
1830
+		// search query handling
1831
+		if (isset($this->_req_data['s'])) {
1832
+			$search_string = '%' . $this->_req_data['s'] . '%';
1833
+			$where['OR'] = array(
1834
+				'EVT_name'       => array('LIKE', $search_string),
1835
+				'EVT_desc'       => array('LIKE', $search_string),
1836
+				'EVT_short_desc' => array('LIKE', $search_string),
1837
+			);
1838
+		}
1839
+		$where = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $this->_req_data);
1840
+		$query_params = apply_filters(
1841
+			'FHEE__Events_Admin_Page__get_events__query_params',
1842
+			array(
1843
+				$where,
1844
+				'limit'    => $limit,
1845
+				'order_by' => $orderby,
1846
+				'order'    => $order,
1847
+				'group_by' => 'EVT_ID',
1848
+			),
1849
+			$this->_req_data
1850
+		);
1851
+		// let's first check if we have special requests coming in.
1852
+		if (isset($this->_req_data['active_status'])) {
1853
+			switch ($this->_req_data['active_status']) {
1854
+				case 'upcoming':
1855
+					return $EEME->get_upcoming_events($query_params, $count);
1856
+					break;
1857
+				case 'expired':
1858
+					return $EEME->get_expired_events($query_params, $count);
1859
+					break;
1860
+				case 'active':
1861
+					return $EEME->get_active_events($query_params, $count);
1862
+					break;
1863
+				case 'inactive':
1864
+					return $EEME->get_inactive_events($query_params, $count);
1865
+					break;
1866
+			}
1867
+		}
1868
+		$events = $count ? $EEME->count(array($where), 'EVT_ID', true) : $EEME->get_all($query_params);
1869
+		return $events;
1870
+	}
1871
+
1872
+
1873
+	/**
1874
+	 * handling for WordPress CPT actions (trash, restore, delete)
1875
+	 *
1876
+	 * @param string $post_id
1877
+	 */
1878
+	public function trash_cpt_item($post_id)
1879
+	{
1880
+		$this->_req_data['EVT_ID'] = $post_id;
1881
+		$this->_trash_or_restore_event('trash', false);
1882
+	}
1883
+
1884
+
1885
+	/**
1886
+	 * @param string $post_id
1887
+	 */
1888
+	public function restore_cpt_item($post_id)
1889
+	{
1890
+		$this->_req_data['EVT_ID'] = $post_id;
1891
+		$this->_trash_or_restore_event('draft', false);
1892
+	}
1893
+
1894
+
1895
+	/**
1896
+	 * @param string $post_id
1897
+	 */
1898
+	public function delete_cpt_item($post_id)
1899
+	{
1900
+		$this->_req_data['EVT_ID'] = $post_id;
1901
+		$this->_delete_event(false);
1902
+	}
1903
+
1904
+
1905
+	/**
1906
+	 * _trash_or_restore_event
1907
+	 *
1908
+	 * @access protected
1909
+	 * @param  string $event_status
1910
+	 * @param bool    $redirect_after
1911
+	 */
1912
+	protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true)
1913
+	{
1914
+		// determine the event id and set to array.
1915
+		$EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : false;
1916
+		// loop thru events
1917
+		if ($EVT_ID) {
1918
+			// clean status
1919
+			$event_status = sanitize_key($event_status);
1920
+			// grab status
1921
+			if (! empty($event_status)) {
1922
+				$success = $this->_change_event_status($EVT_ID, $event_status);
1923
+			} else {
1924
+				$success = false;
1925
+				$msg = esc_html__(
1926
+					'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
1927
+					'event_espresso'
1928
+				);
1929
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
1930
+			}
1931
+		} else {
1932
+			$success = false;
1933
+			$msg = esc_html__(
1934
+				'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
1935
+				'event_espresso'
1936
+			);
1937
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
1938
+		}
1939
+		$action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
1940
+		if ($redirect_after) {
1941
+			$this->_redirect_after_action($success, 'Event', $action, array('action' => 'default'));
1942
+		}
1943
+	}
1944
+
1945
+
1946
+	/**
1947
+	 * _trash_or_restore_events
1948
+	 *
1949
+	 * @access protected
1950
+	 * @param  string $event_status
1951
+	 * @return void
1952
+	 */
1953
+	protected function _trash_or_restore_events($event_status = 'trash')
1954
+	{
1955
+		// clean status
1956
+		$event_status = sanitize_key($event_status);
1957
+		// grab status
1958
+		if (! empty($event_status)) {
1959
+			$success = true;
1960
+			// determine the event id and set to array.
1961
+			$EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array) $this->_req_data['EVT_IDs'] : array();
1962
+			// loop thru events
1963
+			foreach ($EVT_IDs as $EVT_ID) {
1964
+				if ($EVT_ID = absint($EVT_ID)) {
1965
+					$results = $this->_change_event_status($EVT_ID, $event_status);
1966
+					$success = $results !== false ? $success : false;
1967
+				} else {
1968
+					$msg = sprintf(
1969
+						esc_html__(
1970
+							'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
1971
+							'event_espresso'
1972
+						),
1973
+						$EVT_ID
1974
+					);
1975
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
1976
+					$success = false;
1977
+				}
1978
+			}
1979
+		} else {
1980
+			$success = false;
1981
+			$msg = esc_html__(
1982
+				'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
1983
+				'event_espresso'
1984
+			);
1985
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
1986
+		}
1987
+		// in order to force a pluralized result message we need to send back a success status greater than 1
1988
+		$success = $success ? 2 : false;
1989
+		$action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
1990
+		$this->_redirect_after_action($success, 'Events', $action, array('action' => 'default'));
1991
+	}
1992
+
1993
+
1994
+	/**
1995
+	 * _trash_or_restore_events
1996
+	 *
1997
+	 * @access  private
1998
+	 * @param  int    $EVT_ID
1999
+	 * @param  string $event_status
2000
+	 * @return bool
2001
+	 */
2002
+	private function _change_event_status($EVT_ID = 0, $event_status = '')
2003
+	{
2004
+		// grab event id
2005
+		if (! $EVT_ID) {
2006
+			$msg = esc_html__(
2007
+				'An error occurred. No Event ID or an invalid Event ID was received.',
2008
+				'event_espresso'
2009
+			);
2010
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2011
+			return false;
2012
+		}
2013
+		$this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
2014
+		// clean status
2015
+		$event_status = sanitize_key($event_status);
2016
+		// grab status
2017
+		if (empty($event_status)) {
2018
+			$msg = esc_html__(
2019
+				'An error occurred. No Event Status or an invalid Event Status was received.',
2020
+				'event_espresso'
2021
+			);
2022
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2023
+			return false;
2024
+		}
2025
+		// was event trashed or restored ?
2026
+		switch ($event_status) {
2027
+			case 'draft':
2028
+				$action = 'restored from the trash';
2029
+				$hook = 'AHEE_event_restored_from_trash';
2030
+				break;
2031
+			case 'trash':
2032
+				$action = 'moved to the trash';
2033
+				$hook = 'AHEE_event_moved_to_trash';
2034
+				break;
2035
+			default:
2036
+				$action = 'updated';
2037
+				$hook = false;
2038
+		}
2039
+		// use class to change status
2040
+		$this->_cpt_model_obj->set_status($event_status);
2041
+		$success = $this->_cpt_model_obj->save();
2042
+		if ($success === false) {
2043
+			$msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
2044
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2045
+			return false;
2046
+		}
2047
+		if ($hook) {
2048
+			do_action($hook);
2049
+		}
2050
+		return true;
2051
+	}
2052
+
2053
+
2054
+	/**
2055
+	 * _delete_event
2056
+	 *
2057
+	 * @access protected
2058
+	 * @param bool $redirect_after
2059
+	 */
2060
+	protected function _delete_event($redirect_after = true)
2061
+	{
2062
+		// determine the event id and set to array.
2063
+		$EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : null;
2064
+		$EVT_ID = isset($this->_req_data['post']) ? absint($this->_req_data['post']) : $EVT_ID;
2065
+		// loop thru events
2066
+		if ($EVT_ID) {
2067
+			$success = $this->_permanently_delete_event($EVT_ID);
2068
+			// get list of events with no prices
2069
+			$espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
2070
+			// remove this event from the list of events with no prices
2071
+			if (isset($espresso_no_ticket_prices[ $EVT_ID ])) {
2072
+				unset($espresso_no_ticket_prices[ $EVT_ID ]);
2073
+			}
2074
+			update_option('ee_no_ticket_prices', $espresso_no_ticket_prices);
2075
+		} else {
2076
+			$success = false;
2077
+			$msg = esc_html__(
2078
+				'An error occurred. An event could not be deleted because a valid event ID was not not supplied.',
2079
+				'event_espresso'
2080
+			);
2081
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2082
+		}
2083
+		if ($redirect_after) {
2084
+			$this->_redirect_after_action(
2085
+				$success,
2086
+				'Event',
2087
+				'deleted',
2088
+				array('action' => 'default', 'status' => 'trash')
2089
+			);
2090
+		}
2091
+	}
2092
+
2093
+
2094
+	/**
2095
+	 * _delete_events
2096
+	 *
2097
+	 * @access protected
2098
+	 * @return void
2099
+	 */
2100
+	protected function _delete_events()
2101
+	{
2102
+		$success = true;
2103
+		// get list of events with no prices
2104
+		$espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
2105
+		// determine the event id and set to array.
2106
+		$EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array) $this->_req_data['EVT_IDs'] : array();
2107
+		// loop thru events
2108
+		foreach ($EVT_IDs as $EVT_ID) {
2109
+			$EVT_ID = absint($EVT_ID);
2110
+			if ($EVT_ID) {
2111
+				$results = $this->_permanently_delete_event($EVT_ID);
2112
+				$success = $results !== false ? $success : false;
2113
+				// remove this event from the list of events with no prices
2114
+				unset($espresso_no_ticket_prices[ $EVT_ID ]);
2115
+			} else {
2116
+				$success = false;
2117
+				$msg = esc_html__(
2118
+					'An error occurred. An event could not be deleted because a valid event ID was not not supplied.',
2119
+					'event_espresso'
2120
+				);
2121
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2122
+			}
2123
+		}
2124
+		update_option('ee_no_ticket_prices', $espresso_no_ticket_prices);
2125
+		// in order to force a pluralized result message we need to send back a success status greater than 1
2126
+		$success = $success ? 2 : false;
2127
+		$this->_redirect_after_action($success, 'Events', 'deleted', array('action' => 'default'));
2128
+	}
2129
+
2130
+
2131
+	/**
2132
+	 * _permanently_delete_event
2133
+	 *
2134
+	 * @access  private
2135
+	 * @param  int $EVT_ID
2136
+	 * @return bool
2137
+	 */
2138
+	private function _permanently_delete_event($EVT_ID = 0)
2139
+	{
2140
+		// grab event id
2141
+		if (! $EVT_ID) {
2142
+			$msg = esc_html__(
2143
+				'An error occurred. No Event ID or an invalid Event ID was received.',
2144
+				'event_espresso'
2145
+			);
2146
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2147
+			return false;
2148
+		}
2149
+		if (! $this->_cpt_model_obj instanceof EE_Event
2150
+			|| $this->_cpt_model_obj->ID() !== $EVT_ID
2151
+		) {
2152
+			$this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
2153
+		}
2154
+		if (! $this->_cpt_model_obj instanceof EE_Event) {
2155
+			return false;
2156
+		}
2157
+		// need to delete related tickets and prices first.
2158
+		$datetimes = $this->_cpt_model_obj->get_many_related('Datetime');
2159
+		foreach ($datetimes as $datetime) {
2160
+			$this->_cpt_model_obj->_remove_relation_to($datetime, 'Datetime');
2161
+			$tickets = $datetime->get_many_related('Ticket');
2162
+			foreach ($tickets as $ticket) {
2163
+				$ticket->_remove_relation_to($datetime, 'Datetime');
2164
+				$ticket->delete_related_permanently('Price');
2165
+				$ticket->delete_permanently();
2166
+			}
2167
+			$datetime->delete();
2168
+		}
2169
+		// what about related venues or terms?
2170
+		$venues = $this->_cpt_model_obj->get_many_related('Venue');
2171
+		foreach ($venues as $venue) {
2172
+			$this->_cpt_model_obj->_remove_relation_to($venue, 'Venue');
2173
+		}
2174
+		// any attached question groups?
2175
+		$question_groups = $this->_cpt_model_obj->get_many_related('Question_Group');
2176
+		if (! empty($question_groups)) {
2177
+			foreach ($question_groups as $question_group) {
2178
+				$this->_cpt_model_obj->_remove_relation_to($question_group, 'Question_Group');
2179
+			}
2180
+		}
2181
+		// Message Template Groups
2182
+		$this->_cpt_model_obj->_remove_relations('Message_Template_Group');
2183
+		/** @type EE_Term_Taxonomy[] $term_taxonomies */
2184
+		$term_taxonomies = $this->_cpt_model_obj->term_taxonomies();
2185
+		foreach ($term_taxonomies as $term_taxonomy) {
2186
+			$this->_cpt_model_obj->remove_relation_to_term_taxonomy($term_taxonomy);
2187
+		}
2188
+		$success = $this->_cpt_model_obj->delete_permanently();
2189
+		// did it all go as planned ?
2190
+		if ($success) {
2191
+			$msg = sprintf(esc_html__('Event ID # %d has been deleted.', 'event_espresso'), $EVT_ID);
2192
+			EE_Error::add_success($msg);
2193
+		} else {
2194
+			$msg = sprintf(
2195
+				esc_html__('An error occurred. Event ID # %d could not be deleted.', 'event_espresso'),
2196
+				$EVT_ID
2197
+			);
2198
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2199
+			return false;
2200
+		}
2201
+		do_action('AHEE__Events_Admin_Page___permanently_delete_event__after_event_deleted', $EVT_ID);
2202
+		return true;
2203
+	}
2204
+
2205
+
2206
+	/**
2207
+	 * get total number of events
2208
+	 *
2209
+	 * @access public
2210
+	 * @return int
2211
+	 */
2212
+	public function total_events()
2213
+	{
2214
+		$count = EEM_Event::instance()->count(array('caps' => 'read_admin'), 'EVT_ID', true);
2215
+		return $count;
2216
+	}
2217
+
2218
+
2219
+	/**
2220
+	 * get total number of draft events
2221
+	 *
2222
+	 * @access public
2223
+	 * @return int
2224
+	 */
2225
+	public function total_events_draft()
2226
+	{
2227
+		$where = array(
2228
+			'status' => array('IN', array('draft', 'auto-draft')),
2229
+		);
2230
+		$count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
2231
+		return $count;
2232
+	}
2233
+
2234
+
2235
+	/**
2236
+	 * get total number of trashed events
2237
+	 *
2238
+	 * @access public
2239
+	 * @return int
2240
+	 */
2241
+	public function total_trashed_events()
2242
+	{
2243
+		$where = array(
2244
+			'status' => 'trash',
2245
+		);
2246
+		$count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
2247
+		return $count;
2248
+	}
2249
+
2250
+
2251
+	/**
2252
+	 *    _default_event_settings
2253
+	 *    This generates the Default Settings Tab
2254
+	 *
2255
+	 * @return void
2256
+	 * @throws EE_Error
2257
+	 */
2258
+	protected function _default_event_settings()
2259
+	{
2260
+		$this->_set_add_edit_form_tags('update_default_event_settings');
2261
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
2262
+		$this->_template_args['admin_page_content'] = $this->_default_event_settings_form()->get_html();
2263
+		$this->display_admin_page_with_sidebar();
2264
+	}
2265
+
2266
+
2267
+	/**
2268
+	 * Return the form for event settings.
2269
+	 *
2270
+	 * @return EE_Form_Section_Proper
2271
+	 * @throws EE_Error
2272
+	 */
2273
+	protected function _default_event_settings_form()
2274
+	{
2275
+		$registration_config = EE_Registry::instance()->CFG->registration;
2276
+		$registration_stati_for_selection = EEM_Registration::reg_status_array(
2277
+			// exclude
2278
+			array(
2279
+				EEM_Registration::status_id_cancelled,
2280
+				EEM_Registration::status_id_declined,
2281
+				EEM_Registration::status_id_incomplete,
2282
+				EEM_Registration::status_id_wait_list,
2283
+			),
2284
+			true
2285
+		);
2286
+		return new EE_Form_Section_Proper(
2287
+			array(
2288
+				'name'            => 'update_default_event_settings',
2289
+				'html_id'         => 'update_default_event_settings',
2290
+				'html_class'      => 'form-table',
2291
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
2292
+				'subsections'     => apply_filters(
2293
+					'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
2294
+					array(
2295
+						'default_reg_status'  => new EE_Select_Input(
2296
+							$registration_stati_for_selection,
2297
+							array(
2298
+								'default'         => isset($registration_config->default_STS_ID)
2299
+													 && array_key_exists(
2300
+														 $registration_config->default_STS_ID,
2301
+														 $registration_stati_for_selection
2302
+													 )
2303
+									? sanitize_text_field($registration_config->default_STS_ID)
2304
+									: EEM_Registration::status_id_pending_payment,
2305
+								'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
2306
+													 . EEH_Template::get_help_tab_link(
2307
+														 'default_settings_status_help_tab'
2308
+													 ),
2309
+								'html_help_text'  => esc_html__(
2310
+									'This setting allows you to preselect what the default registration status setting is when creating an event.  Note that changing this setting does NOT retroactively apply it to existing events.',
2311
+									'event_espresso'
2312
+								),
2313
+							)
2314
+						),
2315
+						'default_max_tickets' => new EE_Integer_Input(
2316
+							array(
2317
+								'default'         => isset($registration_config->default_maximum_number_of_tickets)
2318
+									? $registration_config->default_maximum_number_of_tickets
2319
+									: EEM_Event::get_default_additional_limit(),
2320
+								'html_label_text' => esc_html__(
2321
+									'Default Maximum Tickets Allowed Per Order:',
2322
+									'event_espresso'
2323
+								)
2324
+													 . EEH_Template::get_help_tab_link(
2325
+														 'default_maximum_tickets_help_tab"'
2326
+													 ),
2327
+								'html_help_text'  => esc_html__(
2328
+									'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
2329
+									'event_espresso'
2330
+								),
2331
+							)
2332
+						),
2333
+					)
2334
+				),
2335
+			)
2336
+		);
2337
+	}
2338
+
2339
+
2340
+	/**
2341
+	 * _update_default_event_settings
2342
+	 *
2343
+	 * @access protected
2344
+	 * @return void
2345
+	 * @throws EE_Error
2346
+	 */
2347
+	protected function _update_default_event_settings()
2348
+	{
2349
+		$registration_config = EE_Registry::instance()->CFG->registration;
2350
+		$form = $this->_default_event_settings_form();
2351
+		if ($form->was_submitted()) {
2352
+			$form->receive_form_submission();
2353
+			if ($form->is_valid()) {
2354
+				$valid_data = $form->valid_data();
2355
+				if (isset($valid_data['default_reg_status'])) {
2356
+					$registration_config->default_STS_ID = $valid_data['default_reg_status'];
2357
+				}
2358
+				if (isset($valid_data['default_max_tickets'])) {
2359
+					$registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
2360
+				}
2361
+				// update because data was valid!
2362
+				EE_Registry::instance()->CFG->update_espresso_config();
2363
+				EE_Error::overwrite_success();
2364
+				EE_Error::add_success(
2365
+					__('Default Event Settings were updated', 'event_espresso')
2366
+				);
2367
+			}
2368
+		}
2369
+		$this->_redirect_after_action(0, '', '', array('action' => 'default_event_settings'), true);
2370
+	}
2371
+
2372
+
2373
+	/*************        Templates        *************/
2374
+	protected function _template_settings()
2375
+	{
2376
+		$this->_admin_page_title = esc_html__('Template Settings (Preview)', 'event_espresso');
2377
+		$this->_template_args['preview_img'] = '<img src="'
2378
+											   . EVENTS_ASSETS_URL
2379
+											   . '/images/'
2380
+											   . 'caffeinated_template_features.jpg" alt="'
2381
+											   . esc_attr__('Template Settings Preview screenshot', 'event_espresso')
2382
+											   . '" />';
2383
+		$this->_template_args['preview_text'] = '<strong>'
2384
+												. esc_html__(
2385
+													'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
2386
+													'event_espresso'
2387
+												) . '</strong>';
2388
+		$this->display_admin_caf_preview_page('template_settings_tab');
2389
+	}
2390
+
2391
+
2392
+	/** Event Category Stuff **/
2393
+	/**
2394
+	 * set the _category property with the category object for the loaded page.
2395
+	 *
2396
+	 * @access private
2397
+	 * @return void
2398
+	 */
2399
+	private function _set_category_object()
2400
+	{
2401
+		if (isset($this->_category->id) && ! empty($this->_category->id)) {
2402
+			return;
2403
+		} //already have the category object so get out.
2404
+		// set default category object
2405
+		$this->_set_empty_category_object();
2406
+		// only set if we've got an id
2407
+		if (! isset($this->_req_data['EVT_CAT_ID'])) {
2408
+			return;
2409
+		}
2410
+		$category_id = absint($this->_req_data['EVT_CAT_ID']);
2411
+		$term = get_term($category_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
2412
+		if (! empty($term)) {
2413
+			$this->_category->category_name = $term->name;
2414
+			$this->_category->category_identifier = $term->slug;
2415
+			$this->_category->category_desc = $term->description;
2416
+			$this->_category->id = $term->term_id;
2417
+			$this->_category->parent = $term->parent;
2418
+		}
2419
+	}
2420
+
2421
+
2422
+	/**
2423
+	 * Clears out category properties.
2424
+	 */
2425
+	private function _set_empty_category_object()
2426
+	{
2427
+		$this->_category = new stdClass();
2428
+		$this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
2429
+		$this->_category->id = $this->_category->parent = 0;
2430
+	}
2431
+
2432
+
2433
+	/**
2434
+	 * @throws EE_Error
2435
+	 */
2436
+	protected function _category_list_table()
2437
+	{
2438
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2439
+		$this->_search_btn_label = esc_html__('Categories', 'event_espresso');
2440
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
2441
+			'add_category',
2442
+			'add_category',
2443
+			array(),
2444
+			'add-new-h2'
2445
+		);
2446
+		$this->display_admin_list_table_page_with_sidebar();
2447
+	}
2448
+
2449
+
2450
+	/**
2451
+	 * Output category details view.
2452
+	 */
2453
+	protected function _category_details($view)
2454
+	{
2455
+		// load formatter helper
2456
+		// load field generator helper
2457
+		$route = $view == 'edit' ? 'update_category' : 'insert_category';
2458
+		$this->_set_add_edit_form_tags($route);
2459
+		$this->_set_category_object();
2460
+		$id = ! empty($this->_category->id) ? $this->_category->id : '';
2461
+		$delete_action = 'delete_category';
2462
+		// custom redirect
2463
+		$redirect = EE_Admin_Page::add_query_args_and_nonce(
2464
+			array('action' => 'category_list'),
2465
+			$this->_admin_base_url
2466
+		);
2467
+		$this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect);
2468
+		// take care of contents
2469
+		$this->_template_args['admin_page_content'] = $this->_category_details_content();
2470
+		$this->display_admin_page_with_sidebar();
2471
+	}
2472
+
2473
+
2474
+	/**
2475
+	 * Output category details content.
2476
+	 */
2477
+	protected function _category_details_content()
2478
+	{
2479
+		$editor_args['category_desc'] = array(
2480
+			'type'          => 'wp_editor',
2481
+			'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
2482
+			'class'         => 'my_editor_custom',
2483
+			'wpeditor_args' => array('media_buttons' => false),
2484
+		);
2485
+		$_wp_editor = $this->_generate_admin_form_fields($editor_args, 'array');
2486
+		$all_terms = get_terms(
2487
+			array(EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY),
2488
+			array('hide_empty' => 0, 'exclude' => array($this->_category->id))
2489
+		);
2490
+		// setup category select for term parents.
2491
+		$category_select_values[] = array(
2492
+			'text' => esc_html__('No Parent', 'event_espresso'),
2493
+			'id'   => 0,
2494
+		);
2495
+		foreach ($all_terms as $term) {
2496
+			$category_select_values[] = array(
2497
+				'text' => $term->name,
2498
+				'id'   => $term->term_id,
2499
+			);
2500
+		}
2501
+		$category_select = EEH_Form_Fields::select_input(
2502
+			'category_parent',
2503
+			$category_select_values,
2504
+			$this->_category->parent
2505
+		);
2506
+		$template_args = array(
2507
+			'category'                 => $this->_category,
2508
+			'category_select'          => $category_select,
2509
+			'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
2510
+			'category_desc_editor'     => $_wp_editor['category_desc']['field'],
2511
+			'disable'                  => '',
2512
+			'disabled_message'         => false,
2513
+		);
2514
+		$template = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
2515
+		return EEH_Template::display_template($template, $template_args, true);
2516
+	}
2517
+
2518
+
2519
+	/**
2520
+	 * Handles deleting categories.
2521
+	 */
2522
+	protected function _delete_categories()
2523
+	{
2524
+		$cat_ids = isset($this->_req_data['EVT_CAT_ID']) ? (array) $this->_req_data['EVT_CAT_ID']
2525
+			: (array) $this->_req_data['category_id'];
2526
+		foreach ($cat_ids as $cat_id) {
2527
+			$this->_delete_category($cat_id);
2528
+		}
2529
+		// doesn't matter what page we're coming from... we're going to the same place after delete.
2530
+		$query_args = array(
2531
+			'action' => 'category_list',
2532
+		);
2533
+		$this->_redirect_after_action(0, '', '', $query_args);
2534
+	}
2535
+
2536
+
2537
+	/**
2538
+	 * Handles deleting specific category.
2539
+	 *
2540
+	 * @param int $cat_id
2541
+	 */
2542
+	protected function _delete_category($cat_id)
2543
+	{
2544
+		$cat_id = absint($cat_id);
2545
+		wp_delete_term($cat_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
2546
+	}
2547
+
2548
+
2549
+	/**
2550
+	 * Handles triggering the update or insertion of a new category.
2551
+	 *
2552
+	 * @param bool $new_category true means we're triggering the insert of a new category.
2553
+	 */
2554
+	protected function _insert_or_update_category($new_category)
2555
+	{
2556
+		$cat_id = $new_category ? $this->_insert_category() : $this->_insert_category(true);
2557
+		$success = 0; // we already have a success message so lets not send another.
2558
+		if ($cat_id) {
2559
+			$query_args = array(
2560
+				'action'     => 'edit_category',
2561
+				'EVT_CAT_ID' => $cat_id,
2562
+			);
2563
+		} else {
2564
+			$query_args = array('action' => 'add_category');
2565
+		}
2566
+		$this->_redirect_after_action($success, '', '', $query_args, true);
2567
+	}
2568
+
2569
+
2570
+	/**
2571
+	 * Inserts or updates category
2572
+	 *
2573
+	 * @param bool $update (true indicates we're updating a category).
2574
+	 * @return bool|mixed|string
2575
+	 */
2576
+	private function _insert_category($update = false)
2577
+	{
2578
+		$cat_id = $update ? $this->_req_data['EVT_CAT_ID'] : '';
2579
+		$category_name = isset($this->_req_data['category_name']) ? $this->_req_data['category_name'] : '';
2580
+		$category_desc = isset($this->_req_data['category_desc']) ? $this->_req_data['category_desc'] : '';
2581
+		$category_parent = isset($this->_req_data['category_parent']) ? $this->_req_data['category_parent'] : 0;
2582
+		if (empty($category_name)) {
2583
+			$msg = esc_html__('You must add a name for the category.', 'event_espresso');
2584
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2585
+			return false;
2586
+		}
2587
+		$term_args = array(
2588
+			'name'        => $category_name,
2589
+			'description' => $category_desc,
2590
+			'parent'      => $category_parent,
2591
+		);
2592
+		// was the category_identifier input disabled?
2593
+		if (isset($this->_req_data['category_identifier'])) {
2594
+			$term_args['slug'] = $this->_req_data['category_identifier'];
2595
+		}
2596
+		$insert_ids = $update
2597
+			? wp_update_term($cat_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args)
2598
+			: wp_insert_term($category_name, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args);
2599
+		if (! is_array($insert_ids)) {
2600
+			$msg = esc_html__(
2601
+				'An error occurred and the category has not been saved to the database.',
2602
+				'event_espresso'
2603
+			);
2604
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2605
+		} else {
2606
+			$cat_id = $insert_ids['term_id'];
2607
+			$msg = sprintf(esc_html__('The category %s was successfully saved', 'event_espresso'), $category_name);
2608
+			EE_Error::add_success($msg);
2609
+		}
2610
+		return $cat_id;
2611
+	}
2612
+
2613
+
2614
+	/**
2615
+	 * Gets categories or count of categories matching the arguments in the request.
2616
+	 *
2617
+	 * @param int  $per_page
2618
+	 * @param int  $current_page
2619
+	 * @param bool $count
2620
+	 * @return EE_Base_Class[]|EE_Term_Taxonomy[]|int
2621
+	 */
2622
+	public function get_categories($per_page = 10, $current_page = 1, $count = false)
2623
+	{
2624
+		// testing term stuff
2625
+		$orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'Term.term_id';
2626
+		$order = isset($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
2627
+		$limit = ($current_page - 1) * $per_page;
2628
+		$where = array('taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
2629
+		if (isset($this->_req_data['s'])) {
2630
+			$sstr = '%' . $this->_req_data['s'] . '%';
2631
+			$where['OR'] = array(
2632
+				'Term.name'   => array('LIKE', $sstr),
2633
+				'description' => array('LIKE', $sstr),
2634
+			);
2635
+		}
2636
+		$query_params = array(
2637
+			$where,
2638
+			'order_by'   => array($orderby => $order),
2639
+			'limit'      => $limit . ',' . $per_page,
2640
+			'force_join' => array('Term'),
2641
+		);
2642
+		$categories = $count
2643
+			? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
2644
+			: EEM_Term_Taxonomy::instance()->get_all($query_params);
2645
+		return $categories;
2646
+	}
2647
+
2648
+	/* end category stuff */
2649
+	/**************/
2650
+
2651
+
2652
+	/**
2653
+	 * Callback for the `ee_save_timezone_setting` ajax action.
2654
+	 *
2655
+	 * @throws EE_Error
2656
+	 */
2657
+	public function save_timezonestring_setting()
2658
+	{
2659
+		$timezone_string = isset($this->_req_data['timezone_selected'])
2660
+			? $this->_req_data['timezone_selected']
2661
+			: '';
2662
+		if (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false)) {
2663
+			EE_Error::add_error(
2664
+				esc_html__('An invalid timezone string submitted.', 'event_espresso'),
2665
+				__FILE__,
2666
+				__FUNCTION__,
2667
+				__LINE__
2668
+			);
2669
+			$this->_template_args['error'] = true;
2670
+			$this->_return_json();
2671
+		}
2672
+
2673
+		update_option('timezone_string', $timezone_string);
2674
+		EE_Error::add_success(
2675
+			esc_html__('Your timezone string was updated.', 'event_espresso')
2676
+		);
2677
+		$this->_template_args['success'] = true;
2678
+		$this->_return_json(true, array('action' => 'create_new'));
2679
+	}
2680 2680
 }
Please login to merge, or discard this patch.
admin_pages/venues/Venues_Admin_Page_Init.core.php 2 patches
Indentation   +31 added lines, -31 removed lines patch added patch discarded remove patch
@@ -17,39 +17,39 @@
 block discarded – undo
17 17
 {
18 18
 
19 19
 
20
-    public function __construct()
21
-    {
22
-        // define some event categories related constants
23
-        define('EE_VENUES_PG_SLUG', 'espresso_venues');
24
-        define('EE_VENUES_ADMIN_URL', admin_url('admin.php?page=' . EE_VENUES_PG_SLUG));
25
-        define('EE_VENUES_ASSETS_URL', EE_ADMIN_PAGES_URL . 'venues/assets/');
26
-        define('EE_VENUES_TEMPLATE_PATH', EE_ADMIN_PAGES . 'venues/templates/');
20
+	public function __construct()
21
+	{
22
+		// define some event categories related constants
23
+		define('EE_VENUES_PG_SLUG', 'espresso_venues');
24
+		define('EE_VENUES_ADMIN_URL', admin_url('admin.php?page=' . EE_VENUES_PG_SLUG));
25
+		define('EE_VENUES_ASSETS_URL', EE_ADMIN_PAGES_URL . 'venues/assets/');
26
+		define('EE_VENUES_TEMPLATE_PATH', EE_ADMIN_PAGES . 'venues/templates/');
27 27
 
28
-        parent::__construct();
29
-        $this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . '/';
30
-    }
28
+		parent::__construct();
29
+		$this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . '/';
30
+	}
31 31
 
32
-    protected function _set_init_properties()
33
-    {
34
-        $this->label = __('Event Venues', 'event_espresso');
35
-        $this->menu_label = __('Venues', 'event_espresso');
36
-        $this->menu_slug = EE_VENUES_PG_SLUG;
37
-    }
32
+	protected function _set_init_properties()
33
+	{
34
+		$this->label = __('Event Venues', 'event_espresso');
35
+		$this->menu_label = __('Venues', 'event_espresso');
36
+		$this->menu_slug = EE_VENUES_PG_SLUG;
37
+	}
38 38
 
39 39
 
40
-    protected function _set_menu_map()
41
-    {
42
-        $this->_menu_map = new EE_Admin_Page_Sub_Menu(
43
-            array(
44
-                'menu_group'      => 'management',
45
-                'menu_order'      => 40,
46
-                'show_on_menu'    => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
47
-                'parent_slug'     => 'espresso_events',
48
-                'menu_slug'       => EE_VENUES_PG_SLUG,
49
-                'menu_label'      => __('Venues', 'event_espresso'),
50
-                'capability'      => 'ee_read_venues',
51
-                'admin_init_page' => $this,
52
-            )
53
-        );
54
-    }
40
+	protected function _set_menu_map()
41
+	{
42
+		$this->_menu_map = new EE_Admin_Page_Sub_Menu(
43
+			array(
44
+				'menu_group'      => 'management',
45
+				'menu_order'      => 40,
46
+				'show_on_menu'    => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
47
+				'parent_slug'     => 'espresso_events',
48
+				'menu_slug'       => EE_VENUES_PG_SLUG,
49
+				'menu_label'      => __('Venues', 'event_espresso'),
50
+				'capability'      => 'ee_read_venues',
51
+				'admin_init_page' => $this,
52
+			)
53
+		);
54
+	}
55 55
 }
Please login to merge, or discard this patch.
Spacing   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -21,12 +21,12 @@
 block discarded – undo
21 21
     {
22 22
         // define some event categories related constants
23 23
         define('EE_VENUES_PG_SLUG', 'espresso_venues');
24
-        define('EE_VENUES_ADMIN_URL', admin_url('admin.php?page=' . EE_VENUES_PG_SLUG));
25
-        define('EE_VENUES_ASSETS_URL', EE_ADMIN_PAGES_URL . 'venues/assets/');
26
-        define('EE_VENUES_TEMPLATE_PATH', EE_ADMIN_PAGES . 'venues/templates/');
24
+        define('EE_VENUES_ADMIN_URL', admin_url('admin.php?page='.EE_VENUES_PG_SLUG));
25
+        define('EE_VENUES_ASSETS_URL', EE_ADMIN_PAGES_URL.'venues/assets/');
26
+        define('EE_VENUES_TEMPLATE_PATH', EE_ADMIN_PAGES.'venues/templates/');
27 27
 
28 28
         parent::__construct();
29
-        $this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . '/';
29
+        $this->_folder_path = EE_ADMIN_PAGES.$this->_folder_name.'/';
30 30
     }
31 31
 
32 32
     protected function _set_init_properties()
Please login to merge, or discard this patch.