eventespresso / event-espresso-core

modules/single_page_checkout/reg_steps/payment_options/EE_SPCO_Reg_Step_Payment_Options.class.php

Indentation +2828 added lines, -2828 removed lines

@@ -19,2832 +19,2832 @@
  */
 class EE_SPCO_Reg_Step_Payment_Options extends EE_SPCO_Reg_Step
 {
-    /**
-     * @var EE_Line_Item_Display $Line_Item_Display
-     */
-    protected $line_item_display;
-
-    /**
-     * @var boolean $handle_IPN_in_this_request
-     */
-    protected $handle_IPN_in_this_request = false;
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        add_filter(
-            'FHEE__SPCO__EE_Line_Item_Filter_Collection',
-            ['EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters']
-        );
-        add_action(
-            'wp_ajax_switch_spco_billing_form',
-            ['EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form']
-        );
-        add_action(
-            'wp_ajax_nopriv_switch_spco_billing_form',
-            ['EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form']
-        );
-        add_action('wp_ajax_save_payer_details', ['EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details']);
-        add_action(
-            'wp_ajax_nopriv_save_payer_details',
-            ['EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details']
-        );
-        add_action(
-            'wp_ajax_get_transaction_details_for_gateways',
-            ['EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details']
-        );
-        add_action(
-            'wp_ajax_nopriv_get_transaction_details_for_gateways',
-            ['EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details']
-        );
-        add_filter(
-            'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
-            ['EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'],
-            10,
-            1
-        );
-    }
-
-
-    /**
-     *    ajax switch_spco_billing_form
-     *
-     */
-    public static function switch_spco_billing_form()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
-    }
-
-
-    /**
-     *    ajax save_payer_details
-     *
-     */
-    public static function save_payer_details()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
-    }
-
-
-    /**
-     *    ajax get_transaction_details
-     *
-     */
-    public static function get_transaction_details()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
-    }
-
-
-    /**
-     * bypass_recaptcha_for_load_payment_method
-     *
-     * @access public
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function bypass_recaptcha_for_load_payment_method()
-    {
-        return [
-            'EESID'  => EE_Registry::instance()->SSN->id(),
-            'step'   => 'payment_options',
-            'action' => 'spco_billing_form',
-        ];
-    }
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param EE_Checkout $checkout
-     */
-    public function __construct(EE_Checkout $checkout)
-    {
-        $this->request   = EED_Single_Page_Checkout::getRequest();
-        $this->_slug     = 'payment_options';
-        $this->_name     = esc_html__('Payment Options', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . '/payment_options_main.template.php';
-        $this->checkout  = $checkout;
-        $this->_reset_success_message();
-        $this->set_instructions(
-            esc_html__(
-                'Please select a method of payment and provide any necessary billing information before proceeding.',
-                'event_espresso'
-            )
-        );
-    }
-
-
-    /**
-     * @return null
-     */
-    public function line_item_display()
-    {
-        return $this->line_item_display;
-    }
-
-
-    /**
-     * @param null $line_item_display
-     */
-    public function set_line_item_display($line_item_display)
-    {
-        $this->line_item_display = $line_item_display;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function handle_IPN_in_this_request()
-    {
-        return $this->handle_IPN_in_this_request;
-    }
-
-
-    /**
-     * @param boolean $handle_IPN_in_this_request
-     */
-    public function set_handle_IPN_in_this_request($handle_IPN_in_this_request)
-    {
-        $this->handle_IPN_in_this_request = filter_var($handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * translate_js_strings
-     *
-     * @return void
-     */
-    public function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
-            'Please select a method of payment in order to continue.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
-            'A valid method of payment could not be determined. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
-            'Forwarding to Secure Payment Provider.',
-            'event_espresso'
-        );
-    }
-
-
-    /**
-     * enqueue_styles_and_scripts
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function enqueue_styles_and_scripts()
-    {
-        $transaction = $this->checkout->transaction;
-        // if the transaction isn't set or nothing is owed on it, don't enqueue any JS
-        if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
-            return;
-        }
-        foreach (
-            EEM_Payment_Method::instance()->get_all_for_transaction(
-                $transaction,
-                EEM_Payment_Method::scope_cart
-            ) as $payment_method
-        ) {
-            $type_obj = $payment_method->type_obj();
-            if ($type_obj instanceof EE_PMT_Base) {
-                $billing_form = $type_obj->generate_new_billing_form($transaction);
-                if ($billing_form instanceof EE_Form_Section_Proper) {
-                    $billing_form->enqueue_js();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * initialize_reg_step
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function initialize_reg_step()
-    {
-        // TODO: if /when we implement donations, then this will need overriding
-        if (
-            // don't need payment options for:
-            // registrations made via the admin
-            // completed transactions
-            // overpaid transactions
-            // $ 0.00 transactions(no payment required)
-            ! $this->checkout->payment_required()
-            // but do NOT remove if current action being called belongs to this reg step
-            && ! is_callable([$this, $this->checkout->action])
-            && ! $this->completed()
-        ) {
-            // and if so, then we no longer need the Payment Options step
-            if ($this->is_current_step()) {
-                $this->checkout->generate_reg_form = false;
-            }
-            $this->checkout->remove_reg_step($this->_slug);
-            // DEBUG LOG
-            // $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
-            return false;
-        }
-        // load EEM_Payment_Method
-        EE_Registry::instance()->load_model('Payment_Method');
-        // get all active payment methods
-        $this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
-            $this->checkout->transaction,
-            EEM_Payment_Method::scope_cart
-        );
-        return true;
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidStatusException
-     */
-    public function generate_reg_form()
-    {
-        // reset in case someone changes their mind
-        $this->_reset_selected_method_of_payment();
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'payments_closed';
-        $registrations_requiring_payment            = [];
-        $registrations_for_free_events              = [];
-        $registrations_requiring_pre_approval       = [];
-        $sold_out_events                            = [];
-        $insufficient_spaces_available              = [];
-        $no_payment_required                        = true;
-        // loop thru registrations to gather info
-        $registrations         = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
-            $registrations,
-            $this->checkout->revisit
-        );
-        foreach ($registrations as $REG_ID => $registration) {
-            /** @var $registration EE_Registration */
-            // has this registration lost it's space ?
-            if (isset($ejected_registrations[ $REG_ID ])) {
-                if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
-                    $sold_out_events[ $registration->event()->ID() ] = $registration->event();
-                } else {
-                    $insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
-                }
-                continue;
-            }
-            // event requires admin approval
-            if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
-                // add event to list of events with pre-approval reg status
-                $registrations_requiring_pre_approval[ $REG_ID ] = $registration;
-                do_action(
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
-                    $registration->event(),
-                    $this
-                );
-                continue;
-            }
-            if (
-                $this->checkout->revisit
-                && $registration->status_ID() !== EEM_Registration::status_id_approved
-                && (
-                    $registration->event()->is_sold_out()
-                    || $registration->event()->is_sold_out(true)
-                )
-            ) {
-                // add event to list of events that are sold out
-                $sold_out_events[ $registration->event()->ID() ] = $registration->event();
-                do_action(
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
-                    $registration->event(),
-                    $this
-                );
-                continue;
-            }
-            // are they allowed to pay now and is there monies owing?
-            if ($registration->owes_monies_and_can_pay()) {
-                $registrations_requiring_payment[ $REG_ID ] = $registration;
-                do_action(
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
-                    $registration->event(),
-                    $this
-                );
-            } elseif (
-                ! $this->checkout->revisit
-                      && $registration->status_ID() !== EEM_Registration::status_id_not_approved
-                      && $registration->ticket()->is_free()
-            ) {
-                $registrations_for_free_events[ $registration->ticket()->ID() ] = $registration;
-            }
-        }
-        $subsections = [];
-        // now decide which template to load
-        if (! empty($sold_out_events)) {
-            $subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
-        }
-        if (! empty($insufficient_spaces_available)) {
-            $subsections['insufficient_space'] = $this->_insufficient_spaces_available(
-                $insufficient_spaces_available
-            );
-        }
-        if (! empty($registrations_requiring_pre_approval)) {
-            $subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
-                $registrations_requiring_pre_approval
-            );
-        }
-        if (! empty($registrations_for_free_events)) {
-            $subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
-        }
-        if (! empty($registrations_requiring_payment)) {
-            if ($this->checkout->amount_owing > 0) {
-                // autoload Line_Item_Display classes
-                EEH_Autoloader::register_line_item_filter_autoloaders();
-                $line_item_filter_processor = new EE_Line_Item_Filter_Processor(
-                    apply_filters(
-                        'FHEE__SPCO__EE_Line_Item_Filter_Collection',
-                        new EE_Line_Item_Filter_Collection()
-                    ),
-                    $this->checkout->cart->get_grand_total()
-                );
-                /** @var EE_Line_Item $filtered_line_item_tree */
-                $filtered_line_item_tree = $line_item_filter_processor->process();
-                EEH_Autoloader::register_line_item_display_autoloaders();
-                $this->set_line_item_display(new EE_Line_Item_Display('spco'));
-                $subsections['payment_options'] = $this->_display_payment_options(
-                    $this->line_item_display->display_line_item(
-                        $filtered_line_item_tree,
-                        ['registrations' => $registrations]
-                    )
-                );
-                $this->checkout->amount_owing   = $filtered_line_item_tree->total();
-                $this->_apply_registration_payments_to_amount_owing($registrations);
-            }
-            $no_payment_required = false;
-        } else {
-            $this->_hide_reg_step_submit_button_if_revisit();
-        }
-        $this->_save_selected_method_of_payment();
-
-        $subsections['default_hidden_inputs'] = $this->reg_step_hidden_inputs();
-        $subsections['extra_hidden_inputs']   = $this->_extra_hidden_inputs($no_payment_required);
-
-        return new EE_Form_Section_Proper(
-            [
-                'name'            => $this->reg_form_name(),
-                'html_id'         => $this->reg_form_name(),
-                'subsections'     => $subsections,
-                'layout_strategy' => new EE_No_Layout(),
-            ]
-        );
-    }
-
-
-    /**
-     * add line item filters required for this reg step
-     * these filters are applied via this line in EE_SPCO_Reg_Step_Payment_Options::set_hooks():
-     *        add_filter( 'FHEE__SPCO__EE_Line_Item_Filter_Collection', array( 'EE_SPCO_Reg_Step_Payment_Options',
-     *        'add_spco_line_item_filters' ) ); so any code that wants to use the same set of filters during the
-     *        payment options reg step, can apply these filters via the following: apply_filters(
-     *        'FHEE__SPCO__EE_Line_Item_Filter_Collection', new EE_Line_Item_Filter_Collection() ) or to an existing
-     *        filter collection by passing that instead of instantiating a new collection
-     *
-     * @param EE_Line_Item_Filter_Collection $line_item_filter_collection
-     * @return EE_Line_Item_Filter_Collection
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidStatusException
-     */
-    public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
-    {
-        if (! EE_Registry::instance()->SSN instanceof EE_Session) {
-            return $line_item_filter_collection;
-        }
-        if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
-            return $line_item_filter_collection;
-        }
-        if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
-            return $line_item_filter_collection;
-        }
-        $line_item_filter_collection->add(
-            new EE_Billable_Line_Item_Filter(
-                EE_SPCO_Reg_Step_Payment_Options::remove_ejected_registrations(
-                    EE_Registry::instance()->SSN->checkout()->transaction->registrations(
-                        EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
-                    )
-                )
-            )
-        );
-        $line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
-        return $line_item_filter_collection;
-    }
-
-
-    /**
-     * remove_ejected_registrations
-     * if a registrant has lost their potential space at an event due to lack of payment,
-     * then this method removes them from the list of registrations being paid for during this request
-     *
-     * @param EE_Registration[] $registrations
-     * @return EE_Registration[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidStatusException
-     */
-    public static function remove_ejected_registrations(array $registrations)
-    {
-        $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
-            $registrations,
-            EE_Registry::instance()->SSN->checkout()->revisit
-        );
-        foreach ($registrations as $REG_ID => $registration) {
-            // has this registration lost it's space ?
-            if (isset($ejected_registrations[ $REG_ID ])) {
-                unset($registrations[ $REG_ID ]);
-            }
-        }
-        return $registrations;
-    }
-
-
-    /**
-     * find_registrations_that_lost_their_space
-     * If a registrant chooses an offline payment method like Invoice,
-     * then no space is reserved for them at the event until they fully pay fo that site
-     * (unless the event's default reg status is set to APPROVED)
-     * if a registrant then later returns to pay, but the number of spaces available has been reduced due to sales,
-     * then this method will determine which registrations have lost the ability to complete the reg process.
-     *
-     * @param EE_Registration[] $registrations
-     * @param bool              $revisit
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidStatusException
-     */
-    public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
-    {
-        // registrations per event
-        $event_reg_count = [];
-        // spaces left per event
-        $event_spaces_remaining = [];
-        // tickets left sorted by ID
-        $tickets_remaining = [];
-        // registrations that have lost their space
-        $ejected_registrations = [];
-        foreach ($registrations as $REG_ID => $registration) {
-            if (
-                $registration->status_ID() === EEM_Registration::status_id_approved
-                || apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
-                    false,
-                    $registration,
-                    $revisit
-                )
-            ) {
-                continue;
-            }
-            $EVT_ID = $registration->event_ID();
-            $ticket = $registration->ticket();
-            if (! isset($tickets_remaining[ $ticket->ID() ])) {
-                $tickets_remaining[ $ticket->ID() ] = $ticket->remaining();
-            }
-            if ($tickets_remaining[ $ticket->ID() ] > 0) {
-                if (! isset($event_reg_count[ $EVT_ID ])) {
-                    $event_reg_count[ $EVT_ID ] = 0;
-                }
-                $event_reg_count[ $EVT_ID ]++;
-                if (! isset($event_spaces_remaining[ $EVT_ID ])) {
-                    $event_spaces_remaining[ $EVT_ID ] = $registration->event()->spaces_remaining_for_sale();
-                }
-            }
-            if (
-                $revisit
-                && ($tickets_remaining[ $ticket->ID() ] === 0
-                    || $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
-                )
-            ) {
-                $ejected_registrations[ $REG_ID ] = $registration->event();
-                if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
-                    /** @type EE_Registration_Processor $registration_processor */
-                    $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-                    // at this point, we should have enough details about the registrant to consider the registration
-                    // NOT incomplete
-                    $registration_processor->manually_update_registration_status(
-                        $registration,
-                        EEM_Registration::status_id_wait_list
-                    );
-                }
-            }
-        }
-        return $ejected_registrations;
-    }
-
-
-    /**
-     * _hide_reg_step_submit_button
-     * removes the html for the reg step submit button
-     * by replacing it with an empty string via filter callback
-     *
-     * @return void
-     */
-    protected function _adjust_registration_status_if_event_old_sold()
-    {
-    }
-
-
-    /**
-     * _hide_reg_step_submit_button
-     * removes the html for the reg step submit button
-     * by replacing it with an empty string via filter callback
-     *
-     * @return void
-     */
-    protected function _hide_reg_step_submit_button_if_revisit()
-    {
-        if ($this->checkout->revisit) {
-            add_filter('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string');
-        }
-    }
-
-
-    /**
-     * sold_out_events
-     * displays notices regarding events that have sold out since hte registrant first signed up
-     *
-     * @param EE_Event[] $sold_out_events_array
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    private function _sold_out_events($sold_out_events_array = [])
-    {
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'events_sold_out';
-        $sold_out_events                            = '';
-        foreach ($sold_out_events_array as $sold_out_event) {
-            $sold_out_events .= EEH_HTML::li(
-                EEH_HTML::span(
-                    '  ' . $sold_out_event->name(),
-                    '',
-                    'dashicons dashicons-marker ee-icon-size-16 pink-text'
-                )
-            );
-        }
-        return new EE_Form_Section_Proper(
-            [
-                'layout_strategy' => new EE_Template_Layout(
-                    [
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . '/sold_out_events.template.php',
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
-                            [
-                                'sold_out_events'     => $sold_out_events,
-                                'sold_out_events_msg' => apply_filters(
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
-                                    sprintf(
-                                        esc_html__(
-                                            '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',
-                                            'event_espresso'
-                                        ),
-                                        '<strong>',
-                                        '</strong>',
-                                        '<br />'
-                                    )
-                                ),
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * _insufficient_spaces_available
-     * displays notices regarding events that do not have enough remaining spaces
-     * to satisfy the current number of registrations looking to pay
-     *
-     * @param EE_Event[] $insufficient_spaces_events_array
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _insufficient_spaces_available($insufficient_spaces_events_array = [])
-    {
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'invoice';
-        $insufficient_space_events                  = '';
-        foreach ($insufficient_spaces_events_array as $event) {
-            if ($event instanceof EE_Event) {
-                $insufficient_space_events .= EEH_HTML::li(
-                    EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
-                );
-            }
-        }
-        return new EE_Form_Section_Proper(
-            [
-                'subsections'     => [
-                    'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
-                    'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
-                ],
-                'layout_strategy' => new EE_Template_Layout(
-                    [
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . '/sold_out_events.template.php',
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
-                            [
-                                'sold_out_events'     => $insufficient_space_events,
-                                'sold_out_events_msg' => apply_filters(
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__insufficient_space_msg',
-                                    esc_html__(
-                                        '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.',
-                                        'event_espresso'
-                                    )
-                                ),
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * registrations_requiring_pre_approval
-     *
-     * @param array $registrations_requiring_pre_approval
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws ReflectionException
-     */
-    private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = [])
-    {
-        $events_requiring_pre_approval = [];
-        foreach ($registrations_requiring_pre_approval as $registration) {
-            if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
-                $events_requiring_pre_approval[ $registration->event()->ID() ] = EEH_HTML::li(
-                    EEH_HTML::span(
-                        '',
-                        '',
-                        'dashicons dashicons-marker ee-icon-size-16 orange-text'
-                    )
-                    . EEH_HTML::span($registration->event()->name(), '', 'orange-text')
-                );
-            }
-        }
-        return new EE_Form_Section_Proper(
-            [
-                'layout_strategy' => new EE_Template_Layout(
-                    [
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . '/events_requiring_pre_approval.template.php', // layout_template
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
-                            [
-                                'events_requiring_pre_approval'     => implode('', $events_requiring_pre_approval),
-                                'events_requiring_pre_approval_msg' => apply_filters(
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___events_requiring_pre_approval__events_requiring_pre_approval_msg',
-                                    esc_html__(
-                                        '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.',
-                                        'event_espresso'
-                                    )
-                                ),
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * _no_payment_required
-     *
-     * @param EE_Event[] $registrations_for_free_events
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    private function _no_payment_required($registrations_for_free_events = [])
-    {
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'no_payment_required';
-        // generate no_payment_required form
-        return new EE_Form_Section_Proper(
-            [
-                'layout_strategy' => new EE_Template_Layout(
-                    [
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . '/no_payment_required.template.php', // layout_template
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
-                            [
-                                'revisit'                       => $this->checkout->revisit,
-                                'registrations'                 => [],
-                                'ticket_count'                  => [],
-                                'registrations_for_free_events' => $registrations_for_free_events,
-                                'no_payment_required_msg'       => EEH_HTML::p(
-                                    esc_html__('This is a free event, so no billing will occur.', 'event_espresso')
-                                ),
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * _display_payment_options
-     *
-     * @param string $transaction_details
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _display_payment_options($transaction_details = '')
-    {
-        // has method_of_payment been set by no-js user?
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment();
-        // build payment options form
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__payment_options_form',
-            new EE_Form_Section_Proper(
-                [
-                    'subsections'     => [
-                        'before_payment_options' => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
-                            new EE_Form_Section_Proper(
-                                ['layout_strategy' => new EE_Div_Per_Section_Layout()]
-                            )
-                        ),
-                        'payment_options'        => $this->_setup_payment_options(),
-                        'after_payment_options'  => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__after_payment_options',
-                            new EE_Form_Section_Proper(
-                                ['layout_strategy' => new EE_Div_Per_Section_Layout()]
-                            )
-                        ),
-                    ],
-                    'layout_strategy' => new EE_Template_Layout(
-                        [
-                            'layout_template_file' => $this->_template,
-                            'template_args'        => apply_filters(
-                                'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
-                                [
-                                    'reg_count'                 => $this->line_item_display->total_items(),
-                                    'transaction_details'       => $transaction_details,
-                                    'available_payment_methods' => [],
-                                ]
-                            ),
-                        ]
-                    ),
-                ]
-            )
-        );
-    }
-
-
-    /**
-     * _extra_hidden_inputs
-     *
-     * @param bool $no_payment_required
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _extra_hidden_inputs($no_payment_required = true)
-    {
-        return new EE_Form_Section_Proper(
-            [
-                'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => [
-                    'spco_no_payment_required' => new EE_Hidden_Input(
-                        [
-                            'normalization_strategy' => new EE_Boolean_Normalization(),
-                            'html_name'              => 'spco_no_payment_required',
-                            'html_id'                => 'spco-no-payment-required-payment_options',
-                            'default'                => $no_payment_required,
-                        ]
-                    ),
-                    'spco_transaction_id'      => new EE_Fixed_Hidden_Input(
-                        [
-                            'normalization_strategy' => new EE_Int_Normalization(),
-                            'html_name'              => 'spco_transaction_id',
-                            'html_id'                => 'spco-transaction-id',
-                            'default'                => $this->checkout->transaction->ID(),
-                        ]
-                    ),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     *    _apply_registration_payments_to_amount_owing
-     *
-     * @param array $registrations
-     * @throws EE_Error
-     */
-    protected function _apply_registration_payments_to_amount_owing(array $registrations)
-    {
-        $payments = [];
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
-                $payments += $registration->registration_payments();
-            }
-        }
-        if (! empty($payments)) {
-            foreach ($payments as $payment) {
-                if ($payment instanceof EE_Registration_Payment) {
-                    $this->checkout->amount_owing -= $payment->amount();
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    _reset_selected_method_of_payment
-     *
-     * @access    private
-     * @param bool $force_reset
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _reset_selected_method_of_payment($force_reset = false)
-    {
-        /** @var RequestInterface $request */
-        $request              = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $reset_payment_method = $request->getRequestParam('reset_payment_method', $force_reset, 'bool');
-        if ($reset_payment_method) {
-            $this->checkout->selected_method_of_payment = null;
-            $this->checkout->payment_method             = null;
-            $this->checkout->billing_form               = null;
-            $this->_save_selected_method_of_payment();
-        }
-    }
-
-
-    /**
-     * _save_selected_method_of_payment
-     * stores the selected_method_of_payment in the session
-     * so that it's available for all subsequent requests including AJAX
-     *
-     * @access        private
-     * @param string $selected_method_of_payment
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _save_selected_method_of_payment($selected_method_of_payment = '')
-    {
-        $selected_method_of_payment = ! empty($selected_method_of_payment)
-            ? $selected_method_of_payment
-            : $this->checkout->selected_method_of_payment;
-        EE_Registry::instance()->SSN->set_session_data(
-            ['selected_method_of_payment' => $selected_method_of_payment]
-        );
-    }
-
-
-    /**
-     * _setup_payment_options
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function _setup_payment_options()
-    {
-        // load payment method classes
-        $this->checkout->available_payment_methods = $this->_get_available_payment_methods();
-        if (empty($this->checkout->available_payment_methods)) {
-            EE_Error::add_error(
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__error_message_no_payment_methods',
-                    sprintf(
-                        esc_html__(
-                            '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.',
-                            'event_espresso'
-                        ),
-                        '<br>',
-                        EE_Registry::instance()->CFG->organization->get_pretty('email')
-                    )
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // switch up header depending on number of available payment methods
-        $payment_method_header     = count($this->checkout->available_payment_methods) > 1
-            ? apply_filters(
-                'FHEE__registration_page_payment_options__method_of_payment_hdr',
-                esc_html__('Please Select Your Method of Payment', 'event_espresso')
-            )
-            : apply_filters(
-                'FHEE__registration_page_payment_options__method_of_payment_hdr',
-                esc_html__('Method of Payment', 'event_espresso')
-            );
-        $available_payment_methods = [
-            // display the "Payment Method" header
-            'payment_method_header' => new EE_Form_Section_HTML(
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__payment_method_header',
-                    EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr'),
-                    $payment_method_header
-                )
-            ),
-        ];
-        // the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
-        $available_payment_method_options = [];
-        $default_payment_method_option    = [];
-        // additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
-        $payment_methods_billing_info = [
-            new EE_Form_Section_HTML(
-                EEH_HTML::div('<br />', '', '', 'clear:both;')
-            ),
-        ];
-        // loop through payment methods
-        foreach ($this->checkout->available_payment_methods as $payment_method) {
-            if ($payment_method instanceof EE_Payment_Method) {
-                $payment_method_button = EEH_HTML::img(
-                    $payment_method->button_url(),
-                    $payment_method->name(),
-                    'spco-payment-method-' . $payment_method->slug() . '-btn-img',
-                    'spco-payment-method-btn-img'
-                );
-                // check if any payment methods are set as default
-                // if payment method is already selected OR nothing is selected and this payment method should be
-                // open_by_default
-                if (
-                    ($this->checkout->selected_method_of_payment === $payment_method->slug())
-                    || (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
-                ) {
-                    $this->checkout->selected_method_of_payment = $payment_method->slug();
-                    $this->_save_selected_method_of_payment();
-                    $default_payment_method_option[ $payment_method->slug() ] = $payment_method_button;
-                } else {
-                    $available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
-                }
-                $payment_methods_billing_info[ $payment_method->slug() . '-info' ] =
-                    $this->_payment_method_billing_info(
-                        $payment_method
-                    );
-            }
-        }
-        // prepend available_payment_method_options with default_payment_method_option so that it appears first in list
-        // of PMs
-        $available_payment_method_options = $default_payment_method_option + $available_payment_method_options;
-        // now generate the actual form  inputs
-        $available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
-            $available_payment_method_options
-        );
-        $available_payment_methods                              += $payment_methods_billing_info;
-        // build the available payment methods form
-        return new EE_Form_Section_Proper(
-            [
-                'html_id'         => 'spco-available-methods-of-payment-dv',
-                'subsections'     => $available_payment_methods,
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-            ]
-        );
-    }
-
-
-    /**
-     * _get_available_payment_methods
-     *
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_available_payment_methods()
-    {
-        if (! empty($this->checkout->available_payment_methods)) {
-            return $this->checkout->available_payment_methods;
-        }
-        $available_payment_methods = [];
-        $EEM_Payment_Method        = EEM_Payment_Method::instance();
-        // get all active payment methods
-        $payment_methods = $EEM_Payment_Method->get_all_for_transaction(
-            $this->checkout->transaction,
-            EEM_Payment_Method::scope_cart
-        );
-        foreach ($payment_methods as $payment_method) {
-            if ($payment_method instanceof EE_Payment_Method) {
-                $available_payment_methods[ $payment_method->slug() ] = $payment_method;
-            }
-        }
-        return $available_payment_methods;
-    }
-
-
-    /**
-     *    _available_payment_method_inputs
-     *
-     * @access    private
-     * @param array $available_payment_method_options
-     * @return    EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    private function _available_payment_method_inputs($available_payment_method_options = [])
-    {
-        // generate inputs
-        return new EE_Form_Section_Proper(
-            [
-                'html_id'         => 'ee-available-payment-method-inputs',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => [
-                    '' => new EE_Radio_Button_Input(
-                        $available_payment_method_options,
-                        [
-                            'html_name'          => 'selected_method_of_payment',
-                            'html_class'         => 'spco-payment-method',
-                            'default'            => $this->checkout->selected_method_of_payment,
-                            'label_size'         => 11,
-                            'enforce_label_size' => true,
-                        ]
-                    ),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     *    _payment_method_billing_info
-     *
-     * @access    private
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _payment_method_billing_info(EE_Payment_Method $payment_method)
-    {
-        $currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug();
-        // generate the billing form for payment method
-        $billing_form                 = $currently_selected
-            ? $this->_get_billing_form_for_payment_method($payment_method)
-            : new EE_Form_Section_HTML();
-        $this->checkout->billing_form = $currently_selected
-            ? $billing_form
-            : $this->checkout->billing_form;
-        // it's all in the details
-        $info_html = EEH_HTML::h3(
-            esc_html__('Important information regarding your payment', 'event_espresso'),
-            '',
-            'spco-payment-method-hdr'
-        );
-        // add some info regarding the step, either from what's saved in the admin,
-        // or a default string depending on whether the PM has a billing form or not
-        if ($payment_method->description()) {
-            $payment_method_info = $payment_method->description();
-        } elseif ($billing_form instanceof EE_Billing_Info_Form) {
-            $payment_method_info = sprintf(
-                esc_html__(
-                    'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
-                    'event_espresso'
-                ),
-                $this->submit_button_text()
-            );
-        } else {
-            $payment_method_info = sprintf(
-                esc_html__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
-                $this->submit_button_text()
-            );
-        }
-        $info_html .= EEH_HTML::div(
-            apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options___payment_method_billing_info__payment_method_info',
-                $payment_method_info
-            ),
-            '',
-            'spco-payment-method-desc ee-attention'
-        );
-        return new EE_Form_Section_Proper(
-            [
-                'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
-                'html_class'      => 'spco-payment-method-info-dv',
-                // only display the selected or default PM
-                'html_style'      => $currently_selected ? '' : 'display:none;',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => [
-                    'info'         => new EE_Form_Section_HTML($info_html),
-                    'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML(),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_billing_form_html_for_payment_method
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_billing_form_html_for_payment_method()
-    {
-        // how have they chosen to pay?
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
-        $this->checkout->payment_method             = $this->_get_payment_method_for_selected_method_of_payment();
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
-            return false;
-        }
-        if (
-            apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
-                false
-            )
-        ) {
-            EE_Error::add_success(
-                apply_filters(
-                    'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
-                    sprintf(
-                        esc_html__(
-                            'You have selected "%s" as your method of payment. Please note the important payment information below.',
-                            'event_espresso'
-                        ),
-                        $this->checkout->payment_method->name()
-                    )
-                )
-            );
-        }
-        // now generate billing form for selected method of payment
-        $payment_method_billing_form = $this->_get_billing_form_for_payment_method($this->checkout->payment_method);
-        // fill form with attendee info if applicable
-        if (
-            $payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
-            && $this->checkout->transaction_has_primary_registrant()
-        ) {
-            $payment_method_billing_form->populate_from_attendee(
-                $this->checkout->transaction->primary_registration()->attendee()
-            );
-        }
-        // and debug content
-        if (
-            $payment_method_billing_form instanceof EE_Billing_Info_Form
-            && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
-        ) {
-            $payment_method_billing_form =
-                $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
-                    $payment_method_billing_form
-                );
-        }
-        $billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
-            ? $payment_method_billing_form->get_html()
-            : '';
-        $this->checkout->json_response->set_return_data(['payment_method_info' => $billing_info]);
-        // localize validation rules for main form
-        $this->checkout->current_step->reg_form->localize_validation_rules();
-        $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
-        return true;
-    }
-
-
-    /**
-     * _get_billing_form_for_payment_method
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Billing_Info_Form|EE_Form_Section_HTML
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method)
-    {
-        $billing_form = $payment_method->type_obj()->billing_form(
-            $this->checkout->transaction,
-            ['amount_owing' => $this->checkout->amount_owing]
-        );
-        if ($billing_form instanceof EE_Billing_Info_Form) {
-            if (
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
-                    false
-                )
-                && $this->request->requestParamIsSet('payment_method')
-            ) {
-                EE_Error::add_success(
-                    apply_filters(
-                        'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
-                        sprintf(
-                            esc_html__(
-                                'You have selected "%s" as your method of payment. Please note the important payment information below.',
-                                'event_espresso'
-                            ),
-                            $payment_method->name()
-                        )
-                    )
-                );
-            }
-            return apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
-                $billing_form,
-                $payment_method
-            );
-        }
-        // no actual billing form, so return empty HTML form section
-        return new EE_Form_Section_HTML();
-    }
-
-
-    /**
-     * _get_selected_method_of_payment
-     *
-     * @param boolean $required whether to throw an error if the "selected_method_of_payment"
-     *                          is not found in the incoming request
-     * @param string  $request_param
-     * @return NULL|string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_selected_method_of_payment(
-        $required = false,
-        $request_param = 'selected_method_of_payment'
-    ) {
-        // is selected_method_of_payment set in the request ?
-        $selected_method_of_payment = $this->request->getRequestParam($request_param);
-        if ($selected_method_of_payment) {
-            // sanitize it
-            $selected_method_of_payment = is_array($selected_method_of_payment)
-                ? array_shift($selected_method_of_payment)
-                : $selected_method_of_payment;
-            $selected_method_of_payment = sanitize_text_field($selected_method_of_payment);
-            // store it in the session so that it's available for all subsequent requests including AJAX
-            $this->_save_selected_method_of_payment($selected_method_of_payment);
-        } else {
-            // or is is set in the session ?
-            $selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
-                'selected_method_of_payment'
-            );
-        }
-        // do ya really really gotta have it?
-        if (empty($selected_method_of_payment) && $required) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        '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.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $selected_method_of_payment;
-    }
-
-
-
-
-
-
-    /********************************************************************************************************/
-    /***********************************  SWITCH PAYMENT METHOD  ************************************/
-    /********************************************************************************************************/
-    /**
-     * switch_payment_method
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function switch_payment_method()
-    {
-        if (! $this->_verify_payment_method_is_set()) {
-            return false;
-        }
-        if (
-            apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
-                false
-            )
-        ) {
-            EE_Error::add_success(
-                apply_filters(
-                    'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
-                    sprintf(
-                        esc_html__(
-                            'You have selected "%s" as your method of payment. Please note the important payment information below.',
-                            'event_espresso'
-                        ),
-                        $this->checkout->payment_method->name()
-                    )
-                )
-            );
-        }
-        // generate billing form for selected method of payment if it hasn't been done already
-        if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
-                $this->checkout->payment_method
-            );
-        }
-        // fill form with attendee info if applicable
-        if (
-            apply_filters(
-                'FHEE__populate_billing_form_fields_from_attendee',
-                (
-                $this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
-                && $this->checkout->transaction_has_primary_registrant()
-                ),
-                $this->checkout->billing_form,
-                $this->checkout->transaction
-            )
-        ) {
-            $this->checkout->billing_form->populate_from_attendee(
-                $this->checkout->transaction->primary_registration()->attendee()
-            );
-        }
-        // and debug content
-        if (
-            $this->checkout->billing_form instanceof EE_Billing_Info_Form
-            && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
-        ) {
-            $this->checkout->billing_form =
-                $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
-                    $this->checkout->billing_form
-                );
-        }
-        // get html and validation rules for form
-        if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
-            $this->checkout->json_response->set_return_data(
-                ['payment_method_info' => $this->checkout->billing_form->get_html()]
-            );
-            // localize validation rules for main form
-            $this->checkout->billing_form->localize_validation_rules(true);
-            $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
-        } else {
-            $this->checkout->json_response->set_return_data(['payment_method_info' => '']);
-        }
-        // prevents advancement to next step
-        $this->checkout->continue_reg = false;
-        return true;
-    }
-
-
-    /**
-     * _verify_payment_method_is_set
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _verify_payment_method_is_set()
-    {
-        // generate billing form for selected method of payment if it hasn't been done already
-        if (empty($this->checkout->selected_method_of_payment)) {
-            // how have they chosen to pay?
-            $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
-        } else {
-            // choose your own adventure based on method_of_payment
-            switch ($this->checkout->selected_method_of_payment) {
-                case 'events_sold_out':
-                    EE_Error::add_attention(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__sold_out_events_msg',
-                            esc_html__(
-                                '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.',
-                                'event_espresso'
-                            )
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                case 'payments_closed':
-                    EE_Error::add_attention(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
-                            esc_html__(
-                                '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.',
-                                'event_espresso'
-                            )
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                case 'no_payment_required':
-                    EE_Error::add_attention(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
-                            esc_html__(
-                                '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.',
-                                'event_espresso'
-                            )
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                default:
-            }
-        }
-        // verify payment method
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
-            // get payment method for selected method of payment
-            $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
-        }
-        return $this->checkout->payment_method instanceof EE_Payment_Method;
-    }
-
-
-
-    /********************************************************************************************************/
-    /***************************************  SAVE PAYER DETAILS  ****************************************/
-    /********************************************************************************************************/
-    /**
-     * save_payer_details_via_ajax
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function save_payer_details_via_ajax()
-    {
-        if (! $this->_verify_payment_method_is_set()) {
-            return;
-        }
-        // generate billing form for selected method of payment if it hasn't been done already
-        if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
-                $this->checkout->payment_method
-            );
-        }
-        // generate primary attendee from payer info if applicable
-        if (! $this->checkout->transaction_has_primary_registrant()) {
-            $attendee = $this->_create_attendee_from_request_data();
-            if ($attendee instanceof EE_Attendee) {
-                foreach ($this->checkout->transaction->registrations() as $registration) {
-                    if ($registration->is_primary_registrant()) {
-                        $this->checkout->primary_attendee_obj = $attendee;
-                        $registration->_add_relation_to($attendee, 'Attendee');
-                        $registration->set_attendee_id($attendee->ID());
-                        $registration->update_cache_after_object_save('Attendee', $attendee);
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * create_attendee_from_request_data
-     * uses info from alternate GET or POST data (such as AJAX) to create a new attendee
-     *
-     * @return EE_Attendee
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _create_attendee_from_request_data()
-    {
-        // get State ID
-        $STA_ID = $this->request->getRequestParam('state');
-        if (! empty($STA_ID)) {
-            // can we get state object from name ?
-            EE_Registry::instance()->load_model('State');
-            $state  = EEM_State::instance()->get_col([['STA_name' => $STA_ID], 'limit' => 1], 'STA_ID');
-            $STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
-        }
-        // get Country ISO
-        $CNT_ISO = $this->request->getRequestParam('country');
-        if (! empty($CNT_ISO)) {
-            // can we get country object from name ?
-            EE_Registry::instance()->load_model('Country');
-            $country = EEM_Country::instance()->get_col(
-                [['CNT_name' => $CNT_ISO], 'limit' => 1],
-                'CNT_ISO'
-            );
-            $CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
-        }
-        // grab attendee data
-        $attendee_data = [
-            'ATT_fname'    => $this->request->getRequestParam('first_name'),
-            'ATT_lname'    => $this->request->getRequestParam('last_name'),
-            'ATT_email'    => $this->request->getRequestParam('email'),
-            'ATT_address'  => $this->request->getRequestParam('address'),
-            'ATT_address2' => $this->request->getRequestParam('address2'),
-            'ATT_city'     => $this->request->getRequestParam('city'),
-            'STA_ID'       => $STA_ID,
-            'CNT_ISO'      => $CNT_ISO,
-            'ATT_zip'      => $this->request->getRequestParam('zip'),
-            'ATT_phone'    => $this->request->getRequestParam('phone'),
-        ];
-        // validate the email address since it is the most important piece of info
-        if (empty($attendee_data['ATT_email'])) {
-            EE_Error::add_error(
-                esc_html__('An invalid email address was submitted.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // does this attendee already exist in the db ? we're searching using a combination of first name, last name,
-        // AND email address
-        if (
-            ! empty($attendee_data['ATT_fname'])
-            && ! empty($attendee_data['ATT_lname'])
-            && ! empty($attendee_data['ATT_email'])
-        ) {
-            $existing_attendee = EEM_Attendee::instance()->find_existing_attendee(
-                [
-                    'ATT_fname' => $attendee_data['ATT_fname'],
-                    'ATT_lname' => $attendee_data['ATT_lname'],
-                    'ATT_email' => $attendee_data['ATT_email'],
-                ]
-            );
-            if ($existing_attendee instanceof EE_Attendee) {
-                return $existing_attendee;
-            }
-        }
-        // no existing attendee? kk let's create a new one
-        // kinda lame, but we need a first and last name to create an attendee, so use the email address if those
-        // don't exist
-        $attendee_data['ATT_fname'] = ! empty($attendee_data['ATT_fname'])
-            ? $attendee_data['ATT_fname']
-            : $attendee_data['ATT_email'];
-        $attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
-            ? $attendee_data['ATT_lname']
-            : $attendee_data['ATT_email'];
-        return EE_Attendee::new_instance($attendee_data);
-    }
-
-
-
-    /********************************************************************************************************/
-    /****************************************  PROCESS REG STEP  *****************************************/
-    /********************************************************************************************************/
-    /**
-     * process_reg_step
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidStatusException
-     */
-    public function process_reg_step()
-    {
-        // how have they chosen to pay?
-        $this->checkout->selected_method_of_payment = $this->checkout->transaction->is_free()
-            ? 'no_payment_required'
-            : $this->_get_selected_method_of_payment(true);
-        // choose your own adventure based on method_of_payment
-        switch ($this->checkout->selected_method_of_payment) {
-            case 'events_sold_out':
-                $this->checkout->redirect     = true;
-                $this->checkout->redirect_url = $this->checkout->cancel_page_url;
-                $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-                // mark this reg step as completed
-                $this->set_completed();
-                return false;
-
-            case 'payments_closed':
-                if (
-                    apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
-                        false
-                    )
-                ) {
-                    EE_Error::add_success(
-                        esc_html__('no payment required at this time.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-                // mark this reg step as completed
-                $this->set_completed();
-                return true;
-
-            case 'no_payment_required':
-                if (
-                    apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
-                        false
-                    )
-                ) {
-                    EE_Error::add_success(
-                        esc_html__('no payment required.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-                // mark this reg step as completed
-                $this->set_completed();
-                return true;
-
-            default:
-                $registrations         = EE_Registry::instance()->SSN->checkout()->transaction->registrations(
-                    EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
-                );
-                $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
-                    $registrations,
-                    EE_Registry::instance()->SSN->checkout()->revisit
-                );
-                // calculate difference between the two arrays
-                $registrations = array_diff($registrations, $ejected_registrations);
-                if (empty($registrations)) {
-                    $this->_redirect_because_event_sold_out();
-                    return false;
-                }
-                $payment = $this->_process_payment();
-                if ($payment instanceof EE_Payment) {
-                    $this->checkout->continue_reg = true;
-                    $this->_maybe_set_completed($payment);
-                } else {
-                    $this->checkout->continue_reg = false;
-                }
-                return $payment instanceof EE_Payment;
-        }
-    }
-
-
-    /**
-     * _redirect_because_event_sold_out
-     *
-     * @return void
-     */
-    protected function _redirect_because_event_sold_out()
-    {
-        $this->checkout->continue_reg = false;
-        // set redirect URL
-        $this->checkout->redirect_url = add_query_arg(
-            ['e_reg_url_link' => $this->checkout->reg_url_link],
-            $this->checkout->current_step->reg_step_url()
-        );
-        $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _maybe_set_completed(EE_Payment $payment)
-    {
-        // Do we need to redirect them? If so, there's more work to be done.
-        if (! $payment->redirect_url()) {
-            $this->set_completed();
-        }
-    }
-
-
-    /**
-     *    update_reg_step
-     *    this is the final step after a user  revisits the site to retry a payment
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidStatusException
-     */
-    public function update_reg_step()
-    {
-        $success = true;
-        // if payment required
-        if ($this->checkout->transaction->total() > 0) {
-            do_action(
-                'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
-                $this->checkout->transaction
-            );
-            // attempt payment via payment method
-            $success = $this->process_reg_step();
-        }
-        if ($success && ! $this->checkout->redirect) {
-            $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
-                $this->checkout->transaction->ID()
-            );
-            // set return URL
-            $this->checkout->redirect_url = add_query_arg(
-                ['e_reg_url_link' => $this->checkout->reg_url_link],
-                $this->checkout->thank_you_page_url
-            );
-        }
-        return $success;
-    }
-
-
-    /**
-     * @return EE_Payment|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _process_payment()
-    {
-        // basically confirm that the event hasn't sold out since they hit the page
-        if (! $this->_last_second_ticket_verifications()) {
-            return null;
-        }
-        // ya gotta make a choice man
-        if (empty($this->checkout->selected_method_of_payment)) {
-            $this->checkout->json_response->set_plz_select_method_of_payment(
-                esc_html__('Please select a method of payment before proceeding.', 'event_espresso')
-            );
-            return null;
-        }
-        // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
-            return null;
-        }
-        // setup billing form
-        if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
-                $this->checkout->payment_method
-            );
-            // bad billing form ?
-            if (! $this->_billing_form_is_valid()) {
-                return null;
-            }
-        }
-        // ensure primary registrant has been fully processed
-        if (! $this->_setup_primary_registrant_prior_to_payment()) {
-            return null;
-        }
-        // if session is close to expiring (under 10 minutes by default)
-        if ((time() - EE_Registry::instance()->SSN->expiration()) < EE_Registry::instance()->SSN->extension()) {
-            // add some time to session expiration so that payment can be completed
-            EE_Registry::instance()->SSN->extend_expiration();
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        // $transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
-        // in case a registrant leaves to an Off-Site Gateway and never returns, we want to approve any registrations
-        // for events with a default reg status of Approved
-        // $transaction_processor->toggle_registration_statuses_for_default_approved_events(
-        //      $this->checkout->transaction, $this->checkout->reg_cache_where_params
-        // );
-        // attempt payment
-        $payment = $this->_attempt_payment($this->checkout->payment_method);
-        // process results
-        $payment = $this->_validate_payment($payment);
-        $payment = $this->_post_payment_processing($payment);
-        // verify payment
-        if ($payment instanceof EE_Payment) {
-            // store that for later
-            $this->checkout->payment = $payment;
-            // we can also consider the TXN to not have been failed, so temporarily upgrade it's status to abandoned
-            $this->checkout->transaction->toggle_failed_transaction_status();
-            $payment_status = $payment->status();
-            if (
-                $payment_status === EEM_Payment::status_id_approved
-                || $payment_status === EEM_Payment::status_id_pending
-            ) {
-                return $payment;
-            }
-            return null;
-        }
-        if ($payment === true) {
-            // please note that offline payment methods will NOT make a payment,
-            // but instead just mark themselves as the PMD_ID on the transaction, and return true
-            $this->checkout->payment = $payment;
-            return $payment;
-        }
-        // where's my money?
-        return null;
-    }
-
-
-    /**
-     * _last_second_ticket_verifications
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _last_second_ticket_verifications()
-    {
-        // don't bother re-validating if not a return visit
-        if (! $this->checkout->revisit) {
-            return true;
-        }
-        $registrations = $this->checkout->transaction->registrations();
-        if (empty($registrations)) {
-            return false;
-        }
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration && ! $registration->is_approved()) {
-                $event = $registration->event_obj();
-                if ($event instanceof EE_Event && $event->is_sold_out(true)) {
-                    EE_Error::add_error(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___last_second_ticket_verifications__sold_out_events_msg',
-                            sprintf(
-                                esc_html__(
-                                    '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.',
-                                    'event_espresso'
-                                ),
-                                $event->name()
-                            )
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                }
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * redirect_form
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function redirect_form()
-    {
-        $payment_method_billing_info = $this->_payment_method_billing_info(
-            $this->_get_payment_method_for_selected_method_of_payment()
-        );
-        $html                        = $payment_method_billing_info->get_html();
-        $html                        .= $this->checkout->redirect_form;
-        /** @var ResponseInterface $response */
-        $response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
-        $response->addOutput($html);
-        return true;
-    }
-
-
-    /**
-     * _billing_form_is_valid
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    private function _billing_form_is_valid()
-    {
-        if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
-            return true;
-        }
-        if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
-            if ($this->checkout->billing_form->was_submitted()) {
-                $this->checkout->billing_form->receive_form_submission();
-                if ($this->checkout->billing_form->is_valid()) {
-                    return true;
-                }
-                $validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
-                $error_strings     = [];
-                foreach ($validation_errors as $validation_error) {
-                    if ($validation_error instanceof EE_Validation_Error) {
-                        $form_section = $validation_error->get_form_section();
-                        if ($form_section instanceof EE_Form_Input_Base) {
-                            $label = $form_section->html_label_text();
-                        } elseif ($form_section instanceof EE_Form_Section_Base) {
-                            $label = $form_section->name();
-                        } else {
-                            $label = esc_html__('Validation Error', 'event_espresso');
-                        }
-                        $error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
-                    }
-                }
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'One or more billing form inputs are invalid and require correction before proceeding. %1$s %2$s',
-                            'event_espresso'
-                        ),
-                        '<br/>',
-                        implode('<br/>', $error_strings)
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'The billing form was not submitted or something prevented it\'s submission.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'The submitted billing form is invalid possibly due to a technical reason.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * _setup_primary_registrant_prior_to_payment
-     * ensures that the primary registrant has a valid attendee object created with the critical details populated
-     * (first & last name & email) and that both the transaction object and primary registration object have been saved
-     * plz note that any other registrations will NOT be saved at this point (because they may not have any details
-     * yet)
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _setup_primary_registrant_prior_to_payment()
-    {
-        // check if transaction has a primary registrant and that it has a related Attendee object
-        // if not, then we need to at least gather some primary registrant data before attempting payment
-        if (
-            $this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
-            && ! $this->checkout->transaction_has_primary_registrant()
-            && ! $this->_capture_primary_registration_data_from_billing_form()
-        ) {
-            return false;
-        }
-        // because saving an object clears it's cache, we need to do the chevy shuffle
-        // grab the primary_registration object
-        $primary_registration = $this->checkout->transaction->primary_registration();
-        // at this point we'll consider a TXN to not have been failed
-        $this->checkout->transaction->toggle_failed_transaction_status();
-        // save the TXN ( which clears cached copy of primary_registration)
-        $this->checkout->transaction->save();
-        // grab TXN ID and save it to the primary_registration
-        $primary_registration->set_transaction_id($this->checkout->transaction->ID());
-        // save what we have so far
-        $primary_registration->save();
-        return true;
-    }
-
-
-    /**
-     * _capture_primary_registration_data_from_billing_form
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _capture_primary_registration_data_from_billing_form()
-    {
-        // convert billing form data into an attendee
-        $this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
-        if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The billing form details could not be used for attendee details due to a technical issue.%sPlease try again or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $primary_registration = $this->checkout->transaction->primary_registration();
-        if (! $primary_registration instanceof EE_Registration) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The primary registrant for this transaction could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if (
-            ! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
-              instanceof
-              EE_Attendee
-        ) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The primary registrant could not be associated with this transaction due to a technical issue.%sPlease try again or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        /** @type EE_Registration_Processor $registration_processor */
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-        // at this point, we should have enough details about the registrant to consider the registration NOT incomplete
-        $registration_processor->toggle_incomplete_registration_status_to_default($primary_registration);
-        return true;
-    }
-
-
-    /**
-     * _get_payment_method_for_selected_method_of_payment
-     * retrieves a valid payment method
-     *
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_payment_method_for_selected_method_of_payment()
-    {
-        if ($this->checkout->selected_method_of_payment === 'events_sold_out') {
-            $this->_redirect_because_event_sold_out();
-            return null;
-        }
-        // get EE_Payment_Method object
-        if (isset($this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ])) {
-            $payment_method = $this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ];
-        } else {
-            // load EEM_Payment_Method
-            EE_Registry::instance()->load_model('Payment_Method');
-            $EEM_Payment_Method = EEM_Payment_Method::instance();
-            $payment_method     = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
-        }
-        // verify $payment_method
-        if (! $payment_method instanceof EE_Payment_Method) {
-            // not a payment
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The selected method of payment could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        // and verify it has a valid Payment_Method Type object
-        if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
-            // not a payment
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $payment_method;
-    }
-
-
-    /**
-     *    _attempt_payment
-     *
-     * @access    private
-     * @type    EE_Payment_Method $payment_method
-     * @return mixed EE_Payment | boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _attempt_payment(EE_Payment_Method $payment_method)
-    {
-        $payment = null;
-        $this->checkout->transaction->save();
-        $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-        if (! $payment_processor instanceof EE_Payment_Processor) {
-            return false;
-        }
-        try {
-            $payment_processor->set_revisit($this->checkout->revisit);
-            // generate payment object
-            $payment = $payment_processor->process_payment(
-                $payment_method,
-                $this->checkout->transaction,
-                $this->checkout->amount_owing,
-                $this->checkout->billing_form,
-                $this->_get_return_url($payment_method),
-                'CART',
-                $this->checkout->admin_request,
-                true,
-                $this->reg_step_url()
-            );
-        } catch (Exception $e) {
-            $this->_handle_payment_processor_exception($e);
-        }
-        return $payment;
-    }
-
-
-    /**
-     * _handle_payment_processor_exception
-     *
-     * @param Exception $e
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _handle_payment_processor_exception(Exception $e)
-    {
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    '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',
-                    'event_espresso'
-                ),
-                '<br/>',
-                EE_Registry::instance()->CFG->organization->get_pretty('email'),
-                $e->getMessage(),
-                $e->getFile(),
-                $e->getLine()
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-    }
-
-
-    /**
-     * _get_return_url
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_return_url(EE_Payment_Method $payment_method)
-    {
-        $return_url = '';
-        switch ($payment_method->type_obj()->payment_occurs()) {
-            case EE_PMT_Base::offsite:
-                $return_url = add_query_arg(
-                    [
-                        'action'                     => 'process_gateway_response',
-                        'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
-                        'spco_txn'                   => $this->checkout->transaction->ID(),
-                    ],
-                    $this->reg_step_url()
-                );
-                break;
-            case EE_PMT_Base::onsite:
-            case EE_PMT_Base::offline:
-                $return_url = $this->checkout->next_step->reg_step_url();
-                break;
-        }
-        return $return_url;
-    }
-
-
-    /**
-     * _validate_payment
-     *
-     * @param EE_Payment $payment
-     * @return EE_Payment|FALSE
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _validate_payment($payment = null)
-    {
-        if ($this->checkout->payment_method->is_off_line()) {
-            return true;
-        }
-        // verify payment object
-        if (! $payment instanceof EE_Payment) {
-            // not a payment
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'A valid payment was not generated due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return $payment;
-    }
-
-
-    /**
-     * _post_payment_processing
-     *
-     * @param EE_Payment|bool $payment
-     * @return bool|EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _post_payment_processing($payment = null)
-    {
-        // Off-Line payment?
-        if ($payment === true) {
-            return true;
-        }
-        if ($payment instanceof EE_Payment) {
-            // Should the user be redirected?
-            if ($payment->redirect_url()) {
-                do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()');
-                $this->checkout->redirect      = true;
-                $this->checkout->redirect_form = $payment->redirect_form();
-                $this->checkout->redirect_url  = $this->reg_step_url('redirect_form');
-                // set JSON response
-                $this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
-                // and lastly, let's bump the payment status to pending
-                $payment->set_status(EEM_Payment::status_id_pending);
-                $payment->save();
-            } elseif (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
-                // User shouldn't be redirected. So let's process it here.
-                // $this->_setup_redirect_for_next_step();
-                $this->checkout->continue_reg = false;
-            }
-            return $payment;
-        }
-        // ummm ya... not Off-Line, not On-Site, not off-Site ????
-        $this->checkout->continue_reg = false;
-        return false;
-    }
-
-
-    /**
-     *    _process_payment_status
-     *
-     * @type    EE_Payment $payment
-     * @param string       $payment_occurs
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline)
-    {
-        // off-line payment? carry on
-        if ($payment_occurs === EE_PMT_Base::offline) {
-            return true;
-        }
-        // verify payment validity
-        if ($payment instanceof EE_Payment) {
-            do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()');
-            $msg = $payment->gateway_response();
-            // check results
-            switch ($payment->status()) {
-                // good payment
-                case EEM_Payment::status_id_approved:
-                    EE_Error::add_success(
-                        esc_html__('Your payment was processed successfully.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return true;
-                // slow payment
-                case EEM_Payment::status_id_pending:
-                    if (empty($msg)) {
-                        $msg = esc_html__(
-                            'Your payment appears to have been processed successfully, but the Instant Payment Notification has not yet been received. It should arrive shortly.',
-                            'event_espresso'
-                        );
-                    }
-                    EE_Error::add_success($msg, __FILE__, __FUNCTION__, __LINE__);
-                    return true;
-                // don't wanna payment
-                case EEM_Payment::status_id_cancelled:
-                    if (empty($msg)) {
-                        $msg = _n(
-                            'Payment cancelled. Please try again.',
-                            'Payment cancelled. Please try again or select another method of payment.',
-                            count($this->checkout->available_payment_methods),
-                            'event_espresso'
-                        );
-                    }
-                    EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
-                    return false;
-                // not enough payment
-                case EEM_Payment::status_id_declined:
-                    if (empty($msg)) {
-                        $msg = _n(
-                            'We\'re sorry but your payment was declined. Please try again.',
-                            'We\'re sorry but your payment was declined. Please try again or select another method of payment.',
-                            count($this->checkout->available_payment_methods),
-                            'event_espresso'
-                        );
-                    }
-                    EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
-                    return false;
-                // bad payment
-                case EEM_Payment::status_id_failed:
-                    if (! empty($msg)) {
-                        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                        return false;
-                    }
-                    // default to error below
-                    break;
-            }
-        }
-        // off-site payment gateway responses are too unreliable, so let's just assume that
-        // the payment processing is just running slower than the registrant's request
-        if ($payment_occurs === EE_PMT_Base::offsite) {
-            return true;
-        }
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'Your payment could not be processed successfully due to a technical issue.%sPlease try again or contact %s for assistance.',
-                    'event_espresso'
-                ),
-                '<br/>',
-                EE_Registry::instance()->CFG->organization->get_pretty('email')
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
-
-
-
-
-
-
-    /********************************************************************************************************/
-    /**********************************  PROCESS GATEWAY RESPONSE  **********************************/
-    /********************************************************************************************************/
-    /**
-     * process_gateway_response
-     * this is the return point for Off-Site Payment Methods
-     * It will attempt to "handle the IPN" if it appears that this has not already occurred,
-     * otherwise, it will load up the last payment made for the TXN.
-     * If the payment retrieved looks good, it will then either:
-     *    complete the current step and allow advancement to the next reg step
-     *        or present the payment options again
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_gateway_response()
-    {
-        // how have they chosen to pay?
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
-        // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
-            $this->checkout->continue_reg = false;
-            return false;
-        }
-        if (! $this->checkout->payment_method->is_off_site()) {
-            return false;
-        }
-        $this->_validate_offsite_return();
-        // verify TXN
-        if ($this->checkout->transaction instanceof EE_Transaction) {
-            $gateway = $this->checkout->payment_method->type_obj()->get_gateway();
-            if (! $gateway instanceof EE_Offsite_Gateway) {
-                $this->checkout->continue_reg = false;
-                return false;
-            }
-            $payment = $this->_process_off_site_payment($gateway);
-            $payment = $this->_process_cancelled_payments($payment);
-            $payment = $this->_validate_payment($payment);
-            // if payment was not declined by the payment gateway or cancelled by the registrant
-            if ($this->_process_payment_status($payment, EE_PMT_Base::offsite)) {
-                // $this->_setup_redirect_for_next_step();
-                // store that for later
-                $this->checkout->payment = $payment;
-                // mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
-                // because we will complete this step during the IPN processing then
-                if (! $this->handle_IPN_in_this_request()) {
-                    $this->set_completed();
-                }
-                return true;
-            }
-        }
-        // DEBUG LOG
-        // $this->checkout->log(
-        //     __CLASS__,
-        //     __FUNCTION__,
-        //     __LINE__,
-        //     array('payment' => $payment)
-        // );
-        $this->checkout->continue_reg = false;
-        return false;
-    }
-
-
-    /**
-     * _validate_return
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _validate_offsite_return()
-    {
-        $TXN_ID = $this->request->getRequestParam('spco_txn', 0, 'int');
-        if ($TXN_ID !== $this->checkout->transaction->ID()) {
-            // Houston... we might have a problem
-            $invalid_TXN = false;
-            // first gather some info
-            $valid_TXN          = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            $primary_registrant = $valid_TXN instanceof EE_Transaction
-                ? $valid_TXN->primary_registration()
-                : null;
-            // let's start by retrieving the cart for this TXN
-            $cart = $this->checkout->get_cart_for_transaction($this->checkout->transaction);
-            if ($cart instanceof EE_Cart) {
-                // verify that the current cart has tickets
-                $tickets = $cart->get_tickets();
-                if (empty($tickets)) {
-                    $invalid_TXN = true;
-                }
-            } else {
-                $invalid_TXN = true;
-            }
-            $valid_TXN_SID = $primary_registrant instanceof EE_Registration
-                ? $primary_registrant->session_ID()
-                : null;
-            // validate current Session ID and compare against valid TXN session ID
-            if (
-                $invalid_TXN // if this is already true, then skip other checks
-                || EE_Session::instance()->id() === null
-                || (
-                    // WARNING !!!
-                    // this could be PayPal sending back duplicate requests (ya they do that)
-                    // or it **could** mean someone is simply registering AGAIN after having just done so
-                    // so now we need to determine if this current TXN looks valid or not
-                    // and whether this reg step has even been started ?
-                    EE_Session::instance()->id() === $valid_TXN_SID
-                    // really? you're half way through this reg step, but you never started it ?
-                    && $this->checkout->transaction->reg_step_completed($this->slug()) === false
-                )
-            ) {
-                $invalid_TXN = true;
-            }
-            if ($invalid_TXN) {
-                // is the valid TXN completed ?
-                if ($valid_TXN instanceof EE_Transaction) {
-                    // has this step even been started ?
-                    $reg_step_completed = $valid_TXN->reg_step_completed($this->slug());
-                    if ($reg_step_completed !== false && $reg_step_completed !== true) {
-                        // so it **looks** like this is a double request from PayPal
-                        // so let's try to pick up where we left off
-                        $this->checkout->transaction = $valid_TXN;
-                        $this->checkout->refresh_all_entities(true);
-                        return;
-                    }
-                }
-                // you appear to be lost?
-                $this->_redirect_wayward_request($primary_registrant);
-            }
-        }
-    }
-
-
-    /**
-     * _redirect_wayward_request
-     *
-     * @param EE_Registration|null $primary_registrant
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _redirect_wayward_request(EE_Registration $primary_registrant)
-    {
-        if (! $primary_registrant instanceof EE_Registration) {
-            // try redirecting based on the current TXN
-            $primary_registrant = $this->checkout->transaction instanceof EE_Transaction
-                ? $this->checkout->transaction->primary_registration()
-                : null;
-        }
-        if (! $primary_registrant instanceof EE_Registration) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        '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.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return;
-        }
-        // make sure transaction is not locked
-        $this->checkout->transaction->unlock();
-        wp_safe_redirect(
-            add_query_arg(
-                [
-                    'e_reg_url_link' => $primary_registrant->reg_url_link(),
-                ],
-                $this->checkout->thank_you_page_url
-            )
-        );
-        exit();
-    }
-
-
-    /**
-     * _process_off_site_payment
-     *
-     * @param EE_Offsite_Gateway $gateway
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
-    {
-        try {
-            $request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-            $request_data = $request->requestParams();
-            // if gateway uses_separate_IPN_request, then we don't have to process the IPN manually
-            $this->set_handle_IPN_in_this_request(
-                $gateway->handle_IPN_in_this_request($request_data, false)
-            );
-            if ($this->handle_IPN_in_this_request()) {
-                // get payment details and process results
-                /** @type EE_Payment_Processor $payment_processor */
-                $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-                $payment           = $payment_processor->process_ipn(
-                    $request_data,
-                    $this->checkout->transaction,
-                    $this->checkout->payment_method,
-                    true,
-                    false
-                );
-                // $payment_source = 'process_ipn';
-            } else {
-                $payment = $this->checkout->transaction->last_payment();
-                // $payment_source = 'last_payment';
-            }
-        } catch (Exception $e) {
-            // let's just eat the exception and try to move on using any previously set payment info
-            $payment = $this->checkout->transaction->last_payment();
-            // $payment_source = 'last_payment after Exception';
-            // but if we STILL don't have a payment object
-            if (! $payment instanceof EE_Payment) {
-                // then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
-                $this->_handle_payment_processor_exception($e);
-            }
-        }
-        return $payment;
-    }
-
-
-    /**
-     * _process_cancelled_payments
-     * just makes sure that the payment status gets updated correctly
-     * so tha tan error isn't generated during payment validation
-     *
-     * @param EE_Payment $payment
-     * @return EE_Payment|null
-     * @throws EE_Error
-     */
-    private function _process_cancelled_payments($payment = null)
-    {
-        if (
-            $payment instanceof EE_Payment
-            && $this->request->requestParamIsSet('ee_cancel_payment')
-            && $payment->status() === EEM_Payment::status_id_failed
-        ) {
-            $payment->set_status(EEM_Payment::status_id_cancelled);
-        }
-        return $payment;
-    }
-
-
-    /**
-     *    get_transaction_details_for_gateways
-     *
-     * @access    public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_transaction_details_for_gateways()
-    {
-        $txn_details = [];
-        // ya gotta make a choice man
-        if (empty($this->checkout->selected_method_of_payment)) {
-            $txn_details = [
-                'error' => esc_html__('Please select a method of payment before proceeding.', 'event_espresso'),
-            ];
-        }
-        // get EE_Payment_Method object
-        if (
-            empty($txn_details)
-            && ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
-        ) {
-            $txn_details = [
-                'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
-                'error'                      => esc_html__(
-                    'A valid Payment Method could not be determined.',
-                    'event_espresso'
-                ),
-            ];
-        }
-        if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
-            $return_url  = $this->_get_return_url($this->checkout->payment_method);
-            $txn_details = [
-                'TXN_ID'         => $this->checkout->transaction->ID(),
-                'TXN_timestamp'  => $this->checkout->transaction->datetime(),
-                'TXN_total'      => $this->checkout->transaction->total(),
-                'TXN_paid'       => $this->checkout->transaction->paid(),
-                'TXN_reg_steps'  => $this->checkout->transaction->reg_steps(),
-                'STS_ID'         => $this->checkout->transaction->status_ID(),
-                'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
-                'payment_amount' => $this->checkout->amount_owing,
-                'return_url'     => $return_url,
-                'cancel_url'     => add_query_arg(['ee_cancel_payment' => true], $return_url),
-                'notify_url'     => EE_Config::instance()->core->txn_page_url(
-                    [
-                        'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
-                        'ee_payment_method' => $this->checkout->payment_method->slug(),
-                    ]
-                ),
-            ];
-        }
-        echo wp_json_encode($txn_details);
-        exit();
-    }
-
-
-    /**
-     *    __sleep
-     * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
-     * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
-     * reg form, because if needed, it will be regenerated anyways
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        // remove the reg form and the checkout
-        return array_diff(array_keys(get_object_vars($this)), ['reg_form', 'checkout', 'line_item_display']);
-    }
+	/**
+	 * @var EE_Line_Item_Display $Line_Item_Display
+	 */
+	protected $line_item_display;
+
+	/**
+	 * @var boolean $handle_IPN_in_this_request
+	 */
+	protected $handle_IPN_in_this_request = false;
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		add_filter(
+			'FHEE__SPCO__EE_Line_Item_Filter_Collection',
+			['EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters']
+		);
+		add_action(
+			'wp_ajax_switch_spco_billing_form',
+			['EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form']
+		);
+		add_action(
+			'wp_ajax_nopriv_switch_spco_billing_form',
+			['EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form']
+		);
+		add_action('wp_ajax_save_payer_details', ['EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details']);
+		add_action(
+			'wp_ajax_nopriv_save_payer_details',
+			['EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details']
+		);
+		add_action(
+			'wp_ajax_get_transaction_details_for_gateways',
+			['EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details']
+		);
+		add_action(
+			'wp_ajax_nopriv_get_transaction_details_for_gateways',
+			['EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details']
+		);
+		add_filter(
+			'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
+			['EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'],
+			10,
+			1
+		);
+	}
+
+
+	/**
+	 *    ajax switch_spco_billing_form
+	 *
+	 */
+	public static function switch_spco_billing_form()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
+	}
+
+
+	/**
+	 *    ajax save_payer_details
+	 *
+	 */
+	public static function save_payer_details()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
+	}
+
+
+	/**
+	 *    ajax get_transaction_details
+	 *
+	 */
+	public static function get_transaction_details()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
+	}
+
+
+	/**
+	 * bypass_recaptcha_for_load_payment_method
+	 *
+	 * @access public
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function bypass_recaptcha_for_load_payment_method()
+	{
+		return [
+			'EESID'  => EE_Registry::instance()->SSN->id(),
+			'step'   => 'payment_options',
+			'action' => 'spco_billing_form',
+		];
+	}
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param EE_Checkout $checkout
+	 */
+	public function __construct(EE_Checkout $checkout)
+	{
+		$this->request   = EED_Single_Page_Checkout::getRequest();
+		$this->_slug     = 'payment_options';
+		$this->_name     = esc_html__('Payment Options', 'event_espresso');
+		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . '/payment_options_main.template.php';
+		$this->checkout  = $checkout;
+		$this->_reset_success_message();
+		$this->set_instructions(
+			esc_html__(
+				'Please select a method of payment and provide any necessary billing information before proceeding.',
+				'event_espresso'
+			)
+		);
+	}
+
+
+	/**
+	 * @return null
+	 */
+	public function line_item_display()
+	{
+		return $this->line_item_display;
+	}
+
+
+	/**
+	 * @param null $line_item_display
+	 */
+	public function set_line_item_display($line_item_display)
+	{
+		$this->line_item_display = $line_item_display;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function handle_IPN_in_this_request()
+	{
+		return $this->handle_IPN_in_this_request;
+	}
+
+
+	/**
+	 * @param boolean $handle_IPN_in_this_request
+	 */
+	public function set_handle_IPN_in_this_request($handle_IPN_in_this_request)
+	{
+		$this->handle_IPN_in_this_request = filter_var($handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * translate_js_strings
+	 *
+	 * @return void
+	 */
+	public function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
+			'Please select a method of payment in order to continue.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
+			'A valid method of payment could not be determined. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
+			'Forwarding to Secure Payment Provider.',
+			'event_espresso'
+		);
+	}
+
+
+	/**
+	 * enqueue_styles_and_scripts
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function enqueue_styles_and_scripts()
+	{
+		$transaction = $this->checkout->transaction;
+		// if the transaction isn't set or nothing is owed on it, don't enqueue any JS
+		if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
+			return;
+		}
+		foreach (
+			EEM_Payment_Method::instance()->get_all_for_transaction(
+				$transaction,
+				EEM_Payment_Method::scope_cart
+			) as $payment_method
+		) {
+			$type_obj = $payment_method->type_obj();
+			if ($type_obj instanceof EE_PMT_Base) {
+				$billing_form = $type_obj->generate_new_billing_form($transaction);
+				if ($billing_form instanceof EE_Form_Section_Proper) {
+					$billing_form->enqueue_js();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * initialize_reg_step
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function initialize_reg_step()
+	{
+		// TODO: if /when we implement donations, then this will need overriding
+		if (
+			// don't need payment options for:
+			// registrations made via the admin
+			// completed transactions
+			// overpaid transactions
+			// $ 0.00 transactions(no payment required)
+			! $this->checkout->payment_required()
+			// but do NOT remove if current action being called belongs to this reg step
+			&& ! is_callable([$this, $this->checkout->action])
+			&& ! $this->completed()
+		) {
+			// and if so, then we no longer need the Payment Options step
+			if ($this->is_current_step()) {
+				$this->checkout->generate_reg_form = false;
+			}
+			$this->checkout->remove_reg_step($this->_slug);
+			// DEBUG LOG
+			// $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
+			return false;
+		}
+		// load EEM_Payment_Method
+		EE_Registry::instance()->load_model('Payment_Method');
+		// get all active payment methods
+		$this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
+			$this->checkout->transaction,
+			EEM_Payment_Method::scope_cart
+		);
+		return true;
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidStatusException
+	 */
+	public function generate_reg_form()
+	{
+		// reset in case someone changes their mind
+		$this->_reset_selected_method_of_payment();
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'payments_closed';
+		$registrations_requiring_payment            = [];
+		$registrations_for_free_events              = [];
+		$registrations_requiring_pre_approval       = [];
+		$sold_out_events                            = [];
+		$insufficient_spaces_available              = [];
+		$no_payment_required                        = true;
+		// loop thru registrations to gather info
+		$registrations         = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
+			$registrations,
+			$this->checkout->revisit
+		);
+		foreach ($registrations as $REG_ID => $registration) {
+			/** @var $registration EE_Registration */
+			// has this registration lost it's space ?
+			if (isset($ejected_registrations[ $REG_ID ])) {
+				if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
+					$sold_out_events[ $registration->event()->ID() ] = $registration->event();
+				} else {
+					$insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
+				}
+				continue;
+			}
+			// event requires admin approval
+			if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
+				// add event to list of events with pre-approval reg status
+				$registrations_requiring_pre_approval[ $REG_ID ] = $registration;
+				do_action(
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
+					$registration->event(),
+					$this
+				);
+				continue;
+			}
+			if (
+				$this->checkout->revisit
+				&& $registration->status_ID() !== EEM_Registration::status_id_approved
+				&& (
+					$registration->event()->is_sold_out()
+					|| $registration->event()->is_sold_out(true)
+				)
+			) {
+				// add event to list of events that are sold out
+				$sold_out_events[ $registration->event()->ID() ] = $registration->event();
+				do_action(
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
+					$registration->event(),
+					$this
+				);
+				continue;
+			}
+			// are they allowed to pay now and is there monies owing?
+			if ($registration->owes_monies_and_can_pay()) {
+				$registrations_requiring_payment[ $REG_ID ] = $registration;
+				do_action(
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
+					$registration->event(),
+					$this
+				);
+			} elseif (
+				! $this->checkout->revisit
+					  && $registration->status_ID() !== EEM_Registration::status_id_not_approved
+					  && $registration->ticket()->is_free()
+			) {
+				$registrations_for_free_events[ $registration->ticket()->ID() ] = $registration;
+			}
+		}
+		$subsections = [];
+		// now decide which template to load
+		if (! empty($sold_out_events)) {
+			$subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
+		}
+		if (! empty($insufficient_spaces_available)) {
+			$subsections['insufficient_space'] = $this->_insufficient_spaces_available(
+				$insufficient_spaces_available
+			);
+		}
+		if (! empty($registrations_requiring_pre_approval)) {
+			$subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
+				$registrations_requiring_pre_approval
+			);
+		}
+		if (! empty($registrations_for_free_events)) {
+			$subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
+		}
+		if (! empty($registrations_requiring_payment)) {
+			if ($this->checkout->amount_owing > 0) {
+				// autoload Line_Item_Display classes
+				EEH_Autoloader::register_line_item_filter_autoloaders();
+				$line_item_filter_processor = new EE_Line_Item_Filter_Processor(
+					apply_filters(
+						'FHEE__SPCO__EE_Line_Item_Filter_Collection',
+						new EE_Line_Item_Filter_Collection()
+					),
+					$this->checkout->cart->get_grand_total()
+				);
+				/** @var EE_Line_Item $filtered_line_item_tree */
+				$filtered_line_item_tree = $line_item_filter_processor->process();
+				EEH_Autoloader::register_line_item_display_autoloaders();
+				$this->set_line_item_display(new EE_Line_Item_Display('spco'));
+				$subsections['payment_options'] = $this->_display_payment_options(
+					$this->line_item_display->display_line_item(
+						$filtered_line_item_tree,
+						['registrations' => $registrations]
+					)
+				);
+				$this->checkout->amount_owing   = $filtered_line_item_tree->total();
+				$this->_apply_registration_payments_to_amount_owing($registrations);
+			}
+			$no_payment_required = false;
+		} else {
+			$this->_hide_reg_step_submit_button_if_revisit();
+		}
+		$this->_save_selected_method_of_payment();
+
+		$subsections['default_hidden_inputs'] = $this->reg_step_hidden_inputs();
+		$subsections['extra_hidden_inputs']   = $this->_extra_hidden_inputs($no_payment_required);
+
+		return new EE_Form_Section_Proper(
+			[
+				'name'            => $this->reg_form_name(),
+				'html_id'         => $this->reg_form_name(),
+				'subsections'     => $subsections,
+				'layout_strategy' => new EE_No_Layout(),
+			]
+		);
+	}
+
+
+	/**
+	 * add line item filters required for this reg step
+	 * these filters are applied via this line in EE_SPCO_Reg_Step_Payment_Options::set_hooks():
+	 *        add_filter( 'FHEE__SPCO__EE_Line_Item_Filter_Collection', array( 'EE_SPCO_Reg_Step_Payment_Options',
+	 *        'add_spco_line_item_filters' ) ); so any code that wants to use the same set of filters during the
+	 *        payment options reg step, can apply these filters via the following: apply_filters(
+	 *        'FHEE__SPCO__EE_Line_Item_Filter_Collection', new EE_Line_Item_Filter_Collection() ) or to an existing
+	 *        filter collection by passing that instead of instantiating a new collection
+	 *
+	 * @param EE_Line_Item_Filter_Collection $line_item_filter_collection
+	 * @return EE_Line_Item_Filter_Collection
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidStatusException
+	 */
+	public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
+	{
+		if (! EE_Registry::instance()->SSN instanceof EE_Session) {
+			return $line_item_filter_collection;
+		}
+		if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
+			return $line_item_filter_collection;
+		}
+		if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
+			return $line_item_filter_collection;
+		}
+		$line_item_filter_collection->add(
+			new EE_Billable_Line_Item_Filter(
+				EE_SPCO_Reg_Step_Payment_Options::remove_ejected_registrations(
+					EE_Registry::instance()->SSN->checkout()->transaction->registrations(
+						EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
+					)
+				)
+			)
+		);
+		$line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
+		return $line_item_filter_collection;
+	}
+
+
+	/**
+	 * remove_ejected_registrations
+	 * if a registrant has lost their potential space at an event due to lack of payment,
+	 * then this method removes them from the list of registrations being paid for during this request
+	 *
+	 * @param EE_Registration[] $registrations
+	 * @return EE_Registration[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidStatusException
+	 */
+	public static function remove_ejected_registrations(array $registrations)
+	{
+		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
+			$registrations,
+			EE_Registry::instance()->SSN->checkout()->revisit
+		);
+		foreach ($registrations as $REG_ID => $registration) {
+			// has this registration lost it's space ?
+			if (isset($ejected_registrations[ $REG_ID ])) {
+				unset($registrations[ $REG_ID ]);
+			}
+		}
+		return $registrations;
+	}
+
+
+	/**
+	 * find_registrations_that_lost_their_space
+	 * If a registrant chooses an offline payment method like Invoice,
+	 * then no space is reserved for them at the event until they fully pay fo that site
+	 * (unless the event's default reg status is set to APPROVED)
+	 * if a registrant then later returns to pay, but the number of spaces available has been reduced due to sales,
+	 * then this method will determine which registrations have lost the ability to complete the reg process.
+	 *
+	 * @param EE_Registration[] $registrations
+	 * @param bool              $revisit
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidStatusException
+	 */
+	public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
+	{
+		// registrations per event
+		$event_reg_count = [];
+		// spaces left per event
+		$event_spaces_remaining = [];
+		// tickets left sorted by ID
+		$tickets_remaining = [];
+		// registrations that have lost their space
+		$ejected_registrations = [];
+		foreach ($registrations as $REG_ID => $registration) {
+			if (
+				$registration->status_ID() === EEM_Registration::status_id_approved
+				|| apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
+					false,
+					$registration,
+					$revisit
+				)
+			) {
+				continue;
+			}
+			$EVT_ID = $registration->event_ID();
+			$ticket = $registration->ticket();
+			if (! isset($tickets_remaining[ $ticket->ID() ])) {
+				$tickets_remaining[ $ticket->ID() ] = $ticket->remaining();
+			}
+			if ($tickets_remaining[ $ticket->ID() ] > 0) {
+				if (! isset($event_reg_count[ $EVT_ID ])) {
+					$event_reg_count[ $EVT_ID ] = 0;
+				}
+				$event_reg_count[ $EVT_ID ]++;
+				if (! isset($event_spaces_remaining[ $EVT_ID ])) {
+					$event_spaces_remaining[ $EVT_ID ] = $registration->event()->spaces_remaining_for_sale();
+				}
+			}
+			if (
+				$revisit
+				&& ($tickets_remaining[ $ticket->ID() ] === 0
+					|| $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
+				)
+			) {
+				$ejected_registrations[ $REG_ID ] = $registration->event();
+				if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
+					/** @type EE_Registration_Processor $registration_processor */
+					$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+					// at this point, we should have enough details about the registrant to consider the registration
+					// NOT incomplete
+					$registration_processor->manually_update_registration_status(
+						$registration,
+						EEM_Registration::status_id_wait_list
+					);
+				}
+			}
+		}
+		return $ejected_registrations;
+	}
+
+
+	/**
+	 * _hide_reg_step_submit_button
+	 * removes the html for the reg step submit button
+	 * by replacing it with an empty string via filter callback
+	 *
+	 * @return void
+	 */
+	protected function _adjust_registration_status_if_event_old_sold()
+	{
+	}
+
+
+	/**
+	 * _hide_reg_step_submit_button
+	 * removes the html for the reg step submit button
+	 * by replacing it with an empty string via filter callback
+	 *
+	 * @return void
+	 */
+	protected function _hide_reg_step_submit_button_if_revisit()
+	{
+		if ($this->checkout->revisit) {
+			add_filter('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string');
+		}
+	}
+
+
+	/**
+	 * sold_out_events
+	 * displays notices regarding events that have sold out since hte registrant first signed up
+	 *
+	 * @param EE_Event[] $sold_out_events_array
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	private function _sold_out_events($sold_out_events_array = [])
+	{
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'events_sold_out';
+		$sold_out_events                            = '';
+		foreach ($sold_out_events_array as $sold_out_event) {
+			$sold_out_events .= EEH_HTML::li(
+				EEH_HTML::span(
+					'  ' . $sold_out_event->name(),
+					'',
+					'dashicons dashicons-marker ee-icon-size-16 pink-text'
+				)
+			);
+		}
+		return new EE_Form_Section_Proper(
+			[
+				'layout_strategy' => new EE_Template_Layout(
+					[
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . '/sold_out_events.template.php',
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
+							[
+								'sold_out_events'     => $sold_out_events,
+								'sold_out_events_msg' => apply_filters(
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
+									sprintf(
+										esc_html__(
+											'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',
+											'event_espresso'
+										),
+										'<strong>',
+										'</strong>',
+										'<br />'
+									)
+								),
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * _insufficient_spaces_available
+	 * displays notices regarding events that do not have enough remaining spaces
+	 * to satisfy the current number of registrations looking to pay
+	 *
+	 * @param EE_Event[] $insufficient_spaces_events_array
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _insufficient_spaces_available($insufficient_spaces_events_array = [])
+	{
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'invoice';
+		$insufficient_space_events                  = '';
+		foreach ($insufficient_spaces_events_array as $event) {
+			if ($event instanceof EE_Event) {
+				$insufficient_space_events .= EEH_HTML::li(
+					EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
+				);
+			}
+		}
+		return new EE_Form_Section_Proper(
+			[
+				'subsections'     => [
+					'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
+					'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
+				],
+				'layout_strategy' => new EE_Template_Layout(
+					[
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . '/sold_out_events.template.php',
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
+							[
+								'sold_out_events'     => $insufficient_space_events,
+								'sold_out_events_msg' => apply_filters(
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__insufficient_space_msg',
+									esc_html__(
+										'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.',
+										'event_espresso'
+									)
+								),
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * registrations_requiring_pre_approval
+	 *
+	 * @param array $registrations_requiring_pre_approval
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws ReflectionException
+	 */
+	private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = [])
+	{
+		$events_requiring_pre_approval = [];
+		foreach ($registrations_requiring_pre_approval as $registration) {
+			if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
+				$events_requiring_pre_approval[ $registration->event()->ID() ] = EEH_HTML::li(
+					EEH_HTML::span(
+						'',
+						'',
+						'dashicons dashicons-marker ee-icon-size-16 orange-text'
+					)
+					. EEH_HTML::span($registration->event()->name(), '', 'orange-text')
+				);
+			}
+		}
+		return new EE_Form_Section_Proper(
+			[
+				'layout_strategy' => new EE_Template_Layout(
+					[
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . '/events_requiring_pre_approval.template.php', // layout_template
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
+							[
+								'events_requiring_pre_approval'     => implode('', $events_requiring_pre_approval),
+								'events_requiring_pre_approval_msg' => apply_filters(
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___events_requiring_pre_approval__events_requiring_pre_approval_msg',
+									esc_html__(
+										'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.',
+										'event_espresso'
+									)
+								),
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * _no_payment_required
+	 *
+	 * @param EE_Event[] $registrations_for_free_events
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	private function _no_payment_required($registrations_for_free_events = [])
+	{
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'no_payment_required';
+		// generate no_payment_required form
+		return new EE_Form_Section_Proper(
+			[
+				'layout_strategy' => new EE_Template_Layout(
+					[
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . '/no_payment_required.template.php', // layout_template
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
+							[
+								'revisit'                       => $this->checkout->revisit,
+								'registrations'                 => [],
+								'ticket_count'                  => [],
+								'registrations_for_free_events' => $registrations_for_free_events,
+								'no_payment_required_msg'       => EEH_HTML::p(
+									esc_html__('This is a free event, so no billing will occur.', 'event_espresso')
+								),
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * _display_payment_options
+	 *
+	 * @param string $transaction_details
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _display_payment_options($transaction_details = '')
+	{
+		// has method_of_payment been set by no-js user?
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment();
+		// build payment options form
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__payment_options_form',
+			new EE_Form_Section_Proper(
+				[
+					'subsections'     => [
+						'before_payment_options' => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
+							new EE_Form_Section_Proper(
+								['layout_strategy' => new EE_Div_Per_Section_Layout()]
+							)
+						),
+						'payment_options'        => $this->_setup_payment_options(),
+						'after_payment_options'  => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__after_payment_options',
+							new EE_Form_Section_Proper(
+								['layout_strategy' => new EE_Div_Per_Section_Layout()]
+							)
+						),
+					],
+					'layout_strategy' => new EE_Template_Layout(
+						[
+							'layout_template_file' => $this->_template,
+							'template_args'        => apply_filters(
+								'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
+								[
+									'reg_count'                 => $this->line_item_display->total_items(),
+									'transaction_details'       => $transaction_details,
+									'available_payment_methods' => [],
+								]
+							),
+						]
+					),
+				]
+			)
+		);
+	}
+
+
+	/**
+	 * _extra_hidden_inputs
+	 *
+	 * @param bool $no_payment_required
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _extra_hidden_inputs($no_payment_required = true)
+	{
+		return new EE_Form_Section_Proper(
+			[
+				'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => [
+					'spco_no_payment_required' => new EE_Hidden_Input(
+						[
+							'normalization_strategy' => new EE_Boolean_Normalization(),
+							'html_name'              => 'spco_no_payment_required',
+							'html_id'                => 'spco-no-payment-required-payment_options',
+							'default'                => $no_payment_required,
+						]
+					),
+					'spco_transaction_id'      => new EE_Fixed_Hidden_Input(
+						[
+							'normalization_strategy' => new EE_Int_Normalization(),
+							'html_name'              => 'spco_transaction_id',
+							'html_id'                => 'spco-transaction-id',
+							'default'                => $this->checkout->transaction->ID(),
+						]
+					),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 *    _apply_registration_payments_to_amount_owing
+	 *
+	 * @param array $registrations
+	 * @throws EE_Error
+	 */
+	protected function _apply_registration_payments_to_amount_owing(array $registrations)
+	{
+		$payments = [];
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
+				$payments += $registration->registration_payments();
+			}
+		}
+		if (! empty($payments)) {
+			foreach ($payments as $payment) {
+				if ($payment instanceof EE_Registration_Payment) {
+					$this->checkout->amount_owing -= $payment->amount();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    _reset_selected_method_of_payment
+	 *
+	 * @access    private
+	 * @param bool $force_reset
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _reset_selected_method_of_payment($force_reset = false)
+	{
+		/** @var RequestInterface $request */
+		$request              = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$reset_payment_method = $request->getRequestParam('reset_payment_method', $force_reset, 'bool');
+		if ($reset_payment_method) {
+			$this->checkout->selected_method_of_payment = null;
+			$this->checkout->payment_method             = null;
+			$this->checkout->billing_form               = null;
+			$this->_save_selected_method_of_payment();
+		}
+	}
+
+
+	/**
+	 * _save_selected_method_of_payment
+	 * stores the selected_method_of_payment in the session
+	 * so that it's available for all subsequent requests including AJAX
+	 *
+	 * @access        private
+	 * @param string $selected_method_of_payment
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _save_selected_method_of_payment($selected_method_of_payment = '')
+	{
+		$selected_method_of_payment = ! empty($selected_method_of_payment)
+			? $selected_method_of_payment
+			: $this->checkout->selected_method_of_payment;
+		EE_Registry::instance()->SSN->set_session_data(
+			['selected_method_of_payment' => $selected_method_of_payment]
+		);
+	}
+
+
+	/**
+	 * _setup_payment_options
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function _setup_payment_options()
+	{
+		// load payment method classes
+		$this->checkout->available_payment_methods = $this->_get_available_payment_methods();
+		if (empty($this->checkout->available_payment_methods)) {
+			EE_Error::add_error(
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__error_message_no_payment_methods',
+					sprintf(
+						esc_html__(
+							'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.',
+							'event_espresso'
+						),
+						'<br>',
+						EE_Registry::instance()->CFG->organization->get_pretty('email')
+					)
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// switch up header depending on number of available payment methods
+		$payment_method_header     = count($this->checkout->available_payment_methods) > 1
+			? apply_filters(
+				'FHEE__registration_page_payment_options__method_of_payment_hdr',
+				esc_html__('Please Select Your Method of Payment', 'event_espresso')
+			)
+			: apply_filters(
+				'FHEE__registration_page_payment_options__method_of_payment_hdr',
+				esc_html__('Method of Payment', 'event_espresso')
+			);
+		$available_payment_methods = [
+			// display the "Payment Method" header
+			'payment_method_header' => new EE_Form_Section_HTML(
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__payment_method_header',
+					EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr'),
+					$payment_method_header
+				)
+			),
+		];
+		// the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
+		$available_payment_method_options = [];
+		$default_payment_method_option    = [];
+		// additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
+		$payment_methods_billing_info = [
+			new EE_Form_Section_HTML(
+				EEH_HTML::div('<br />', '', '', 'clear:both;')
+			),
+		];
+		// loop through payment methods
+		foreach ($this->checkout->available_payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
+				$payment_method_button = EEH_HTML::img(
+					$payment_method->button_url(),
+					$payment_method->name(),
+					'spco-payment-method-' . $payment_method->slug() . '-btn-img',
+					'spco-payment-method-btn-img'
+				);
+				// check if any payment methods are set as default
+				// if payment method is already selected OR nothing is selected and this payment method should be
+				// open_by_default
+				if (
+					($this->checkout->selected_method_of_payment === $payment_method->slug())
+					|| (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
+				) {
+					$this->checkout->selected_method_of_payment = $payment_method->slug();
+					$this->_save_selected_method_of_payment();
+					$default_payment_method_option[ $payment_method->slug() ] = $payment_method_button;
+				} else {
+					$available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
+				}
+				$payment_methods_billing_info[ $payment_method->slug() . '-info' ] =
+					$this->_payment_method_billing_info(
+						$payment_method
+					);
+			}
+		}
+		// prepend available_payment_method_options with default_payment_method_option so that it appears first in list
+		// of PMs
+		$available_payment_method_options = $default_payment_method_option + $available_payment_method_options;
+		// now generate the actual form  inputs
+		$available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
+			$available_payment_method_options
+		);
+		$available_payment_methods                              += $payment_methods_billing_info;
+		// build the available payment methods form
+		return new EE_Form_Section_Proper(
+			[
+				'html_id'         => 'spco-available-methods-of-payment-dv',
+				'subsections'     => $available_payment_methods,
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+			]
+		);
+	}
+
+
+	/**
+	 * _get_available_payment_methods
+	 *
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_available_payment_methods()
+	{
+		if (! empty($this->checkout->available_payment_methods)) {
+			return $this->checkout->available_payment_methods;
+		}
+		$available_payment_methods = [];
+		$EEM_Payment_Method        = EEM_Payment_Method::instance();
+		// get all active payment methods
+		$payment_methods = $EEM_Payment_Method->get_all_for_transaction(
+			$this->checkout->transaction,
+			EEM_Payment_Method::scope_cart
+		);
+		foreach ($payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
+				$available_payment_methods[ $payment_method->slug() ] = $payment_method;
+			}
+		}
+		return $available_payment_methods;
+	}
+
+
+	/**
+	 *    _available_payment_method_inputs
+	 *
+	 * @access    private
+	 * @param array $available_payment_method_options
+	 * @return    EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	private function _available_payment_method_inputs($available_payment_method_options = [])
+	{
+		// generate inputs
+		return new EE_Form_Section_Proper(
+			[
+				'html_id'         => 'ee-available-payment-method-inputs',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => [
+					'' => new EE_Radio_Button_Input(
+						$available_payment_method_options,
+						[
+							'html_name'          => 'selected_method_of_payment',
+							'html_class'         => 'spco-payment-method',
+							'default'            => $this->checkout->selected_method_of_payment,
+							'label_size'         => 11,
+							'enforce_label_size' => true,
+						]
+					),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 *    _payment_method_billing_info
+	 *
+	 * @access    private
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _payment_method_billing_info(EE_Payment_Method $payment_method)
+	{
+		$currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug();
+		// generate the billing form for payment method
+		$billing_form                 = $currently_selected
+			? $this->_get_billing_form_for_payment_method($payment_method)
+			: new EE_Form_Section_HTML();
+		$this->checkout->billing_form = $currently_selected
+			? $billing_form
+			: $this->checkout->billing_form;
+		// it's all in the details
+		$info_html = EEH_HTML::h3(
+			esc_html__('Important information regarding your payment', 'event_espresso'),
+			'',
+			'spco-payment-method-hdr'
+		);
+		// add some info regarding the step, either from what's saved in the admin,
+		// or a default string depending on whether the PM has a billing form or not
+		if ($payment_method->description()) {
+			$payment_method_info = $payment_method->description();
+		} elseif ($billing_form instanceof EE_Billing_Info_Form) {
+			$payment_method_info = sprintf(
+				esc_html__(
+					'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
+					'event_espresso'
+				),
+				$this->submit_button_text()
+			);
+		} else {
+			$payment_method_info = sprintf(
+				esc_html__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
+				$this->submit_button_text()
+			);
+		}
+		$info_html .= EEH_HTML::div(
+			apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options___payment_method_billing_info__payment_method_info',
+				$payment_method_info
+			),
+			'',
+			'spco-payment-method-desc ee-attention'
+		);
+		return new EE_Form_Section_Proper(
+			[
+				'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
+				'html_class'      => 'spco-payment-method-info-dv',
+				// only display the selected or default PM
+				'html_style'      => $currently_selected ? '' : 'display:none;',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => [
+					'info'         => new EE_Form_Section_HTML($info_html),
+					'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML(),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_billing_form_html_for_payment_method
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_billing_form_html_for_payment_method()
+	{
+		// how have they chosen to pay?
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
+		$this->checkout->payment_method             = $this->_get_payment_method_for_selected_method_of_payment();
+		if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
+			return false;
+		}
+		if (
+			apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
+				false
+			)
+		) {
+			EE_Error::add_success(
+				apply_filters(
+					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
+					sprintf(
+						esc_html__(
+							'You have selected "%s" as your method of payment. Please note the important payment information below.',
+							'event_espresso'
+						),
+						$this->checkout->payment_method->name()
+					)
+				)
+			);
+		}
+		// now generate billing form for selected method of payment
+		$payment_method_billing_form = $this->_get_billing_form_for_payment_method($this->checkout->payment_method);
+		// fill form with attendee info if applicable
+		if (
+			$payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
+			&& $this->checkout->transaction_has_primary_registrant()
+		) {
+			$payment_method_billing_form->populate_from_attendee(
+				$this->checkout->transaction->primary_registration()->attendee()
+			);
+		}
+		// and debug content
+		if (
+			$payment_method_billing_form instanceof EE_Billing_Info_Form
+			&& $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
+		) {
+			$payment_method_billing_form =
+				$this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
+					$payment_method_billing_form
+				);
+		}
+		$billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
+			? $payment_method_billing_form->get_html()
+			: '';
+		$this->checkout->json_response->set_return_data(['payment_method_info' => $billing_info]);
+		// localize validation rules for main form
+		$this->checkout->current_step->reg_form->localize_validation_rules();
+		$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
+		return true;
+	}
+
+
+	/**
+	 * _get_billing_form_for_payment_method
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Billing_Info_Form|EE_Form_Section_HTML
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method)
+	{
+		$billing_form = $payment_method->type_obj()->billing_form(
+			$this->checkout->transaction,
+			['amount_owing' => $this->checkout->amount_owing]
+		);
+		if ($billing_form instanceof EE_Billing_Info_Form) {
+			if (
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
+					false
+				)
+				&& $this->request->requestParamIsSet('payment_method')
+			) {
+				EE_Error::add_success(
+					apply_filters(
+						'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
+						sprintf(
+							esc_html__(
+								'You have selected "%s" as your method of payment. Please note the important payment information below.',
+								'event_espresso'
+							),
+							$payment_method->name()
+						)
+					)
+				);
+			}
+			return apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
+				$billing_form,
+				$payment_method
+			);
+		}
+		// no actual billing form, so return empty HTML form section
+		return new EE_Form_Section_HTML();
+	}
+
+
+	/**
+	 * _get_selected_method_of_payment
+	 *
+	 * @param boolean $required whether to throw an error if the "selected_method_of_payment"
+	 *                          is not found in the incoming request
+	 * @param string  $request_param
+	 * @return NULL|string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_selected_method_of_payment(
+		$required = false,
+		$request_param = 'selected_method_of_payment'
+	) {
+		// is selected_method_of_payment set in the request ?
+		$selected_method_of_payment = $this->request->getRequestParam($request_param);
+		if ($selected_method_of_payment) {
+			// sanitize it
+			$selected_method_of_payment = is_array($selected_method_of_payment)
+				? array_shift($selected_method_of_payment)
+				: $selected_method_of_payment;
+			$selected_method_of_payment = sanitize_text_field($selected_method_of_payment);
+			// store it in the session so that it's available for all subsequent requests including AJAX
+			$this->_save_selected_method_of_payment($selected_method_of_payment);
+		} else {
+			// or is is set in the session ?
+			$selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
+				'selected_method_of_payment'
+			);
+		}
+		// do ya really really gotta have it?
+		if (empty($selected_method_of_payment) && $required) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'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.',
+						'event_espresso'
+					),
+					'<br/>',
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $selected_method_of_payment;
+	}
+
+
+
+
+
+
+	/********************************************************************************************************/
+	/***********************************  SWITCH PAYMENT METHOD  ************************************/
+	/********************************************************************************************************/
+	/**
+	 * switch_payment_method
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function switch_payment_method()
+	{
+		if (! $this->_verify_payment_method_is_set()) {
+			return false;
+		}
+		if (
+			apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
+				false
+			)
+		) {
+			EE_Error::add_success(
+				apply_filters(
+					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
+					sprintf(
+						esc_html__(
+							'You have selected "%s" as your method of payment. Please note the important payment information below.',
+							'event_espresso'
+						),
+						$this->checkout->payment_method->name()
+					)
+				)
+			);
+		}
+		// generate billing form for selected method of payment if it hasn't been done already
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
+				$this->checkout->payment_method
+			);
+		}
+		// fill form with attendee info if applicable
+		if (
+			apply_filters(
+				'FHEE__populate_billing_form_fields_from_attendee',
+				(
+				$this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
+				&& $this->checkout->transaction_has_primary_registrant()
+				),
+				$this->checkout->billing_form,
+				$this->checkout->transaction
+			)
+		) {
+			$this->checkout->billing_form->populate_from_attendee(
+				$this->checkout->transaction->primary_registration()->attendee()
+			);
+		}
+		// and debug content
+		if (
+			$this->checkout->billing_form instanceof EE_Billing_Info_Form
+			&& $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
+		) {
+			$this->checkout->billing_form =
+				$this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
+					$this->checkout->billing_form
+				);
+		}
+		// get html and validation rules for form
+		if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
+			$this->checkout->json_response->set_return_data(
+				['payment_method_info' => $this->checkout->billing_form->get_html()]
+			);
+			// localize validation rules for main form
+			$this->checkout->billing_form->localize_validation_rules(true);
+			$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
+		} else {
+			$this->checkout->json_response->set_return_data(['payment_method_info' => '']);
+		}
+		// prevents advancement to next step
+		$this->checkout->continue_reg = false;
+		return true;
+	}
+
+
+	/**
+	 * _verify_payment_method_is_set
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _verify_payment_method_is_set()
+	{
+		// generate billing form for selected method of payment if it hasn't been done already
+		if (empty($this->checkout->selected_method_of_payment)) {
+			// how have they chosen to pay?
+			$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
+		} else {
+			// choose your own adventure based on method_of_payment
+			switch ($this->checkout->selected_method_of_payment) {
+				case 'events_sold_out':
+					EE_Error::add_attention(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__sold_out_events_msg',
+							esc_html__(
+								'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.',
+								'event_espresso'
+							)
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+				case 'payments_closed':
+					EE_Error::add_attention(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
+							esc_html__(
+								'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.',
+								'event_espresso'
+							)
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+				case 'no_payment_required':
+					EE_Error::add_attention(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
+							esc_html__(
+								'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.',
+								'event_espresso'
+							)
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+				default:
+			}
+		}
+		// verify payment method
+		if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
+			// get payment method for selected method of payment
+			$this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
+		}
+		return $this->checkout->payment_method instanceof EE_Payment_Method;
+	}
+
+
+
+	/********************************************************************************************************/
+	/***************************************  SAVE PAYER DETAILS  ****************************************/
+	/********************************************************************************************************/
+	/**
+	 * save_payer_details_via_ajax
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function save_payer_details_via_ajax()
+	{
+		if (! $this->_verify_payment_method_is_set()) {
+			return;
+		}
+		// generate billing form for selected method of payment if it hasn't been done already
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
+				$this->checkout->payment_method
+			);
+		}
+		// generate primary attendee from payer info if applicable
+		if (! $this->checkout->transaction_has_primary_registrant()) {
+			$attendee = $this->_create_attendee_from_request_data();
+			if ($attendee instanceof EE_Attendee) {
+				foreach ($this->checkout->transaction->registrations() as $registration) {
+					if ($registration->is_primary_registrant()) {
+						$this->checkout->primary_attendee_obj = $attendee;
+						$registration->_add_relation_to($attendee, 'Attendee');
+						$registration->set_attendee_id($attendee->ID());
+						$registration->update_cache_after_object_save('Attendee', $attendee);
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * create_attendee_from_request_data
+	 * uses info from alternate GET or POST data (such as AJAX) to create a new attendee
+	 *
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _create_attendee_from_request_data()
+	{
+		// get State ID
+		$STA_ID = $this->request->getRequestParam('state');
+		if (! empty($STA_ID)) {
+			// can we get state object from name ?
+			EE_Registry::instance()->load_model('State');
+			$state  = EEM_State::instance()->get_col([['STA_name' => $STA_ID], 'limit' => 1], 'STA_ID');
+			$STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
+		}
+		// get Country ISO
+		$CNT_ISO = $this->request->getRequestParam('country');
+		if (! empty($CNT_ISO)) {
+			// can we get country object from name ?
+			EE_Registry::instance()->load_model('Country');
+			$country = EEM_Country::instance()->get_col(
+				[['CNT_name' => $CNT_ISO], 'limit' => 1],
+				'CNT_ISO'
+			);
+			$CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
+		}
+		// grab attendee data
+		$attendee_data = [
+			'ATT_fname'    => $this->request->getRequestParam('first_name'),
+			'ATT_lname'    => $this->request->getRequestParam('last_name'),
+			'ATT_email'    => $this->request->getRequestParam('email'),
+			'ATT_address'  => $this->request->getRequestParam('address'),
+			'ATT_address2' => $this->request->getRequestParam('address2'),
+			'ATT_city'     => $this->request->getRequestParam('city'),
+			'STA_ID'       => $STA_ID,
+			'CNT_ISO'      => $CNT_ISO,
+			'ATT_zip'      => $this->request->getRequestParam('zip'),
+			'ATT_phone'    => $this->request->getRequestParam('phone'),
+		];
+		// validate the email address since it is the most important piece of info
+		if (empty($attendee_data['ATT_email'])) {
+			EE_Error::add_error(
+				esc_html__('An invalid email address was submitted.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// does this attendee already exist in the db ? we're searching using a combination of first name, last name,
+		// AND email address
+		if (
+			! empty($attendee_data['ATT_fname'])
+			&& ! empty($attendee_data['ATT_lname'])
+			&& ! empty($attendee_data['ATT_email'])
+		) {
+			$existing_attendee = EEM_Attendee::instance()->find_existing_attendee(
+				[
+					'ATT_fname' => $attendee_data['ATT_fname'],
+					'ATT_lname' => $attendee_data['ATT_lname'],
+					'ATT_email' => $attendee_data['ATT_email'],
+				]
+			);
+			if ($existing_attendee instanceof EE_Attendee) {
+				return $existing_attendee;
+			}
+		}
+		// no existing attendee? kk let's create a new one
+		// kinda lame, but we need a first and last name to create an attendee, so use the email address if those
+		// don't exist
+		$attendee_data['ATT_fname'] = ! empty($attendee_data['ATT_fname'])
+			? $attendee_data['ATT_fname']
+			: $attendee_data['ATT_email'];
+		$attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
+			? $attendee_data['ATT_lname']
+			: $attendee_data['ATT_email'];
+		return EE_Attendee::new_instance($attendee_data);
+	}
+
+
+
+	/********************************************************************************************************/
+	/****************************************  PROCESS REG STEP  *****************************************/
+	/********************************************************************************************************/
+	/**
+	 * process_reg_step
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidStatusException
+	 */
+	public function process_reg_step()
+	{
+		// how have they chosen to pay?
+		$this->checkout->selected_method_of_payment = $this->checkout->transaction->is_free()
+			? 'no_payment_required'
+			: $this->_get_selected_method_of_payment(true);
+		// choose your own adventure based on method_of_payment
+		switch ($this->checkout->selected_method_of_payment) {
+			case 'events_sold_out':
+				$this->checkout->redirect     = true;
+				$this->checkout->redirect_url = $this->checkout->cancel_page_url;
+				$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+				// mark this reg step as completed
+				$this->set_completed();
+				return false;
+
+			case 'payments_closed':
+				if (
+					apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
+						false
+					)
+				) {
+					EE_Error::add_success(
+						esc_html__('no payment required at this time.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+				// mark this reg step as completed
+				$this->set_completed();
+				return true;
+
+			case 'no_payment_required':
+				if (
+					apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
+						false
+					)
+				) {
+					EE_Error::add_success(
+						esc_html__('no payment required.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+				// mark this reg step as completed
+				$this->set_completed();
+				return true;
+
+			default:
+				$registrations         = EE_Registry::instance()->SSN->checkout()->transaction->registrations(
+					EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
+				);
+				$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
+					$registrations,
+					EE_Registry::instance()->SSN->checkout()->revisit
+				);
+				// calculate difference between the two arrays
+				$registrations = array_diff($registrations, $ejected_registrations);
+				if (empty($registrations)) {
+					$this->_redirect_because_event_sold_out();
+					return false;
+				}
+				$payment = $this->_process_payment();
+				if ($payment instanceof EE_Payment) {
+					$this->checkout->continue_reg = true;
+					$this->_maybe_set_completed($payment);
+				} else {
+					$this->checkout->continue_reg = false;
+				}
+				return $payment instanceof EE_Payment;
+		}
+	}
+
+
+	/**
+	 * _redirect_because_event_sold_out
+	 *
+	 * @return void
+	 */
+	protected function _redirect_because_event_sold_out()
+	{
+		$this->checkout->continue_reg = false;
+		// set redirect URL
+		$this->checkout->redirect_url = add_query_arg(
+			['e_reg_url_link' => $this->checkout->reg_url_link],
+			$this->checkout->current_step->reg_step_url()
+		);
+		$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _maybe_set_completed(EE_Payment $payment)
+	{
+		// Do we need to redirect them? If so, there's more work to be done.
+		if (! $payment->redirect_url()) {
+			$this->set_completed();
+		}
+	}
+
+
+	/**
+	 *    update_reg_step
+	 *    this is the final step after a user  revisits the site to retry a payment
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidStatusException
+	 */
+	public function update_reg_step()
+	{
+		$success = true;
+		// if payment required
+		if ($this->checkout->transaction->total() > 0) {
+			do_action(
+				'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
+				$this->checkout->transaction
+			);
+			// attempt payment via payment method
+			$success = $this->process_reg_step();
+		}
+		if ($success && ! $this->checkout->redirect) {
+			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
+				$this->checkout->transaction->ID()
+			);
+			// set return URL
+			$this->checkout->redirect_url = add_query_arg(
+				['e_reg_url_link' => $this->checkout->reg_url_link],
+				$this->checkout->thank_you_page_url
+			);
+		}
+		return $success;
+	}
+
+
+	/**
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _process_payment()
+	{
+		// basically confirm that the event hasn't sold out since they hit the page
+		if (! $this->_last_second_ticket_verifications()) {
+			return null;
+		}
+		// ya gotta make a choice man
+		if (empty($this->checkout->selected_method_of_payment)) {
+			$this->checkout->json_response->set_plz_select_method_of_payment(
+				esc_html__('Please select a method of payment before proceeding.', 'event_espresso')
+			);
+			return null;
+		}
+		// get EE_Payment_Method object
+		if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+			return null;
+		}
+		// setup billing form
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
+				$this->checkout->payment_method
+			);
+			// bad billing form ?
+			if (! $this->_billing_form_is_valid()) {
+				return null;
+			}
+		}
+		// ensure primary registrant has been fully processed
+		if (! $this->_setup_primary_registrant_prior_to_payment()) {
+			return null;
+		}
+		// if session is close to expiring (under 10 minutes by default)
+		if ((time() - EE_Registry::instance()->SSN->expiration()) < EE_Registry::instance()->SSN->extension()) {
+			// add some time to session expiration so that payment can be completed
+			EE_Registry::instance()->SSN->extend_expiration();
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		// $transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
+		// in case a registrant leaves to an Off-Site Gateway and never returns, we want to approve any registrations
+		// for events with a default reg status of Approved
+		// $transaction_processor->toggle_registration_statuses_for_default_approved_events(
+		//      $this->checkout->transaction, $this->checkout->reg_cache_where_params
+		// );
+		// attempt payment
+		$payment = $this->_attempt_payment($this->checkout->payment_method);
+		// process results
+		$payment = $this->_validate_payment($payment);
+		$payment = $this->_post_payment_processing($payment);
+		// verify payment
+		if ($payment instanceof EE_Payment) {
+			// store that for later
+			$this->checkout->payment = $payment;
+			// we can also consider the TXN to not have been failed, so temporarily upgrade it's status to abandoned
+			$this->checkout->transaction->toggle_failed_transaction_status();
+			$payment_status = $payment->status();
+			if (
+				$payment_status === EEM_Payment::status_id_approved
+				|| $payment_status === EEM_Payment::status_id_pending
+			) {
+				return $payment;
+			}
+			return null;
+		}
+		if ($payment === true) {
+			// please note that offline payment methods will NOT make a payment,
+			// but instead just mark themselves as the PMD_ID on the transaction, and return true
+			$this->checkout->payment = $payment;
+			return $payment;
+		}
+		// where's my money?
+		return null;
+	}
+
+
+	/**
+	 * _last_second_ticket_verifications
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _last_second_ticket_verifications()
+	{
+		// don't bother re-validating if not a return visit
+		if (! $this->checkout->revisit) {
+			return true;
+		}
+		$registrations = $this->checkout->transaction->registrations();
+		if (empty($registrations)) {
+			return false;
+		}
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration && ! $registration->is_approved()) {
+				$event = $registration->event_obj();
+				if ($event instanceof EE_Event && $event->is_sold_out(true)) {
+					EE_Error::add_error(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___last_second_ticket_verifications__sold_out_events_msg',
+							sprintf(
+								esc_html__(
+									'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.',
+									'event_espresso'
+								),
+								$event->name()
+							)
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+				}
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * redirect_form
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function redirect_form()
+	{
+		$payment_method_billing_info = $this->_payment_method_billing_info(
+			$this->_get_payment_method_for_selected_method_of_payment()
+		);
+		$html                        = $payment_method_billing_info->get_html();
+		$html                        .= $this->checkout->redirect_form;
+		/** @var ResponseInterface $response */
+		$response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
+		$response->addOutput($html);
+		return true;
+	}
+
+
+	/**
+	 * _billing_form_is_valid
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	private function _billing_form_is_valid()
+	{
+		if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
+			return true;
+		}
+		if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
+			if ($this->checkout->billing_form->was_submitted()) {
+				$this->checkout->billing_form->receive_form_submission();
+				if ($this->checkout->billing_form->is_valid()) {
+					return true;
+				}
+				$validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
+				$error_strings     = [];
+				foreach ($validation_errors as $validation_error) {
+					if ($validation_error instanceof EE_Validation_Error) {
+						$form_section = $validation_error->get_form_section();
+						if ($form_section instanceof EE_Form_Input_Base) {
+							$label = $form_section->html_label_text();
+						} elseif ($form_section instanceof EE_Form_Section_Base) {
+							$label = $form_section->name();
+						} else {
+							$label = esc_html__('Validation Error', 'event_espresso');
+						}
+						$error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
+					}
+				}
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'One or more billing form inputs are invalid and require correction before proceeding. %1$s %2$s',
+							'event_espresso'
+						),
+						'<br/>',
+						implode('<br/>', $error_strings)
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'The billing form was not submitted or something prevented it\'s submission.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'The submitted billing form is invalid possibly due to a technical reason.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * _setup_primary_registrant_prior_to_payment
+	 * ensures that the primary registrant has a valid attendee object created with the critical details populated
+	 * (first & last name & email) and that both the transaction object and primary registration object have been saved
+	 * plz note that any other registrations will NOT be saved at this point (because they may not have any details
+	 * yet)
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _setup_primary_registrant_prior_to_payment()
+	{
+		// check if transaction has a primary registrant and that it has a related Attendee object
+		// if not, then we need to at least gather some primary registrant data before attempting payment
+		if (
+			$this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
+			&& ! $this->checkout->transaction_has_primary_registrant()
+			&& ! $this->_capture_primary_registration_data_from_billing_form()
+		) {
+			return false;
+		}
+		// because saving an object clears it's cache, we need to do the chevy shuffle
+		// grab the primary_registration object
+		$primary_registration = $this->checkout->transaction->primary_registration();
+		// at this point we'll consider a TXN to not have been failed
+		$this->checkout->transaction->toggle_failed_transaction_status();
+		// save the TXN ( which clears cached copy of primary_registration)
+		$this->checkout->transaction->save();
+		// grab TXN ID and save it to the primary_registration
+		$primary_registration->set_transaction_id($this->checkout->transaction->ID());
+		// save what we have so far
+		$primary_registration->save();
+		return true;
+	}
+
+
+	/**
+	 * _capture_primary_registration_data_from_billing_form
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _capture_primary_registration_data_from_billing_form()
+	{
+		// convert billing form data into an attendee
+		$this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
+		if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The billing form details could not be used for attendee details due to a technical issue.%sPlease try again or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$primary_registration = $this->checkout->transaction->primary_registration();
+		if (! $primary_registration instanceof EE_Registration) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The primary registrant for this transaction could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if (
+			! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
+			  instanceof
+			  EE_Attendee
+		) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The primary registrant could not be associated with this transaction due to a technical issue.%sPlease try again or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		/** @type EE_Registration_Processor $registration_processor */
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+		// at this point, we should have enough details about the registrant to consider the registration NOT incomplete
+		$registration_processor->toggle_incomplete_registration_status_to_default($primary_registration);
+		return true;
+	}
+
+
+	/**
+	 * _get_payment_method_for_selected_method_of_payment
+	 * retrieves a valid payment method
+	 *
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_payment_method_for_selected_method_of_payment()
+	{
+		if ($this->checkout->selected_method_of_payment === 'events_sold_out') {
+			$this->_redirect_because_event_sold_out();
+			return null;
+		}
+		// get EE_Payment_Method object
+		if (isset($this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ])) {
+			$payment_method = $this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ];
+		} else {
+			// load EEM_Payment_Method
+			EE_Registry::instance()->load_model('Payment_Method');
+			$EEM_Payment_Method = EEM_Payment_Method::instance();
+			$payment_method     = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
+		}
+		// verify $payment_method
+		if (! $payment_method instanceof EE_Payment_Method) {
+			// not a payment
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The selected method of payment could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		// and verify it has a valid Payment_Method Type object
+		if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
+			// not a payment
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $payment_method;
+	}
+
+
+	/**
+	 *    _attempt_payment
+	 *
+	 * @access    private
+	 * @type    EE_Payment_Method $payment_method
+	 * @return mixed EE_Payment | boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _attempt_payment(EE_Payment_Method $payment_method)
+	{
+		$payment = null;
+		$this->checkout->transaction->save();
+		$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+		if (! $payment_processor instanceof EE_Payment_Processor) {
+			return false;
+		}
+		try {
+			$payment_processor->set_revisit($this->checkout->revisit);
+			// generate payment object
+			$payment = $payment_processor->process_payment(
+				$payment_method,
+				$this->checkout->transaction,
+				$this->checkout->amount_owing,
+				$this->checkout->billing_form,
+				$this->_get_return_url($payment_method),
+				'CART',
+				$this->checkout->admin_request,
+				true,
+				$this->reg_step_url()
+			);
+		} catch (Exception $e) {
+			$this->_handle_payment_processor_exception($e);
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * _handle_payment_processor_exception
+	 *
+	 * @param Exception $e
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _handle_payment_processor_exception(Exception $e)
+	{
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'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',
+					'event_espresso'
+				),
+				'<br/>',
+				EE_Registry::instance()->CFG->organization->get_pretty('email'),
+				$e->getMessage(),
+				$e->getFile(),
+				$e->getLine()
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+	}
+
+
+	/**
+	 * _get_return_url
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_return_url(EE_Payment_Method $payment_method)
+	{
+		$return_url = '';
+		switch ($payment_method->type_obj()->payment_occurs()) {
+			case EE_PMT_Base::offsite:
+				$return_url = add_query_arg(
+					[
+						'action'                     => 'process_gateway_response',
+						'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
+						'spco_txn'                   => $this->checkout->transaction->ID(),
+					],
+					$this->reg_step_url()
+				);
+				break;
+			case EE_PMT_Base::onsite:
+			case EE_PMT_Base::offline:
+				$return_url = $this->checkout->next_step->reg_step_url();
+				break;
+		}
+		return $return_url;
+	}
+
+
+	/**
+	 * _validate_payment
+	 *
+	 * @param EE_Payment $payment
+	 * @return EE_Payment|FALSE
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _validate_payment($payment = null)
+	{
+		if ($this->checkout->payment_method->is_off_line()) {
+			return true;
+		}
+		// verify payment object
+		if (! $payment instanceof EE_Payment) {
+			// not a payment
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'A valid payment was not generated due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * _post_payment_processing
+	 *
+	 * @param EE_Payment|bool $payment
+	 * @return bool|EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _post_payment_processing($payment = null)
+	{
+		// Off-Line payment?
+		if ($payment === true) {
+			return true;
+		}
+		if ($payment instanceof EE_Payment) {
+			// Should the user be redirected?
+			if ($payment->redirect_url()) {
+				do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()');
+				$this->checkout->redirect      = true;
+				$this->checkout->redirect_form = $payment->redirect_form();
+				$this->checkout->redirect_url  = $this->reg_step_url('redirect_form');
+				// set JSON response
+				$this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
+				// and lastly, let's bump the payment status to pending
+				$payment->set_status(EEM_Payment::status_id_pending);
+				$payment->save();
+			} elseif (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
+				// User shouldn't be redirected. So let's process it here.
+				// $this->_setup_redirect_for_next_step();
+				$this->checkout->continue_reg = false;
+			}
+			return $payment;
+		}
+		// ummm ya... not Off-Line, not On-Site, not off-Site ????
+		$this->checkout->continue_reg = false;
+		return false;
+	}
+
+
+	/**
+	 *    _process_payment_status
+	 *
+	 * @type    EE_Payment $payment
+	 * @param string       $payment_occurs
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline)
+	{
+		// off-line payment? carry on
+		if ($payment_occurs === EE_PMT_Base::offline) {
+			return true;
+		}
+		// verify payment validity
+		if ($payment instanceof EE_Payment) {
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()');
+			$msg = $payment->gateway_response();
+			// check results
+			switch ($payment->status()) {
+				// good payment
+				case EEM_Payment::status_id_approved:
+					EE_Error::add_success(
+						esc_html__('Your payment was processed successfully.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return true;
+				// slow payment
+				case EEM_Payment::status_id_pending:
+					if (empty($msg)) {
+						$msg = esc_html__(
+							'Your payment appears to have been processed successfully, but the Instant Payment Notification has not yet been received. It should arrive shortly.',
+							'event_espresso'
+						);
+					}
+					EE_Error::add_success($msg, __FILE__, __FUNCTION__, __LINE__);
+					return true;
+				// don't wanna payment
+				case EEM_Payment::status_id_cancelled:
+					if (empty($msg)) {
+						$msg = _n(
+							'Payment cancelled. Please try again.',
+							'Payment cancelled. Please try again or select another method of payment.',
+							count($this->checkout->available_payment_methods),
+							'event_espresso'
+						);
+					}
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
+					return false;
+				// not enough payment
+				case EEM_Payment::status_id_declined:
+					if (empty($msg)) {
+						$msg = _n(
+							'We\'re sorry but your payment was declined. Please try again.',
+							'We\'re sorry but your payment was declined. Please try again or select another method of payment.',
+							count($this->checkout->available_payment_methods),
+							'event_espresso'
+						);
+					}
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
+					return false;
+				// bad payment
+				case EEM_Payment::status_id_failed:
+					if (! empty($msg)) {
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+						return false;
+					}
+					// default to error below
+					break;
+			}
+		}
+		// off-site payment gateway responses are too unreliable, so let's just assume that
+		// the payment processing is just running slower than the registrant's request
+		if ($payment_occurs === EE_PMT_Base::offsite) {
+			return true;
+		}
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'Your payment could not be processed successfully due to a technical issue.%sPlease try again or contact %s for assistance.',
+					'event_espresso'
+				),
+				'<br/>',
+				EE_Registry::instance()->CFG->organization->get_pretty('email')
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
+
+
+
+
+
+
+	/********************************************************************************************************/
+	/**********************************  PROCESS GATEWAY RESPONSE  **********************************/
+	/********************************************************************************************************/
+	/**
+	 * process_gateway_response
+	 * this is the return point for Off-Site Payment Methods
+	 * It will attempt to "handle the IPN" if it appears that this has not already occurred,
+	 * otherwise, it will load up the last payment made for the TXN.
+	 * If the payment retrieved looks good, it will then either:
+	 *    complete the current step and allow advancement to the next reg step
+	 *        or present the payment options again
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_gateway_response()
+	{
+		// how have they chosen to pay?
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
+		// get EE_Payment_Method object
+		if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+			$this->checkout->continue_reg = false;
+			return false;
+		}
+		if (! $this->checkout->payment_method->is_off_site()) {
+			return false;
+		}
+		$this->_validate_offsite_return();
+		// verify TXN
+		if ($this->checkout->transaction instanceof EE_Transaction) {
+			$gateway = $this->checkout->payment_method->type_obj()->get_gateway();
+			if (! $gateway instanceof EE_Offsite_Gateway) {
+				$this->checkout->continue_reg = false;
+				return false;
+			}
+			$payment = $this->_process_off_site_payment($gateway);
+			$payment = $this->_process_cancelled_payments($payment);
+			$payment = $this->_validate_payment($payment);
+			// if payment was not declined by the payment gateway or cancelled by the registrant
+			if ($this->_process_payment_status($payment, EE_PMT_Base::offsite)) {
+				// $this->_setup_redirect_for_next_step();
+				// store that for later
+				$this->checkout->payment = $payment;
+				// mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
+				// because we will complete this step during the IPN processing then
+				if (! $this->handle_IPN_in_this_request()) {
+					$this->set_completed();
+				}
+				return true;
+			}
+		}
+		// DEBUG LOG
+		// $this->checkout->log(
+		//     __CLASS__,
+		//     __FUNCTION__,
+		//     __LINE__,
+		//     array('payment' => $payment)
+		// );
+		$this->checkout->continue_reg = false;
+		return false;
+	}
+
+
+	/**
+	 * _validate_return
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _validate_offsite_return()
+	{
+		$TXN_ID = $this->request->getRequestParam('spco_txn', 0, 'int');
+		if ($TXN_ID !== $this->checkout->transaction->ID()) {
+			// Houston... we might have a problem
+			$invalid_TXN = false;
+			// first gather some info
+			$valid_TXN          = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			$primary_registrant = $valid_TXN instanceof EE_Transaction
+				? $valid_TXN->primary_registration()
+				: null;
+			// let's start by retrieving the cart for this TXN
+			$cart = $this->checkout->get_cart_for_transaction($this->checkout->transaction);
+			if ($cart instanceof EE_Cart) {
+				// verify that the current cart has tickets
+				$tickets = $cart->get_tickets();
+				if (empty($tickets)) {
+					$invalid_TXN = true;
+				}
+			} else {
+				$invalid_TXN = true;
+			}
+			$valid_TXN_SID = $primary_registrant instanceof EE_Registration
+				? $primary_registrant->session_ID()
+				: null;
+			// validate current Session ID and compare against valid TXN session ID
+			if (
+				$invalid_TXN // if this is already true, then skip other checks
+				|| EE_Session::instance()->id() === null
+				|| (
+					// WARNING !!!
+					// this could be PayPal sending back duplicate requests (ya they do that)
+					// or it **could** mean someone is simply registering AGAIN after having just done so
+					// so now we need to determine if this current TXN looks valid or not
+					// and whether this reg step has even been started ?
+					EE_Session::instance()->id() === $valid_TXN_SID
+					// really? you're half way through this reg step, but you never started it ?
+					&& $this->checkout->transaction->reg_step_completed($this->slug()) === false
+				)
+			) {
+				$invalid_TXN = true;
+			}
+			if ($invalid_TXN) {
+				// is the valid TXN completed ?
+				if ($valid_TXN instanceof EE_Transaction) {
+					// has this step even been started ?
+					$reg_step_completed = $valid_TXN->reg_step_completed($this->slug());
+					if ($reg_step_completed !== false && $reg_step_completed !== true) {
+						// so it **looks** like this is a double request from PayPal
+						// so let's try to pick up where we left off
+						$this->checkout->transaction = $valid_TXN;
+						$this->checkout->refresh_all_entities(true);
+						return;
+					}
+				}
+				// you appear to be lost?
+				$this->_redirect_wayward_request($primary_registrant);
+			}
+		}
+	}
+
+
+	/**
+	 * _redirect_wayward_request
+	 *
+	 * @param EE_Registration|null $primary_registrant
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _redirect_wayward_request(EE_Registration $primary_registrant)
+	{
+		if (! $primary_registrant instanceof EE_Registration) {
+			// try redirecting based on the current TXN
+			$primary_registrant = $this->checkout->transaction instanceof EE_Transaction
+				? $this->checkout->transaction->primary_registration()
+				: null;
+		}
+		if (! $primary_registrant instanceof EE_Registration) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'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.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return;
+		}
+		// make sure transaction is not locked
+		$this->checkout->transaction->unlock();
+		wp_safe_redirect(
+			add_query_arg(
+				[
+					'e_reg_url_link' => $primary_registrant->reg_url_link(),
+				],
+				$this->checkout->thank_you_page_url
+			)
+		);
+		exit();
+	}
+
+
+	/**
+	 * _process_off_site_payment
+	 *
+	 * @param EE_Offsite_Gateway $gateway
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
+	{
+		try {
+			$request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+			$request_data = $request->requestParams();
+			// if gateway uses_separate_IPN_request, then we don't have to process the IPN manually
+			$this->set_handle_IPN_in_this_request(
+				$gateway->handle_IPN_in_this_request($request_data, false)
+			);
+			if ($this->handle_IPN_in_this_request()) {
+				// get payment details and process results
+				/** @type EE_Payment_Processor $payment_processor */
+				$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+				$payment           = $payment_processor->process_ipn(
+					$request_data,
+					$this->checkout->transaction,
+					$this->checkout->payment_method,
+					true,
+					false
+				);
+				// $payment_source = 'process_ipn';
+			} else {
+				$payment = $this->checkout->transaction->last_payment();
+				// $payment_source = 'last_payment';
+			}
+		} catch (Exception $e) {
+			// let's just eat the exception and try to move on using any previously set payment info
+			$payment = $this->checkout->transaction->last_payment();
+			// $payment_source = 'last_payment after Exception';
+			// but if we STILL don't have a payment object
+			if (! $payment instanceof EE_Payment) {
+				// then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
+				$this->_handle_payment_processor_exception($e);
+			}
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * _process_cancelled_payments
+	 * just makes sure that the payment status gets updated correctly
+	 * so tha tan error isn't generated during payment validation
+	 *
+	 * @param EE_Payment $payment
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 */
+	private function _process_cancelled_payments($payment = null)
+	{
+		if (
+			$payment instanceof EE_Payment
+			&& $this->request->requestParamIsSet('ee_cancel_payment')
+			&& $payment->status() === EEM_Payment::status_id_failed
+		) {
+			$payment->set_status(EEM_Payment::status_id_cancelled);
+		}
+		return $payment;
+	}
+
+
+	/**
+	 *    get_transaction_details_for_gateways
+	 *
+	 * @access    public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_transaction_details_for_gateways()
+	{
+		$txn_details = [];
+		// ya gotta make a choice man
+		if (empty($this->checkout->selected_method_of_payment)) {
+			$txn_details = [
+				'error' => esc_html__('Please select a method of payment before proceeding.', 'event_espresso'),
+			];
+		}
+		// get EE_Payment_Method object
+		if (
+			empty($txn_details)
+			&& ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
+		) {
+			$txn_details = [
+				'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
+				'error'                      => esc_html__(
+					'A valid Payment Method could not be determined.',
+					'event_espresso'
+				),
+			];
+		}
+		if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
+			$return_url  = $this->_get_return_url($this->checkout->payment_method);
+			$txn_details = [
+				'TXN_ID'         => $this->checkout->transaction->ID(),
+				'TXN_timestamp'  => $this->checkout->transaction->datetime(),
+				'TXN_total'      => $this->checkout->transaction->total(),
+				'TXN_paid'       => $this->checkout->transaction->paid(),
+				'TXN_reg_steps'  => $this->checkout->transaction->reg_steps(),
+				'STS_ID'         => $this->checkout->transaction->status_ID(),
+				'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
+				'payment_amount' => $this->checkout->amount_owing,
+				'return_url'     => $return_url,
+				'cancel_url'     => add_query_arg(['ee_cancel_payment' => true], $return_url),
+				'notify_url'     => EE_Config::instance()->core->txn_page_url(
+					[
+						'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
+						'ee_payment_method' => $this->checkout->payment_method->slug(),
+					]
+				),
+			];
+		}
+		echo wp_json_encode($txn_details);
+		exit();
+	}
+
+
+	/**
+	 *    __sleep
+	 * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
+	 * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
+	 * reg form, because if needed, it will be regenerated anyways
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		// remove the reg form and the checkout
+		return array_diff(array_keys(get_object_vars($this)), ['reg_form', 'checkout', 'line_item_display']);
+	}
 }

Spacing +80 added lines, -80 removed lines

@@ -132,7 +132,7 @@ 
         $this->request   = EED_Single_Page_Checkout::getRequest();
         $this->_slug     = 'payment_options';
         $this->_name     = esc_html__('Payment Options', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . '/payment_options_main.template.php';
+        $this->_template = SPCO_REG_STEPS_PATH.$this->_slug.'/payment_options_main.template.php';
         $this->checkout  = $checkout;
         $this->_reset_success_message();
         $this->set_instructions(
@@ -187,7 +187,7 @@ 
      */
     public function translate_js_strings()
     {
-        EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
+        EE_Registry::$i18n_js_strings['no_payment_method'] = esc_html__(
             'Please select a method of payment in order to continue.',
             'event_espresso'
         );
@@ -195,7 +195,7 @@ 
             'A valid method of payment could not be determined. Please refresh the page and try again.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
+        EE_Registry::$i18n_js_strings['forwarding_to_offsite'] = esc_html__(
             'Forwarding to Secure Payment Provider.',
             'event_espresso'
         );
@@ -216,7 +216,7 @@ 
     {
         $transaction = $this->checkout->transaction;
         // if the transaction isn't set or nothing is owed on it, don't enqueue any JS
-        if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
+        if ( ! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
             return;
         }
         foreach (
@@ -311,18 +311,18 @@ 
         foreach ($registrations as $REG_ID => $registration) {
             /** @var $registration EE_Registration */
             // has this registration lost it's space ?
-            if (isset($ejected_registrations[ $REG_ID ])) {
+            if (isset($ejected_registrations[$REG_ID])) {
                 if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
-                    $sold_out_events[ $registration->event()->ID() ] = $registration->event();
+                    $sold_out_events[$registration->event()->ID()] = $registration->event();
                 } else {
-                    $insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
+                    $insufficient_spaces_available[$registration->event()->ID()] = $registration->event();
                 }
                 continue;
             }
             // event requires admin approval
             if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
                 // add event to list of events with pre-approval reg status
-                $registrations_requiring_pre_approval[ $REG_ID ] = $registration;
+                $registrations_requiring_pre_approval[$REG_ID] = $registration;
                 do_action(
                     'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
                     $registration->event(),
@@ -339,7 +339,7 @@ 
                 )
             ) {
                 // add event to list of events that are sold out
-                $sold_out_events[ $registration->event()->ID() ] = $registration->event();
+                $sold_out_events[$registration->event()->ID()] = $registration->event();
                 do_action(
                     'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
                     $registration->event(),
@@ -349,7 +349,7 @@ 
             }
             // are they allowed to pay now and is there monies owing?
             if ($registration->owes_monies_and_can_pay()) {
-                $registrations_requiring_payment[ $REG_ID ] = $registration;
+                $registrations_requiring_payment[$REG_ID] = $registration;
                 do_action(
                     'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
                     $registration->event(),
@@ -360,28 +360,28 @@ 
                       && $registration->status_ID() !== EEM_Registration::status_id_not_approved
                       && $registration->ticket()->is_free()
             ) {
-                $registrations_for_free_events[ $registration->ticket()->ID() ] = $registration;
+                $registrations_for_free_events[$registration->ticket()->ID()] = $registration;
             }
         }
         $subsections = [];
         // now decide which template to load
-        if (! empty($sold_out_events)) {
+        if ( ! empty($sold_out_events)) {
             $subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
         }
-        if (! empty($insufficient_spaces_available)) {
+        if ( ! empty($insufficient_spaces_available)) {
             $subsections['insufficient_space'] = $this->_insufficient_spaces_available(
                 $insufficient_spaces_available
             );
         }
-        if (! empty($registrations_requiring_pre_approval)) {
+        if ( ! empty($registrations_requiring_pre_approval)) {
             $subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
                 $registrations_requiring_pre_approval
             );
         }
-        if (! empty($registrations_for_free_events)) {
+        if ( ! empty($registrations_for_free_events)) {
             $subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
         }
-        if (! empty($registrations_requiring_payment)) {
+        if ( ! empty($registrations_requiring_payment)) {
             if ($this->checkout->amount_owing > 0) {
                 // autoload Line_Item_Display classes
                 EEH_Autoloader::register_line_item_filter_autoloaders();
@@ -402,7 +402,7 @@ 
                         ['registrations' => $registrations]
                     )
                 );
-                $this->checkout->amount_owing   = $filtered_line_item_tree->total();
+                $this->checkout->amount_owing = $filtered_line_item_tree->total();
                 $this->_apply_registration_payments_to_amount_owing($registrations);
             }
             $no_payment_required = false;
@@ -446,13 +446,13 @@ 
      */
     public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
     {
-        if (! EE_Registry::instance()->SSN instanceof EE_Session) {
+        if ( ! EE_Registry::instance()->SSN instanceof EE_Session) {
             return $line_item_filter_collection;
         }
-        if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
+        if ( ! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
             return $line_item_filter_collection;
         }
-        if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
+        if ( ! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
             return $line_item_filter_collection;
         }
         $line_item_filter_collection->add(
@@ -492,8 +492,8 @@ 
         );
         foreach ($registrations as $REG_ID => $registration) {
             // has this registration lost it's space ?
-            if (isset($ejected_registrations[ $REG_ID ])) {
-                unset($registrations[ $REG_ID ]);
+            if (isset($ejected_registrations[$REG_ID])) {
+                unset($registrations[$REG_ID]);
             }
         }
         return $registrations;
@@ -543,25 +543,25 @@ 
             }
             $EVT_ID = $registration->event_ID();
             $ticket = $registration->ticket();
-            if (! isset($tickets_remaining[ $ticket->ID() ])) {
-                $tickets_remaining[ $ticket->ID() ] = $ticket->remaining();
+            if ( ! isset($tickets_remaining[$ticket->ID()])) {
+                $tickets_remaining[$ticket->ID()] = $ticket->remaining();
             }
-            if ($tickets_remaining[ $ticket->ID() ] > 0) {
-                if (! isset($event_reg_count[ $EVT_ID ])) {
-                    $event_reg_count[ $EVT_ID ] = 0;
+            if ($tickets_remaining[$ticket->ID()] > 0) {
+                if ( ! isset($event_reg_count[$EVT_ID])) {
+                    $event_reg_count[$EVT_ID] = 0;
                 }
-                $event_reg_count[ $EVT_ID ]++;
-                if (! isset($event_spaces_remaining[ $EVT_ID ])) {
-                    $event_spaces_remaining[ $EVT_ID ] = $registration->event()->spaces_remaining_for_sale();
+                $event_reg_count[$EVT_ID]++;
+                if ( ! isset($event_spaces_remaining[$EVT_ID])) {
+                    $event_spaces_remaining[$EVT_ID] = $registration->event()->spaces_remaining_for_sale();
                 }
             }
             if (
                 $revisit
-                && ($tickets_remaining[ $ticket->ID() ] === 0
-                    || $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
+                && ($tickets_remaining[$ticket->ID()] === 0
+                    || $event_reg_count[$EVT_ID] > $event_spaces_remaining[$EVT_ID]
                 )
             ) {
-                $ejected_registrations[ $REG_ID ] = $registration->event();
+                $ejected_registrations[$REG_ID] = $registration->event();
                 if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
                     /** @type EE_Registration_Processor $registration_processor */
                     $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
@@ -621,7 +621,7 @@ 
         foreach ($sold_out_events_array as $sold_out_event) {
             $sold_out_events .= EEH_HTML::li(
                 EEH_HTML::span(
-                    '  ' . $sold_out_event->name(),
+                    '  '.$sold_out_event->name(),
                     '',
                     'dashicons dashicons-marker ee-icon-size-16 pink-text'
                 )
@@ -677,7 +677,7 @@ 
         foreach ($insufficient_spaces_events_array as $event) {
             if ($event instanceof EE_Event) {
                 $insufficient_space_events .= EEH_HTML::li(
-                    EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
+                    EEH_HTML::span(' '.$event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
                 );
             }
         }
@@ -726,7 +726,7 @@ 
         $events_requiring_pre_approval = [];
         foreach ($registrations_requiring_pre_approval as $registration) {
             if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
-                $events_requiring_pre_approval[ $registration->event()->ID() ] = EEH_HTML::li(
+                $events_requiring_pre_approval[$registration->event()->ID()] = EEH_HTML::li(
                     EEH_HTML::span(
                         '',
                         '',
@@ -866,7 +866,7 @@ 
     {
         return new EE_Form_Section_Proper(
             [
-                'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
+                'html_id'         => 'ee-'.$this->slug().'-extra-hidden-inputs',
                 'layout_strategy' => new EE_Div_Per_Section_Layout(),
                 'subsections'     => [
                     'spco_no_payment_required' => new EE_Hidden_Input(
@@ -905,7 +905,7 @@ 
                 $payments += $registration->registration_payments();
             }
         }
-        if (! empty($payments)) {
+        if ( ! empty($payments)) {
             foreach ($payments as $payment) {
                 if ($payment instanceof EE_Registration_Payment) {
                     $this->checkout->amount_owing -= $payment->amount();
@@ -994,7 +994,7 @@ 
             );
         }
         // switch up header depending on number of available payment methods
-        $payment_method_header     = count($this->checkout->available_payment_methods) > 1
+        $payment_method_header = count($this->checkout->available_payment_methods) > 1
             ? apply_filters(
                 'FHEE__registration_page_payment_options__method_of_payment_hdr',
                 esc_html__('Please Select Your Method of Payment', 'event_espresso')
@@ -1028,7 +1028,7 @@ 
                 $payment_method_button = EEH_HTML::img(
                     $payment_method->button_url(),
                     $payment_method->name(),
-                    'spco-payment-method-' . $payment_method->slug() . '-btn-img',
+                    'spco-payment-method-'.$payment_method->slug().'-btn-img',
                     'spco-payment-method-btn-img'
                 );
                 // check if any payment methods are set as default
@@ -1036,15 +1036,15 @@ 
                 // open_by_default
                 if (
                     ($this->checkout->selected_method_of_payment === $payment_method->slug())
-                    || (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
+                    || ( ! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
                 ) {
                     $this->checkout->selected_method_of_payment = $payment_method->slug();
                     $this->_save_selected_method_of_payment();
-                    $default_payment_method_option[ $payment_method->slug() ] = $payment_method_button;
+                    $default_payment_method_option[$payment_method->slug()] = $payment_method_button;
                 } else {
-                    $available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
+                    $available_payment_method_options[$payment_method->slug()] = $payment_method_button;
                 }
-                $payment_methods_billing_info[ $payment_method->slug() . '-info' ] =
+                $payment_methods_billing_info[$payment_method->slug().'-info'] =
                     $this->_payment_method_billing_info(
                         $payment_method
                     );
@@ -1057,7 +1057,7 @@ 
         $available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
             $available_payment_method_options
         );
-        $available_payment_methods                              += $payment_methods_billing_info;
+        $available_payment_methods += $payment_methods_billing_info;
         // build the available payment methods form
         return new EE_Form_Section_Proper(
             [
@@ -1080,7 +1080,7 @@ 
      */
     protected function _get_available_payment_methods()
     {
-        if (! empty($this->checkout->available_payment_methods)) {
+        if ( ! empty($this->checkout->available_payment_methods)) {
             return $this->checkout->available_payment_methods;
         }
         $available_payment_methods = [];
@@ -1092,7 +1092,7 @@ 
         );
         foreach ($payment_methods as $payment_method) {
             if ($payment_method instanceof EE_Payment_Method) {
-                $available_payment_methods[ $payment_method->slug() ] = $payment_method;
+                $available_payment_methods[$payment_method->slug()] = $payment_method;
             }
         }
         return $available_payment_methods;
@@ -1187,7 +1187,7 @@ 
         );
         return new EE_Form_Section_Proper(
             [
-                'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
+                'html_id'         => 'spco-payment-method-info-'.$payment_method->slug(),
                 'html_class'      => 'spco-payment-method-info-dv',
                 // only display the selected or default PM
                 'html_style'      => $currently_selected ? '' : 'display:none;',
@@ -1216,7 +1216,7 @@ 
         // how have they chosen to pay?
         $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
         $this->checkout->payment_method             = $this->_get_payment_method_for_selected_method_of_payment();
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
+        if ( ! $this->checkout->payment_method instanceof EE_Payment_Method) {
             return false;
         }
         if (
@@ -1391,7 +1391,7 @@ 
      */
     public function switch_payment_method()
     {
-        if (! $this->_verify_payment_method_is_set()) {
+        if ( ! $this->_verify_payment_method_is_set()) {
             return false;
         }
         if (
@@ -1527,7 +1527,7 @@ 
             }
         }
         // verify payment method
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
+        if ( ! $this->checkout->payment_method instanceof EE_Payment_Method) {
             // get payment method for selected method of payment
             $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
         }
@@ -1552,7 +1552,7 @@ 
      */
     public function save_payer_details_via_ajax()
     {
-        if (! $this->_verify_payment_method_is_set()) {
+        if ( ! $this->_verify_payment_method_is_set()) {
             return;
         }
         // generate billing form for selected method of payment if it hasn't been done already
@@ -1562,7 +1562,7 @@ 
             );
         }
         // generate primary attendee from payer info if applicable
-        if (! $this->checkout->transaction_has_primary_registrant()) {
+        if ( ! $this->checkout->transaction_has_primary_registrant()) {
             $attendee = $this->_create_attendee_from_request_data();
             if ($attendee instanceof EE_Attendee) {
                 foreach ($this->checkout->transaction->registrations() as $registration) {
@@ -1593,7 +1593,7 @@ 
     {
         // get State ID
         $STA_ID = $this->request->getRequestParam('state');
-        if (! empty($STA_ID)) {
+        if ( ! empty($STA_ID)) {
             // can we get state object from name ?
             EE_Registry::instance()->load_model('State');
             $state  = EEM_State::instance()->get_col([['STA_name' => $STA_ID], 'limit' => 1], 'STA_ID');
@@ -1601,7 +1601,7 @@ 
         }
         // get Country ISO
         $CNT_ISO = $this->request->getRequestParam('country');
-        if (! empty($CNT_ISO)) {
+        if ( ! empty($CNT_ISO)) {
             // can we get country object from name ?
             EE_Registry::instance()->load_model('Country');
             $country = EEM_Country::instance()->get_col(
@@ -1782,7 +1782,7 @@ 
     protected function _maybe_set_completed(EE_Payment $payment)
     {
         // Do we need to redirect them? If so, there's more work to be done.
-        if (! $payment->redirect_url()) {
+        if ( ! $payment->redirect_url()) {
             $this->set_completed();
         }
     }
@@ -1839,7 +1839,7 @@ 
     private function _process_payment()
     {
         // basically confirm that the event hasn't sold out since they hit the page
-        if (! $this->_last_second_ticket_verifications()) {
+        if ( ! $this->_last_second_ticket_verifications()) {
             return null;
         }
         // ya gotta make a choice man
@@ -1850,7 +1850,7 @@ 
             return null;
         }
         // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+        if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
             return null;
         }
         // setup billing form
@@ -1859,12 +1859,12 @@ 
                 $this->checkout->payment_method
             );
             // bad billing form ?
-            if (! $this->_billing_form_is_valid()) {
+            if ( ! $this->_billing_form_is_valid()) {
                 return null;
             }
         }
         // ensure primary registrant has been fully processed
-        if (! $this->_setup_primary_registrant_prior_to_payment()) {
+        if ( ! $this->_setup_primary_registrant_prior_to_payment()) {
             return null;
         }
         // if session is close to expiring (under 10 minutes by default)
@@ -1920,7 +1920,7 @@ 
     protected function _last_second_ticket_verifications()
     {
         // don't bother re-validating if not a return visit
-        if (! $this->checkout->revisit) {
+        if ( ! $this->checkout->revisit) {
             return true;
         }
         $registrations = $this->checkout->transaction->registrations();
@@ -1970,7 +1970,7 @@ 
             $this->_get_payment_method_for_selected_method_of_payment()
         );
         $html                        = $payment_method_billing_info->get_html();
-        $html                        .= $this->checkout->redirect_form;
+        $html .= $this->checkout->redirect_form;
         /** @var ResponseInterface $response */
         $response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
         $response->addOutput($html);
@@ -1986,7 +1986,7 @@ 
      */
     private function _billing_form_is_valid()
     {
-        if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
+        if ( ! $this->checkout->payment_method->type_obj()->has_billing_form()) {
             return true;
         }
         if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
@@ -2104,7 +2104,7 @@ 
     {
         // convert billing form data into an attendee
         $this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
-        if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
+        if ( ! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -2121,7 +2121,7 @@ 
             return false;
         }
         $primary_registration = $this->checkout->transaction->primary_registration();
-        if (! $primary_registration instanceof EE_Registration) {
+        if ( ! $primary_registration instanceof EE_Registration) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -2183,8 +2183,8 @@ 
             return null;
         }
         // get EE_Payment_Method object
-        if (isset($this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ])) {
-            $payment_method = $this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ];
+        if (isset($this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment])) {
+            $payment_method = $this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment];
         } else {
             // load EEM_Payment_Method
             EE_Registry::instance()->load_model('Payment_Method');
@@ -2192,7 +2192,7 @@ 
             $payment_method     = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
         }
         // verify $payment_method
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             // not a payment
             EE_Error::add_error(
                 sprintf(
@@ -2210,7 +2210,7 @@ 
             return null;
         }
         // and verify it has a valid Payment_Method Type object
-        if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
+        if ( ! $payment_method->type_obj() instanceof EE_PMT_Base) {
             // not a payment
             EE_Error::add_error(
                 sprintf(
@@ -2248,7 +2248,7 @@ 
         $payment = null;
         $this->checkout->transaction->save();
         $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-        if (! $payment_processor instanceof EE_Payment_Processor) {
+        if ( ! $payment_processor instanceof EE_Payment_Processor) {
             return false;
         }
         try {
@@ -2350,7 +2350,7 @@ 
             return true;
         }
         // verify payment object
-        if (! $payment instanceof EE_Payment) {
+        if ( ! $payment instanceof EE_Payment) {
             // not a payment
             EE_Error::add_error(
                 sprintf(
@@ -2400,7 +2400,7 @@ 
                 // and lastly, let's bump the payment status to pending
                 $payment->set_status(EEM_Payment::status_id_pending);
                 $payment->save();
-            } elseif (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
+            } elseif ( ! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
                 // User shouldn't be redirected. So let's process it here.
                 // $this->_setup_redirect_for_next_step();
                 $this->checkout->continue_reg = false;
@@ -2481,7 +2481,7 @@ 
                     return false;
                 // bad payment
                 case EEM_Payment::status_id_failed:
-                    if (! empty($msg)) {
+                    if ( ! empty($msg)) {
                         EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
                         return false;
                     }
@@ -2539,18 +2539,18 @@ 
         // how have they chosen to pay?
         $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
         // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+        if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
             $this->checkout->continue_reg = false;
             return false;
         }
-        if (! $this->checkout->payment_method->is_off_site()) {
+        if ( ! $this->checkout->payment_method->is_off_site()) {
             return false;
         }
         $this->_validate_offsite_return();
         // verify TXN
         if ($this->checkout->transaction instanceof EE_Transaction) {
             $gateway = $this->checkout->payment_method->type_obj()->get_gateway();
-            if (! $gateway instanceof EE_Offsite_Gateway) {
+            if ( ! $gateway instanceof EE_Offsite_Gateway) {
                 $this->checkout->continue_reg = false;
                 return false;
             }
@@ -2564,7 +2564,7 @@ 
                 $this->checkout->payment = $payment;
                 // mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
                 // because we will complete this step during the IPN processing then
-                if (! $this->handle_IPN_in_this_request()) {
+                if ( ! $this->handle_IPN_in_this_request()) {
                     $this->set_completed();
                 }
                 return true;
@@ -2667,13 +2667,13 @@ 
      */
     private function _redirect_wayward_request(EE_Registration $primary_registrant)
     {
-        if (! $primary_registrant instanceof EE_Registration) {
+        if ( ! $primary_registrant instanceof EE_Registration) {
             // try redirecting based on the current TXN
             $primary_registrant = $this->checkout->transaction instanceof EE_Transaction
                 ? $this->checkout->transaction->primary_registration()
                 : null;
         }
-        if (! $primary_registrant instanceof EE_Registration) {
+        if ( ! $primary_registrant instanceof EE_Registration) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -2744,7 +2744,7 @@ 
             $payment = $this->checkout->transaction->last_payment();
             // $payment_source = 'last_payment after Exception';
             // but if we STILL don't have a payment object
-            if (! $payment instanceof EE_Payment) {
+            if ( ! $payment instanceof EE_Payment) {
                 // then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
                 $this->_handle_payment_processor_exception($e);
             }

modules/single_page_checkout/inc/EE_SPCO_JSON_Response.php

Indentation +397 added lines, -397 removed lines

@@ -14,401 +14,401 @@
  */
 class EE_SPCO_JSON_Response
 {
-    /**
-     * @var string
-     */
-    protected $_errors = '';
-
-    /**
-     * @var string
-     */
-    protected $_unexpected_errors = '';
-
-    /**
-     * @var string
-     */
-    protected $_attention = '';
-
-    /**
-     * @var string
-     */
-    protected $_success = '';
-
-    /**
-     * @var string
-     */
-    protected $_plz_select_method_of_payment = '';
-
-    /**
-     * @var string
-     */
-    protected $_redirect_url = '';
-
-    /**
-     * @var string
-     */
-    protected $_registration_time_limit = '';
-
-    /**
-     * @var string
-     */
-    protected $_redirect_form = '';
-
-    /**
-     * @var string
-     */
-    protected $_reg_step_html = '';
-
-    /**
-     * @var string
-     */
-    protected $_method_of_payment = '';
-
-    /**
-     * @var float
-     */
-    protected $_payment_amount;
-
-    /**
-     * @var array
-     */
-    protected $_return_data = array();
-
-
-    /**
-     * @var array
-     */
-    protected $_validation_rules = array();
-
-
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-    }
-
-
-    /**
-     *    __toString
-     *
-     *        allows you to simply echo or print an EE_SPCO_JSON_Response object to produce a  JSON encoded string
-     *
-     * @access    public
-     * @return    string
-     */
-    public function __toString()
-    {
-        $JSON_response = array();
-        // grab notices
-        $notices = EE_Error::get_notices(false);
-        $this->set_attention(isset($notices['attention']) ? $notices['attention'] : '');
-        $this->set_errors(isset($notices['errors']) ? $notices['errors'] : '');
-        $this->set_success(isset($notices['success']) ? $notices['success'] : '');
-        // add notices to JSON response, but only if they exist
-        if ($this->attention()) {
-            $JSON_response['attention'] = $this->attention();
-        }
-        if ($this->errors()) {
-            $JSON_response['errors'] = $this->errors();
-        }
-        if ($this->unexpected_errors()) {
-            $JSON_response['unexpected_errors'] = $this->unexpected_errors();
-        }
-        if ($this->success()) {
-            $JSON_response['success'] = $this->success();
-        }
-        // but if NO notices are set... at least set the "success" as a key so that the JS knows everything worked
-        if (! isset($JSON_response['attention']) && ! isset($JSON_response['errors']) && ! isset($JSON_response['success'])) {
-            $JSON_response['success'] = null;
-        }
-        // set redirect_url, IF it exists
-        if ($this->redirect_url()) {
-            $JSON_response['redirect_url'] = $this->redirect_url();
-        }
-        // set registration_time_limit, IF it exists
-        if ($this->registration_time_limit()) {
-            $JSON_response['registration_time_limit'] = $this->registration_time_limit();
-        }
-        // set payment_amount, IF it exists
-        if ($this->payment_amount() !== null) {
-            $JSON_response['payment_amount'] = $this->payment_amount();
-        }
-        // grab generic return data
-        $return_data = $this->return_data();
-        // add billing form validation rules
-        if ($this->validation_rules()) {
-            $return_data['validation_rules'] = $this->validation_rules();
-        }
-        // set reg_step_html, IF it exists
-        if ($this->reg_step_html()) {
-            $return_data['reg_step_html'] = $this->reg_step_html();
-        }
-        // set method of payment, IF it exists
-        if ($this->method_of_payment()) {
-            $return_data['method_of_payment'] = $this->method_of_payment();
-        }
-        // set "plz_select_method_of_payment" message, IF it exists
-        if ($this->plz_select_method_of_payment()) {
-            $return_data['plz_select_method_of_payment'] = $this->plz_select_method_of_payment();
-        }
-        // set redirect_form, IF it exists
-        if ($this->redirect_form()) {
-            $return_data['redirect_form'] = $this->redirect_form();
-        }
-        // and finally, add return_data array to main JSON response array, IF it contains anything
-        // why did we add some of the above properties to the return data array?
-        // because it is easier and cleaner in the Javascript to deal with this way
-        if (! empty($return_data)) {
-            $JSON_response['return_data'] = $return_data;
-        }
-        // filter final array
-        $JSON_response = apply_filters('FHEE__EE_SPCO_JSON_Response___toString__JSON_response', $JSON_response);
-        // return encoded array
-        return (string) wp_json_encode($JSON_response);
-    }
-
-
-    /**
-     * @param string $attention
-     */
-    public function set_attention($attention)
-    {
-        $this->_attention = $attention;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function attention()
-    {
-        return $this->_attention;
-    }
-
-
-    /**
-     * @param string $errors
-     */
-    public function set_errors($errors)
-    {
-        $this->_errors = $errors;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function errors()
-    {
-        return $this->_errors;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function unexpected_errors()
-    {
-        return $this->_unexpected_errors;
-    }
-
-
-    /**
-     * @param string $unexpected_errors
-     */
-    public function set_unexpected_errors($unexpected_errors)
-    {
-        $this->_unexpected_errors = $unexpected_errors;
-    }
-
-
-    /**
-     * @param string $success
-     */
-    public function set_success($success)
-    {
-        $this->_success = $success;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function success()
-    {
-        return $this->_success;
-    }
-
-
-    /**
-     * @param string $method_of_payment
-     */
-    public function set_method_of_payment($method_of_payment)
-    {
-        $this->_method_of_payment = $method_of_payment;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function method_of_payment()
-    {
-        return $this->_method_of_payment;
-    }
-
-
-    /**
-     * @return float
-     */
-    public function payment_amount()
-    {
-        return $this->_payment_amount;
-    }
-
-
-    /**
-     * @param float $payment_amount
-     * @throws EE_Error
-     */
-    public function set_payment_amount($payment_amount)
-    {
-        $this->_payment_amount = (float) $payment_amount;
-    }
-
-
-    /**
-     * @param string $next_step_html
-     */
-    public function set_reg_step_html($next_step_html)
-    {
-        $this->_reg_step_html = $next_step_html;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function reg_step_html()
-    {
-        return $this->_reg_step_html;
-    }
-
-
-    /**
-     * @param string $redirect_form
-     */
-    public function set_redirect_form($redirect_form)
-    {
-        $this->_redirect_form = $redirect_form;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function redirect_form()
-    {
-        return ! empty($this->_redirect_form) ? $this->_redirect_form : false;
-    }
-
-
-    /**
-     * @param string $plz_select_method_of_payment
-     */
-    public function set_plz_select_method_of_payment($plz_select_method_of_payment)
-    {
-        $this->_plz_select_method_of_payment = $plz_select_method_of_payment;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plz_select_method_of_payment()
-    {
-        return $this->_plz_select_method_of_payment;
-    }
-
-
-    /**
-     * @param string $redirect_url
-     */
-    public function set_redirect_url($redirect_url)
-    {
-        $this->_redirect_url = $redirect_url;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function redirect_url()
-    {
-        return $this->_redirect_url;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function registration_time_limit()
-    {
-        return $this->_registration_time_limit;
-    }
-
-
-    /**
-     * @param string $registration_time_limit
-     */
-    public function set_registration_time_limit($registration_time_limit)
-    {
-        $this->_registration_time_limit = $registration_time_limit;
-    }
-
-
-    /**
-     * @param array $return_data
-     */
-    public function set_return_data($return_data)
-    {
-        $this->_return_data = array_merge($this->_return_data, $return_data);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function return_data()
-    {
-        return $this->_return_data;
-    }
-
-
-    /**
-     * @param array $validation_rules
-     */
-    public function add_validation_rules(array $validation_rules = array())
-    {
-        if (is_array($validation_rules) && ! empty($validation_rules)) {
-            $this->_validation_rules = array_merge($this->_validation_rules, $validation_rules);
-        }
-    }
-
-
-    /**
-     * @return array | bool
-     */
-    public function validation_rules()
-    {
-        return ! empty($this->_validation_rules) ? $this->_validation_rules : false;
-    }
-
-
-    public function echoAndExit()
-    {
-        echo ($this);
-        exit();
-    }
+	/**
+	 * @var string
+	 */
+	protected $_errors = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_unexpected_errors = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_attention = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_success = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_plz_select_method_of_payment = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_redirect_url = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_registration_time_limit = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_redirect_form = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_reg_step_html = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_method_of_payment = '';
+
+	/**
+	 * @var float
+	 */
+	protected $_payment_amount;
+
+	/**
+	 * @var array
+	 */
+	protected $_return_data = array();
+
+
+	/**
+	 * @var array
+	 */
+	protected $_validation_rules = array();
+
+
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+	}
+
+
+	/**
+	 *    __toString
+	 *
+	 *        allows you to simply echo or print an EE_SPCO_JSON_Response object to produce a  JSON encoded string
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function __toString()
+	{
+		$JSON_response = array();
+		// grab notices
+		$notices = EE_Error::get_notices(false);
+		$this->set_attention(isset($notices['attention']) ? $notices['attention'] : '');
+		$this->set_errors(isset($notices['errors']) ? $notices['errors'] : '');
+		$this->set_success(isset($notices['success']) ? $notices['success'] : '');
+		// add notices to JSON response, but only if they exist
+		if ($this->attention()) {
+			$JSON_response['attention'] = $this->attention();
+		}
+		if ($this->errors()) {
+			$JSON_response['errors'] = $this->errors();
+		}
+		if ($this->unexpected_errors()) {
+			$JSON_response['unexpected_errors'] = $this->unexpected_errors();
+		}
+		if ($this->success()) {
+			$JSON_response['success'] = $this->success();
+		}
+		// but if NO notices are set... at least set the "success" as a key so that the JS knows everything worked
+		if (! isset($JSON_response['attention']) && ! isset($JSON_response['errors']) && ! isset($JSON_response['success'])) {
+			$JSON_response['success'] = null;
+		}
+		// set redirect_url, IF it exists
+		if ($this->redirect_url()) {
+			$JSON_response['redirect_url'] = $this->redirect_url();
+		}
+		// set registration_time_limit, IF it exists
+		if ($this->registration_time_limit()) {
+			$JSON_response['registration_time_limit'] = $this->registration_time_limit();
+		}
+		// set payment_amount, IF it exists
+		if ($this->payment_amount() !== null) {
+			$JSON_response['payment_amount'] = $this->payment_amount();
+		}
+		// grab generic return data
+		$return_data = $this->return_data();
+		// add billing form validation rules
+		if ($this->validation_rules()) {
+			$return_data['validation_rules'] = $this->validation_rules();
+		}
+		// set reg_step_html, IF it exists
+		if ($this->reg_step_html()) {
+			$return_data['reg_step_html'] = $this->reg_step_html();
+		}
+		// set method of payment, IF it exists
+		if ($this->method_of_payment()) {
+			$return_data['method_of_payment'] = $this->method_of_payment();
+		}
+		// set "plz_select_method_of_payment" message, IF it exists
+		if ($this->plz_select_method_of_payment()) {
+			$return_data['plz_select_method_of_payment'] = $this->plz_select_method_of_payment();
+		}
+		// set redirect_form, IF it exists
+		if ($this->redirect_form()) {
+			$return_data['redirect_form'] = $this->redirect_form();
+		}
+		// and finally, add return_data array to main JSON response array, IF it contains anything
+		// why did we add some of the above properties to the return data array?
+		// because it is easier and cleaner in the Javascript to deal with this way
+		if (! empty($return_data)) {
+			$JSON_response['return_data'] = $return_data;
+		}
+		// filter final array
+		$JSON_response = apply_filters('FHEE__EE_SPCO_JSON_Response___toString__JSON_response', $JSON_response);
+		// return encoded array
+		return (string) wp_json_encode($JSON_response);
+	}
+
+
+	/**
+	 * @param string $attention
+	 */
+	public function set_attention($attention)
+	{
+		$this->_attention = $attention;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function attention()
+	{
+		return $this->_attention;
+	}
+
+
+	/**
+	 * @param string $errors
+	 */
+	public function set_errors($errors)
+	{
+		$this->_errors = $errors;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function errors()
+	{
+		return $this->_errors;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function unexpected_errors()
+	{
+		return $this->_unexpected_errors;
+	}
+
+
+	/**
+	 * @param string $unexpected_errors
+	 */
+	public function set_unexpected_errors($unexpected_errors)
+	{
+		$this->_unexpected_errors = $unexpected_errors;
+	}
+
+
+	/**
+	 * @param string $success
+	 */
+	public function set_success($success)
+	{
+		$this->_success = $success;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function success()
+	{
+		return $this->_success;
+	}
+
+
+	/**
+	 * @param string $method_of_payment
+	 */
+	public function set_method_of_payment($method_of_payment)
+	{
+		$this->_method_of_payment = $method_of_payment;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function method_of_payment()
+	{
+		return $this->_method_of_payment;
+	}
+
+
+	/**
+	 * @return float
+	 */
+	public function payment_amount()
+	{
+		return $this->_payment_amount;
+	}
+
+
+	/**
+	 * @param float $payment_amount
+	 * @throws EE_Error
+	 */
+	public function set_payment_amount($payment_amount)
+	{
+		$this->_payment_amount = (float) $payment_amount;
+	}
+
+
+	/**
+	 * @param string $next_step_html
+	 */
+	public function set_reg_step_html($next_step_html)
+	{
+		$this->_reg_step_html = $next_step_html;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function reg_step_html()
+	{
+		return $this->_reg_step_html;
+	}
+
+
+	/**
+	 * @param string $redirect_form
+	 */
+	public function set_redirect_form($redirect_form)
+	{
+		$this->_redirect_form = $redirect_form;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function redirect_form()
+	{
+		return ! empty($this->_redirect_form) ? $this->_redirect_form : false;
+	}
+
+
+	/**
+	 * @param string $plz_select_method_of_payment
+	 */
+	public function set_plz_select_method_of_payment($plz_select_method_of_payment)
+	{
+		$this->_plz_select_method_of_payment = $plz_select_method_of_payment;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plz_select_method_of_payment()
+	{
+		return $this->_plz_select_method_of_payment;
+	}
+
+
+	/**
+	 * @param string $redirect_url
+	 */
+	public function set_redirect_url($redirect_url)
+	{
+		$this->_redirect_url = $redirect_url;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function redirect_url()
+	{
+		return $this->_redirect_url;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function registration_time_limit()
+	{
+		return $this->_registration_time_limit;
+	}
+
+
+	/**
+	 * @param string $registration_time_limit
+	 */
+	public function set_registration_time_limit($registration_time_limit)
+	{
+		$this->_registration_time_limit = $registration_time_limit;
+	}
+
+
+	/**
+	 * @param array $return_data
+	 */
+	public function set_return_data($return_data)
+	{
+		$this->_return_data = array_merge($this->_return_data, $return_data);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function return_data()
+	{
+		return $this->_return_data;
+	}
+
+
+	/**
+	 * @param array $validation_rules
+	 */
+	public function add_validation_rules(array $validation_rules = array())
+	{
+		if (is_array($validation_rules) && ! empty($validation_rules)) {
+			$this->_validation_rules = array_merge($this->_validation_rules, $validation_rules);
+		}
+	}
+
+
+	/**
+	 * @return array | bool
+	 */
+	public function validation_rules()
+	{
+		return ! empty($this->_validation_rules) ? $this->_validation_rules : false;
+	}
+
+
+	public function echoAndExit()
+	{
+		echo ($this);
+		exit();
+	}
 }

core/libraries/messages/messenger/EE_Html_messenger.class.php

Indentation +545 added lines, -545 removed lines

@@ -12,549 +12,549 @@
  */
 class EE_Html_messenger extends EE_messenger
 {
-    /**
-     * The following are the properties that this messenger requires for displaying the html
-     */
-    /**
-     * This is the html body generated by the template via the message type.
-     *
-     * @var string
-     */
-    protected $_content = '';
-
-    /**
-     * This is for the page title that gets displayed.  (Why use "subject"?  Because the "title" tag in html is
-     * equivalent to the "subject" of the page.
-     *
-     * @var string
-     */
-    protected $_subject = '';
-
-
-    /**
-     * EE_Html_messenger constructor.
-     */
-    public function __construct()
-    {
-        // set properties
-        $this->name                = 'html';
-        $this->description         = esc_html__(
-            'This messenger outputs a message to a browser for display.',
-            'event_espresso'
-        );
-        $this->label               = [
-            'singular' => esc_html__('html', 'event_espresso'),
-            'plural'   => esc_html__('html', 'event_espresso'),
-        ];
-        $this->activate_on_install = true;
-        // add the "powered by EE" credit link to the HTML receipt and invoice
-        add_filter(
-            'FHEE__EE_Html_messenger___send_message__main_body',
-            [$this, 'add_powered_by_credit_link_to_receipt_and_invoice'],
-            10,
-            3
-        );
-        parent::__construct();
-    }
-
-
-    /**
-     * HTML Messenger desires execution immediately.
-     *
-     * @return bool
-     * @since  4.9.0
-     * @see    parent::send_now() for documentation.
-     */
-    public function send_now(): bool
-    {
-        return true;
-    }
-
-
-    /**
-     * HTML Messenger allows an empty to field.
-     *
-     * @return bool
-     * @since  4.9.0
-     * @see    parent::allow_empty_to_field() for documentation
-     */
-    public function allow_empty_to_field(): bool
-    {
-        return true;
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = ['events_edit' => true];
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_valid_shortcodes()
-    {
-        $this->_valid_shortcodes = [];
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_validator_config()
-    {
-        $this->_validator_config = [
-            'subject'                       => [
-                'shortcodes' => ['organization', 'primary_registration_details', 'email', 'transaction'],
-            ],
-            'content'                       => [
-                'shortcodes' => [
-                    'organization',
-                    'primary_registration_list',
-                    'primary_registration_details',
-                    'email',
-                    'transaction',
-                    'event_list',
-                    'payment_list',
-                    'venue',
-                    'line_item_list',
-                    'messenger',
-                    'ticket_list',
-                ],
-            ],
-            'event_list'                    => [
-                'shortcodes' => [
-                    'event',
-                    'ticket_list',
-                    'venue',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                ],
-                'required'   => ['[EVENT_LIST]'],
-            ],
-            'ticket_list'                   => [
-                'shortcodes' => [
-                    'attendee_list',
-                    'ticket',
-                    'datetime_list',
-                    'primary_registration_details',
-                    'line_item_list',
-                    'venue',
-                ],
-                'required'   => ['[TICKET_LIST]'],
-            ],
-            'ticket_line_item_no_pms'       => [
-                'shortcodes' => ['line_item', 'ticket'],
-                'required'   => ['[TICKET_LINE_ITEM_LIST]'],
-            ],
-            'ticket_line_item_pms'          => [
-                'shortcodes' => ['line_item', 'ticket', 'line_item_list'],
-                'required'   => ['[TICKET_LINE_ITEM_LIST]'],
-            ],
-            'price_modifier_line_item_list' => [
-                'shortcodes' => ['line_item'],
-                'required'   => ['[PRICE_MODIFIER_LINE_ITEM_LIST]'],
-            ],
-            'datetime_list'                 => [
-                'shortcodes' => ['datetime'],
-                'required'   => ['[DATETIME_LIST]'],
-            ],
-            'attendee_list'                 => [
-                'shortcodes' => ['attendee'],
-                'required'   => ['[ATTENDEE_LIST]'],
-            ],
-            'tax_line_item_list'            => [
-                'shortcodes' => ['line_item'],
-                'required'   => ['[TAX_LINE_ITEM_LIST]'],
-            ],
-            'additional_line_item_list'     => [
-                'shortcodes' => ['line_item'],
-                'required'   => ['[ADDITIONAL_LINE_ITEM_LIST]'],
-            ],
-            'payment_list'                  => [
-                'shortcodes' => ['payment'],
-                'required'   => ['[PAYMENT_LIST_*]'],
-            ],
-        ];
-    }
-
-
-    /**
-     * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger
-     * is a different messenger.  Child messengers can set hooks for the sending messenger to callback on if necessary
-     * (i.e. swap out css files or something else).
-     *
-     * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed.
-     * @return void
-     * @since 4.5.0
-     */
-    public function do_secondary_messenger_hooks($sending_messenger_name)
-    {
-        if ($sending_messenger_name === 'pdf') {
-            add_filter('EE_messenger__get_variation__variation', [$this, 'add_html_css'], 10, 8);
-        }
-    }
-
-
-    /**
-     * @param                            $variation_path
-     * @param EE_Messages_Template_Pack  $template_pack
-     * @param                            $messenger_name
-     * @param                            $message_type_name
-     * @param                            $url
-     * @param                            $type
-     * @param                            $variation
-     * @param                            $skip_filters
-     * @return string
-     */
-    public function add_html_css(
-        $variation_path,
-        EE_Messages_Template_Pack $template_pack,
-        $messenger_name,
-        $message_type_name,
-        $url,
-        $type,
-        $variation,
-        $skip_filters
-    ): string {
-        return $template_pack->get_variation(
-            $this->name,
-            $message_type_name,
-            $type,
-            $variation,
-            $url,
-            '.css',
-            $skip_filters
-        );
-    }
-
-
-    /**
-     * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this
-     * messenger can add their own js.
-     *
-     * @return void.
-     */
-    public function enqueue_scripts_styles()
-    {
-        parent::enqueue_scripts_styles();
-        do_action('AHEE__EE_Html_messenger__enqueue_scripts_styles');
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger
-        // but will get used by a messenger field for shortcode replacement
-        // get added to the 'extra' key in an associated array
-        // indexed by the messenger field they relate to.
-        // This is important for the Messages_admin to know what fields to display to the user.
-        // Also, notice that the "values" are equal to the field type
-        // that messages admin will use to know what kind of field to display.
-        // The values ALSO have one index labeled "shortcode".
-        // The values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE])
-        // is required in order for this extra field to be displayed.
-        //  If the required shortcode isn't part of the shortcodes array
-        // then the field is not needed and will not be displayed/parsed.
-        $this->_template_fields = [
-            'subject' => [
-                'input'      => 'text',
-                'label'      => esc_html__('Page Title', 'event_espresso'),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ],
-            'content' => '',
-            // left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra'   => [
-                'content' => [
-                    'main'                          => [
-                        'input'      => 'wp_editor',
-                        'label'      => esc_html__('Main Content', 'event_espresso'),
-                        'type'       => 'string',
-                        'required'   => true,
-                        'validation' => true,
-                        'format'     => '%s',
-                        'rows'       => '15',
-                    ],
-                    'event_list'                    => [
-                        'input'               => 'wp_editor',
-                        'label'               => '[EVENT_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'rows'                => '15',
-                        'shortcodes_required' => ['[EVENT_LIST]'],
-                    ],
-                    'ticket_list'                   => [
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => ['[TICKET_LIST]'],
-                    ],
-                    'ticket_line_item_no_pms'       => [
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LINE_ITEM_LIST] <br>' . esc_html__(
-                            'Ticket Line Item List with no Price Modifiers',
-                            'event_espresso'
-                        ),
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[TICKET_LINE_ITEM_LIST]'],
-                    ],
-                    'ticket_line_item_pms'          => [
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LINE_ITEM_LIST] <br>' . esc_html__(
-                            'Ticket Line Item List with Price Modifiers',
-                            'event_espresso'
-                        ),
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[TICKET_LINE_ITEM_LIST]'],
-                    ],
-                    'price_modifier_line_item_list' => [
-                        'input'               => 'textarea',
-                        'label'               => '[PRICE_MODIFIER_LINE_ITEM_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[PRICE_MODIFIER_LINE_ITEM_LIST]'],
-                    ],
-                    'datetime_list'                 => [
-                        'input'               => 'textarea',
-                        'label'               => '[DATETIME_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[DATETIME_LIST]'],
-                    ],
-                    'attendee_list'                 => [
-                        'input'               => 'textarea',
-                        'label'               => '[ATTENDEE_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[ATTENDEE_LIST]'],
-                    ],
-                    'tax_line_item_list'            => [
-                        'input'               => 'textarea',
-                        'label'               => '[TAX_LINE_ITEM_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[TAX_LINE_ITEM_LIST]'],
-                    ],
-                    'additional_line_item_list'     => [
-                        'input'               => 'textarea',
-                        'label'               => '[ADDITIONAL_LINE_ITEM_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[ADDITIONAL_LINE_ITEM_LIST]'],
-                    ],
-                    'payment_list'                  => [
-                        'input'               => 'textarea',
-                        'label'               => '[PAYMENT_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[PAYMENT_LIST_*]'],
-                    ],
-                ],
-            ],
-        ];
-    }
-
-
-    /**
-     * @see   definition of this method in parent
-     * @since 4.5.0
-     */
-    protected function _set_default_message_types()
-    {
-        $this->_default_message_types = ['receipt', 'invoice'];
-    }
-
-
-    /**
-     * @see   definition of this method in parent
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = ['receipt', 'invoice'];
-    }
-
-
-    /**
-     * Displays the message in the browser.
-     *
-     * @return void.
-     * @since 4.5.0
-     */
-    protected function _send_message()
-    {
-        $this->_template_args = [
-            'page_title' => $this->_subject,
-            'base_css'   => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'base',
-                $this->_variation
-            ),
-            'print_css'  => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'print',
-                $this->_variation
-            ),
-            'main_css'   => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'main',
-                $this->_variation
-            ),
-            'main_body'  => wpautop(
-                apply_filters(
-                    'FHEE__EE_Html_messenger___send_message__main_body',
-                    $this->_content,
-                    $this->_content,
-                    $this->_incoming_message_type
-                )
-            ),
-        ];
-        $this->_deregister_wp_hooks();
-        add_action('wp_enqueue_scripts', [$this, 'enqueue_scripts_styles']);
-        echo ($this->_get_main_template());
-        exit();
-    }
-
-
-    /**
-     * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't
-     * interfere with our templates.  If users want to add any custom styles or scripts they must use the
-     * AHEE__EE_Html_messenger__enqueue_scripts_styles hook.
-     *
-     * @return void
-     * @since 4.5.0
-     */
-    protected function _deregister_wp_hooks()
-    {
-        remove_all_actions('wp_head');
-        remove_all_actions('wp_footer');
-        remove_all_actions('wp_print_footer_scripts');
-        remove_all_actions('wp_enqueue_scripts');
-        global $wp_scripts, $wp_styles;
-        $wp_scripts = $wp_styles = [];
-        // just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
-        add_action('wp_footer', 'wp_print_footer_scripts');
-        add_action('wp_print_footer_scripts', '_wp_footer_scripts');
-        add_action('wp_head', 'wp_enqueue_scripts');
-    }
-
-
-    /**
-     * Overwrite parent _get_main_template for display_html purposes.
-     *
-     * @param bool $preview
-     * @return string
-     * @since  4.5.0
-     */
-    protected function _get_main_template($preview = false): string
-    {
-        $wrapper_template = $this->_tmp_pack->get_wrapper($this->name);
-        // include message type as a template arg
-        $this->_template_args['message_type'] = $this->_incoming_message_type;
-        return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
-    }
-
-
-    /**
-     * @return void
-     */
-    protected function _preview()
-    {
-        $this->_send_message();
-    }
-
-
-    protected function _set_admin_settings_fields()
-    {
-    }
-
-
-    /**
-     * add the "powered by EE" credit link to the HTML receipt and invoice
-     *
-     * @param string          $content
-     * @param string          $content_again
-     * @param EE_message_type $incoming_message_type
-     * @return string
-     */
-    public function add_powered_by_credit_link_to_receipt_and_invoice(
-        string $content,
-        string $content_again,
-        EE_message_type $incoming_message_type
-    ): string {
-        if (
-            ($incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt')
-            && apply_filters('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true)
-        ) {
-            $content .= EEH_Template::powered_by_event_espresso(
-                'aln-cntr',
-                '',
-                ['utm_content' => 'messages_system']
-            ) . EEH_HTML::div(EEH_HTML::p('&nbsp;'));
-        }
-        return $content;
-    }
+	/**
+	 * The following are the properties that this messenger requires for displaying the html
+	 */
+	/**
+	 * This is the html body generated by the template via the message type.
+	 *
+	 * @var string
+	 */
+	protected $_content = '';
+
+	/**
+	 * This is for the page title that gets displayed.  (Why use "subject"?  Because the "title" tag in html is
+	 * equivalent to the "subject" of the page.
+	 *
+	 * @var string
+	 */
+	protected $_subject = '';
+
+
+	/**
+	 * EE_Html_messenger constructor.
+	 */
+	public function __construct()
+	{
+		// set properties
+		$this->name                = 'html';
+		$this->description         = esc_html__(
+			'This messenger outputs a message to a browser for display.',
+			'event_espresso'
+		);
+		$this->label               = [
+			'singular' => esc_html__('html', 'event_espresso'),
+			'plural'   => esc_html__('html', 'event_espresso'),
+		];
+		$this->activate_on_install = true;
+		// add the "powered by EE" credit link to the HTML receipt and invoice
+		add_filter(
+			'FHEE__EE_Html_messenger___send_message__main_body',
+			[$this, 'add_powered_by_credit_link_to_receipt_and_invoice'],
+			10,
+			3
+		);
+		parent::__construct();
+	}
+
+
+	/**
+	 * HTML Messenger desires execution immediately.
+	 *
+	 * @return bool
+	 * @since  4.9.0
+	 * @see    parent::send_now() for documentation.
+	 */
+	public function send_now(): bool
+	{
+		return true;
+	}
+
+
+	/**
+	 * HTML Messenger allows an empty to field.
+	 *
+	 * @return bool
+	 * @since  4.9.0
+	 * @see    parent::allow_empty_to_field() for documentation
+	 */
+	public function allow_empty_to_field(): bool
+	{
+		return true;
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = ['events_edit' => true];
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		$this->_valid_shortcodes = [];
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_validator_config()
+	{
+		$this->_validator_config = [
+			'subject'                       => [
+				'shortcodes' => ['organization', 'primary_registration_details', 'email', 'transaction'],
+			],
+			'content'                       => [
+				'shortcodes' => [
+					'organization',
+					'primary_registration_list',
+					'primary_registration_details',
+					'email',
+					'transaction',
+					'event_list',
+					'payment_list',
+					'venue',
+					'line_item_list',
+					'messenger',
+					'ticket_list',
+				],
+			],
+			'event_list'                    => [
+				'shortcodes' => [
+					'event',
+					'ticket_list',
+					'venue',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+				],
+				'required'   => ['[EVENT_LIST]'],
+			],
+			'ticket_list'                   => [
+				'shortcodes' => [
+					'attendee_list',
+					'ticket',
+					'datetime_list',
+					'primary_registration_details',
+					'line_item_list',
+					'venue',
+				],
+				'required'   => ['[TICKET_LIST]'],
+			],
+			'ticket_line_item_no_pms'       => [
+				'shortcodes' => ['line_item', 'ticket'],
+				'required'   => ['[TICKET_LINE_ITEM_LIST]'],
+			],
+			'ticket_line_item_pms'          => [
+				'shortcodes' => ['line_item', 'ticket', 'line_item_list'],
+				'required'   => ['[TICKET_LINE_ITEM_LIST]'],
+			],
+			'price_modifier_line_item_list' => [
+				'shortcodes' => ['line_item'],
+				'required'   => ['[PRICE_MODIFIER_LINE_ITEM_LIST]'],
+			],
+			'datetime_list'                 => [
+				'shortcodes' => ['datetime'],
+				'required'   => ['[DATETIME_LIST]'],
+			],
+			'attendee_list'                 => [
+				'shortcodes' => ['attendee'],
+				'required'   => ['[ATTENDEE_LIST]'],
+			],
+			'tax_line_item_list'            => [
+				'shortcodes' => ['line_item'],
+				'required'   => ['[TAX_LINE_ITEM_LIST]'],
+			],
+			'additional_line_item_list'     => [
+				'shortcodes' => ['line_item'],
+				'required'   => ['[ADDITIONAL_LINE_ITEM_LIST]'],
+			],
+			'payment_list'                  => [
+				'shortcodes' => ['payment'],
+				'required'   => ['[PAYMENT_LIST_*]'],
+			],
+		];
+	}
+
+
+	/**
+	 * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger
+	 * is a different messenger.  Child messengers can set hooks for the sending messenger to callback on if necessary
+	 * (i.e. swap out css files or something else).
+	 *
+	 * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed.
+	 * @return void
+	 * @since 4.5.0
+	 */
+	public function do_secondary_messenger_hooks($sending_messenger_name)
+	{
+		if ($sending_messenger_name === 'pdf') {
+			add_filter('EE_messenger__get_variation__variation', [$this, 'add_html_css'], 10, 8);
+		}
+	}
+
+
+	/**
+	 * @param                            $variation_path
+	 * @param EE_Messages_Template_Pack  $template_pack
+	 * @param                            $messenger_name
+	 * @param                            $message_type_name
+	 * @param                            $url
+	 * @param                            $type
+	 * @param                            $variation
+	 * @param                            $skip_filters
+	 * @return string
+	 */
+	public function add_html_css(
+		$variation_path,
+		EE_Messages_Template_Pack $template_pack,
+		$messenger_name,
+		$message_type_name,
+		$url,
+		$type,
+		$variation,
+		$skip_filters
+	): string {
+		return $template_pack->get_variation(
+			$this->name,
+			$message_type_name,
+			$type,
+			$variation,
+			$url,
+			'.css',
+			$skip_filters
+		);
+	}
+
+
+	/**
+	 * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this
+	 * messenger can add their own js.
+	 *
+	 * @return void.
+	 */
+	public function enqueue_scripts_styles()
+	{
+		parent::enqueue_scripts_styles();
+		do_action('AHEE__EE_Html_messenger__enqueue_scripts_styles');
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger
+		// but will get used by a messenger field for shortcode replacement
+		// get added to the 'extra' key in an associated array
+		// indexed by the messenger field they relate to.
+		// This is important for the Messages_admin to know what fields to display to the user.
+		// Also, notice that the "values" are equal to the field type
+		// that messages admin will use to know what kind of field to display.
+		// The values ALSO have one index labeled "shortcode".
+		// The values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE])
+		// is required in order for this extra field to be displayed.
+		//  If the required shortcode isn't part of the shortcodes array
+		// then the field is not needed and will not be displayed/parsed.
+		$this->_template_fields = [
+			'subject' => [
+				'input'      => 'text',
+				'label'      => esc_html__('Page Title', 'event_espresso'),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			],
+			'content' => '',
+			// left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra'   => [
+				'content' => [
+					'main'                          => [
+						'input'      => 'wp_editor',
+						'label'      => esc_html__('Main Content', 'event_espresso'),
+						'type'       => 'string',
+						'required'   => true,
+						'validation' => true,
+						'format'     => '%s',
+						'rows'       => '15',
+					],
+					'event_list'                    => [
+						'input'               => 'wp_editor',
+						'label'               => '[EVENT_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'rows'                => '15',
+						'shortcodes_required' => ['[EVENT_LIST]'],
+					],
+					'ticket_list'                   => [
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => ['[TICKET_LIST]'],
+					],
+					'ticket_line_item_no_pms'       => [
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LINE_ITEM_LIST] <br>' . esc_html__(
+							'Ticket Line Item List with no Price Modifiers',
+							'event_espresso'
+						),
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[TICKET_LINE_ITEM_LIST]'],
+					],
+					'ticket_line_item_pms'          => [
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LINE_ITEM_LIST] <br>' . esc_html__(
+							'Ticket Line Item List with Price Modifiers',
+							'event_espresso'
+						),
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[TICKET_LINE_ITEM_LIST]'],
+					],
+					'price_modifier_line_item_list' => [
+						'input'               => 'textarea',
+						'label'               => '[PRICE_MODIFIER_LINE_ITEM_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[PRICE_MODIFIER_LINE_ITEM_LIST]'],
+					],
+					'datetime_list'                 => [
+						'input'               => 'textarea',
+						'label'               => '[DATETIME_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[DATETIME_LIST]'],
+					],
+					'attendee_list'                 => [
+						'input'               => 'textarea',
+						'label'               => '[ATTENDEE_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[ATTENDEE_LIST]'],
+					],
+					'tax_line_item_list'            => [
+						'input'               => 'textarea',
+						'label'               => '[TAX_LINE_ITEM_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[TAX_LINE_ITEM_LIST]'],
+					],
+					'additional_line_item_list'     => [
+						'input'               => 'textarea',
+						'label'               => '[ADDITIONAL_LINE_ITEM_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[ADDITIONAL_LINE_ITEM_LIST]'],
+					],
+					'payment_list'                  => [
+						'input'               => 'textarea',
+						'label'               => '[PAYMENT_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[PAYMENT_LIST_*]'],
+					],
+				],
+			],
+		];
+	}
+
+
+	/**
+	 * @see   definition of this method in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_default_message_types()
+	{
+		$this->_default_message_types = ['receipt', 'invoice'];
+	}
+
+
+	/**
+	 * @see   definition of this method in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = ['receipt', 'invoice'];
+	}
+
+
+	/**
+	 * Displays the message in the browser.
+	 *
+	 * @return void.
+	 * @since 4.5.0
+	 */
+	protected function _send_message()
+	{
+		$this->_template_args = [
+			'page_title' => $this->_subject,
+			'base_css'   => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'base',
+				$this->_variation
+			),
+			'print_css'  => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'print',
+				$this->_variation
+			),
+			'main_css'   => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'main',
+				$this->_variation
+			),
+			'main_body'  => wpautop(
+				apply_filters(
+					'FHEE__EE_Html_messenger___send_message__main_body',
+					$this->_content,
+					$this->_content,
+					$this->_incoming_message_type
+				)
+			),
+		];
+		$this->_deregister_wp_hooks();
+		add_action('wp_enqueue_scripts', [$this, 'enqueue_scripts_styles']);
+		echo ($this->_get_main_template());
+		exit();
+	}
+
+
+	/**
+	 * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't
+	 * interfere with our templates.  If users want to add any custom styles or scripts they must use the
+	 * AHEE__EE_Html_messenger__enqueue_scripts_styles hook.
+	 *
+	 * @return void
+	 * @since 4.5.0
+	 */
+	protected function _deregister_wp_hooks()
+	{
+		remove_all_actions('wp_head');
+		remove_all_actions('wp_footer');
+		remove_all_actions('wp_print_footer_scripts');
+		remove_all_actions('wp_enqueue_scripts');
+		global $wp_scripts, $wp_styles;
+		$wp_scripts = $wp_styles = [];
+		// just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
+		add_action('wp_footer', 'wp_print_footer_scripts');
+		add_action('wp_print_footer_scripts', '_wp_footer_scripts');
+		add_action('wp_head', 'wp_enqueue_scripts');
+	}
+
+
+	/**
+	 * Overwrite parent _get_main_template for display_html purposes.
+	 *
+	 * @param bool $preview
+	 * @return string
+	 * @since  4.5.0
+	 */
+	protected function _get_main_template($preview = false): string
+	{
+		$wrapper_template = $this->_tmp_pack->get_wrapper($this->name);
+		// include message type as a template arg
+		$this->_template_args['message_type'] = $this->_incoming_message_type;
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	protected function _preview()
+	{
+		$this->_send_message();
+	}
+
+
+	protected function _set_admin_settings_fields()
+	{
+	}
+
+
+	/**
+	 * add the "powered by EE" credit link to the HTML receipt and invoice
+	 *
+	 * @param string          $content
+	 * @param string          $content_again
+	 * @param EE_message_type $incoming_message_type
+	 * @return string
+	 */
+	public function add_powered_by_credit_link_to_receipt_and_invoice(
+		string $content,
+		string $content_again,
+		EE_message_type $incoming_message_type
+	): string {
+		if (
+			($incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt')
+			&& apply_filters('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true)
+		) {
+			$content .= EEH_Template::powered_by_event_espresso(
+				'aln-cntr',
+				'',
+				['utm_content' => 'messages_system']
+			) . EEH_HTML::div(EEH_HTML::p('&nbsp;'));
+		}
+		return $content;
+	}
 }

core/libraries/iframe_display/Iframe.php

Indentation +334 added lines, -334 removed lines

@@ -18,373 +18,373 @@
  */
 class Iframe
 {
-    /*
+	/*
     * HTML for notices and ajax gif
     * @var string $title
     */
-    protected $title = '';
+	protected $title = '';
 
-    /*
+	/*
     * HTML for the content being displayed
     * @var string $content
     */
-    protected $content = '';
+	protected $content = '';
 
-    /*
+	/*
     * whether or not to call wp_head() and wp_footer()
     * @var boolean $enqueue_wp_assets
     */
-    protected $enqueue_wp_assets = false;
+	protected $enqueue_wp_assets = false;
 
-    /*
+	/*
     * an array of CSS URLs
     * @var array $css
     */
-    protected $css = array();
+	protected $css = array();
 
-    /*
+	/*
     * an array of JS URLs to be set in the HTML header.
     * @var array $header_js
     */
-    protected $header_js = array();
+	protected $header_js = array();
 
-    /*
+	/*
     * an array of additional attributes to be added to <script> tags for header JS
     * @var array $footer_js
     */
-    protected $header_js_attributes = array();
+	protected $header_js_attributes = array();
 
-    /*
+	/*
     * an array of JS URLs to be displayed before the HTML </body> tag
     * @var array $footer_js
     */
-    protected $footer_js = array();
+	protected $footer_js = array();
 
-    /*
+	/*
     * an array of additional attributes to be added to <script> tags for footer JS
     * @var array $footer_js_attributes
     */
-    protected $footer_js_attributes = array();
+	protected $footer_js_attributes = array();
 
-    /*
+	/*
     * an array of JSON vars to be set in the HTML header.
     * @var array $localized_vars
     */
-    protected $localized_vars = array();
-
-
-    /**
-     * Iframe constructor
-     *
-     * @param string $title
-     * @param string $content
-     * @throws DomainException
-     */
-    public function __construct($title, $content)
-    {
-        global $wp_version;
-        if (! defined('EE_IFRAME_DIR_URL')) {
-            define('EE_IFRAME_DIR_URL', plugin_dir_url(__FILE__));
-        }
-        $this->setContent($content);
-        $this->setTitle($title);
-        $this->addStylesheets(
-            apply_filters(
-                'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_css',
-                array(
-                    'site_theme'       => get_stylesheet_directory_uri()
-                                          . '/style.css?ver=' . EVENT_ESPRESSO_VERSION,
-                    'dashicons'        => includes_url('css/dashicons.min.css?ver=' . $wp_version),
-                    'espresso_default' => EE_GLOBAL_ASSETS_URL
-                                          . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
-                ),
-                $this
-            )
-        );
-        $this->addScripts(
-            apply_filters(
-                'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_js',
-                array(
-                    'jquery'        => includes_url('js/jquery/jquery.js?ver=' . $wp_version),
-                    'espresso_core' => EE_GLOBAL_ASSETS_URL
-                                       . 'scripts/espresso_core.js?ver=' . EVENT_ESPRESSO_VERSION,
-                ),
-                $this
-            )
-        );
-        if (
-            apply_filters(
-                'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__load_default_theme_stylesheet',
-                false
-            )
-        ) {
-            $this->addStylesheets(
-                apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_theme_stylesheet',
-                    array('default_theme_stylesheet' => get_stylesheet_uri()),
-                    $this
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param string $title
-     * @throws DomainException
-     */
-    public function setTitle($title)
-    {
-        if (empty($title)) {
-            throw new DomainException(
-                esc_html__('You must provide a page title in order to create an iframe.', 'event_espresso')
-            );
-        }
-        $this->title = $title;
-    }
-
-
-    /**
-     * @param string $content
-     * @throws DomainException
-     */
-    public function setContent($content)
-    {
-        if (empty($content)) {
-            throw new DomainException(
-                esc_html__('You must provide content in order to create an iframe.', 'event_espresso')
-            );
-        }
-        $this->content = $content;
-    }
-
-
-    /**
-     * @param boolean $enqueue_wp_assets
-     */
-    public function setEnqueueWpAssets($enqueue_wp_assets)
-    {
-        $this->enqueue_wp_assets = filter_var($enqueue_wp_assets, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @param array $stylesheets
-     * @throws DomainException
-     */
-    public function addStylesheets(array $stylesheets)
-    {
-        if (empty($stylesheets)) {
-            throw new DomainException(
-                esc_html__(
-                    'A non-empty array of URLs, is required to add a CSS stylesheet to an iframe.',
-                    'event_espresso'
-                )
-            );
-        }
-        foreach ($stylesheets as $handle => $stylesheet) {
-            $this->css[ $handle ] = $stylesheet;
-        }
-    }
-
-
-    /**
-     * @param array $scripts
-     * @param bool  $add_to_header
-     * @throws DomainException
-     */
-    public function addScripts(array $scripts, $add_to_header = false)
-    {
-        if (empty($scripts)) {
-            throw new DomainException(
-                esc_html__(
-                    'A non-empty array of URLs, is required to add Javascript to an iframe.',
-                    'event_espresso'
-                )
-            );
-        }
-        foreach ($scripts as $handle => $script) {
-            if ($add_to_header) {
-                $this->header_js[ $handle ] = $script;
-            } else {
-                $this->footer_js[ $handle ] = $script;
-            }
-        }
-    }
-
-
-    /**
-     * @param array $script_attributes
-     * @param bool  $add_to_header
-     * @throws DomainException
-     */
-    public function addScriptAttributes(array $script_attributes, $add_to_header = false)
-    {
-        if (empty($script_attributes)) {
-            throw new DomainException(
-                esc_html__(
-                    'A non-empty array of strings, is required to add attributes to iframe Javascript.',
-                    'event_espresso'
-                )
-            );
-        }
-        foreach ($script_attributes as $handle => $script_attribute) {
-            if ($add_to_header) {
-                $this->header_js_attributes[ $handle ] = $script_attribute;
-            } else {
-                $this->footer_js_attributes[ $handle ] = $script_attribute;
-            }
-        }
-    }
-
-
-    /**
-     * @param array  $vars
-     * @param string $var_name
-     * @throws DomainException
-     */
-    public function addLocalizedVars(array $vars, $var_name = 'eei18n')
-    {
-        if (empty($vars)) {
-            throw new DomainException(
-                esc_html__(
-                    'A non-empty array of vars, is required to add localized Javascript vars to an iframe.',
-                    'event_espresso'
-                )
-            );
-        }
-        foreach ($vars as $handle => $var) {
-            if ($var_name === 'eei18n') {
-                EE_Registry::$i18n_js_strings[ $handle ] = $var;
-            } elseif ($var_name === 'eeCAL' && $handle === 'espresso_calendar') {
-                $this->localized_vars[ $var_name ] = $var;
-            } else {
-                if (! isset($this->localized_vars[ $var_name ])) {
-                    $this->localized_vars[ $var_name ] = array();
-                }
-                $this->localized_vars[ $var_name ][ $handle ] = $var;
-            }
-        }
-    }
-
-
-    /**
-     * @param string $utm_content
-     * @throws DomainException
-     */
-    public function display($utm_content = '')
-    {
-        $this->content .= EEH_Template::powered_by_event_espresso(
-            '',
-            '',
-            ! empty($utm_content) ? array('utm_content' => $utm_content) : array()
-        );
-        EE_System::do_not_cache();
-        echo ($this->getTemplate());
-        exit;
-    }
-
-
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function getTemplate()
-    {
-        return EEH_Template::display_template(
-            __DIR__ . DIRECTORY_SEPARATOR . 'iframe_wrapper.template.php',
-            array(
-                'title'                => apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__title',
-                    $this->title,
-                    $this
-                ),
-                'content'              => apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__content',
-                    $this->content,
-                    $this
-                ),
-                'enqueue_wp_assets'    => apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__enqueue_wp_assets',
-                    $this->enqueue_wp_assets,
-                    $this
-                ),
-                'css'                  => (array) apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__css_urls',
-                    $this->css,
-                    $this
-                ),
-                'header_js'            => (array) apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_urls',
-                    $this->header_js,
-                    $this
-                ),
-                'header_js_attributes' => (array) apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_attributes',
-                    $this->header_js_attributes,
-                    $this
-                ),
-                'footer_js'            => (array) apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_urls',
-                    $this->footer_js,
-                    $this
-                ),
-                'footer_js_attributes' => (array) apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_attributes',
-                    $this->footer_js_attributes,
-                    $this
-                ),
-                'eei18n'               => apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__eei18n_js_strings',
-                    EE_Registry::localize_i18n_js_strings() . $this->localizeJsonVars(),
-                    $this
-                ),
-                'notices'              => EEH_Template::display_template(
-                    EE_TEMPLATES . 'espresso-ajax-notices.template.php',
-                    array(),
-                    true
-                ),
-            ),
-            true,
-            true
-        );
-    }
-
-
-    /**
-     * localizeJsonVars
-     *
-     * @return string
-     */
-    public function localizeJsonVars()
-    {
-        $JSON = '';
-        foreach ($this->localized_vars as $var_name => $vars) {
-            $this->localized_vars[ $var_name ] = $this->encodeJsonVars($vars);
-            $JSON .= "/* <![CDATA[ */ var {$var_name} = ";
-            $JSON .= wp_json_encode($this->localized_vars[ $var_name ]);
-            $JSON .= '; /* ]]> */';
-        }
-        return $JSON;
-    }
-
-
-    /**
-     * @param bool|int|float|string|array $var
-     * @return array|string|null
-     */
-    public function encodeJsonVars($var)
-    {
-        if (is_array($var)) {
-            $localized_vars = array();
-            foreach ((array) $var as $key => $value) {
-                $localized_vars[ $key ] = $this->encodeJsonVars($value);
-            }
-            return $localized_vars;
-        }
-        if (is_scalar($var)) {
-            return html_entity_decode((string) $var, ENT_QUOTES, 'UTF-8');
-        }
-        return null;
-    }
+	protected $localized_vars = array();
+
+
+	/**
+	 * Iframe constructor
+	 *
+	 * @param string $title
+	 * @param string $content
+	 * @throws DomainException
+	 */
+	public function __construct($title, $content)
+	{
+		global $wp_version;
+		if (! defined('EE_IFRAME_DIR_URL')) {
+			define('EE_IFRAME_DIR_URL', plugin_dir_url(__FILE__));
+		}
+		$this->setContent($content);
+		$this->setTitle($title);
+		$this->addStylesheets(
+			apply_filters(
+				'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_css',
+				array(
+					'site_theme'       => get_stylesheet_directory_uri()
+										  . '/style.css?ver=' . EVENT_ESPRESSO_VERSION,
+					'dashicons'        => includes_url('css/dashicons.min.css?ver=' . $wp_version),
+					'espresso_default' => EE_GLOBAL_ASSETS_URL
+										  . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
+				),
+				$this
+			)
+		);
+		$this->addScripts(
+			apply_filters(
+				'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_js',
+				array(
+					'jquery'        => includes_url('js/jquery/jquery.js?ver=' . $wp_version),
+					'espresso_core' => EE_GLOBAL_ASSETS_URL
+									   . 'scripts/espresso_core.js?ver=' . EVENT_ESPRESSO_VERSION,
+				),
+				$this
+			)
+		);
+		if (
+			apply_filters(
+				'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__load_default_theme_stylesheet',
+				false
+			)
+		) {
+			$this->addStylesheets(
+				apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_theme_stylesheet',
+					array('default_theme_stylesheet' => get_stylesheet_uri()),
+					$this
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $title
+	 * @throws DomainException
+	 */
+	public function setTitle($title)
+	{
+		if (empty($title)) {
+			throw new DomainException(
+				esc_html__('You must provide a page title in order to create an iframe.', 'event_espresso')
+			);
+		}
+		$this->title = $title;
+	}
+
+
+	/**
+	 * @param string $content
+	 * @throws DomainException
+	 */
+	public function setContent($content)
+	{
+		if (empty($content)) {
+			throw new DomainException(
+				esc_html__('You must provide content in order to create an iframe.', 'event_espresso')
+			);
+		}
+		$this->content = $content;
+	}
+
+
+	/**
+	 * @param boolean $enqueue_wp_assets
+	 */
+	public function setEnqueueWpAssets($enqueue_wp_assets)
+	{
+		$this->enqueue_wp_assets = filter_var($enqueue_wp_assets, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @param array $stylesheets
+	 * @throws DomainException
+	 */
+	public function addStylesheets(array $stylesheets)
+	{
+		if (empty($stylesheets)) {
+			throw new DomainException(
+				esc_html__(
+					'A non-empty array of URLs, is required to add a CSS stylesheet to an iframe.',
+					'event_espresso'
+				)
+			);
+		}
+		foreach ($stylesheets as $handle => $stylesheet) {
+			$this->css[ $handle ] = $stylesheet;
+		}
+	}
+
+
+	/**
+	 * @param array $scripts
+	 * @param bool  $add_to_header
+	 * @throws DomainException
+	 */
+	public function addScripts(array $scripts, $add_to_header = false)
+	{
+		if (empty($scripts)) {
+			throw new DomainException(
+				esc_html__(
+					'A non-empty array of URLs, is required to add Javascript to an iframe.',
+					'event_espresso'
+				)
+			);
+		}
+		foreach ($scripts as $handle => $script) {
+			if ($add_to_header) {
+				$this->header_js[ $handle ] = $script;
+			} else {
+				$this->footer_js[ $handle ] = $script;
+			}
+		}
+	}
+
+
+	/**
+	 * @param array $script_attributes
+	 * @param bool  $add_to_header
+	 * @throws DomainException
+	 */
+	public function addScriptAttributes(array $script_attributes, $add_to_header = false)
+	{
+		if (empty($script_attributes)) {
+			throw new DomainException(
+				esc_html__(
+					'A non-empty array of strings, is required to add attributes to iframe Javascript.',
+					'event_espresso'
+				)
+			);
+		}
+		foreach ($script_attributes as $handle => $script_attribute) {
+			if ($add_to_header) {
+				$this->header_js_attributes[ $handle ] = $script_attribute;
+			} else {
+				$this->footer_js_attributes[ $handle ] = $script_attribute;
+			}
+		}
+	}
+
+
+	/**
+	 * @param array  $vars
+	 * @param string $var_name
+	 * @throws DomainException
+	 */
+	public function addLocalizedVars(array $vars, $var_name = 'eei18n')
+	{
+		if (empty($vars)) {
+			throw new DomainException(
+				esc_html__(
+					'A non-empty array of vars, is required to add localized Javascript vars to an iframe.',
+					'event_espresso'
+				)
+			);
+		}
+		foreach ($vars as $handle => $var) {
+			if ($var_name === 'eei18n') {
+				EE_Registry::$i18n_js_strings[ $handle ] = $var;
+			} elseif ($var_name === 'eeCAL' && $handle === 'espresso_calendar') {
+				$this->localized_vars[ $var_name ] = $var;
+			} else {
+				if (! isset($this->localized_vars[ $var_name ])) {
+					$this->localized_vars[ $var_name ] = array();
+				}
+				$this->localized_vars[ $var_name ][ $handle ] = $var;
+			}
+		}
+	}
+
+
+	/**
+	 * @param string $utm_content
+	 * @throws DomainException
+	 */
+	public function display($utm_content = '')
+	{
+		$this->content .= EEH_Template::powered_by_event_espresso(
+			'',
+			'',
+			! empty($utm_content) ? array('utm_content' => $utm_content) : array()
+		);
+		EE_System::do_not_cache();
+		echo ($this->getTemplate());
+		exit;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function getTemplate()
+	{
+		return EEH_Template::display_template(
+			__DIR__ . DIRECTORY_SEPARATOR . 'iframe_wrapper.template.php',
+			array(
+				'title'                => apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__title',
+					$this->title,
+					$this
+				),
+				'content'              => apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__content',
+					$this->content,
+					$this
+				),
+				'enqueue_wp_assets'    => apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__enqueue_wp_assets',
+					$this->enqueue_wp_assets,
+					$this
+				),
+				'css'                  => (array) apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__css_urls',
+					$this->css,
+					$this
+				),
+				'header_js'            => (array) apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_urls',
+					$this->header_js,
+					$this
+				),
+				'header_js_attributes' => (array) apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_attributes',
+					$this->header_js_attributes,
+					$this
+				),
+				'footer_js'            => (array) apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_urls',
+					$this->footer_js,
+					$this
+				),
+				'footer_js_attributes' => (array) apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_attributes',
+					$this->footer_js_attributes,
+					$this
+				),
+				'eei18n'               => apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__eei18n_js_strings',
+					EE_Registry::localize_i18n_js_strings() . $this->localizeJsonVars(),
+					$this
+				),
+				'notices'              => EEH_Template::display_template(
+					EE_TEMPLATES . 'espresso-ajax-notices.template.php',
+					array(),
+					true
+				),
+			),
+			true,
+			true
+		);
+	}
+
+
+	/**
+	 * localizeJsonVars
+	 *
+	 * @return string
+	 */
+	public function localizeJsonVars()
+	{
+		$JSON = '';
+		foreach ($this->localized_vars as $var_name => $vars) {
+			$this->localized_vars[ $var_name ] = $this->encodeJsonVars($vars);
+			$JSON .= "/* <![CDATA[ */ var {$var_name} = ";
+			$JSON .= wp_json_encode($this->localized_vars[ $var_name ]);
+			$JSON .= '; /* ]]> */';
+		}
+		return $JSON;
+	}
+
+
+	/**
+	 * @param bool|int|float|string|array $var
+	 * @return array|string|null
+	 */
+	public function encodeJsonVars($var)
+	{
+		if (is_array($var)) {
+			$localized_vars = array();
+			foreach ((array) $var as $key => $value) {
+				$localized_vars[ $key ] = $this->encodeJsonVars($value);
+			}
+			return $localized_vars;
+		}
+		if (is_scalar($var)) {
+			return html_entity_decode((string) $var, ENT_QUOTES, 'UTF-8');
+		}
+		return null;
+	}
 }

core/libraries/iframe_display/iframe_wrapper.template.php

Spacing +2 added lines, -2 removed lines

@@ -36,7 +36,7 @@ 
                 <?php echo ($eei18n); ?>
             </script>
         <?php foreach ($header_js as $key => $url) :?>
-            <?php $header_attributes = isset($header_js_attributes[ $key ]) ? $header_js_attributes[ $key ] : ''; ?>
+            <?php $header_attributes = isset($header_js_attributes[$key]) ? $header_js_attributes[$key] : ''; ?>
         <script type="text/javascript" src="<?php echo esc_url_raw($url); ?>" <?php echo AttributesSanitizer::clean($header_attributes, AllowedTags::getAllowedTags(), 'script'); ?>></script>
         <?php endforeach; ?>
     <?php endif; ?>
@@ -47,7 +47,7 @@ 
     <?php echo wp_kses($content, AllowedTags::getWithFullTags()); ?>
 </div>
 <?php foreach ($footer_js as $key => $url) : ?>
-    <?php $footer_attributes = isset($footer_js_attributes[ $key ]) ? $footer_js_attributes[ $key ] : ''; ?>
+    <?php $footer_attributes = isset($footer_js_attributes[$key]) ? $footer_js_attributes[$key] : ''; ?>
     <script type="text/javascript" src="<?php echo esc_url_raw($url); ?>" <?php echo AttributesSanitizer::clean($footer_attributes, AllowedTags::getAllowedTags(), 'script'); ?>></script>
 <?php endforeach; ?>
 <?php if ($enqueue_wp_assets) : ?>

Braces +5 added lines, -2 removed lines

@@ -28,9 +28,12 @@
     <title><?php echo wp_strip_all_tags($title); ?></title>
     <?php if ($enqueue_wp_assets) : ?>
         <?php wp_head(); ?>
-    <?php else : ?>
+    <?php else {
+	: ?>
         <?php foreach ($css as $url) :?>
-    <link rel="stylesheet" type="text/css" href="<?php echo esc_url_raw($url); ?>">
+    <link rel="stylesheet" type="text/css" href="<?php echo esc_url_raw($url);
+}
+?>">
         <?php endforeach; ?>
             <script type="text/javascript">
                 <?php echo ($eei18n); ?>

admin_pages/events/Events_Admin_Page.core.php

Indentation +2799 added lines, -2799 removed lines

@@ -15,2806 +15,2806 @@
  */
 class Events_Admin_Page extends EE_Admin_Page_CPT
 {
-    /**
-     * This will hold the event object for event_details screen.
+	/**
+	 * This will hold the event object for event_details screen.
+	 *
+	 * @var EE_Event $_event
+	 */
+	protected $_event;
+
+
+	/**
+	 * This will hold the category object for category_details screen.
+	 *
+	 * @var stdClass $_category
+	 */
+	protected $_category;
+
+
+	/**
+	 * This will hold the event model instance
+	 *
+	 * @var EEM_Event $_event_model
+	 */
+	protected $_event_model;
+
+
+	/**
+	 * @var EE_Event
+	 */
+	protected $_cpt_model_obj = false;
+
+
+	/**
+	 * @var NodeGroupDao
+	 */
+	protected $model_obj_node_group_persister;
+
+
+	/**
+	 * Initialize page props for this admin page group.
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug        = EVENTS_PG_SLUG;
+		$this->page_label       = EVENTS_LABEL;
+		$this->_admin_base_url  = EVENTS_ADMIN_URL;
+		$this->_admin_base_path = EVENTS_ADMIN;
+		$this->_cpt_model_names = [
+			'create_new' => 'EEM_Event',
+			'edit'       => 'EEM_Event',
+		];
+		$this->_cpt_edit_routes = [
+			'espresso_events' => 'edit',
+		];
+		add_action(
+			'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
+			[$this, 'verify_event_edit'],
+			10,
+			2
+		);
+	}
+
+
+	/**
+	 * Sets the ajax hooks used for this admin page group.
+	 */
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_ee_save_timezone_setting', [$this, 'saveTimezoneString']);
+	}
+
+
+	/**
+	 * Sets the page properties for this admin page group.
+	 */
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = EVENTS_LABEL;
+		$this->_labels           = [
+			'buttons'      => [
+				'add'             => esc_html__('Add New Event', 'event_espresso'),
+				'edit'            => esc_html__('Edit Event', 'event_espresso'),
+				'delete'          => esc_html__('Delete Event', 'event_espresso'),
+				'add_category'    => esc_html__('Add New Category', 'event_espresso'),
+				'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
+				'delete_category' => esc_html__('Delete Category', 'event_espresso'),
+			],
+			'editor_title' => [
+				'espresso_events' => esc_html__('Enter event title here', 'event_espresso'),
+			],
+			'publishbox'   => [
+				'create_new'        => esc_html__('Save New Event', 'event_espresso'),
+				'edit'              => esc_html__('Update Event', 'event_espresso'),
+				'add_category'      => esc_html__('Save New Category', 'event_espresso'),
+				'edit_category'     => esc_html__('Update Category', 'event_espresso'),
+				'template_settings' => esc_html__('Update Settings', 'event_espresso'),
+			],
+		];
+	}
+
+
+	/**
+	 * Sets the page routes property for this admin page group.
+	 */
+	protected function _set_page_routes()
+	{
+		// load formatter helper
+		// load field generator helper
+		// is there a evt_id in the request?
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		$EVT_ID = $this->request->getRequestParam('post', $EVT_ID, 'int');
+
+		$this->_page_routes = [
+			'default'                       => [
+				'func'       => '_events_overview_list_table',
+				'capability' => 'ee_read_events',
+			],
+			'create_new'                    => [
+				'func'       => '_create_new_cpt_item',
+				'capability' => 'ee_edit_events',
+			],
+			'edit'                          => [
+				'func'       => '_edit_cpt_item',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $EVT_ID,
+			],
+			'copy_event'                    => [
+				'func'       => '_copy_events',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'trash_event'                   => [
+				'func'       => '_trash_or_restore_event',
+				'args'       => ['event_status' => 'trash'],
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'trash_events'                  => [
+				'func'       => '_trash_or_restore_events',
+				'args'       => ['event_status' => 'trash'],
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+			'restore_event'                 => [
+				'func'       => '_trash_or_restore_event',
+				'args'       => ['event_status' => 'draft'],
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'restore_events'                => [
+				'func'       => '_trash_or_restore_events',
+				'args'       => ['event_status' => 'draft'],
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+			'delete_event'                  => [
+				'func'       => '_delete_event',
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'delete_events'                 => [
+				'func'       => '_delete_events',
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+			'view_report'                   => [
+				'func'       => '_view_report',
+				'capability' => 'ee_edit_events',
+			],
+			'default_event_settings'        => [
+				'func'       => '_default_event_settings',
+				'capability' => 'manage_options',
+			],
+			'update_default_event_settings' => [
+				'func'       => '_update_default_event_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'template_settings'             => [
+				'func'       => '_template_settings',
+				'capability' => 'manage_options',
+			],
+			// event category tab related
+			'add_category'                  => [
+				'func'       => '_category_details',
+				'capability' => 'ee_edit_event_category',
+				'args'       => ['add'],
+			],
+			'edit_category'                 => [
+				'func'       => '_category_details',
+				'capability' => 'ee_edit_event_category',
+				'args'       => ['edit'],
+			],
+			'delete_categories'             => [
+				'func'       => '_delete_categories',
+				'capability' => 'ee_delete_event_category',
+				'noheader'   => true,
+			],
+			'delete_category'               => [
+				'func'       => '_delete_categories',
+				'capability' => 'ee_delete_event_category',
+				'noheader'   => true,
+			],
+			'insert_category'               => [
+				'func'       => '_insert_or_update_category',
+				'args'       => ['new_category' => true],
+				'capability' => 'ee_edit_event_category',
+				'noheader'   => true,
+			],
+			'update_category'               => [
+				'func'       => '_insert_or_update_category',
+				'args'       => ['new_category' => false],
+				'capability' => 'ee_edit_event_category',
+				'noheader'   => true,
+			],
+			'category_list'                 => [
+				'func'       => '_category_list_table',
+				'capability' => 'ee_manage_event_categories',
+			],
+			'preview_deletion'              => [
+				'func'       => 'previewDeletion',
+				'capability' => 'ee_delete_events',
+			],
+			'confirm_deletion'              => [
+				'func'       => 'confirmDeletion',
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+		];
+	}
+
+
+	/**
+	 * Set the _page_config property for this admin page group.
+	 */
+	protected function _set_page_config()
+	{
+		$post_id            = $this->request->getRequestParam('post', 0, 'int');
+		$EVT_CAT_ID         = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
+		$this->_page_config = [
+			'default'                => [
+				'nav'           => [
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'order' => 10,
+				],
+				'list_table'    => 'Events_Admin_List_Table',
+				'help_tabs'     => [
+					'events_overview_help_tab'                       => [
+						'title'    => esc_html__('Events Overview', 'event_espresso'),
+						'filename' => 'events_overview',
+					],
+					'events_overview_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'events_overview_table_column_headings',
+					],
+					'events_overview_filters_help_tab'               => [
+						'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
+						'filename' => 'events_overview_filters',
+					],
+					'events_overview_view_help_tab'                  => [
+						'title'    => esc_html__('Events Overview Views', 'event_espresso'),
+						'filename' => 'events_overview_views',
+					],
+					'events_overview_other_help_tab'                 => [
+						'title'    => esc_html__('Events Overview Other', 'event_espresso'),
+						'filename' => 'events_overview_other',
+					],
+				],
+				'qtips'         => [
+					'EE_Event_List_Table_Tips',
+				],
+				'require_nonce' => false,
+			],
+			'create_new'             => [
+				'nav'           => [
+					'label'      => esc_html__('Add Event', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+				],
+				'metaboxes'     => ['_register_event_editor_meta_boxes'],
+				'help_tabs'     => [
+					'event_editor_help_tab'                            => [
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
+						'filename' => 'event_editor',
+					],
+					'event_editor_title_richtexteditor_help_tab'       => [
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'event_editor_title_richtexteditor',
+					],
+					'event_editor_venue_details_help_tab'              => [
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
+						'filename' => 'event_editor_venue_details',
+					],
+					'event_editor_event_datetimes_help_tab'            => [
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
+						'filename' => 'event_editor_event_datetimes',
+					],
+					'event_editor_event_tickets_help_tab'              => [
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
+						'filename' => 'event_editor_event_tickets',
+					],
+					'event_editor_event_registration_options_help_tab' => [
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
+						'filename' => 'event_editor_event_registration_options',
+					],
+					'event_editor_tags_categories_help_tab'            => [
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
+						'filename' => 'event_editor_tags_categories',
+					],
+					'event_editor_questions_registrants_help_tab'      => [
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
+						'filename' => 'event_editor_questions_registrants',
+					],
+					'event_editor_save_new_event_help_tab'             => [
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
+						'filename' => 'event_editor_save_new_event',
+					],
+					'event_editor_other_help_tab'                      => [
+						'title'    => esc_html__('Event Other', 'event_espresso'),
+						'filename' => 'event_editor_other',
+					],
+				],
+				'qtips'         => ['EE_Event_Editor_Decaf_Tips'],
+				'require_nonce' => false,
+			],
+			'edit'                   => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Event', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => $post_id
+						? EE_Admin_Page::add_query_args_and_nonce(
+							['post' => $post_id, 'action' => 'edit'],
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				],
+				'metaboxes'     => ['_register_event_editor_meta_boxes'],
+				'help_tabs'     => [
+					'event_editor_help_tab'                            => [
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
+						'filename' => 'event_editor',
+					],
+					'event_editor_title_richtexteditor_help_tab'       => [
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'event_editor_title_richtexteditor',
+					],
+					'event_editor_venue_details_help_tab'              => [
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
+						'filename' => 'event_editor_venue_details',
+					],
+					'event_editor_event_datetimes_help_tab'            => [
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
+						'filename' => 'event_editor_event_datetimes',
+					],
+					'event_editor_event_tickets_help_tab'              => [
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
+						'filename' => 'event_editor_event_tickets',
+					],
+					'event_editor_event_registration_options_help_tab' => [
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
+						'filename' => 'event_editor_event_registration_options',
+					],
+					'event_editor_tags_categories_help_tab'            => [
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
+						'filename' => 'event_editor_tags_categories',
+					],
+					'event_editor_questions_registrants_help_tab'      => [
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
+						'filename' => 'event_editor_questions_registrants',
+					],
+					'event_editor_save_new_event_help_tab'             => [
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
+						'filename' => 'event_editor_save_new_event',
+					],
+					'event_editor_other_help_tab'                      => [
+						'title'    => esc_html__('Event Other', 'event_espresso'),
+						'filename' => 'event_editor_other',
+					],
+				],
+				'qtips'         => ['EE_Event_Editor_Decaf_Tips'],
+				'require_nonce' => false,
+			],
+			'default_event_settings' => [
+				'nav'           => [
+					'label' => esc_html__('Default Settings', 'event_espresso'),
+					'order' => 40,
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'labels'        => [
+					'publishbox' => esc_html__('Update Settings', 'event_espresso'),
+				],
+				'help_tabs'     => [
+					'default_settings_help_tab'        => [
+						'title'    => esc_html__('Default Event Settings', 'event_espresso'),
+						'filename' => 'events_default_settings',
+					],
+					'default_settings_status_help_tab' => [
+						'title'    => esc_html__('Default Registration Status', 'event_espresso'),
+						'filename' => 'events_default_settings_status',
+					],
+					'default_maximum_tickets_help_tab' => [
+						'title'    => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
+						'filename' => 'events_default_settings_max_tickets',
+					],
+				],
+				'require_nonce' => false,
+			],
+			// template settings
+			'template_settings'      => [
+				'nav'           => [
+					'label' => esc_html__('Templates', 'event_espresso'),
+					'order' => 30,
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => [
+					'general_settings_templates_help_tab' => [
+						'title'    => esc_html__('Templates', 'event_espresso'),
+						'filename' => 'general_settings_templates',
+					],
+				],
+				'require_nonce' => false,
+			],
+			// event category stuff
+			'add_category'           => [
+				'nav'           => [
+					'label'      => esc_html__('Add Category', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+				],
+				'help_tabs'     => [
+					'add_category_help_tab' => [
+						'title'    => esc_html__('Add New Event Category', 'event_espresso'),
+						'filename' => 'events_add_category',
+					],
+				],
+				'metaboxes'     => ['_publish_post_box'],
+				'require_nonce' => false,
+			],
+			'edit_category'          => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Category', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => $EVT_CAT_ID
+						? add_query_arg(
+							['EVT_CAT_ID' => $EVT_CAT_ID],
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				],
+				'help_tabs'     => [
+					'edit_category_help_tab' => [
+						'title'    => esc_html__('Edit Event Category', 'event_espresso'),
+						'filename' => 'events_edit_category',
+					],
+				],
+				'metaboxes'     => ['_publish_post_box'],
+				'require_nonce' => false,
+			],
+			'category_list'          => [
+				'nav'           => [
+					'label' => esc_html__('Categories', 'event_espresso'),
+					'order' => 20,
+				],
+				'list_table'    => 'Event_Categories_Admin_List_Table',
+				'help_tabs'     => [
+					'events_categories_help_tab'                       => [
+						'title'    => esc_html__('Event Categories', 'event_espresso'),
+						'filename' => 'events_categories',
+					],
+					'events_categories_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
+						'filename' => 'events_categories_table_column_headings',
+					],
+					'events_categories_view_help_tab'                  => [
+						'title'    => esc_html__('Event Categories Views', 'event_espresso'),
+						'filename' => 'events_categories_views',
+					],
+					'events_categories_other_help_tab'                 => [
+						'title'    => esc_html__('Event Categories Other', 'event_espresso'),
+						'filename' => 'events_categories_other',
+					],
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			],
+			'preview_deletion'       => [
+				'nav'           => [
+					'label'      => esc_html__('Preview Deletion', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => '',
+				],
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	/**
+	 * Used to register any global screen options if necessary for every route in this admin page group.
+	 */
+	protected function _add_screen_options()
+	{
+	}
+
+
+	/**
+	 * Implementing the screen options for the 'default' route.
+	 */
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * Implementing screen options for the category list route.
+	 */
+	protected function _add_screen_options_category_list()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Categories', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	/**
+	 * Used to register any global feature pointers for the admin page group.
+	 */
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	/**
+	 * Registers and enqueues any global scripts and styles for the entire admin page group.
+	 */
+	public function load_scripts_styles()
+	{
+		wp_register_style(
+			'events-admin-css',
+			EVENTS_ASSETS_URL . 'events-admin-page.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', [], EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('events-admin-css');
+		wp_enqueue_style('ee-cat-admin');
+		// todo note: we also need to load_scripts_styles per view (i.e. default/view_report/event_details
+		// registers for all views
+		// scripts
+		wp_register_script(
+			'event_editor_js',
+			EVENTS_ASSETS_URL . 'event_editor.js',
+			['ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+	}
+
+
+	/**
+	 * Enqueuing scripts and styles specific to this view
+	 */
+	public function load_scripts_styles_create_new()
+	{
+		$this->load_scripts_styles_edit();
+	}
+
+
+	/**
+	 * Enqueuing scripts and styles specific to this view
+	 */
+	public function load_scripts_styles_edit()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_register_style(
+			'event-editor-css',
+			EVENTS_ASSETS_URL . 'event-editor.css',
+			['ee-admin-css'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('event-editor-css');
+		// scripts
+		wp_register_script(
+			'event-datetime-metabox',
+			EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
+			['event_editor_js', 'ee-datepicker'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_script('event-datetime-metabox');
+	}
+
+
+	/**
+	 * Populating the _views property for the category list table view.
+	 */
+	protected function _set_list_table_views_category_list()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			],
+		];
+	}
+
+
+	/**
+	 * For adding anything that fires on the admin_init hook for any route within this admin page group.
+	 */
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__(
+			'Do you really want to delete this image? Please remember to update your event to complete the removal.',
+			'event_espresso'
+		);
+	}
+
+
+	/**
+	 * For adding anything that should be triggered on the admin_notices hook for any route within this admin page
+	 * group.
+	 */
+	public function admin_notices()
+	{
+	}
+
+
+	/**
+	 * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
+	 * this admin page group.
+	 */
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	/**
+	 * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
+	 * warning (via EE_Error::add_error());
+	 *
+	 * @param EE_Event $event Event object
+	 * @param string   $req_type
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function verify_event_edit($event = null, $req_type = '')
+	{
+		// don't need to do this when processing
+		if (! empty($req_type)) {
+			return;
+		}
+		// no event?
+		if (empty($event)) {
+			// set event
+			$event = $this->_cpt_model_obj;
+		}
+		// STILL no event?
+		if (! $event instanceof EE_Event) {
+			return;
+		}
+		$orig_status = $event->status();
+		// first check if event is active.
+		if (
+			$orig_status === EEM_Event::cancelled
+			|| $orig_status === EEM_Event::postponed
+			|| $event->is_expired()
+			|| $event->is_inactive()
+		) {
+			return;
+		}
+		// made it here so it IS active... next check that any of the tickets are sold.
+		if ($event->is_sold_out(true)) {
+			if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
+				EE_Error::add_attention(
+					sprintf(
+						esc_html__(
+							'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.',
+							'event_espresso'
+						),
+						EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
+					)
+				);
+			}
+			return;
+		} elseif ($orig_status === EEM_Event::sold_out) {
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__(
+						'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.',
+						'event_espresso'
+					),
+					EEH_Template::pretty_status($event->status(), false, 'sentence')
+				)
+			);
+		}
+		// now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
+		if (! $event->tickets_on_sale()) {
+			return;
+		}
+		// made it here so show warning
+		$this->_edit_event_warning();
+	}
+
+
+	/**
+	 * This is the text used for when an event is being edited that is public and has tickets for sale.
+	 * When needed, hook this into a EE_Error::add_error() notice.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _edit_event_warning()
+	{
+		// we don't want to add warnings during these requests
+		if ($this->request->getRequestParam('action') === 'editpost') {
+			return;
+		}
+		EE_Error::add_attention(
+			sprintf(
+				esc_html__(
+					'Your event is open for registration. Making changes may disrupt any transactions in progress. %sLearn more%s',
+					'event_espresso'
+				),
+				'<a class="espresso-help-tab-lnk">',
+				'</a>'
+			)
+		);
+	}
+
+
+	/**
+	 * When a user is creating a new event, notify them if they haven't set their timezone.
+	 * Otherwise, do the normal logic
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _create_new_cpt_item()
+	{
+		$has_timezone_string = get_option('timezone_string');
+		// only nag them about setting their timezone if it's their first event, and they haven't already done it
+		if (! $has_timezone_string && ! EEM_Event::instance()->exists([])) {
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__(
+						'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',
+						'event_espresso'
+					),
+					'<br>',
+					'<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
+					. EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
+					. '</select>',
+					'<button class="button button-secondary timezone-submit">',
+					'</button><span class="spinner"></span>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		parent::_create_new_cpt_item();
+	}
+
+
+	/**
+	 * Sets the _views property for the default route in this admin page group.
+	 */
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = [
+			'all'   => [
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Events', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+			'draft' => [
+				'slug'        => 'draft',
+				'label'       => esc_html__('Draft', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+		];
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
+			$this->_views['trash'] = [
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
+					'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			];
+		}
+	}
+
+
+	/**
+	 * Provides the legend item array for the default list table view.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function _event_legend_items()
+	{
+		$items    = [
+			'view_details'   => [
+				'class' => 'dashicons dashicons-search',
+				'desc'  => esc_html__('View Event', 'event_espresso'),
+			],
+			'edit_event'     => [
+				'class' => 'ee-icon ee-icon-calendar-edit',
+				'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
+			],
+			'view_attendees' => [
+				'class' => 'dashicons dashicons-groups',
+				'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
+			],
+		];
+		$items    = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
+		$statuses = [
+			'sold_out_status'  => [
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::sold_out,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
+			],
+			'active_status'    => [
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::active,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
+			],
+			'upcoming_status'  => [
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::upcoming,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
+			],
+			'postponed_status' => [
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::postponed,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
+			],
+			'cancelled_status' => [
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::cancelled,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
+			],
+			'expired_status'   => [
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::expired,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
+			],
+			'inactive_status'  => [
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::inactive,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
+			],
+		];
+		$statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
+		return array_merge($items, $statuses);
+	}
+
+
+	/**
+	 * @return EEM_Event
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _event_model()
+	{
+		if (! $this->_event_model instanceof EEM_Event) {
+			$this->_event_model = EE_Registry::instance()->load_model('Event');
+		}
+		return $this->_event_model;
+	}
+
+
+	/**
+	 * Adds extra buttons to the WP CPT permalink field row.
+	 * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
+	 *
+	 * @param string $return    the current html
+	 * @param int    $id        the post id for the page
+	 * @param string $new_title What the title is
+	 * @param string $new_slug  what the slug is
+	 * @return string            The new html string for the permalink area
+	 */
+	public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
+	{
+		// make sure this is only when editing
+		if (! empty($id)) {
+			$post   = get_post($id);
+			$return .= '<a class="button button-small" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#"  tabindex="-1">'
+					   . esc_html__('Shortcode', 'event_espresso')
+					   . '</a> ';
+			$return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id='
+					   . $post->ID
+					   . ']">';
+		}
+		return $return;
+	}
+
+
+	/**
+	 * _events_overview_list_table
+	 * This contains the logic for showing the events_overview list
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _events_overview_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_template_args['after_list_table']                           =
+			! empty($this->_template_args['after_list_table'])
+				? (array) $this->_template_args['after_list_table']
+				: [];
+		$this->_template_args['after_list_table']['view_event_list_button'] = EEH_HTML::br()
+			. EEH_Template::get_button_or_link(
+				get_post_type_archive_link('espresso_events'),
+				esc_html__("View Event Archive Page", "event_espresso"),
+				'button'
+			);
+		$this->_template_args['after_list_table']['legend']                 = $this->_display_legend(
+			$this->_event_legend_items()
+		);
+		$this->_admin_page_title                                            .= ' ' . $this->get_action_link_or_button(
+			'create_new',
+			'add',
+			[],
+			'add-new-h2'
+		);
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * this allows for extra misc actions in the default WP publish box
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function extra_misc_actions_publish_box()
+	{
+		$this->_generate_publish_box_extra_content();
+	}
+
+
+	/**
+	 * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
+	 * saved.
+	 * Typically you would use this to save any additional data.
+	 * Keep in mind also that "save_post" runs on EVERY post update to the database.
+	 * ALSO very important.  When a post transitions from scheduled to published,
+	 * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from
+	 * other meta saves. So MAKE sure that you handle this accordingly.
+	 *
+	 * @access protected
+	 * @abstract
+	 * @param string $post_id The ID of the cpt that was saved (so you can link relationally)
+	 * @param WP_Post $post    The post object of the cpt that was saved.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+		if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
+			// get out we're not processing an event save.
+			return;
+		}
+
+		$event_values = [
+			'EVT_display_desc'                => $this->request->getRequestParam('display_desc', false, 'bool'),
+			'EVT_display_ticket_selector'     => $this->request->getRequestParam(
+				'display_ticket_selector',
+				false,
+				'bool'
+			),
+			'EVT_additional_limit'            => min(
+				apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
+				$this->request->getRequestParam('additional_limit', null, 'int')
+			),
+			'EVT_default_registration_status' => $this->request->getRequestParam(
+				'EVT_default_registration_status',
+				EE_Registry::instance()->CFG->registration->default_STS_ID
+			),
+
+			'EVT_member_only'     => $this->request->getRequestParam('member_only', false, 'bool'),
+			'EVT_allow_overflow'  => $this->request->getRequestParam('EVT_allow_overflow', false, 'bool'),
+			'EVT_timezone_string' => $this->request->getRequestParam('timezone_string'),
+			'EVT_external_URL'    => $this->request->getRequestParam('externalURL'),
+			'EVT_phone'           => $this->request->getRequestParam('event_phone'),
+		];
+		// update event
+		$success = $this->_event_model()->update_by_ID($event_values, $post_id);
+		// 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!
+		$event = $this->_event_model()->get_one(
+			[
+				[
+					$this->_event_model()->primary_key_name() => $post_id,
+					'OR'                                      => [
+						'status'   => $post->post_status,
+						// if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
+						// but the returned object here has a status of "publish", so use the original post status as well
+						'status*1' => $this->request->getRequestParam('original_post_status'),
+					],
+				],
+			]
+		);
+		// the following are default callbacks for event attachment updates that can be overridden by caffeinated functionality and/or addons.
+		$event_update_callbacks = apply_filters(
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			[
+				[$this, '_default_venue_update'],
+				[$this, '_default_tickets_update'],
+			]
+		);
+		$att_success            = true;
+		foreach ($event_update_callbacks as $e_callback) {
+			$_success = is_callable($e_callback)
+				? call_user_func($e_callback, $event, $this->request->requestParams())
+				: false;
+			// if ANY of these updates fail then we want the appropriate global error message
+			$att_success = ! $att_success ? $att_success : $_success;
+		}
+		// any errors?
+		if ($success && false === $att_success) {
+			EE_Error::add_error(
+				esc_html__(
+					'Event Details saved successfully but something went wrong with saving attachments.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} elseif ($success === false) {
+			EE_Error::add_error(
+				esc_html__('Event Details did not save successfully.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * @param int $post_id
+	 * @param int $revision_id
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see parent::restore_item()
+	 */
+	protected function _restore_cpt_item($post_id, $revision_id)
+	{
+		// copy existing event meta to new post
+		$post_evt = $this->_event_model()->get_one_by_ID($post_id);
+		if ($post_evt instanceof EE_Event) {
+			// meta revision restore
+			$post_evt->restore_revision($revision_id);
+			// related objs restore
+			$post_evt->restore_revision($revision_id, ['Venue', 'Datetime', 'Price']);
+		}
+	}
+
+
+	/**
+	 * Attach the venue to the Event
+	 *
+	 * @param EE_Event $event Event Object to add the venue to
+	 * @param array    $data  The request data from the form
+	 * @return bool           Success or fail.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _default_venue_update(EE_Event $event, $data)
+	{
+		require_once(EE_MODELS . 'EEM_Venue.model.php');
+		$venue_model = EE_Registry::instance()->load_model('Venue');
+		$venue_id    = ! empty($data['venue_id']) ? $data['venue_id'] : null;
+		// very important.  If we don't have a venue name...
+		// then we'll get out because not necessary to create empty venue
+		if (empty($data['venue_title'])) {
+			return false;
+		}
+		$venue_array = [
+			'VNU_wp_user'         => $event->get('EVT_wp_user'),
+			'VNU_name'            => $data['venue_title'],
+			'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
+			'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
+			'VNU_short_desc'      => ! empty($data['venue_short_description'])
+				? $data['venue_short_description']
+				: null,
+			'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
+			'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
+			'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
+			'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
+			'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
+			'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
+			'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
+			'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
+			'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
+			'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
+			'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
+			'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
+			'status'              => 'publish',
+		];
+		// if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
+		if (! empty($venue_id)) {
+			$update_where  = [$venue_model->primary_key_name() => $venue_id];
+			$rows_affected = $venue_model->update($venue_array, [$update_where]);
+			// 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.
+			$event->_add_relation_to($venue_id, 'Venue');
+			return $rows_affected > 0;
+		}
+		// we insert the venue
+		$venue_id = $venue_model->insert($venue_array);
+		$event->_add_relation_to($venue_id, 'Venue');
+		return ! empty($venue_id);
+		// when we have the ancestor come in it's already been handled by the revision save.
+	}
+
+
+	/**
+	 * Handles saving everything related to Tickets (datetimes, tickets, prices)
+	 *
+	 * @param EE_Event $event The Event object we're attaching data to
+	 * @param array    $data  The request data from the form
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	protected function _default_tickets_update(EE_Event $event, $data)
+	{
+		$datetime       = null;
+		$saved_tickets  = [];
+		$event_timezone = $event->get_timezone();
+		$date_formats   = ['Y-m-d', 'h:i a'];
+		foreach ($data['edit_event_datetimes'] as $row => $datetime_data) {
+			// trim all values to ensure any excess whitespace is removed.
+			$datetime_data                = array_map('trim', $datetime_data);
+			$datetime_data['DTT_EVT_end'] =
+				isset($datetime_data['DTT_EVT_end']) && ! empty($datetime_data['DTT_EVT_end'])
+					? $datetime_data['DTT_EVT_end']
+					: $datetime_data['DTT_EVT_start'];
+			$datetime_values              = [
+				'DTT_ID'        => ! empty($datetime_data['DTT_ID']) ? $datetime_data['DTT_ID'] : null,
+				'DTT_EVT_start' => $datetime_data['DTT_EVT_start'],
+				'DTT_EVT_end'   => $datetime_data['DTT_EVT_end'],
+				'DTT_reg_limit' => empty($datetime_data['DTT_reg_limit']) ? EE_INF : $datetime_data['DTT_reg_limit'],
+				'DTT_order'     => $row,
+			];
+			// 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.
+			if (! empty($datetime_data['DTT_ID'])) {
+				$datetime = EEM_Datetime::instance($event_timezone)->get_one_by_ID($datetime_data['DTT_ID']);
+				if (! $datetime instanceof EE_Datetime) {
+					throw new RuntimeException(
+						sprintf(
+							esc_html__(
+								'Something went wrong! A valid Datetime could not be retrieved from the database using the supplied ID: %1$d',
+								'event_espresso'
+							),
+							$datetime_data['DTT_ID']
+						)
+					);
+				}
+				$datetime->set_date_format($date_formats[0]);
+				$datetime->set_time_format($date_formats[1]);
+				foreach ($datetime_values as $field => $value) {
+					$datetime->set($field, $value);
+				}
+			} else {
+				$datetime = EE_Datetime::new_instance($datetime_values, $event_timezone, $date_formats);
+			}
+			if (! $datetime instanceof EE_Datetime) {
+				throw new RuntimeException(
+					sprintf(
+						esc_html__(
+							'Something went wrong! A valid Datetime could not be generated or retrieved using the supplied data: %1$s',
+							'event_espresso'
+						),
+						print_r($datetime_values, true)
+					)
+				);
+			}
+			// 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.
+			if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) {
+				$datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start'));
+				$datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days');
+			}
+			$datetime->save();
+			$event->_add_relation_to($datetime, 'Datetime');
+		}
+		// no datetimes get deleted so we don't do any of that logic here.
+		// update tickets next
+		$old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : [];
+
+		// set up some default start and end dates in case those are not present in the incoming data
+		$default_start_date = new DateTime('now', new DateTimeZone($event->get_timezone()));
+		$default_start_date = $default_start_date->format($date_formats[0] . ' ' . $date_formats[1]);
+		// use the start date of the first datetime for the end date
+		$first_datetime   = $event->first_datetime();
+		$default_end_date = $first_datetime->start_date_and_time($date_formats[0], $date_formats[1]);
+
+		// now process the incoming data
+		foreach ($data['edit_tickets'] as $row => $ticket_data) {
+			$update_prices = false;
+			$ticket_price  = isset($data['edit_prices'][ $row ][1]['PRC_amount'])
+				? $data['edit_prices'][ $row ][1]['PRC_amount']
+				: 0;
+			// trim inputs to ensure any excess whitespace is removed.
+			$ticket_data   = array_map('trim', $ticket_data);
+			$ticket_values = [
+				'TKT_ID'          => ! empty($ticket_data['TKT_ID']) ? $ticket_data['TKT_ID'] : null,
+				'TTM_ID'          => ! empty($ticket_data['TTM_ID']) ? $ticket_data['TTM_ID'] : 0,
+				'TKT_name'        => ! empty($ticket_data['TKT_name']) ? $ticket_data['TKT_name'] : '',
+				'TKT_description' => ! empty($ticket_data['TKT_description']) ? $ticket_data['TKT_description'] : '',
+				'TKT_start_date'  => ! empty($ticket_data['TKT_start_date'])
+					? $ticket_data['TKT_start_date']
+					: $default_start_date,
+				'TKT_end_date'    => ! empty($ticket_data['TKT_end_date'])
+					? $ticket_data['TKT_end_date']
+					: $default_end_date,
+				'TKT_qty'         => ! empty($ticket_data['TKT_qty'])
+									 || (isset($ticket_data['TKT_qty']) && (int) $ticket_data['TKT_qty'] === 0)
+					? $ticket_data['TKT_qty']
+					: EE_INF,
+				'TKT_uses'        => ! empty($ticket_data['TKT_uses'])
+									 || (isset($ticket_data['TKT_uses']) && (int) $ticket_data['TKT_uses'] === 0)
+					? $ticket_data['TKT_uses']
+					: EE_INF,
+				'TKT_min'         => ! empty($ticket_data['TKT_min']) ? $ticket_data['TKT_min'] : 0,
+				'TKT_max'         => ! empty($ticket_data['TKT_max']) ? $ticket_data['TKT_max'] : EE_INF,
+				'TKT_order'       => isset($ticket_data['TKT_order']) ? $ticket_data['TKT_order'] : $row,
+				'TKT_price'       => $ticket_price,
+				'TKT_row'         => $row,
+			];
+			// if this is a default ticket, 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.
+			if (isset($ticket_data['TKT_is_default']) && $ticket_data['TKT_is_default']) {
+				$ticket_values['TKT_ID']         = 0;
+				$ticket_values['TKT_is_default'] = 0;
+				$update_prices                   = true;
+			}
+			// if we have a TKT_ID then we need to get that existing TKT_obj and update it
+			// we actually do our saves ahead of adding any relations because its entirely possible that this
+			// ticket didn't get removed or added to any datetime in the session but DID have it's items modified.
+			// keep in mind that if the ticket 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.
+			if (! empty($ticket_data['TKT_ID'])) {
+				$existing_ticket = EEM_Ticket::instance($event_timezone)->get_one_by_ID($ticket_data['TKT_ID']);
+				if (! $existing_ticket instanceof EE_Ticket) {
+					throw new RuntimeException(
+						sprintf(
+							esc_html__(
+								'Something went wrong! A valid Ticket could not be retrieved from the database using the supplied ID: %1$d',
+								'event_espresso'
+							),
+							$ticket_data['TKT_ID']
+						)
+					);
+				}
+				$ticket_sold = $existing_ticket->count_related(
+					'Registration',
+					[
+						[
+							'STS_ID' => [
+								'NOT IN',
+								[EEM_Registration::status_id_incomplete],
+							],
+						],
+					]
+				) > 0;
+				// 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 $ticket_sold)
+				// if they aren't different then we go ahead and modify existing ticket.
+				$create_new_ticket = $ticket_sold
+									 && $ticket_price !== $existing_ticket->price()
+									 && ! $existing_ticket->deleted();
+				$existing_ticket->set_date_format($date_formats[0]);
+				$existing_ticket->set_time_format($date_formats[1]);
+				// set new values
+				foreach ($ticket_values as $field => $value) {
+					if ($field == 'TKT_qty') {
+						$existing_ticket->set_qty($value);
+					} elseif ($field == 'TKT_price') {
+						$existing_ticket->set('TKT_price', $ticket_price);
+					} else {
+						$existing_ticket->set($field, $value);
+					}
+				}
+				$ticket = $existing_ticket;
+				// if $create_new_ticket is false then we can safely update the existing ticket.
+				//  Otherwise we have to create a new ticket.
+				if ($create_new_ticket) {
+					// archive the old ticket first
+					$existing_ticket->set('TKT_deleted', 1);
+					$existing_ticket->save();
+					// make sure this ticket is still recorded in our $saved_tickets
+					// so we don't run it through the regular trash routine.
+					$saved_tickets[ $existing_ticket->ID() ] = $existing_ticket;
+					// 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.
+					$new_ticket = clone $existing_ticket;
+					$new_ticket->set('TKT_ID', 0);
+					$new_ticket->set('TKT_deleted', 0);
+					$new_ticket->set('TKT_sold', 0);
+					// now we need to make sure that $new prices are created as well and attached to new ticket.
+					$update_prices = true;
+					$ticket        = $new_ticket;
+				}
+			} else {
+				// no TKT_id so a new ticket
+				$ticket_values['TKT_price'] = $ticket_price;
+				$ticket                     = EE_Ticket::new_instance($ticket_values, $event_timezone, $date_formats);
+				$update_prices              = true;
+			}
+			if (! $ticket instanceof EE_Ticket) {
+				throw new RuntimeException(
+					sprintf(
+						esc_html__(
+							'Something went wrong! A valid Ticket could not be generated or retrieved using the supplied data: %1$s',
+							'event_espresso'
+						),
+						print_r($ticket_values, true)
+					)
+				);
+			}
+			// cap ticket qty by datetime reg limits
+			$ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit')));
+			// update ticket.
+			$ticket->save();
+			// 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.
+			if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) {
+				$ticket->set('TKT_end_date', $ticket->get('TKT_start_date'));
+				$ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days');
+				$ticket->save();
+			}
+			// initially let's add the ticket to the datetime
+			$datetime->_add_relation_to($ticket, 'Ticket');
+			$saved_tickets[ $ticket->ID() ] = $ticket;
+			// add prices to ticket
+			$prices_data = isset($data['edit_prices'][ $row ]) && is_array($data['edit_prices'][ $row ])
+				? $data['edit_prices'][ $row ]
+				: [];
+			$this->_add_prices_to_ticket($prices_data, $ticket, $update_prices);
+		}
+		// 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.
+		$old_tickets     = isset($old_tickets[0]) && $old_tickets[0] == '' ? [] : $old_tickets;
+		$tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
+		foreach ($tickets_removed as $id) {
+			$id = absint($id);
+			// get the ticket for this id
+			$ticket_to_remove = EEM_Ticket::instance()->get_one_by_ID($id);
+			if (! $ticket_to_remove instanceof EE_Ticket) {
+				continue;
+			}
+			// 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 tickets sold)
+			$related_datetimes = $ticket_to_remove->get_many_related('Datetime');
+			foreach ($related_datetimes as $related_datetime) {
+				$ticket_to_remove->_remove_relation_to($related_datetime, 'Datetime');
+			}
+			// 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))
+			$ticket_to_remove->delete_related_permanently('Price');
+			// finally let's delete this ticket
+			// (which should not be blocked at this point b/c we've removed all our relationships)
+			$ticket_to_remove->delete_permanently();
+		}
+		return [$datetime, $saved_tickets];
+	}
+
+
+	/**
+	 * This attaches a list of given prices to a ticket.
+	 * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
+	 * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
+	 * price info and prices are automatically "archived" via the ticket.
+	 *
+	 * @access  private
+	 * @param array     $prices_data Array of prices from the form.
+	 * @param EE_Ticket $ticket      EE_Ticket object that prices are being attached to.
+	 * @param bool      $new_prices  Whether attach existing incoming prices or create new ones.
+	 * @return  void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _add_prices_to_ticket($prices_data, EE_Ticket $ticket, $new_prices = false)
+	{
+		$timezone = $ticket->get_timezone();
+		foreach ($prices_data as $row => $price_data) {
+			$price_values = [
+				'PRC_ID'         => ! empty($price_data['PRC_ID']) ? $price_data['PRC_ID'] : null,
+				'PRT_ID'         => ! empty($price_data['PRT_ID']) ? $price_data['PRT_ID'] : null,
+				'PRC_amount'     => ! empty($price_data['PRC_amount']) ? $price_data['PRC_amount'] : 0,
+				'PRC_name'       => ! empty($price_data['PRC_name']) ? $price_data['PRC_name'] : '',
+				'PRC_desc'       => ! empty($price_data['PRC_desc']) ? $price_data['PRC_desc'] : '',
+				'PRC_is_default' => 0, // make sure prices are NOT set as default from this context
+				'PRC_order'      => $row,
+			];
+			if ($new_prices || empty($price_values['PRC_ID'])) {
+				$price_values['PRC_ID'] = 0;
+				$price                  = EE_Price::new_instance($price_values, $timezone);
+			} else {
+				$price = EEM_Price::instance($timezone)->get_one_by_ID($price_data['PRC_ID']);
+				// update this price with new values
+				foreach ($price_values as $field => $new_price) {
+					$price->set($field, $new_price);
+				}
+			}
+			if (! $price instanceof EE_Price) {
+				throw new RuntimeException(
+					sprintf(
+						esc_html__(
+							'Something went wrong! A valid Price could not be generated or retrieved using the supplied data: %1$s',
+							'event_espresso'
+						),
+						print_r($price_values, true)
+					)
+				);
+			}
+			$price->save();
+			$ticket->_add_relation_to($price, 'Price');
+		}
+	}
+
+
+	/**
+	 * Add in our autosave ajax handlers
+	 *
+	 */
+	protected function _ee_autosave_create_new()
+	{
+	}
+
+
+	/**
+	 * More autosave handlers.
+	 */
+	protected function _ee_autosave_edit()
+	{
+		// TEMPORARILY EXITING CAUSE THIS IS A TODO
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _generate_publish_box_extra_content()
+	{
+		// load formatter helper
+		// args for getting related registrations
+		$approved_query_args        = [
+			[
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_approved,
+			],
+		];
+		$not_approved_query_args    = [
+			[
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_not_approved,
+			],
+		];
+		$pending_payment_query_args = [
+			[
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_pending_payment,
+			],
+		];
+		// publish box
+		$publish_box_extra_args = [
+			'view_approved_reg_url'        => add_query_arg(
+				[
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_approved,
+					'use_filters' => true,
+				],
+				REG_ADMIN_URL
+			),
+			'view_not_approved_reg_url'    => add_query_arg(
+				[
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_not_approved,
+					'use_filters' => true,
+				],
+				REG_ADMIN_URL
+			),
+			'view_pending_payment_reg_url' => add_query_arg(
+				[
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_pending_payment,
+					'use_filters' => true,
+				],
+				REG_ADMIN_URL
+			),
+			'approved_regs'                => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$approved_query_args
+			),
+			'not_approved_regs'            => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$not_approved_query_args
+			),
+			'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$pending_payment_query_args
+			),
+			'misc_pub_section_class'       => apply_filters(
+				'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
+				'misc-pub-section'
+			),
+		];
+		ob_start();
+		do_action(
+			'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
+			$this->_cpt_model_obj
+		);
+		$publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
+		// load template
+		EEH_Template::display_template(
+			EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
+			$publish_box_extra_args
+		);
+	}
+
+
+	/**
+	 * @return EE_Event
+	 */
+	public function get_event_object()
+	{
+		return $this->_cpt_model_obj;
+	}
+
+
+
+
+	/** METABOXES * */
+	/**
+	 * _register_event_editor_meta_boxes
+	 * add all metaboxes related to the event_editor
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _register_event_editor_meta_boxes()
+	{
+		$this->verify_cpt_object();
+		add_meta_box(
+			'espresso_event_editor_tickets',
+			esc_html__('Event Datetime & Ticket', 'event_espresso'),
+			[$this, 'ticket_metabox'],
+			$this->page_slug,
+			'normal',
+			'high'
+		);
+		add_meta_box(
+			'espresso_event_editor_event_options',
+			esc_html__('Event Registration Options', 'event_espresso'),
+			[$this, 'registration_options_meta_box'],
+			$this->page_slug,
+			'side'
+		);
+		// NOTE: if you're looking for other metaboxes in here,
+		// where a metabox has a related management page in the admin
+		// you will find it setup in the related management page's "_Hooks" file.
+		// i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function ticket_metabox()
+	{
+		$existing_datetime_ids = $existing_ticket_ids = [];
+		// defaults for template args
+		$template_args = [
+			'existing_datetime_ids'    => '',
+			'event_datetime_help_link' => '',
+			'ticket_options_help_link' => '',
+			'time'                     => null,
+			'ticket_rows'              => '',
+			'existing_ticket_ids'      => '',
+			'total_ticket_rows'        => 1,
+			'ticket_js_structure'      => '',
+			'trash_icon'               => 'ee-lock-icon',
+			'disabled'                 => '',
+		];
+		$event_id      = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
+		/**
+		 * 1. Start with retrieving Datetimes
+		 * 2. Fore each datetime get related tickets
+		 * 3. For each ticket get related prices
+		 */
+		$times          = EEM_Datetime::instance()->get_all_event_dates($event_id);
+		$first_datetime = reset($times);
+		// do we get related tickets?
+		if (
+			$first_datetime instanceof EE_Datetime
+			&& $first_datetime->ID() !== 0
+		) {
+			$existing_datetime_ids[] = $first_datetime->get('DTT_ID');
+			$template_args['time']   = $first_datetime;
+			$related_tickets         = $first_datetime->tickets(
+				[
+					['OR' => ['TKT_deleted' => 1, 'TKT_deleted*' => 0]],
+					'default_where_conditions' => 'none',
+				]
+			);
+			if (! empty($related_tickets)) {
+				$template_args['total_ticket_rows'] = count($related_tickets);
+				$row                                = 0;
+				foreach ($related_tickets as $ticket) {
+					$existing_ticket_ids[]        = $ticket->get('TKT_ID');
+					$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
+					$row++;
+				}
+			} else {
+				$template_args['total_ticket_rows'] = 1;
+				/** @type EE_Ticket $ticket */
+				$ticket                       = EEM_Ticket::instance()->create_default_object();
+				$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
+			}
+		} else {
+			$template_args['time']        = $times[0];
+			$tickets                      = EEM_Ticket::instance()->get_all_default_tickets();
+			$template_args['ticket_rows'] .= $this->_get_ticket_row($tickets[1]);
+			// NOTE: we're just sending the first default row
+			// (decaf can't manage default tickets so this should be sufficient);
+		}
+		$template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
+			'event_editor_event_datetimes_help_tab'
+		);
+		$template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
+		$template_args['existing_datetime_ids']    = implode(',', $existing_datetime_ids);
+		$template_args['existing_ticket_ids']      = implode(',', $existing_ticket_ids);
+		$template_args['ticket_js_structure']      = $this->_get_ticket_row(
+			EEM_Ticket::instance()->create_default_object(),
+			true
+		);
+		$template                                  = apply_filters(
+			'FHEE__Events_Admin_Page__ticket_metabox__template',
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
+		);
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	/**
+	 * Setup an individual ticket form for the decaf event editor page
+	 *
+	 * @access private
+	 * @param EE_Ticket $ticket   the ticket object
+	 * @param boolean   $skeleton whether we're generating a skeleton for js manipulation
+	 * @param int       $row
+	 * @return string generated html for the ticket row.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
+	{
+		$template_args = [
+			'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
+			'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
+				: '',
+			'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
+			'TKT_ID'              => $ticket->get('TKT_ID'),
+			'TKT_name'            => $ticket->get('TKT_name'),
+			'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
+			'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
+			'TKT_is_default'      => $ticket->get('TKT_is_default'),
+			'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
+			'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
+			'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
+			'trash_icon'          => ($skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')))
+									 && (! empty($ticket) && $ticket->get('TKT_sold') === 0)
+				? 'trash-icon dashicons dashicons-post-trash clickable' : 'ee-lock-icon',
+			'disabled'            => $skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
+				: ' disabled=disabled',
+		];
+		$price         = $ticket->ID() !== 0
+			? $ticket->get_first_related('Price', ['default_where_conditions' => 'none'])
+			: null;
+		$price         = $price instanceof EE_Price
+			? $price
+			: EEM_Price::instance()->create_default_object();
+		$price_args    = [
+			'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
+			'PRC_amount'            => $price->get('PRC_amount'),
+			'PRT_ID'                => $price->get('PRT_ID'),
+			'PRC_ID'                => $price->get('PRC_ID'),
+			'PRC_is_default'        => $price->get('PRC_is_default'),
+		];
+		// make sure we have default start and end dates if skeleton
+		// handle rows that should NOT be empty
+		if (empty($template_args['TKT_start_date'])) {
+			// if empty then the start date will be now.
+			$template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
+		}
+		if (empty($template_args['TKT_end_date'])) {
+			// get the earliest datetime (if present);
+			$earliest_datetime             = $this->_cpt_model_obj->ID() > 0
+				? $this->_cpt_model_obj->get_first_related(
+					'Datetime',
+					['order_by' => ['DTT_EVT_start' => 'ASC']]
+				)
+				: null;
+			$template_args['TKT_end_date'] = $earliest_datetime instanceof EE_Datetime
+				? $earliest_datetime->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a')
+				: date('Y-m-d h:i a', mktime(0, 0, 0, date('m'), date('d') + 7, date('Y')));
+		}
+		$template_args = array_merge($template_args, $price_args);
+		$template      = apply_filters(
+			'FHEE__Events_Admin_Page__get_ticket_row__template',
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
+			$ticket
+		);
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function registration_options_meta_box()
+	{
+		$yes_no_values             = [
+			['id' => true, 'text' => esc_html__('Yes', 'event_espresso')],
+			['id' => false, 'text' => esc_html__('No', 'event_espresso')],
+		];
+		$default_reg_status_values = EEM_Registration::reg_status_array(
+			[
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+			],
+			true
+		);
+		// $template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
+		$template_args['_event']                          = $this->_cpt_model_obj;
+		$template_args['event']                           = $this->_cpt_model_obj;
+		$template_args['active_status']                   = $this->_cpt_model_obj->pretty_active_status(false);
+		$template_args['additional_limit']                = $this->_cpt_model_obj->additional_limit();
+		$template_args['default_registration_status']     = EEH_Form_Fields::select_input(
+			'default_reg_status',
+			$default_reg_status_values,
+			$this->_cpt_model_obj->default_registration_status()
+		);
+		$template_args['display_description']             = EEH_Form_Fields::select_input(
+			'display_desc',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_description()
+		);
+		$template_args['display_ticket_selector']         = EEH_Form_Fields::select_input(
+			'display_ticket_selector',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_ticket_selector(),
+			'',
+			'',
+			false
+		);
+		$template_args['additional_registration_options'] = apply_filters(
+			'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
+			'',
+			$template_args,
+			$yes_no_values,
+			$default_reg_status_values
+		);
+		EEH_Template::display_template(
+			EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php',
+			$template_args
+		);
+	}
+
+
+	/**
+	 * _get_events()
+	 * This method simply returns all the events (for the given _view and paging)
+	 *
+	 * @access public
+	 * @param int  $per_page     count of items per page (20 default);
+	 * @param int  $current_page what is the current page being viewed.
+	 * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
+	 *                           If FALSE then we return an array of event objects
+	 *                           that match the given _view and paging parameters.
+	 * @return array|int         an array of event objects or a count of them.
+	 * @throws Exception
+	 */
+	public function get_events($per_page = 10, $current_page = 1, $count = false)
+	{
+		$EEM_Event   = $this->_event_model();
+		$offset      = ($current_page - 1) * $per_page;
+		$limit       = $count ? null : $offset . ',' . $per_page;
+		$orderby     = $this->request->getRequestParam('orderby', 'EVT_ID');
+		$order       = $this->request->getRequestParam('order', 'DESC');
+		$month_range = $this->request->getRequestParam('month_range');
+		if ($month_range) {
+			$pieces = explode(' ', $month_range, 3);
+			// simulate the FIRST day of the month, that fixes issues for months like February
+			// where PHP doesn't know what to assume for date.
+			// @see https://events.codebasehq.com/projects/event-espresso/tickets/10437
+			$month_r = ! empty($pieces[0]) ? date('m', EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
+			$year_r  = ! empty($pieces[1]) ? $pieces[1] : '';
+		}
+		$where  = [];
+		$status = $this->request->getRequestParam('status');
+		// determine what post_status our condition will have for the query.
+		switch ($status) {
+			case 'month':
+			case 'today':
+			case null:
+			case 'all':
+				break;
+			case 'draft':
+				$where['status'] = ['IN', ['draft', 'auto-draft']];
+				break;
+			default:
+				$where['status'] = $status;
+		}
+		// categories? The default for all categories is -1
+		$category = $this->request->getRequestParam('EVT_CAT', -1, 'int');
+		if ($category !== -1) {
+			$where['Term_Taxonomy.taxonomy'] = EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY;
+			$where['Term_Taxonomy.term_id']  = $category;
+		}
+		// date where conditions
+		$start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
+		if ($month_range) {
+			$DateTime = new DateTime(
+				$year_r . '-' . $month_r . '-01 00:00:00',
+				new DateTimeZone('UTC')
+			);
+			$start    = $DateTime->getTimestamp();
+			// set the datetime to be the end of the month
+			$DateTime->setDate(
+				$year_r,
+				$month_r,
+				$DateTime->format('t')
+			)->setTime(23, 59, 59);
+			$end                             = $DateTime->getTimestamp();
+			$where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
+		} elseif ($status === 'today') {
+			$DateTime                        =
+				new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
+			$start                           = $DateTime->setTime(0, 0)->format(implode(' ', $start_formats));
+			$end                             = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
+		} elseif ($status === 'month') {
+			$now                             = date('Y-m-01');
+			$DateTime                        =
+				new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
+			$start                           = $DateTime->setTime(0, 0)->format(implode(' ', $start_formats));
+			$end                             = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
+														->setTime(23, 59, 59)
+														->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
+		}
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
+			$where['EVT_wp_user'] = get_current_user_id();
+		} else {
+			if (! isset($where['status'])) {
+				if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
+					$where['OR'] = [
+						'status*restrict_private' => ['!=', 'private'],
+						'AND'                     => [
+							'status*inclusive' => ['=', 'private'],
+							'EVT_wp_user'      => get_current_user_id(),
+						],
+					];
+				}
+			}
+		}
+		$wp_user = $this->request->getRequestParam('EVT_wp_user', 0, 'int');
+		if (
+			$wp_user
+			&& $wp_user !== get_current_user_id()
+			&& EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
+		) {
+			$where['EVT_wp_user'] = $wp_user;
+		}
+		// search query handling
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$where['OR'] = [
+				'EVT_name'       => ['LIKE', $search_term],
+				'EVT_desc'       => ['LIKE', $search_term],
+				'EVT_short_desc' => ['LIKE', $search_term],
+			];
+		}
+		// filter events by venue.
+		$venue = $this->request->getRequestParam('venue', 0, 'int');
+		if ($venue) {
+			$where['Venue.VNU_ID'] = $venue;
+		}
+		$request_params = $this->request->requestParams();
+		$where          = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $request_params);
+		$query_params   = apply_filters(
+			'FHEE__Events_Admin_Page__get_events__query_params',
+			[
+				$where,
+				'limit'    => $limit,
+				'order_by' => $orderby,
+				'order'    => $order,
+				'group_by' => 'EVT_ID',
+			],
+			$request_params
+		);
+
+		// let's first check if we have special requests coming in.
+		$active_status = $this->request->getRequestParam('active_status');
+		if ($active_status) {
+			switch ($active_status) {
+				case 'upcoming':
+					return $EEM_Event->get_upcoming_events($query_params, $count);
+				case 'expired':
+					return $EEM_Event->get_expired_events($query_params, $count);
+				case 'active':
+					return $EEM_Event->get_active_events($query_params, $count);
+				case 'inactive':
+					return $EEM_Event->get_inactive_events($query_params, $count);
+			}
+		}
+
+		return $count ? $EEM_Event->count([$where], 'EVT_ID', true) : $EEM_Event->get_all($query_params);
+	}
+
+
+	/**
+	 * handling for WordPress CPT actions (trash, restore, delete)
+	 *
+	 * @param string $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function trash_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('EVT_ID', $post_id);
+		$this->_trash_or_restore_event('trash', false);
+	}
+
+
+	/**
+	 * @param string $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function restore_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('EVT_ID', $post_id);
+		$this->_trash_or_restore_event('draft', false);
+	}
+
+
+	/**
+	 * @param string $post_id
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function delete_cpt_item($post_id)
+	{
+		throw new EE_Error(
+			esc_html__(
+				'Please contact Event Espresso support with the details of the steps taken to produce this error.',
+				'event_espresso'
+			)
+		);
+		// $this->request->setRequestParam('EVT_ID', $post_id);
+		// $this->_delete_event();
+	}
+
+
+	/**
+	 * _trash_or_restore_event
+	 *
+	 * @access protected
+	 * @param string $event_status
+	 * @param bool   $redirect_after
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true)
+	{
+		// determine the event id and set to array.
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		// loop thru events
+		if ($EVT_ID) {
+			// clean status
+			$event_status = sanitize_key($event_status);
+			// grab status
+			if (! empty($event_status)) {
+				$success = $this->_change_event_status($EVT_ID, $event_status);
+			} else {
+				$success = false;
+				$msg     = esc_html__(
+					'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		$action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Event', $action, ['action' => 'default']);
+		}
+	}
+
+
+	/**
+	 * _trash_or_restore_events
+	 *
+	 * @access protected
+	 * @param string $event_status
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_events($event_status = 'trash')
+	{
+		// clean status
+		$event_status = sanitize_key($event_status);
+		// grab status
+		if (! empty($event_status)) {
+			$success = true;
+			// determine the event id and set to array.
+			$EVT_IDs = $this->request->getRequestParam('EVT_IDs', [], 'int', true);
+			// loop thru events
+			foreach ($EVT_IDs as $EVT_ID) {
+				if ($EVT_ID = absint($EVT_ID)) {
+					$results = $this->_change_event_status($EVT_ID, $event_status);
+					$success = $results !== false ? $success : false;
+				} else {
+					$msg = sprintf(
+						esc_html__(
+							'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
+							'event_espresso'
+						),
+						$EVT_ID
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+					$success = false;
+				}
+			}
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$action  = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+		$this->_redirect_after_action($success, 'Events', $action, ['action' => 'default']);
+	}
+
+
+	/**
+	 * @param int    $EVT_ID
+	 * @param string $event_status
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _change_event_status($EVT_ID = 0, $event_status = '')
+	{
+		// grab event id
+		if (! $EVT_ID) {
+			$msg = esc_html__(
+				'An error occurred. No Event ID or an invalid Event ID was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		// clean status
+		$event_status = sanitize_key($event_status);
+		// grab status
+		if (empty($event_status)) {
+			$msg = esc_html__(
+				'An error occurred. No Event Status or an invalid Event Status was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// was event trashed or restored ?
+		switch ($event_status) {
+			case 'draft':
+				$action = 'restored from the trash';
+				$hook   = 'AHEE_event_restored_from_trash';
+				break;
+			case 'trash':
+				$action = 'moved to the trash';
+				$hook   = 'AHEE_event_moved_to_trash';
+				break;
+			default:
+				$action = 'updated';
+				$hook   = false;
+		}
+		// use class to change status
+		$this->_cpt_model_obj->set_status($event_status);
+		$success = $this->_cpt_model_obj->save();
+		if (! $success) {
+			$msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if ($hook) {
+			do_action($hook);
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param array $event_ids
+	 * @return array
+	 * @since   4.10.23.p
+	 */
+	private function cleanEventIds(array $event_ids)
+	{
+		return array_map('absint', $event_ids);
+	}
+
+
+	/**
+	 * @return array
+	 * @since   4.10.23.p
+	 */
+	private function getEventIdsFromRequest()
+	{
+		if ($this->request->requestParamIsSet('EVT_IDs')) {
+			return $this->request->getRequestParam('EVT_IDs', [], 'int', true);
+		} else {
+			return $this->request->getRequestParam('EVT_ID', [], 'int', true);
+		}
+	}
+
+
+	/**
+	 * @param bool $preview_delete
+	 * @throws EE_Error
+	 */
+	protected function _delete_event($preview_delete = true)
+	{
+		$this->_delete_events($preview_delete);
+	}
+
+
+	/**
+	 * Gets the tree traversal batch persister.
+	 *
+	 * @return NodeGroupDao
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.10.12.p
+	 */
+	protected function getModelObjNodeGroupPersister()
+	{
+		if (! $this->model_obj_node_group_persister instanceof NodeGroupDao) {
+			$this->model_obj_node_group_persister =
+				$this->getLoader()->load('\EventEspresso\core\services\orm\tree_traversal\NodeGroupDao');
+		}
+		return $this->model_obj_node_group_persister;
+	}
+
+
+	/**
+	 * @param bool $preview_delete
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _delete_events($preview_delete = true)
+	{
+		$event_ids = $this->getEventIdsFromRequest();
+		if ($preview_delete) {
+			$this->generateDeletionPreview($event_ids);
+		} else {
+			EEM_Event::instance()->delete_permanently([['EVT_ID' => ['IN', $event_ids]]]);
+		}
+	}
+
+
+	/**
+	 * @param array $event_ids
+	 */
+	protected function generateDeletionPreview(array $event_ids)
+	{
+		$event_ids = $this->cleanEventIds($event_ids);
+		// Set a code we can use to reference this deletion task in the batch jobs and preview page.
+		$deletion_job_code = $this->getModelObjNodeGroupPersister()->generateGroupCode();
+		$return_url        = EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'action'            => 'preview_deletion',
+				'deletion_job_code' => $deletion_job_code,
+			],
+			$this->_admin_base_url
+		);
+		EEH_URL::safeRedirectAndExit(
+			EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'page'              => 'espresso_batch',
+					'batch'             => EED_Batch::batch_job,
+					'EVT_IDs'           => $event_ids,
+					'deletion_job_code' => $deletion_job_code,
+					'job_handler'       => urlencode('EventEspressoBatchRequest\JobHandlers\PreviewEventDeletion'),
+					'return_url'        => urlencode($return_url),
+				],
+				admin_url()
+			)
+		);
+	}
+
+
+	/**
+	 * Checks for a POST submission
+	 *
+	 * @since 4.10.12.p
+	 */
+	protected function confirmDeletion()
+	{
+		$deletion_redirect_logic =
+			$this->getLoader()->getShared('\EventEspresso\core\domain\services\admin\events\data\ConfirmDeletion');
+		$deletion_redirect_logic->handle($this->get_request_data(), $this->admin_base_url());
+	}
+
+
+	/**
+	 * A page for users to preview what exactly will be deleted, and confirm they want to delete it.
+	 *
+	 * @throws EE_Error
+	 * @since 4.10.12.p
+	 */
+	protected function previewDeletion()
+	{
+		$preview_deletion_logic =
+			$this->getLoader()->getShared('\EventEspresso\core\domain\services\admin\events\data\PreviewDeletion');
+		$this->set_template_args($preview_deletion_logic->handle($this->get_request_data(), $this->admin_base_url()));
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * get total number of events
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function total_events()
+	{
+		return EEM_Event::instance()->count(
+			['caps' => 'read_admin'],
+			'EVT_ID',
+			true
+		);
+	}
+
+
+	/**
+	 * get total number of draft events
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function total_events_draft()
+	{
+		return EEM_Event::instance()->count(
+			[
+				['status' => ['IN', ['draft', 'auto-draft']]],
+				'caps' => 'read_admin',
+			],
+			'EVT_ID',
+			true
+		);
+	}
+
+
+	/**
+	 * get total number of trashed events
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function total_trashed_events()
+	{
+		return EEM_Event::instance()->count(
+			[
+				['status' => 'trash'],
+				'caps' => 'read_admin',
+			],
+			'EVT_ID',
+			true
+		);
+	}
+
+
+	/**
+	 *    _default_event_settings
+	 *    This generates the Default Settings Tab
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _default_event_settings()
+	{
+		$this->_set_add_edit_form_tags('update_default_event_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = $this->_default_event_settings_form()->get_html();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Return the form for event settings.
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function _default_event_settings_form()
+	{
+		$registration_config              = EE_Registry::instance()->CFG->registration;
+		$registration_stati_for_selection = EEM_Registration::reg_status_array(
+		// exclude
+			[
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_wait_list,
+			],
+			true
+		);
+		return new EE_Form_Section_Proper(
+			[
+				'name'            => 'update_default_event_settings',
+				'html_id'         => 'update_default_event_settings',
+				'html_class'      => 'form-table',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
+					[
+						'default_reg_status'  => new EE_Select_Input(
+							$registration_stati_for_selection,
+							[
+								'default'         => isset($registration_config->default_STS_ID)
+													 && array_key_exists(
+														 $registration_config->default_STS_ID,
+														 $registration_stati_for_selection
+													 )
+									? sanitize_text_field($registration_config->default_STS_ID)
+									: EEM_Registration::status_id_pending_payment,
+								'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
+													 . EEH_Template::get_help_tab_link(
+														 'default_settings_status_help_tab'
+													 ),
+								'html_help_text'  => esc_html__(
+									'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.',
+									'event_espresso'
+								),
+							]
+						),
+						'default_max_tickets' => new EE_Integer_Input(
+							[
+								'default'         => isset($registration_config->default_maximum_number_of_tickets)
+									? $registration_config->default_maximum_number_of_tickets
+									: EEM_Event::get_default_additional_limit(),
+								'html_label_text' => esc_html__(
+									'Default Maximum Tickets Allowed Per Order:',
+									'event_espresso'
+								)
+								. EEH_Template::get_help_tab_link(
+									'default_maximum_tickets_help_tab"'
+								),
+								'html_help_text'  => esc_html__(
+									'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
+									'event_espresso'
+								),
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * _update_default_event_settings
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _update_default_event_settings()
+	{
+		$registration_config = EE_Registry::instance()->CFG->registration;
+		$form                = $this->_default_event_settings_form();
+		if ($form->was_submitted()) {
+			$form->receive_form_submission();
+			if ($form->is_valid()) {
+				$valid_data = $form->valid_data();
+				if (isset($valid_data['default_reg_status'])) {
+					$registration_config->default_STS_ID = $valid_data['default_reg_status'];
+				}
+				if (isset($valid_data['default_max_tickets'])) {
+					$registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
+				}
+				// update because data was valid!
+				EE_Registry::instance()->CFG->update_espresso_config();
+				EE_Error::overwrite_success();
+				EE_Error::add_success(
+					esc_html__('Default Event Settings were updated', 'event_espresso')
+				);
+			}
+		}
+		$this->_redirect_after_action(0, '', '', ['action' => 'default_event_settings'], true);
+	}
+
+
+	/*************        Templates        *************
      *
-     * @var EE_Event $_event
-     */
-    protected $_event;
-
-
-    /**
-     * This will hold the category object for category_details screen.
-     *
-     * @var stdClass $_category
-     */
-    protected $_category;
-
-
-    /**
-     * This will hold the event model instance
-     *
-     * @var EEM_Event $_event_model
-     */
-    protected $_event_model;
-
-
-    /**
-     * @var EE_Event
-     */
-    protected $_cpt_model_obj = false;
-
-
-    /**
-     * @var NodeGroupDao
-     */
-    protected $model_obj_node_group_persister;
-
-
-    /**
-     * Initialize page props for this admin page group.
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug        = EVENTS_PG_SLUG;
-        $this->page_label       = EVENTS_LABEL;
-        $this->_admin_base_url  = EVENTS_ADMIN_URL;
-        $this->_admin_base_path = EVENTS_ADMIN;
-        $this->_cpt_model_names = [
-            'create_new' => 'EEM_Event',
-            'edit'       => 'EEM_Event',
-        ];
-        $this->_cpt_edit_routes = [
-            'espresso_events' => 'edit',
-        ];
-        add_action(
-            'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
-            [$this, 'verify_event_edit'],
-            10,
-            2
-        );
-    }
-
-
-    /**
-     * Sets the ajax hooks used for this admin page group.
-     */
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_ee_save_timezone_setting', [$this, 'saveTimezoneString']);
-    }
-
-
-    /**
-     * Sets the page properties for this admin page group.
-     */
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = EVENTS_LABEL;
-        $this->_labels           = [
-            'buttons'      => [
-                'add'             => esc_html__('Add New Event', 'event_espresso'),
-                'edit'            => esc_html__('Edit Event', 'event_espresso'),
-                'delete'          => esc_html__('Delete Event', 'event_espresso'),
-                'add_category'    => esc_html__('Add New Category', 'event_espresso'),
-                'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
-                'delete_category' => esc_html__('Delete Category', 'event_espresso'),
-            ],
-            'editor_title' => [
-                'espresso_events' => esc_html__('Enter event title here', 'event_espresso'),
-            ],
-            'publishbox'   => [
-                'create_new'        => esc_html__('Save New Event', 'event_espresso'),
-                'edit'              => esc_html__('Update Event', 'event_espresso'),
-                'add_category'      => esc_html__('Save New Category', 'event_espresso'),
-                'edit_category'     => esc_html__('Update Category', 'event_espresso'),
-                'template_settings' => esc_html__('Update Settings', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    /**
-     * Sets the page routes property for this admin page group.
-     */
-    protected function _set_page_routes()
-    {
-        // load formatter helper
-        // load field generator helper
-        // is there a evt_id in the request?
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        $EVT_ID = $this->request->getRequestParam('post', $EVT_ID, 'int');
-
-        $this->_page_routes = [
-            'default'                       => [
-                'func'       => '_events_overview_list_table',
-                'capability' => 'ee_read_events',
-            ],
-            'create_new'                    => [
-                'func'       => '_create_new_cpt_item',
-                'capability' => 'ee_edit_events',
-            ],
-            'edit'                          => [
-                'func'       => '_edit_cpt_item',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $EVT_ID,
-            ],
-            'copy_event'                    => [
-                'func'       => '_copy_events',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'trash_event'                   => [
-                'func'       => '_trash_or_restore_event',
-                'args'       => ['event_status' => 'trash'],
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'trash_events'                  => [
-                'func'       => '_trash_or_restore_events',
-                'args'       => ['event_status' => 'trash'],
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-            'restore_event'                 => [
-                'func'       => '_trash_or_restore_event',
-                'args'       => ['event_status' => 'draft'],
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'restore_events'                => [
-                'func'       => '_trash_or_restore_events',
-                'args'       => ['event_status' => 'draft'],
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-            'delete_event'                  => [
-                'func'       => '_delete_event',
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'delete_events'                 => [
-                'func'       => '_delete_events',
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-            'view_report'                   => [
-                'func'       => '_view_report',
-                'capability' => 'ee_edit_events',
-            ],
-            'default_event_settings'        => [
-                'func'       => '_default_event_settings',
-                'capability' => 'manage_options',
-            ],
-            'update_default_event_settings' => [
-                'func'       => '_update_default_event_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'template_settings'             => [
-                'func'       => '_template_settings',
-                'capability' => 'manage_options',
-            ],
-            // event category tab related
-            'add_category'                  => [
-                'func'       => '_category_details',
-                'capability' => 'ee_edit_event_category',
-                'args'       => ['add'],
-            ],
-            'edit_category'                 => [
-                'func'       => '_category_details',
-                'capability' => 'ee_edit_event_category',
-                'args'       => ['edit'],
-            ],
-            'delete_categories'             => [
-                'func'       => '_delete_categories',
-                'capability' => 'ee_delete_event_category',
-                'noheader'   => true,
-            ],
-            'delete_category'               => [
-                'func'       => '_delete_categories',
-                'capability' => 'ee_delete_event_category',
-                'noheader'   => true,
-            ],
-            'insert_category'               => [
-                'func'       => '_insert_or_update_category',
-                'args'       => ['new_category' => true],
-                'capability' => 'ee_edit_event_category',
-                'noheader'   => true,
-            ],
-            'update_category'               => [
-                'func'       => '_insert_or_update_category',
-                'args'       => ['new_category' => false],
-                'capability' => 'ee_edit_event_category',
-                'noheader'   => true,
-            ],
-            'category_list'                 => [
-                'func'       => '_category_list_table',
-                'capability' => 'ee_manage_event_categories',
-            ],
-            'preview_deletion'              => [
-                'func'       => 'previewDeletion',
-                'capability' => 'ee_delete_events',
-            ],
-            'confirm_deletion'              => [
-                'func'       => 'confirmDeletion',
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-        ];
-    }
-
-
-    /**
-     * Set the _page_config property for this admin page group.
-     */
-    protected function _set_page_config()
-    {
-        $post_id            = $this->request->getRequestParam('post', 0, 'int');
-        $EVT_CAT_ID         = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
-        $this->_page_config = [
-            'default'                => [
-                'nav'           => [
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'order' => 10,
-                ],
-                'list_table'    => 'Events_Admin_List_Table',
-                'help_tabs'     => [
-                    'events_overview_help_tab'                       => [
-                        'title'    => esc_html__('Events Overview', 'event_espresso'),
-                        'filename' => 'events_overview',
-                    ],
-                    'events_overview_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'events_overview_table_column_headings',
-                    ],
-                    'events_overview_filters_help_tab'               => [
-                        'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
-                        'filename' => 'events_overview_filters',
-                    ],
-                    'events_overview_view_help_tab'                  => [
-                        'title'    => esc_html__('Events Overview Views', 'event_espresso'),
-                        'filename' => 'events_overview_views',
-                    ],
-                    'events_overview_other_help_tab'                 => [
-                        'title'    => esc_html__('Events Overview Other', 'event_espresso'),
-                        'filename' => 'events_overview_other',
-                    ],
-                ],
-                'qtips'         => [
-                    'EE_Event_List_Table_Tips',
-                ],
-                'require_nonce' => false,
-            ],
-            'create_new'             => [
-                'nav'           => [
-                    'label'      => esc_html__('Add Event', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                ],
-                'metaboxes'     => ['_register_event_editor_meta_boxes'],
-                'help_tabs'     => [
-                    'event_editor_help_tab'                            => [
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
-                        'filename' => 'event_editor',
-                    ],
-                    'event_editor_title_richtexteditor_help_tab'       => [
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'event_editor_title_richtexteditor',
-                    ],
-                    'event_editor_venue_details_help_tab'              => [
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
-                        'filename' => 'event_editor_venue_details',
-                    ],
-                    'event_editor_event_datetimes_help_tab'            => [
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
-                        'filename' => 'event_editor_event_datetimes',
-                    ],
-                    'event_editor_event_tickets_help_tab'              => [
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
-                        'filename' => 'event_editor_event_tickets',
-                    ],
-                    'event_editor_event_registration_options_help_tab' => [
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
-                        'filename' => 'event_editor_event_registration_options',
-                    ],
-                    'event_editor_tags_categories_help_tab'            => [
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
-                        'filename' => 'event_editor_tags_categories',
-                    ],
-                    'event_editor_questions_registrants_help_tab'      => [
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
-                        'filename' => 'event_editor_questions_registrants',
-                    ],
-                    'event_editor_save_new_event_help_tab'             => [
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
-                        'filename' => 'event_editor_save_new_event',
-                    ],
-                    'event_editor_other_help_tab'                      => [
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
-                        'filename' => 'event_editor_other',
-                    ],
-                ],
-                'qtips'         => ['EE_Event_Editor_Decaf_Tips'],
-                'require_nonce' => false,
-            ],
-            'edit'                   => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Event', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => $post_id
-                        ? EE_Admin_Page::add_query_args_and_nonce(
-                            ['post' => $post_id, 'action' => 'edit'],
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ],
-                'metaboxes'     => ['_register_event_editor_meta_boxes'],
-                'help_tabs'     => [
-                    'event_editor_help_tab'                            => [
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
-                        'filename' => 'event_editor',
-                    ],
-                    'event_editor_title_richtexteditor_help_tab'       => [
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'event_editor_title_richtexteditor',
-                    ],
-                    'event_editor_venue_details_help_tab'              => [
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
-                        'filename' => 'event_editor_venue_details',
-                    ],
-                    'event_editor_event_datetimes_help_tab'            => [
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
-                        'filename' => 'event_editor_event_datetimes',
-                    ],
-                    'event_editor_event_tickets_help_tab'              => [
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
-                        'filename' => 'event_editor_event_tickets',
-                    ],
-                    'event_editor_event_registration_options_help_tab' => [
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
-                        'filename' => 'event_editor_event_registration_options',
-                    ],
-                    'event_editor_tags_categories_help_tab'            => [
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
-                        'filename' => 'event_editor_tags_categories',
-                    ],
-                    'event_editor_questions_registrants_help_tab'      => [
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
-                        'filename' => 'event_editor_questions_registrants',
-                    ],
-                    'event_editor_save_new_event_help_tab'             => [
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
-                        'filename' => 'event_editor_save_new_event',
-                    ],
-                    'event_editor_other_help_tab'                      => [
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
-                        'filename' => 'event_editor_other',
-                    ],
-                ],
-                'qtips'         => ['EE_Event_Editor_Decaf_Tips'],
-                'require_nonce' => false,
-            ],
-            'default_event_settings' => [
-                'nav'           => [
-                    'label' => esc_html__('Default Settings', 'event_espresso'),
-                    'order' => 40,
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'labels'        => [
-                    'publishbox' => esc_html__('Update Settings', 'event_espresso'),
-                ],
-                'help_tabs'     => [
-                    'default_settings_help_tab'        => [
-                        'title'    => esc_html__('Default Event Settings', 'event_espresso'),
-                        'filename' => 'events_default_settings',
-                    ],
-                    'default_settings_status_help_tab' => [
-                        'title'    => esc_html__('Default Registration Status', 'event_espresso'),
-                        'filename' => 'events_default_settings_status',
-                    ],
-                    'default_maximum_tickets_help_tab' => [
-                        'title'    => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
-                        'filename' => 'events_default_settings_max_tickets',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            // template settings
-            'template_settings'      => [
-                'nav'           => [
-                    'label' => esc_html__('Templates', 'event_espresso'),
-                    'order' => 30,
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => [
-                    'general_settings_templates_help_tab' => [
-                        'title'    => esc_html__('Templates', 'event_espresso'),
-                        'filename' => 'general_settings_templates',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            // event category stuff
-            'add_category'           => [
-                'nav'           => [
-                    'label'      => esc_html__('Add Category', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                ],
-                'help_tabs'     => [
-                    'add_category_help_tab' => [
-                        'title'    => esc_html__('Add New Event Category', 'event_espresso'),
-                        'filename' => 'events_add_category',
-                    ],
-                ],
-                'metaboxes'     => ['_publish_post_box'],
-                'require_nonce' => false,
-            ],
-            'edit_category'          => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Category', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => $EVT_CAT_ID
-                        ? add_query_arg(
-                            ['EVT_CAT_ID' => $EVT_CAT_ID],
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ],
-                'help_tabs'     => [
-                    'edit_category_help_tab' => [
-                        'title'    => esc_html__('Edit Event Category', 'event_espresso'),
-                        'filename' => 'events_edit_category',
-                    ],
-                ],
-                'metaboxes'     => ['_publish_post_box'],
-                'require_nonce' => false,
-            ],
-            'category_list'          => [
-                'nav'           => [
-                    'label' => esc_html__('Categories', 'event_espresso'),
-                    'order' => 20,
-                ],
-                'list_table'    => 'Event_Categories_Admin_List_Table',
-                'help_tabs'     => [
-                    'events_categories_help_tab'                       => [
-                        'title'    => esc_html__('Event Categories', 'event_espresso'),
-                        'filename' => 'events_categories',
-                    ],
-                    'events_categories_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
-                        'filename' => 'events_categories_table_column_headings',
-                    ],
-                    'events_categories_view_help_tab'                  => [
-                        'title'    => esc_html__('Event Categories Views', 'event_espresso'),
-                        'filename' => 'events_categories_views',
-                    ],
-                    'events_categories_other_help_tab'                 => [
-                        'title'    => esc_html__('Event Categories Other', 'event_espresso'),
-                        'filename' => 'events_categories_other',
-                    ],
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ],
-            'preview_deletion'       => [
-                'nav'           => [
-                    'label'      => esc_html__('Preview Deletion', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => '',
-                ],
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    /**
-     * Used to register any global screen options if necessary for every route in this admin page group.
-     */
-    protected function _add_screen_options()
-    {
-    }
-
-
-    /**
-     * Implementing the screen options for the 'default' route.
-     */
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * Implementing screen options for the category list route.
-     */
-    protected function _add_screen_options_category_list()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Categories', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    /**
-     * Used to register any global feature pointers for the admin page group.
-     */
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    /**
-     * Registers and enqueues any global scripts and styles for the entire admin page group.
-     */
-    public function load_scripts_styles()
-    {
-        wp_register_style(
-            'events-admin-css',
-            EVENTS_ASSETS_URL . 'events-admin-page.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', [], EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('events-admin-css');
-        wp_enqueue_style('ee-cat-admin');
-        // todo note: we also need to load_scripts_styles per view (i.e. default/view_report/event_details
-        // registers for all views
-        // scripts
-        wp_register_script(
-            'event_editor_js',
-            EVENTS_ASSETS_URL . 'event_editor.js',
-            ['ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-    }
-
-
-    /**
-     * Enqueuing scripts and styles specific to this view
-     */
-    public function load_scripts_styles_create_new()
-    {
-        $this->load_scripts_styles_edit();
-    }
-
-
-    /**
-     * Enqueuing scripts and styles specific to this view
-     */
-    public function load_scripts_styles_edit()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_register_style(
-            'event-editor-css',
-            EVENTS_ASSETS_URL . 'event-editor.css',
-            ['ee-admin-css'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('event-editor-css');
-        // scripts
-        wp_register_script(
-            'event-datetime-metabox',
-            EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
-            ['event_editor_js', 'ee-datepicker'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_script('event-datetime-metabox');
-    }
-
-
-    /**
-     * Populating the _views property for the category list table view.
-     */
-    protected function _set_list_table_views_category_list()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ],
-        ];
-    }
-
-
-    /**
-     * For adding anything that fires on the admin_init hook for any route within this admin page group.
-     */
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__(
-            'Do you really want to delete this image? Please remember to update your event to complete the removal.',
-            'event_espresso'
-        );
-    }
-
-
-    /**
-     * For adding anything that should be triggered on the admin_notices hook for any route within this admin page
-     * group.
-     */
-    public function admin_notices()
-    {
-    }
-
-
-    /**
-     * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
-     * this admin page group.
-     */
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    /**
-     * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
-     * warning (via EE_Error::add_error());
-     *
-     * @param EE_Event $event Event object
-     * @param string   $req_type
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function verify_event_edit($event = null, $req_type = '')
-    {
-        // don't need to do this when processing
-        if (! empty($req_type)) {
-            return;
-        }
-        // no event?
-        if (empty($event)) {
-            // set event
-            $event = $this->_cpt_model_obj;
-        }
-        // STILL no event?
-        if (! $event instanceof EE_Event) {
-            return;
-        }
-        $orig_status = $event->status();
-        // first check if event is active.
-        if (
-            $orig_status === EEM_Event::cancelled
-            || $orig_status === EEM_Event::postponed
-            || $event->is_expired()
-            || $event->is_inactive()
-        ) {
-            return;
-        }
-        // made it here so it IS active... next check that any of the tickets are sold.
-        if ($event->is_sold_out(true)) {
-            if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
-                EE_Error::add_attention(
-                    sprintf(
-                        esc_html__(
-                            '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.',
-                            'event_espresso'
-                        ),
-                        EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
-                    )
-                );
-            }
-            return;
-        } elseif ($orig_status === EEM_Event::sold_out) {
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__(
-                        '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.',
-                        'event_espresso'
-                    ),
-                    EEH_Template::pretty_status($event->status(), false, 'sentence')
-                )
-            );
-        }
-        // now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
-        if (! $event->tickets_on_sale()) {
-            return;
-        }
-        // made it here so show warning
-        $this->_edit_event_warning();
-    }
-
-
-    /**
-     * This is the text used for when an event is being edited that is public and has tickets for sale.
-     * When needed, hook this into a EE_Error::add_error() notice.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _edit_event_warning()
-    {
-        // we don't want to add warnings during these requests
-        if ($this->request->getRequestParam('action') === 'editpost') {
-            return;
-        }
-        EE_Error::add_attention(
-            sprintf(
-                esc_html__(
-                    'Your event is open for registration. Making changes may disrupt any transactions in progress. %sLearn more%s',
-                    'event_espresso'
-                ),
-                '<a class="espresso-help-tab-lnk">',
-                '</a>'
-            )
-        );
-    }
-
-
-    /**
-     * When a user is creating a new event, notify them if they haven't set their timezone.
-     * Otherwise, do the normal logic
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _create_new_cpt_item()
-    {
-        $has_timezone_string = get_option('timezone_string');
-        // only nag them about setting their timezone if it's their first event, and they haven't already done it
-        if (! $has_timezone_string && ! EEM_Event::instance()->exists([])) {
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__(
-                        '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',
-                        'event_espresso'
-                    ),
-                    '<br>',
-                    '<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
-                    . EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
-                    . '</select>',
-                    '<button class="button button-secondary timezone-submit">',
-                    '</button><span class="spinner"></span>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        parent::_create_new_cpt_item();
-    }
-
-
-    /**
-     * Sets the _views property for the default route in this admin page group.
-     */
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = [
-            'all'   => [
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Events', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-            'draft' => [
-                'slug'        => 'draft',
-                'label'       => esc_html__('Draft', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-        ];
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
-            $this->_views['trash'] = [
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
-                    'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ];
-        }
-    }
-
-
-    /**
-     * Provides the legend item array for the default list table view.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function _event_legend_items()
-    {
-        $items    = [
-            'view_details'   => [
-                'class' => 'dashicons dashicons-search',
-                'desc'  => esc_html__('View Event', 'event_espresso'),
-            ],
-            'edit_event'     => [
-                'class' => 'ee-icon ee-icon-calendar-edit',
-                'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
-            ],
-            'view_attendees' => [
-                'class' => 'dashicons dashicons-groups',
-                'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
-            ],
-        ];
-        $items    = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
-        $statuses = [
-            'sold_out_status'  => [
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::sold_out,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
-            ],
-            'active_status'    => [
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::active,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
-            ],
-            'upcoming_status'  => [
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::upcoming,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
-            ],
-            'postponed_status' => [
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::postponed,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
-            ],
-            'cancelled_status' => [
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::cancelled,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
-            ],
-            'expired_status'   => [
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::expired,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
-            ],
-            'inactive_status'  => [
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::inactive,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
-            ],
-        ];
-        $statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
-        return array_merge($items, $statuses);
-    }
-
-
-    /**
-     * @return EEM_Event
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _event_model()
-    {
-        if (! $this->_event_model instanceof EEM_Event) {
-            $this->_event_model = EE_Registry::instance()->load_model('Event');
-        }
-        return $this->_event_model;
-    }
-
-
-    /**
-     * Adds extra buttons to the WP CPT permalink field row.
-     * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
-     *
-     * @param string $return    the current html
-     * @param int    $id        the post id for the page
-     * @param string $new_title What the title is
-     * @param string $new_slug  what the slug is
-     * @return string            The new html string for the permalink area
-     */
-    public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
-    {
-        // make sure this is only when editing
-        if (! empty($id)) {
-            $post   = get_post($id);
-            $return .= '<a class="button button-small" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#"  tabindex="-1">'
-                       . esc_html__('Shortcode', 'event_espresso')
-                       . '</a> ';
-            $return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id='
-                       . $post->ID
-                       . ']">';
-        }
-        return $return;
-    }
-
-
-    /**
-     * _events_overview_list_table
-     * This contains the logic for showing the events_overview list
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _events_overview_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_template_args['after_list_table']                           =
-            ! empty($this->_template_args['after_list_table'])
-                ? (array) $this->_template_args['after_list_table']
-                : [];
-        $this->_template_args['after_list_table']['view_event_list_button'] = EEH_HTML::br()
-            . EEH_Template::get_button_or_link(
-                get_post_type_archive_link('espresso_events'),
-                esc_html__("View Event Archive Page", "event_espresso"),
-                'button'
-            );
-        $this->_template_args['after_list_table']['legend']                 = $this->_display_legend(
-            $this->_event_legend_items()
-        );
-        $this->_admin_page_title                                            .= ' ' . $this->get_action_link_or_button(
-            'create_new',
-            'add',
-            [],
-            'add-new-h2'
-        );
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * this allows for extra misc actions in the default WP publish box
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function extra_misc_actions_publish_box()
-    {
-        $this->_generate_publish_box_extra_content();
-    }
-
-
-    /**
-     * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
-     * saved.
-     * Typically you would use this to save any additional data.
-     * Keep in mind also that "save_post" runs on EVERY post update to the database.
-     * ALSO very important.  When a post transitions from scheduled to published,
-     * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from
-     * other meta saves. So MAKE sure that you handle this accordingly.
-     *
-     * @access protected
-     * @abstract
-     * @param string $post_id The ID of the cpt that was saved (so you can link relationally)
-     * @param WP_Post $post    The post object of the cpt that was saved.
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-        if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
-            // get out we're not processing an event save.
-            return;
-        }
-
-        $event_values = [
-            'EVT_display_desc'                => $this->request->getRequestParam('display_desc', false, 'bool'),
-            'EVT_display_ticket_selector'     => $this->request->getRequestParam(
-                'display_ticket_selector',
-                false,
-                'bool'
-            ),
-            'EVT_additional_limit'            => min(
-                apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
-                $this->request->getRequestParam('additional_limit', null, 'int')
-            ),
-            'EVT_default_registration_status' => $this->request->getRequestParam(
-                'EVT_default_registration_status',
-                EE_Registry::instance()->CFG->registration->default_STS_ID
-            ),
-
-            'EVT_member_only'     => $this->request->getRequestParam('member_only', false, 'bool'),
-            'EVT_allow_overflow'  => $this->request->getRequestParam('EVT_allow_overflow', false, 'bool'),
-            'EVT_timezone_string' => $this->request->getRequestParam('timezone_string'),
-            'EVT_external_URL'    => $this->request->getRequestParam('externalURL'),
-            'EVT_phone'           => $this->request->getRequestParam('event_phone'),
-        ];
-        // update event
-        $success = $this->_event_model()->update_by_ID($event_values, $post_id);
-        // 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!
-        $event = $this->_event_model()->get_one(
-            [
-                [
-                    $this->_event_model()->primary_key_name() => $post_id,
-                    'OR'                                      => [
-                        'status'   => $post->post_status,
-                        // if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
-                        // but the returned object here has a status of "publish", so use the original post status as well
-                        'status*1' => $this->request->getRequestParam('original_post_status'),
-                    ],
-                ],
-            ]
-        );
-        // the following are default callbacks for event attachment updates that can be overridden by caffeinated functionality and/or addons.
-        $event_update_callbacks = apply_filters(
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            [
-                [$this, '_default_venue_update'],
-                [$this, '_default_tickets_update'],
-            ]
-        );
-        $att_success            = true;
-        foreach ($event_update_callbacks as $e_callback) {
-            $_success = is_callable($e_callback)
-                ? call_user_func($e_callback, $event, $this->request->requestParams())
-                : false;
-            // if ANY of these updates fail then we want the appropriate global error message
-            $att_success = ! $att_success ? $att_success : $_success;
-        }
-        // any errors?
-        if ($success && false === $att_success) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Event Details saved successfully but something went wrong with saving attachments.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } elseif ($success === false) {
-            EE_Error::add_error(
-                esc_html__('Event Details did not save successfully.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * @param int $post_id
-     * @param int $revision_id
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see parent::restore_item()
-     */
-    protected function _restore_cpt_item($post_id, $revision_id)
-    {
-        // copy existing event meta to new post
-        $post_evt = $this->_event_model()->get_one_by_ID($post_id);
-        if ($post_evt instanceof EE_Event) {
-            // meta revision restore
-            $post_evt->restore_revision($revision_id);
-            // related objs restore
-            $post_evt->restore_revision($revision_id, ['Venue', 'Datetime', 'Price']);
-        }
-    }
-
-
-    /**
-     * Attach the venue to the Event
-     *
-     * @param EE_Event $event Event Object to add the venue to
-     * @param array    $data  The request data from the form
-     * @return bool           Success or fail.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _default_venue_update(EE_Event $event, $data)
-    {
-        require_once(EE_MODELS . 'EEM_Venue.model.php');
-        $venue_model = EE_Registry::instance()->load_model('Venue');
-        $venue_id    = ! empty($data['venue_id']) ? $data['venue_id'] : null;
-        // very important.  If we don't have a venue name...
-        // then we'll get out because not necessary to create empty venue
-        if (empty($data['venue_title'])) {
-            return false;
-        }
-        $venue_array = [
-            'VNU_wp_user'         => $event->get('EVT_wp_user'),
-            'VNU_name'            => $data['venue_title'],
-            'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
-            'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
-            'VNU_short_desc'      => ! empty($data['venue_short_description'])
-                ? $data['venue_short_description']
-                : null,
-            'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
-            'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
-            'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
-            'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
-            'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
-            'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
-            'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
-            'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
-            'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
-            'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
-            'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
-            'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
-            'status'              => 'publish',
-        ];
-        // if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
-        if (! empty($venue_id)) {
-            $update_where  = [$venue_model->primary_key_name() => $venue_id];
-            $rows_affected = $venue_model->update($venue_array, [$update_where]);
-            // 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.
-            $event->_add_relation_to($venue_id, 'Venue');
-            return $rows_affected > 0;
-        }
-        // we insert the venue
-        $venue_id = $venue_model->insert($venue_array);
-        $event->_add_relation_to($venue_id, 'Venue');
-        return ! empty($venue_id);
-        // when we have the ancestor come in it's already been handled by the revision save.
-    }
-
-
-    /**
-     * Handles saving everything related to Tickets (datetimes, tickets, prices)
-     *
-     * @param EE_Event $event The Event object we're attaching data to
-     * @param array    $data  The request data from the form
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    protected function _default_tickets_update(EE_Event $event, $data)
-    {
-        $datetime       = null;
-        $saved_tickets  = [];
-        $event_timezone = $event->get_timezone();
-        $date_formats   = ['Y-m-d', 'h:i a'];
-        foreach ($data['edit_event_datetimes'] as $row => $datetime_data) {
-            // trim all values to ensure any excess whitespace is removed.
-            $datetime_data                = array_map('trim', $datetime_data);
-            $datetime_data['DTT_EVT_end'] =
-                isset($datetime_data['DTT_EVT_end']) && ! empty($datetime_data['DTT_EVT_end'])
-                    ? $datetime_data['DTT_EVT_end']
-                    : $datetime_data['DTT_EVT_start'];
-            $datetime_values              = [
-                'DTT_ID'        => ! empty($datetime_data['DTT_ID']) ? $datetime_data['DTT_ID'] : null,
-                'DTT_EVT_start' => $datetime_data['DTT_EVT_start'],
-                'DTT_EVT_end'   => $datetime_data['DTT_EVT_end'],
-                'DTT_reg_limit' => empty($datetime_data['DTT_reg_limit']) ? EE_INF : $datetime_data['DTT_reg_limit'],
-                'DTT_order'     => $row,
-            ];
-            // 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.
-            if (! empty($datetime_data['DTT_ID'])) {
-                $datetime = EEM_Datetime::instance($event_timezone)->get_one_by_ID($datetime_data['DTT_ID']);
-                if (! $datetime instanceof EE_Datetime) {
-                    throw new RuntimeException(
-                        sprintf(
-                            esc_html__(
-                                'Something went wrong! A valid Datetime could not be retrieved from the database using the supplied ID: %1$d',
-                                'event_espresso'
-                            ),
-                            $datetime_data['DTT_ID']
-                        )
-                    );
-                }
-                $datetime->set_date_format($date_formats[0]);
-                $datetime->set_time_format($date_formats[1]);
-                foreach ($datetime_values as $field => $value) {
-                    $datetime->set($field, $value);
-                }
-            } else {
-                $datetime = EE_Datetime::new_instance($datetime_values, $event_timezone, $date_formats);
-            }
-            if (! $datetime instanceof EE_Datetime) {
-                throw new RuntimeException(
-                    sprintf(
-                        esc_html__(
-                            'Something went wrong! A valid Datetime could not be generated or retrieved using the supplied data: %1$s',
-                            'event_espresso'
-                        ),
-                        print_r($datetime_values, true)
-                    )
-                );
-            }
-            // 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.
-            if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) {
-                $datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start'));
-                $datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days');
-            }
-            $datetime->save();
-            $event->_add_relation_to($datetime, 'Datetime');
-        }
-        // no datetimes get deleted so we don't do any of that logic here.
-        // update tickets next
-        $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : [];
-
-        // set up some default start and end dates in case those are not present in the incoming data
-        $default_start_date = new DateTime('now', new DateTimeZone($event->get_timezone()));
-        $default_start_date = $default_start_date->format($date_formats[0] . ' ' . $date_formats[1]);
-        // use the start date of the first datetime for the end date
-        $first_datetime   = $event->first_datetime();
-        $default_end_date = $first_datetime->start_date_and_time($date_formats[0], $date_formats[1]);
-
-        // now process the incoming data
-        foreach ($data['edit_tickets'] as $row => $ticket_data) {
-            $update_prices = false;
-            $ticket_price  = isset($data['edit_prices'][ $row ][1]['PRC_amount'])
-                ? $data['edit_prices'][ $row ][1]['PRC_amount']
-                : 0;
-            // trim inputs to ensure any excess whitespace is removed.
-            $ticket_data   = array_map('trim', $ticket_data);
-            $ticket_values = [
-                'TKT_ID'          => ! empty($ticket_data['TKT_ID']) ? $ticket_data['TKT_ID'] : null,
-                'TTM_ID'          => ! empty($ticket_data['TTM_ID']) ? $ticket_data['TTM_ID'] : 0,
-                'TKT_name'        => ! empty($ticket_data['TKT_name']) ? $ticket_data['TKT_name'] : '',
-                'TKT_description' => ! empty($ticket_data['TKT_description']) ? $ticket_data['TKT_description'] : '',
-                'TKT_start_date'  => ! empty($ticket_data['TKT_start_date'])
-                    ? $ticket_data['TKT_start_date']
-                    : $default_start_date,
-                'TKT_end_date'    => ! empty($ticket_data['TKT_end_date'])
-                    ? $ticket_data['TKT_end_date']
-                    : $default_end_date,
-                'TKT_qty'         => ! empty($ticket_data['TKT_qty'])
-                                     || (isset($ticket_data['TKT_qty']) && (int) $ticket_data['TKT_qty'] === 0)
-                    ? $ticket_data['TKT_qty']
-                    : EE_INF,
-                'TKT_uses'        => ! empty($ticket_data['TKT_uses'])
-                                     || (isset($ticket_data['TKT_uses']) && (int) $ticket_data['TKT_uses'] === 0)
-                    ? $ticket_data['TKT_uses']
-                    : EE_INF,
-                'TKT_min'         => ! empty($ticket_data['TKT_min']) ? $ticket_data['TKT_min'] : 0,
-                'TKT_max'         => ! empty($ticket_data['TKT_max']) ? $ticket_data['TKT_max'] : EE_INF,
-                'TKT_order'       => isset($ticket_data['TKT_order']) ? $ticket_data['TKT_order'] : $row,
-                'TKT_price'       => $ticket_price,
-                'TKT_row'         => $row,
-            ];
-            // if this is a default ticket, 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.
-            if (isset($ticket_data['TKT_is_default']) && $ticket_data['TKT_is_default']) {
-                $ticket_values['TKT_ID']         = 0;
-                $ticket_values['TKT_is_default'] = 0;
-                $update_prices                   = true;
-            }
-            // if we have a TKT_ID then we need to get that existing TKT_obj and update it
-            // we actually do our saves ahead of adding any relations because its entirely possible that this
-            // ticket didn't get removed or added to any datetime in the session but DID have it's items modified.
-            // keep in mind that if the ticket 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.
-            if (! empty($ticket_data['TKT_ID'])) {
-                $existing_ticket = EEM_Ticket::instance($event_timezone)->get_one_by_ID($ticket_data['TKT_ID']);
-                if (! $existing_ticket instanceof EE_Ticket) {
-                    throw new RuntimeException(
-                        sprintf(
-                            esc_html__(
-                                'Something went wrong! A valid Ticket could not be retrieved from the database using the supplied ID: %1$d',
-                                'event_espresso'
-                            ),
-                            $ticket_data['TKT_ID']
-                        )
-                    );
-                }
-                $ticket_sold = $existing_ticket->count_related(
-                    'Registration',
-                    [
-                        [
-                            'STS_ID' => [
-                                'NOT IN',
-                                [EEM_Registration::status_id_incomplete],
-                            ],
-                        ],
-                    ]
-                ) > 0;
-                // 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 $ticket_sold)
-                // if they aren't different then we go ahead and modify existing ticket.
-                $create_new_ticket = $ticket_sold
-                                     && $ticket_price !== $existing_ticket->price()
-                                     && ! $existing_ticket->deleted();
-                $existing_ticket->set_date_format($date_formats[0]);
-                $existing_ticket->set_time_format($date_formats[1]);
-                // set new values
-                foreach ($ticket_values as $field => $value) {
-                    if ($field == 'TKT_qty') {
-                        $existing_ticket->set_qty($value);
-                    } elseif ($field == 'TKT_price') {
-                        $existing_ticket->set('TKT_price', $ticket_price);
-                    } else {
-                        $existing_ticket->set($field, $value);
-                    }
-                }
-                $ticket = $existing_ticket;
-                // if $create_new_ticket is false then we can safely update the existing ticket.
-                //  Otherwise we have to create a new ticket.
-                if ($create_new_ticket) {
-                    // archive the old ticket first
-                    $existing_ticket->set('TKT_deleted', 1);
-                    $existing_ticket->save();
-                    // make sure this ticket is still recorded in our $saved_tickets
-                    // so we don't run it through the regular trash routine.
-                    $saved_tickets[ $existing_ticket->ID() ] = $existing_ticket;
-                    // 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.
-                    $new_ticket = clone $existing_ticket;
-                    $new_ticket->set('TKT_ID', 0);
-                    $new_ticket->set('TKT_deleted', 0);
-                    $new_ticket->set('TKT_sold', 0);
-                    // now we need to make sure that $new prices are created as well and attached to new ticket.
-                    $update_prices = true;
-                    $ticket        = $new_ticket;
-                }
-            } else {
-                // no TKT_id so a new ticket
-                $ticket_values['TKT_price'] = $ticket_price;
-                $ticket                     = EE_Ticket::new_instance($ticket_values, $event_timezone, $date_formats);
-                $update_prices              = true;
-            }
-            if (! $ticket instanceof EE_Ticket) {
-                throw new RuntimeException(
-                    sprintf(
-                        esc_html__(
-                            'Something went wrong! A valid Ticket could not be generated or retrieved using the supplied data: %1$s',
-                            'event_espresso'
-                        ),
-                        print_r($ticket_values, true)
-                    )
-                );
-            }
-            // cap ticket qty by datetime reg limits
-            $ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit')));
-            // update ticket.
-            $ticket->save();
-            // 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.
-            if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) {
-                $ticket->set('TKT_end_date', $ticket->get('TKT_start_date'));
-                $ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days');
-                $ticket->save();
-            }
-            // initially let's add the ticket to the datetime
-            $datetime->_add_relation_to($ticket, 'Ticket');
-            $saved_tickets[ $ticket->ID() ] = $ticket;
-            // add prices to ticket
-            $prices_data = isset($data['edit_prices'][ $row ]) && is_array($data['edit_prices'][ $row ])
-                ? $data['edit_prices'][ $row ]
-                : [];
-            $this->_add_prices_to_ticket($prices_data, $ticket, $update_prices);
-        }
-        // 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.
-        $old_tickets     = isset($old_tickets[0]) && $old_tickets[0] == '' ? [] : $old_tickets;
-        $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
-        foreach ($tickets_removed as $id) {
-            $id = absint($id);
-            // get the ticket for this id
-            $ticket_to_remove = EEM_Ticket::instance()->get_one_by_ID($id);
-            if (! $ticket_to_remove instanceof EE_Ticket) {
-                continue;
-            }
-            // 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 tickets sold)
-            $related_datetimes = $ticket_to_remove->get_many_related('Datetime');
-            foreach ($related_datetimes as $related_datetime) {
-                $ticket_to_remove->_remove_relation_to($related_datetime, 'Datetime');
-            }
-            // 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))
-            $ticket_to_remove->delete_related_permanently('Price');
-            // finally let's delete this ticket
-            // (which should not be blocked at this point b/c we've removed all our relationships)
-            $ticket_to_remove->delete_permanently();
-        }
-        return [$datetime, $saved_tickets];
-    }
-
-
-    /**
-     * This attaches a list of given prices to a ticket.
-     * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
-     * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
-     * price info and prices are automatically "archived" via the ticket.
-     *
-     * @access  private
-     * @param array     $prices_data Array of prices from the form.
-     * @param EE_Ticket $ticket      EE_Ticket object that prices are being attached to.
-     * @param bool      $new_prices  Whether attach existing incoming prices or create new ones.
-     * @return  void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _add_prices_to_ticket($prices_data, EE_Ticket $ticket, $new_prices = false)
-    {
-        $timezone = $ticket->get_timezone();
-        foreach ($prices_data as $row => $price_data) {
-            $price_values = [
-                'PRC_ID'         => ! empty($price_data['PRC_ID']) ? $price_data['PRC_ID'] : null,
-                'PRT_ID'         => ! empty($price_data['PRT_ID']) ? $price_data['PRT_ID'] : null,
-                'PRC_amount'     => ! empty($price_data['PRC_amount']) ? $price_data['PRC_amount'] : 0,
-                'PRC_name'       => ! empty($price_data['PRC_name']) ? $price_data['PRC_name'] : '',
-                'PRC_desc'       => ! empty($price_data['PRC_desc']) ? $price_data['PRC_desc'] : '',
-                'PRC_is_default' => 0, // make sure prices are NOT set as default from this context
-                'PRC_order'      => $row,
-            ];
-            if ($new_prices || empty($price_values['PRC_ID'])) {
-                $price_values['PRC_ID'] = 0;
-                $price                  = EE_Price::new_instance($price_values, $timezone);
-            } else {
-                $price = EEM_Price::instance($timezone)->get_one_by_ID($price_data['PRC_ID']);
-                // update this price with new values
-                foreach ($price_values as $field => $new_price) {
-                    $price->set($field, $new_price);
-                }
-            }
-            if (! $price instanceof EE_Price) {
-                throw new RuntimeException(
-                    sprintf(
-                        esc_html__(
-                            'Something went wrong! A valid Price could not be generated or retrieved using the supplied data: %1$s',
-                            'event_espresso'
-                        ),
-                        print_r($price_values, true)
-                    )
-                );
-            }
-            $price->save();
-            $ticket->_add_relation_to($price, 'Price');
-        }
-    }
-
-
-    /**
-     * Add in our autosave ajax handlers
-     *
-     */
-    protected function _ee_autosave_create_new()
-    {
-    }
-
-
-    /**
-     * More autosave handlers.
-     */
-    protected function _ee_autosave_edit()
-    {
-        // TEMPORARILY EXITING CAUSE THIS IS A TODO
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _generate_publish_box_extra_content()
-    {
-        // load formatter helper
-        // args for getting related registrations
-        $approved_query_args        = [
-            [
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_approved,
-            ],
-        ];
-        $not_approved_query_args    = [
-            [
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_not_approved,
-            ],
-        ];
-        $pending_payment_query_args = [
-            [
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_pending_payment,
-            ],
-        ];
-        // publish box
-        $publish_box_extra_args = [
-            'view_approved_reg_url'        => add_query_arg(
-                [
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_approved,
-                    'use_filters' => true,
-                ],
-                REG_ADMIN_URL
-            ),
-            'view_not_approved_reg_url'    => add_query_arg(
-                [
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
-                    'use_filters' => true,
-                ],
-                REG_ADMIN_URL
-            ),
-            'view_pending_payment_reg_url' => add_query_arg(
-                [
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_pending_payment,
-                    'use_filters' => true,
-                ],
-                REG_ADMIN_URL
-            ),
-            'approved_regs'                => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $approved_query_args
-            ),
-            'not_approved_regs'            => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $not_approved_query_args
-            ),
-            'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $pending_payment_query_args
-            ),
-            'misc_pub_section_class'       => apply_filters(
-                'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
-                'misc-pub-section'
-            ),
-        ];
-        ob_start();
-        do_action(
-            'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
-            $this->_cpt_model_obj
-        );
-        $publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
-        // load template
-        EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
-            $publish_box_extra_args
-        );
-    }
-
-
-    /**
-     * @return EE_Event
-     */
-    public function get_event_object()
-    {
-        return $this->_cpt_model_obj;
-    }
-
-
-
-
-    /** METABOXES * */
-    /**
-     * _register_event_editor_meta_boxes
-     * add all metaboxes related to the event_editor
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _register_event_editor_meta_boxes()
-    {
-        $this->verify_cpt_object();
-        add_meta_box(
-            'espresso_event_editor_tickets',
-            esc_html__('Event Datetime & Ticket', 'event_espresso'),
-            [$this, 'ticket_metabox'],
-            $this->page_slug,
-            'normal',
-            'high'
-        );
-        add_meta_box(
-            'espresso_event_editor_event_options',
-            esc_html__('Event Registration Options', 'event_espresso'),
-            [$this, 'registration_options_meta_box'],
-            $this->page_slug,
-            'side'
-        );
-        // NOTE: if you're looking for other metaboxes in here,
-        // where a metabox has a related management page in the admin
-        // you will find it setup in the related management page's "_Hooks" file.
-        // i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function ticket_metabox()
-    {
-        $existing_datetime_ids = $existing_ticket_ids = [];
-        // defaults for template args
-        $template_args = [
-            'existing_datetime_ids'    => '',
-            'event_datetime_help_link' => '',
-            'ticket_options_help_link' => '',
-            'time'                     => null,
-            'ticket_rows'              => '',
-            'existing_ticket_ids'      => '',
-            'total_ticket_rows'        => 1,
-            'ticket_js_structure'      => '',
-            'trash_icon'               => 'ee-lock-icon',
-            'disabled'                 => '',
-        ];
-        $event_id      = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
-        /**
-         * 1. Start with retrieving Datetimes
-         * 2. Fore each datetime get related tickets
-         * 3. For each ticket get related prices
-         */
-        $times          = EEM_Datetime::instance()->get_all_event_dates($event_id);
-        $first_datetime = reset($times);
-        // do we get related tickets?
-        if (
-            $first_datetime instanceof EE_Datetime
-            && $first_datetime->ID() !== 0
-        ) {
-            $existing_datetime_ids[] = $first_datetime->get('DTT_ID');
-            $template_args['time']   = $first_datetime;
-            $related_tickets         = $first_datetime->tickets(
-                [
-                    ['OR' => ['TKT_deleted' => 1, 'TKT_deleted*' => 0]],
-                    'default_where_conditions' => 'none',
-                ]
-            );
-            if (! empty($related_tickets)) {
-                $template_args['total_ticket_rows'] = count($related_tickets);
-                $row                                = 0;
-                foreach ($related_tickets as $ticket) {
-                    $existing_ticket_ids[]        = $ticket->get('TKT_ID');
-                    $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
-                    $row++;
-                }
-            } else {
-                $template_args['total_ticket_rows'] = 1;
-                /** @type EE_Ticket $ticket */
-                $ticket                       = EEM_Ticket::instance()->create_default_object();
-                $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
-            }
-        } else {
-            $template_args['time']        = $times[0];
-            $tickets                      = EEM_Ticket::instance()->get_all_default_tickets();
-            $template_args['ticket_rows'] .= $this->_get_ticket_row($tickets[1]);
-            // NOTE: we're just sending the first default row
-            // (decaf can't manage default tickets so this should be sufficient);
-        }
-        $template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
-            'event_editor_event_datetimes_help_tab'
-        );
-        $template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
-        $template_args['existing_datetime_ids']    = implode(',', $existing_datetime_ids);
-        $template_args['existing_ticket_ids']      = implode(',', $existing_ticket_ids);
-        $template_args['ticket_js_structure']      = $this->_get_ticket_row(
-            EEM_Ticket::instance()->create_default_object(),
-            true
-        );
-        $template                                  = apply_filters(
-            'FHEE__Events_Admin_Page__ticket_metabox__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
-        );
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    /**
-     * Setup an individual ticket form for the decaf event editor page
-     *
-     * @access private
-     * @param EE_Ticket $ticket   the ticket object
-     * @param boolean   $skeleton whether we're generating a skeleton for js manipulation
-     * @param int       $row
-     * @return string generated html for the ticket row.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
-    {
-        $template_args = [
-            'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
-            'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
-                : '',
-            'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
-            'TKT_ID'              => $ticket->get('TKT_ID'),
-            'TKT_name'            => $ticket->get('TKT_name'),
-            'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
-            'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
-            'TKT_is_default'      => $ticket->get('TKT_is_default'),
-            'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
-            'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
-            'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
-            'trash_icon'          => ($skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')))
-                                     && (! empty($ticket) && $ticket->get('TKT_sold') === 0)
-                ? 'trash-icon dashicons dashicons-post-trash clickable' : 'ee-lock-icon',
-            'disabled'            => $skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
-                : ' disabled=disabled',
-        ];
-        $price         = $ticket->ID() !== 0
-            ? $ticket->get_first_related('Price', ['default_where_conditions' => 'none'])
-            : null;
-        $price         = $price instanceof EE_Price
-            ? $price
-            : EEM_Price::instance()->create_default_object();
-        $price_args    = [
-            'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
-            'PRC_amount'            => $price->get('PRC_amount'),
-            'PRT_ID'                => $price->get('PRT_ID'),
-            'PRC_ID'                => $price->get('PRC_ID'),
-            'PRC_is_default'        => $price->get('PRC_is_default'),
-        ];
-        // make sure we have default start and end dates if skeleton
-        // handle rows that should NOT be empty
-        if (empty($template_args['TKT_start_date'])) {
-            // if empty then the start date will be now.
-            $template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
-        }
-        if (empty($template_args['TKT_end_date'])) {
-            // get the earliest datetime (if present);
-            $earliest_datetime             = $this->_cpt_model_obj->ID() > 0
-                ? $this->_cpt_model_obj->get_first_related(
-                    'Datetime',
-                    ['order_by' => ['DTT_EVT_start' => 'ASC']]
-                )
-                : null;
-            $template_args['TKT_end_date'] = $earliest_datetime instanceof EE_Datetime
-                ? $earliest_datetime->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a')
-                : date('Y-m-d h:i a', mktime(0, 0, 0, date('m'), date('d') + 7, date('Y')));
-        }
-        $template_args = array_merge($template_args, $price_args);
-        $template      = apply_filters(
-            'FHEE__Events_Admin_Page__get_ticket_row__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
-            $ticket
-        );
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function registration_options_meta_box()
-    {
-        $yes_no_values             = [
-            ['id' => true, 'text' => esc_html__('Yes', 'event_espresso')],
-            ['id' => false, 'text' => esc_html__('No', 'event_espresso')],
-        ];
-        $default_reg_status_values = EEM_Registration::reg_status_array(
-            [
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-            ],
-            true
-        );
-        // $template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
-        $template_args['_event']                          = $this->_cpt_model_obj;
-        $template_args['event']                           = $this->_cpt_model_obj;
-        $template_args['active_status']                   = $this->_cpt_model_obj->pretty_active_status(false);
-        $template_args['additional_limit']                = $this->_cpt_model_obj->additional_limit();
-        $template_args['default_registration_status']     = EEH_Form_Fields::select_input(
-            'default_reg_status',
-            $default_reg_status_values,
-            $this->_cpt_model_obj->default_registration_status()
-        );
-        $template_args['display_description']             = EEH_Form_Fields::select_input(
-            'display_desc',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_description()
-        );
-        $template_args['display_ticket_selector']         = EEH_Form_Fields::select_input(
-            'display_ticket_selector',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_ticket_selector(),
-            '',
-            '',
-            false
-        );
-        $template_args['additional_registration_options'] = apply_filters(
-            'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
-            '',
-            $template_args,
-            $yes_no_values,
-            $default_reg_status_values
-        );
-        EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php',
-            $template_args
-        );
-    }
-
-
-    /**
-     * _get_events()
-     * This method simply returns all the events (for the given _view and paging)
-     *
-     * @access public
-     * @param int  $per_page     count of items per page (20 default);
-     * @param int  $current_page what is the current page being viewed.
-     * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
-     *                           If FALSE then we return an array of event objects
-     *                           that match the given _view and paging parameters.
-     * @return array|int         an array of event objects or a count of them.
-     * @throws Exception
-     */
-    public function get_events($per_page = 10, $current_page = 1, $count = false)
-    {
-        $EEM_Event   = $this->_event_model();
-        $offset      = ($current_page - 1) * $per_page;
-        $limit       = $count ? null : $offset . ',' . $per_page;
-        $orderby     = $this->request->getRequestParam('orderby', 'EVT_ID');
-        $order       = $this->request->getRequestParam('order', 'DESC');
-        $month_range = $this->request->getRequestParam('month_range');
-        if ($month_range) {
-            $pieces = explode(' ', $month_range, 3);
-            // simulate the FIRST day of the month, that fixes issues for months like February
-            // where PHP doesn't know what to assume for date.
-            // @see https://events.codebasehq.com/projects/event-espresso/tickets/10437
-            $month_r = ! empty($pieces[0]) ? date('m', EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
-            $year_r  = ! empty($pieces[1]) ? $pieces[1] : '';
-        }
-        $where  = [];
-        $status = $this->request->getRequestParam('status');
-        // determine what post_status our condition will have for the query.
-        switch ($status) {
-            case 'month':
-            case 'today':
-            case null:
-            case 'all':
-                break;
-            case 'draft':
-                $where['status'] = ['IN', ['draft', 'auto-draft']];
-                break;
-            default:
-                $where['status'] = $status;
-        }
-        // categories? The default for all categories is -1
-        $category = $this->request->getRequestParam('EVT_CAT', -1, 'int');
-        if ($category !== -1) {
-            $where['Term_Taxonomy.taxonomy'] = EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY;
-            $where['Term_Taxonomy.term_id']  = $category;
-        }
-        // date where conditions
-        $start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
-        if ($month_range) {
-            $DateTime = new DateTime(
-                $year_r . '-' . $month_r . '-01 00:00:00',
-                new DateTimeZone('UTC')
-            );
-            $start    = $DateTime->getTimestamp();
-            // set the datetime to be the end of the month
-            $DateTime->setDate(
-                $year_r,
-                $month_r,
-                $DateTime->format('t')
-            )->setTime(23, 59, 59);
-            $end                             = $DateTime->getTimestamp();
-            $where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
-        } elseif ($status === 'today') {
-            $DateTime                        =
-                new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
-            $start                           = $DateTime->setTime(0, 0)->format(implode(' ', $start_formats));
-            $end                             = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
-        } elseif ($status === 'month') {
-            $now                             = date('Y-m-01');
-            $DateTime                        =
-                new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
-            $start                           = $DateTime->setTime(0, 0)->format(implode(' ', $start_formats));
-            $end                             = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
-                                                        ->setTime(23, 59, 59)
-                                                        ->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
-        }
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
-            $where['EVT_wp_user'] = get_current_user_id();
-        } else {
-            if (! isset($where['status'])) {
-                if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
-                    $where['OR'] = [
-                        'status*restrict_private' => ['!=', 'private'],
-                        'AND'                     => [
-                            'status*inclusive' => ['=', 'private'],
-                            'EVT_wp_user'      => get_current_user_id(),
-                        ],
-                    ];
-                }
-            }
-        }
-        $wp_user = $this->request->getRequestParam('EVT_wp_user', 0, 'int');
-        if (
-            $wp_user
-            && $wp_user !== get_current_user_id()
-            && EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
-        ) {
-            $where['EVT_wp_user'] = $wp_user;
-        }
-        // search query handling
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $where['OR'] = [
-                'EVT_name'       => ['LIKE', $search_term],
-                'EVT_desc'       => ['LIKE', $search_term],
-                'EVT_short_desc' => ['LIKE', $search_term],
-            ];
-        }
-        // filter events by venue.
-        $venue = $this->request->getRequestParam('venue', 0, 'int');
-        if ($venue) {
-            $where['Venue.VNU_ID'] = $venue;
-        }
-        $request_params = $this->request->requestParams();
-        $where          = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $request_params);
-        $query_params   = apply_filters(
-            'FHEE__Events_Admin_Page__get_events__query_params',
-            [
-                $where,
-                'limit'    => $limit,
-                'order_by' => $orderby,
-                'order'    => $order,
-                'group_by' => 'EVT_ID',
-            ],
-            $request_params
-        );
-
-        // let's first check if we have special requests coming in.
-        $active_status = $this->request->getRequestParam('active_status');
-        if ($active_status) {
-            switch ($active_status) {
-                case 'upcoming':
-                    return $EEM_Event->get_upcoming_events($query_params, $count);
-                case 'expired':
-                    return $EEM_Event->get_expired_events($query_params, $count);
-                case 'active':
-                    return $EEM_Event->get_active_events($query_params, $count);
-                case 'inactive':
-                    return $EEM_Event->get_inactive_events($query_params, $count);
-            }
-        }
-
-        return $count ? $EEM_Event->count([$where], 'EVT_ID', true) : $EEM_Event->get_all($query_params);
-    }
-
-
-    /**
-     * handling for WordPress CPT actions (trash, restore, delete)
-     *
-     * @param string $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function trash_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('EVT_ID', $post_id);
-        $this->_trash_or_restore_event('trash', false);
-    }
-
-
-    /**
-     * @param string $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function restore_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('EVT_ID', $post_id);
-        $this->_trash_or_restore_event('draft', false);
-    }
-
-
-    /**
-     * @param string $post_id
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function delete_cpt_item($post_id)
-    {
-        throw new EE_Error(
-            esc_html__(
-                'Please contact Event Espresso support with the details of the steps taken to produce this error.',
-                'event_espresso'
-            )
-        );
-        // $this->request->setRequestParam('EVT_ID', $post_id);
-        // $this->_delete_event();
-    }
-
-
-    /**
-     * _trash_or_restore_event
-     *
-     * @access protected
-     * @param string $event_status
-     * @param bool   $redirect_after
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true)
-    {
-        // determine the event id and set to array.
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        // loop thru events
-        if ($EVT_ID) {
-            // clean status
-            $event_status = sanitize_key($event_status);
-            // grab status
-            if (! empty($event_status)) {
-                $success = $this->_change_event_status($EVT_ID, $event_status);
-            } else {
-                $success = false;
-                $msg     = esc_html__(
-                    'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        $action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Event', $action, ['action' => 'default']);
-        }
-    }
-
-
-    /**
-     * _trash_or_restore_events
-     *
-     * @access protected
-     * @param string $event_status
-     * @return void
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_events($event_status = 'trash')
-    {
-        // clean status
-        $event_status = sanitize_key($event_status);
-        // grab status
-        if (! empty($event_status)) {
-            $success = true;
-            // determine the event id and set to array.
-            $EVT_IDs = $this->request->getRequestParam('EVT_IDs', [], 'int', true);
-            // loop thru events
-            foreach ($EVT_IDs as $EVT_ID) {
-                if ($EVT_ID = absint($EVT_ID)) {
-                    $results = $this->_change_event_status($EVT_ID, $event_status);
-                    $success = $results !== false ? $success : false;
-                } else {
-                    $msg = sprintf(
-                        esc_html__(
-                            'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
-                            'event_espresso'
-                        ),
-                        $EVT_ID
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                    $success = false;
-                }
-            }
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $action  = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-        $this->_redirect_after_action($success, 'Events', $action, ['action' => 'default']);
-    }
-
-
-    /**
-     * @param int    $EVT_ID
-     * @param string $event_status
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _change_event_status($EVT_ID = 0, $event_status = '')
-    {
-        // grab event id
-        if (! $EVT_ID) {
-            $msg = esc_html__(
-                'An error occurred. No Event ID or an invalid Event ID was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        // clean status
-        $event_status = sanitize_key($event_status);
-        // grab status
-        if (empty($event_status)) {
-            $msg = esc_html__(
-                'An error occurred. No Event Status or an invalid Event Status was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // was event trashed or restored ?
-        switch ($event_status) {
-            case 'draft':
-                $action = 'restored from the trash';
-                $hook   = 'AHEE_event_restored_from_trash';
-                break;
-            case 'trash':
-                $action = 'moved to the trash';
-                $hook   = 'AHEE_event_moved_to_trash';
-                break;
-            default:
-                $action = 'updated';
-                $hook   = false;
-        }
-        // use class to change status
-        $this->_cpt_model_obj->set_status($event_status);
-        $success = $this->_cpt_model_obj->save();
-        if (! $success) {
-            $msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if ($hook) {
-            do_action($hook);
-        }
-        return true;
-    }
-
-
-    /**
-     * @param array $event_ids
-     * @return array
-     * @since   4.10.23.p
-     */
-    private function cleanEventIds(array $event_ids)
-    {
-        return array_map('absint', $event_ids);
-    }
-
-
-    /**
-     * @return array
-     * @since   4.10.23.p
-     */
-    private function getEventIdsFromRequest()
-    {
-        if ($this->request->requestParamIsSet('EVT_IDs')) {
-            return $this->request->getRequestParam('EVT_IDs', [], 'int', true);
-        } else {
-            return $this->request->getRequestParam('EVT_ID', [], 'int', true);
-        }
-    }
-
-
-    /**
-     * @param bool $preview_delete
-     * @throws EE_Error
-     */
-    protected function _delete_event($preview_delete = true)
-    {
-        $this->_delete_events($preview_delete);
-    }
-
-
-    /**
-     * Gets the tree traversal batch persister.
-     *
-     * @return NodeGroupDao
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.10.12.p
-     */
-    protected function getModelObjNodeGroupPersister()
-    {
-        if (! $this->model_obj_node_group_persister instanceof NodeGroupDao) {
-            $this->model_obj_node_group_persister =
-                $this->getLoader()->load('\EventEspresso\core\services\orm\tree_traversal\NodeGroupDao');
-        }
-        return $this->model_obj_node_group_persister;
-    }
-
-
-    /**
-     * @param bool $preview_delete
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _delete_events($preview_delete = true)
-    {
-        $event_ids = $this->getEventIdsFromRequest();
-        if ($preview_delete) {
-            $this->generateDeletionPreview($event_ids);
-        } else {
-            EEM_Event::instance()->delete_permanently([['EVT_ID' => ['IN', $event_ids]]]);
-        }
-    }
-
-
-    /**
-     * @param array $event_ids
-     */
-    protected function generateDeletionPreview(array $event_ids)
-    {
-        $event_ids = $this->cleanEventIds($event_ids);
-        // Set a code we can use to reference this deletion task in the batch jobs and preview page.
-        $deletion_job_code = $this->getModelObjNodeGroupPersister()->generateGroupCode();
-        $return_url        = EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'action'            => 'preview_deletion',
-                'deletion_job_code' => $deletion_job_code,
-            ],
-            $this->_admin_base_url
-        );
-        EEH_URL::safeRedirectAndExit(
-            EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'page'              => 'espresso_batch',
-                    'batch'             => EED_Batch::batch_job,
-                    'EVT_IDs'           => $event_ids,
-                    'deletion_job_code' => $deletion_job_code,
-                    'job_handler'       => urlencode('EventEspressoBatchRequest\JobHandlers\PreviewEventDeletion'),
-                    'return_url'        => urlencode($return_url),
-                ],
-                admin_url()
-            )
-        );
-    }
-
-
-    /**
-     * Checks for a POST submission
-     *
-     * @since 4.10.12.p
-     */
-    protected function confirmDeletion()
-    {
-        $deletion_redirect_logic =
-            $this->getLoader()->getShared('\EventEspresso\core\domain\services\admin\events\data\ConfirmDeletion');
-        $deletion_redirect_logic->handle($this->get_request_data(), $this->admin_base_url());
-    }
-
-
-    /**
-     * A page for users to preview what exactly will be deleted, and confirm they want to delete it.
-     *
-     * @throws EE_Error
-     * @since 4.10.12.p
-     */
-    protected function previewDeletion()
-    {
-        $preview_deletion_logic =
-            $this->getLoader()->getShared('\EventEspresso\core\domain\services\admin\events\data\PreviewDeletion');
-        $this->set_template_args($preview_deletion_logic->handle($this->get_request_data(), $this->admin_base_url()));
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     * get total number of events
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function total_events()
-    {
-        return EEM_Event::instance()->count(
-            ['caps' => 'read_admin'],
-            'EVT_ID',
-            true
-        );
-    }
-
-
-    /**
-     * get total number of draft events
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function total_events_draft()
-    {
-        return EEM_Event::instance()->count(
-            [
-                ['status' => ['IN', ['draft', 'auto-draft']]],
-                'caps' => 'read_admin',
-            ],
-            'EVT_ID',
-            true
-        );
-    }
-
-
-    /**
-     * get total number of trashed events
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function total_trashed_events()
-    {
-        return EEM_Event::instance()->count(
-            [
-                ['status' => 'trash'],
-                'caps' => 'read_admin',
-            ],
-            'EVT_ID',
-            true
-        );
-    }
-
-
-    /**
-     *    _default_event_settings
-     *    This generates the Default Settings Tab
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _default_event_settings()
-    {
-        $this->_set_add_edit_form_tags('update_default_event_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = $this->_default_event_settings_form()->get_html();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Return the form for event settings.
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function _default_event_settings_form()
-    {
-        $registration_config              = EE_Registry::instance()->CFG->registration;
-        $registration_stati_for_selection = EEM_Registration::reg_status_array(
-        // exclude
-            [
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_wait_list,
-            ],
-            true
-        );
-        return new EE_Form_Section_Proper(
-            [
-                'name'            => 'update_default_event_settings',
-                'html_id'         => 'update_default_event_settings',
-                'html_class'      => 'form-table',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
-                    [
-                        'default_reg_status'  => new EE_Select_Input(
-                            $registration_stati_for_selection,
-                            [
-                                'default'         => isset($registration_config->default_STS_ID)
-                                                     && array_key_exists(
-                                                         $registration_config->default_STS_ID,
-                                                         $registration_stati_for_selection
-                                                     )
-                                    ? sanitize_text_field($registration_config->default_STS_ID)
-                                    : EEM_Registration::status_id_pending_payment,
-                                'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
-                                                     . EEH_Template::get_help_tab_link(
-                                                         'default_settings_status_help_tab'
-                                                     ),
-                                'html_help_text'  => esc_html__(
-                                    '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.',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                        'default_max_tickets' => new EE_Integer_Input(
-                            [
-                                'default'         => isset($registration_config->default_maximum_number_of_tickets)
-                                    ? $registration_config->default_maximum_number_of_tickets
-                                    : EEM_Event::get_default_additional_limit(),
-                                'html_label_text' => esc_html__(
-                                    'Default Maximum Tickets Allowed Per Order:',
-                                    'event_espresso'
-                                )
-                                . EEH_Template::get_help_tab_link(
-                                    'default_maximum_tickets_help_tab"'
-                                ),
-                                'html_help_text'  => esc_html__(
-                                    'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * _update_default_event_settings
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _update_default_event_settings()
-    {
-        $registration_config = EE_Registry::instance()->CFG->registration;
-        $form                = $this->_default_event_settings_form();
-        if ($form->was_submitted()) {
-            $form->receive_form_submission();
-            if ($form->is_valid()) {
-                $valid_data = $form->valid_data();
-                if (isset($valid_data['default_reg_status'])) {
-                    $registration_config->default_STS_ID = $valid_data['default_reg_status'];
-                }
-                if (isset($valid_data['default_max_tickets'])) {
-                    $registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
-                }
-                // update because data was valid!
-                EE_Registry::instance()->CFG->update_espresso_config();
-                EE_Error::overwrite_success();
-                EE_Error::add_success(
-                    esc_html__('Default Event Settings were updated', 'event_espresso')
-                );
-            }
-        }
-        $this->_redirect_after_action(0, '', '', ['action' => 'default_event_settings'], true);
-    }
-
-
-    /*************        Templates        *************
-     *
-     * @throws EE_Error
-     */
-    protected function _template_settings()
-    {
-        $this->_admin_page_title              = esc_html__('Template Settings (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  = '<img src="'
-                                                . EVENTS_ASSETS_URL
-                                                . '/images/'
-                                                . 'caffeinated_template_features.jpg" alt="'
-                                                . esc_attr__('Template Settings Preview screenshot', 'event_espresso')
-                                                . '" />';
-        $this->_template_args['preview_text'] = '<strong>'
-                                                . esc_html__(
-                                                    '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.',
-                                                    'event_espresso'
-                                                ) . '</strong>';
-        $this->display_admin_caf_preview_page('template_settings_tab');
-    }
-
-
-    /** Event Category Stuff **/
-    /**
-     * set the _category property with the category object for the loaded page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_category_object()
-    {
-        if (isset($this->_category->id) && ! empty($this->_category->id)) {
-            return;
-        } //already have the category object so get out.
-        // set default category object
-        $this->_set_empty_category_object();
-        // only set if we've got an id
-        $category_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
-        if (! $category_ID) {
-            return;
-        }
-        $term = get_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
-        if (! empty($term)) {
-            $this->_category->category_name       = $term->name;
-            $this->_category->category_identifier = $term->slug;
-            $this->_category->category_desc       = $term->description;
-            $this->_category->id                  = $term->term_id;
-            $this->_category->parent              = $term->parent;
-        }
-    }
-
-
-    /**
-     * Clears out category properties.
-     */
-    private function _set_empty_category_object()
-    {
-        $this->_category                = new stdClass();
-        $this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
-        $this->_category->id            = $this->_category->parent = 0;
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _category_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_search_btn_label = esc_html__('Categories', 'event_espresso');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-            'add_category',
-            'add_category',
-            [],
-            'add-new-h2'
-        );
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * Output category details view.
-     *
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function _category_details($view)
-    {
-        // load formatter helper
-        // load field generator helper
-        $route = $view == 'edit' ? 'update_category' : 'insert_category';
-        $this->_set_add_edit_form_tags($route);
-        $this->_set_category_object();
-        $id            = ! empty($this->_category->id) ? $this->_category->id : '';
-        $delete_action = 'delete_category';
-        // custom redirect
-        $redirect = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'category_list'],
-            $this->_admin_base_url
-        );
-        $this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect);
-        // take care of contents
-        $this->_template_args['admin_page_content'] = $this->_category_details_content();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Output category details content.
-     */
-    protected function _category_details_content()
-    {
-        $editor_args['category_desc'] = [
-            'type'          => 'wp_editor',
-            'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
-            'class'         => 'my_editor_custom',
-            'wpeditor_args' => ['media_buttons' => false],
-        ];
-        $_wp_editor                   = $this->_generate_admin_form_fields($editor_args, 'array');
-        $all_terms                    = get_terms(
-            [EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY],
-            ['hide_empty' => 0, 'exclude' => [$this->_category->id]]
-        );
-        // setup category select for term parents.
-        $category_select_values[] = [
-            'text' => esc_html__('No Parent', 'event_espresso'),
-            'id'   => 0,
-        ];
-        foreach ($all_terms as $term) {
-            $category_select_values[] = [
-                'text' => $term->name,
-                'id'   => $term->term_id,
-            ];
-        }
-        $category_select = EEH_Form_Fields::select_input(
-            'category_parent',
-            $category_select_values,
-            $this->_category->parent
-        );
-        $template_args   = [
-            'category'                 => $this->_category,
-            'category_select'          => $category_select,
-            'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
-            'category_desc_editor'     => $_wp_editor['category_desc']['field'],
-            'disable'                  => '',
-            'disabled_message'         => false,
-        ];
-        $template        = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * Handles deleting categories.
-     *
-     * @throws EE_Error
-     */
-    protected function _delete_categories()
-    {
-        $category_IDs = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int', true);
-        foreach ($category_IDs as $category_ID) {
-            $this->_delete_category($category_ID);
-        }
-        // doesn't matter what page we're coming from... we're going to the same place after delete.
-        $query_args = [
-            'action' => 'category_list',
-        ];
-        $this->_redirect_after_action(0, '', '', $query_args);
-    }
-
-
-    /**
-     * Handles deleting specific category.
-     *
-     * @param int $cat_id
-     */
-    protected function _delete_category($cat_id)
-    {
-        $cat_id = absint($cat_id);
-        wp_delete_term($cat_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
-    }
-
-
-    /**
-     * Handles triggering the update or insertion of a new category.
-     *
-     * @param bool $new_category true means we're triggering the insert of a new category.
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function _insert_or_update_category($new_category)
-    {
-        $cat_id  = $new_category ? $this->_insert_category() : $this->_insert_category(true);
-        $success = 0; // we already have a success message so lets not send another.
-        if ($cat_id) {
-            $query_args = [
-                'action'     => 'edit_category',
-                'EVT_CAT_ID' => $cat_id,
-            ];
-        } else {
-            $query_args = ['action' => 'add_category'];
-        }
-        $this->_redirect_after_action($success, '', '', $query_args, true);
-    }
-
-
-    /**
-     * Inserts or updates category
-     *
-     * @param bool $update (true indicates we're updating a category).
-     * @return bool|mixed|string
-     */
-    private function _insert_category($update = false)
-    {
-        $category_ID         = $update ? $this->request->getRequestParam('EVT_CAT_ID', 0, 'int') : 0;
-        $category_name       = $this->request->getRequestParam('category_name', '');
-        $category_desc       = $this->request->getRequestParam('category_desc', '');
-        $category_parent     = $this->request->getRequestParam('category_parent', 0, 'int');
-        $category_identifier = $this->request->getRequestParam('category_identifier', '');
-
-        if (empty($category_name)) {
-            $msg = esc_html__('You must add a name for the category.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $term_args = [
-            'name'        => $category_name,
-            'description' => $category_desc,
-            'parent'      => $category_parent,
-        ];
-        // was the category_identifier input disabled?
-        if ($category_identifier) {
-            $term_args['slug'] = $category_identifier;
-        }
-        $insert_ids = $update
-            ? wp_update_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args)
-            : wp_insert_term($category_name, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args);
-        if (! is_array($insert_ids)) {
-            $msg = esc_html__(
-                'An error occurred and the category has not been saved to the database.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        } else {
-            $category_ID = $insert_ids['term_id'];
-            $msg         =
-                sprintf(esc_html__('The category %s was successfully saved', 'event_espresso'), $category_name);
-            EE_Error::add_success($msg);
-        }
-        return $category_ID;
-    }
-
-
-    /**
-     * Gets categories or count of categories matching the arguments in the request.
-     *
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return EE_Term_Taxonomy[]|int
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function get_categories($per_page = 10, $current_page = 1, $count = false)
-    {
-        // testing term stuff
-        $orderby     = $this->request->getRequestParam('orderby', 'Term.term_id');
-        $order       = $this->request->getRequestParam('order', 'DESC');
-        $limit       = ($current_page - 1) * $per_page;
-        $where       = ['taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY];
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $where['OR'] = [
-                'Term.name'   => ['LIKE', $search_term],
-                'description' => ['LIKE', $search_term],
-            ];
-        }
-        $query_params = [
-            $where,
-            'order_by'   => [$orderby => $order],
-            'limit'      => $limit . ',' . $per_page,
-            'force_join' => ['Term'],
-        ];
-        return $count
-            ? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
-            : EEM_Term_Taxonomy::instance()->get_all($query_params);
-    }
-
-    /* end category stuff */
-    /**************/
-
-
-    /**
-     * Callback for the `ee_save_timezone_setting` ajax action.
-     *
-     * @throws EE_Error
-     */
-    public function saveTimezoneString()
-    {
-        $timezone_string = $this->request->getRequestParam('timezone_selected');
-        if (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false)) {
-            EE_Error::add_error(
-                esc_html__('An invalid timezone string submitted.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-
-        update_option('timezone_string', $timezone_string);
-        EE_Error::add_success(
-            esc_html__('Your timezone string was updated.', 'event_espresso')
-        );
-        $this->_template_args['success'] = true;
-        $this->_return_json(true, ['action' => 'create_new']);
-    }
-
-
-    /**
      * @throws EE_Error
-     * @deprecated 4.10.25.p
      */
-    public function save_timezonestring_setting()
-    {
-        $this->saveTimezoneString();
-    }
+	protected function _template_settings()
+	{
+		$this->_admin_page_title              = esc_html__('Template Settings (Preview)', 'event_espresso');
+		$this->_template_args['preview_img']  = '<img src="'
+												. EVENTS_ASSETS_URL
+												. '/images/'
+												. 'caffeinated_template_features.jpg" alt="'
+												. esc_attr__('Template Settings Preview screenshot', 'event_espresso')
+												. '" />';
+		$this->_template_args['preview_text'] = '<strong>'
+												. esc_html__(
+													'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.',
+													'event_espresso'
+												) . '</strong>';
+		$this->display_admin_caf_preview_page('template_settings_tab');
+	}
+
+
+	/** Event Category Stuff **/
+	/**
+	 * set the _category property with the category object for the loaded page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_category_object()
+	{
+		if (isset($this->_category->id) && ! empty($this->_category->id)) {
+			return;
+		} //already have the category object so get out.
+		// set default category object
+		$this->_set_empty_category_object();
+		// only set if we've got an id
+		$category_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
+		if (! $category_ID) {
+			return;
+		}
+		$term = get_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
+		if (! empty($term)) {
+			$this->_category->category_name       = $term->name;
+			$this->_category->category_identifier = $term->slug;
+			$this->_category->category_desc       = $term->description;
+			$this->_category->id                  = $term->term_id;
+			$this->_category->parent              = $term->parent;
+		}
+	}
+
+
+	/**
+	 * Clears out category properties.
+	 */
+	private function _set_empty_category_object()
+	{
+		$this->_category                = new stdClass();
+		$this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
+		$this->_category->id            = $this->_category->parent = 0;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _category_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_search_btn_label = esc_html__('Categories', 'event_espresso');
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+			'add_category',
+			'add_category',
+			[],
+			'add-new-h2'
+		);
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * Output category details view.
+	 *
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function _category_details($view)
+	{
+		// load formatter helper
+		// load field generator helper
+		$route = $view == 'edit' ? 'update_category' : 'insert_category';
+		$this->_set_add_edit_form_tags($route);
+		$this->_set_category_object();
+		$id            = ! empty($this->_category->id) ? $this->_category->id : '';
+		$delete_action = 'delete_category';
+		// custom redirect
+		$redirect = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'category_list'],
+			$this->_admin_base_url
+		);
+		$this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect);
+		// take care of contents
+		$this->_template_args['admin_page_content'] = $this->_category_details_content();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Output category details content.
+	 */
+	protected function _category_details_content()
+	{
+		$editor_args['category_desc'] = [
+			'type'          => 'wp_editor',
+			'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
+			'class'         => 'my_editor_custom',
+			'wpeditor_args' => ['media_buttons' => false],
+		];
+		$_wp_editor                   = $this->_generate_admin_form_fields($editor_args, 'array');
+		$all_terms                    = get_terms(
+			[EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY],
+			['hide_empty' => 0, 'exclude' => [$this->_category->id]]
+		);
+		// setup category select for term parents.
+		$category_select_values[] = [
+			'text' => esc_html__('No Parent', 'event_espresso'),
+			'id'   => 0,
+		];
+		foreach ($all_terms as $term) {
+			$category_select_values[] = [
+				'text' => $term->name,
+				'id'   => $term->term_id,
+			];
+		}
+		$category_select = EEH_Form_Fields::select_input(
+			'category_parent',
+			$category_select_values,
+			$this->_category->parent
+		);
+		$template_args   = [
+			'category'                 => $this->_category,
+			'category_select'          => $category_select,
+			'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
+			'category_desc_editor'     => $_wp_editor['category_desc']['field'],
+			'disable'                  => '',
+			'disabled_message'         => false,
+		];
+		$template        = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * Handles deleting categories.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _delete_categories()
+	{
+		$category_IDs = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int', true);
+		foreach ($category_IDs as $category_ID) {
+			$this->_delete_category($category_ID);
+		}
+		// doesn't matter what page we're coming from... we're going to the same place after delete.
+		$query_args = [
+			'action' => 'category_list',
+		];
+		$this->_redirect_after_action(0, '', '', $query_args);
+	}
+
+
+	/**
+	 * Handles deleting specific category.
+	 *
+	 * @param int $cat_id
+	 */
+	protected function _delete_category($cat_id)
+	{
+		$cat_id = absint($cat_id);
+		wp_delete_term($cat_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
+	}
+
+
+	/**
+	 * Handles triggering the update or insertion of a new category.
+	 *
+	 * @param bool $new_category true means we're triggering the insert of a new category.
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function _insert_or_update_category($new_category)
+	{
+		$cat_id  = $new_category ? $this->_insert_category() : $this->_insert_category(true);
+		$success = 0; // we already have a success message so lets not send another.
+		if ($cat_id) {
+			$query_args = [
+				'action'     => 'edit_category',
+				'EVT_CAT_ID' => $cat_id,
+			];
+		} else {
+			$query_args = ['action' => 'add_category'];
+		}
+		$this->_redirect_after_action($success, '', '', $query_args, true);
+	}
+
+
+	/**
+	 * Inserts or updates category
+	 *
+	 * @param bool $update (true indicates we're updating a category).
+	 * @return bool|mixed|string
+	 */
+	private function _insert_category($update = false)
+	{
+		$category_ID         = $update ? $this->request->getRequestParam('EVT_CAT_ID', 0, 'int') : 0;
+		$category_name       = $this->request->getRequestParam('category_name', '');
+		$category_desc       = $this->request->getRequestParam('category_desc', '');
+		$category_parent     = $this->request->getRequestParam('category_parent', 0, 'int');
+		$category_identifier = $this->request->getRequestParam('category_identifier', '');
+
+		if (empty($category_name)) {
+			$msg = esc_html__('You must add a name for the category.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$term_args = [
+			'name'        => $category_name,
+			'description' => $category_desc,
+			'parent'      => $category_parent,
+		];
+		// was the category_identifier input disabled?
+		if ($category_identifier) {
+			$term_args['slug'] = $category_identifier;
+		}
+		$insert_ids = $update
+			? wp_update_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args)
+			: wp_insert_term($category_name, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args);
+		if (! is_array($insert_ids)) {
+			$msg = esc_html__(
+				'An error occurred and the category has not been saved to the database.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		} else {
+			$category_ID = $insert_ids['term_id'];
+			$msg         =
+				sprintf(esc_html__('The category %s was successfully saved', 'event_espresso'), $category_name);
+			EE_Error::add_success($msg);
+		}
+		return $category_ID;
+	}
+
+
+	/**
+	 * Gets categories or count of categories matching the arguments in the request.
+	 *
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return EE_Term_Taxonomy[]|int
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function get_categories($per_page = 10, $current_page = 1, $count = false)
+	{
+		// testing term stuff
+		$orderby     = $this->request->getRequestParam('orderby', 'Term.term_id');
+		$order       = $this->request->getRequestParam('order', 'DESC');
+		$limit       = ($current_page - 1) * $per_page;
+		$where       = ['taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY];
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$where['OR'] = [
+				'Term.name'   => ['LIKE', $search_term],
+				'description' => ['LIKE', $search_term],
+			];
+		}
+		$query_params = [
+			$where,
+			'order_by'   => [$orderby => $order],
+			'limit'      => $limit . ',' . $per_page,
+			'force_join' => ['Term'],
+		];
+		return $count
+			? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
+			: EEM_Term_Taxonomy::instance()->get_all($query_params);
+	}
+
+	/* end category stuff */
+	/**************/
+
+
+	/**
+	 * Callback for the `ee_save_timezone_setting` ajax action.
+	 *
+	 * @throws EE_Error
+	 */
+	public function saveTimezoneString()
+	{
+		$timezone_string = $this->request->getRequestParam('timezone_selected');
+		if (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false)) {
+			EE_Error::add_error(
+				esc_html__('An invalid timezone string submitted.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+
+		update_option('timezone_string', $timezone_string);
+		EE_Error::add_success(
+			esc_html__('Your timezone string was updated.', 'event_espresso')
+		);
+		$this->_template_args['success'] = true;
+		$this->_return_json(true, ['action' => 'create_new']);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @deprecated 4.10.25.p
+	 */
+	public function save_timezonestring_setting()
+	{
+		$this->saveTimezoneString();
+	}
 }

modules/single_page_checkout/EED_Single_Page_Checkout.module.php

Indentation +1788 added lines, -1788 removed lines

@@ -19,1792 +19,1792 @@
  */
 class EED_Single_Page_Checkout extends EED_Module
 {
-    /**
-     * $_initialized - has the SPCO controller already been initialized ?
-     *
-     * @var bool $_initialized
-     */
-    private static $_initialized = false;
-
-
-    /**
-     * $_checkout_verified - is the EE_Checkout verified as correct for this request ?
-     *
-     * @var bool $_valid_checkout
-     */
-    private static $_checkout_verified = true;
-
-    /**
-     *    $_reg_steps_array - holds initial array of reg steps
-     *
-     * @var array $_reg_steps_array
-     */
-    private static $_reg_steps_array = array();
-
-    /**
-     *    $checkout - EE_Checkout object for handling the properties of the current checkout process
-     *
-     * @var EE_Checkout $checkout
-     */
-    public $checkout;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-
-    /**
-     * @return EED_Single_Page_Checkout|EED_Module
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance()
-    {
-        add_filter('EED_Single_Page_Checkout__SPCO_active', '__return_true');
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * @return EE_CART
-     */
-    public function cart()
-    {
-        return $this->checkout->cart;
-    }
-
-
-    /**
-     * @return RequestInterface
-     * @since   4.10.14.p
-     */
-    public static function getRequest()
-    {
-        return LoaderFactory::getLoader()->getShared(RequestInterface::class);
-    }
-
-
-    /**
-     * @return EE_Transaction
-     */
-    public function transaction()
-    {
-        return $this->checkout->transaction;
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function set_hooks()
-    {
-        EED_Single_Page_Checkout::set_definitions();
-    }
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function set_hooks_admin()
-    {
-        EED_Single_Page_Checkout::set_definitions();
-        if (! (defined('DOING_AJAX') && DOING_AJAX)) {
-            return;
-        }
-        // going to start an output buffer in case anything gets accidentally output
-        // that might disrupt our JSON response
-        ob_start();
-        EED_Single_Page_Checkout::load_reg_steps();
-        // set ajax hooks
-        add_action('wp_ajax_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step'));
-        add_action('wp_ajax_nopriv_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step'));
-        add_action('wp_ajax_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step'));
-        add_action('wp_ajax_nopriv_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step'));
-        add_action('wp_ajax_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step'));
-        add_action('wp_ajax_nopriv_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step'));
-    }
-
-
-    /**
-     *    process ajax request
-     *
-     * @param string $ajax_action
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function process_ajax_request($ajax_action)
-    {
-        $request = EED_Single_Page_Checkout::getRequest();
-        $request->setRequestParam('action', $ajax_action);
-        EED_Single_Page_Checkout::instance()->_initialize();
-    }
-
-
-    /**
-     * ajax display registration step
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function display_reg_step()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('display_spco_reg_step');
-    }
-
-
-    /**
-     * ajax process registration step
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function process_reg_step()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('process_reg_step');
-    }
-
-
-    /**
-     * ajax process registration step
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function update_reg_step()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('update_reg_step');
-    }
-
-
-    /**
-     * update_checkout
-     *
-     * @return void
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public static function update_checkout()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('update_checkout');
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 4.10.14.p
-     */
-    public static function load_request_handler()
-    {
-    }
-
-
-    /**
-     *    set_definitions
-     *
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function set_definitions()
-    {
-        if (defined('SPCO_BASE_PATH')) {
-            return;
-        }
-        define(
-            'SPCO_BASE_PATH',
-            rtrim(str_replace(array('\\', '/'), '/', plugin_dir_path(__FILE__)), '/') . '/'
-        );
-        define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css/');
-        define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img/');
-        define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js/');
-        define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc/');
-        define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps/');
-        define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates/');
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true);
-        EE_Registry::$i18n_js_strings['registration_expiration_notice'] = EED_Single_Page_Checkout::getRegistrationExpirationNotice(
-        );
-    }
-
-
-    /**
-     * load_reg_steps
-     * loads and instantiates each reg step based on the EE_Registry::instance()->CFG->registration->reg_steps array
-     *
-     * @throws EE_Error
-     */
-    public static function load_reg_steps()
-    {
-        static $reg_steps_loaded = false;
-        if ($reg_steps_loaded) {
-            return;
-        }
-        // filter list of reg_steps
-        $reg_steps_to_load = (array) apply_filters(
-            'AHEE__SPCO__load_reg_steps__reg_steps_to_load',
-            EED_Single_Page_Checkout::get_reg_steps()
-        );
-        // sort by key (order)
-        ksort($reg_steps_to_load);
-        // loop through folders
-        foreach ($reg_steps_to_load as $order => $reg_step) {
-            // we need a
-            if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
-                // copy over to the reg_steps_array
-                EED_Single_Page_Checkout::$_reg_steps_array[ $order ] = $reg_step;
-                // register custom key route for each reg step
-                // ie: step=>"slug" - this is the entire reason we load the reg steps array now
-                EE_Config::register_route(
-                    $reg_step['slug'],
-                    'EED_Single_Page_Checkout',
-                    'run',
-                    'step'
-                );
-                // add AJAX or other hooks
-                if (isset($reg_step['has_hooks']) && $reg_step['has_hooks']) {
-                    // setup autoloaders if necessary
-                    if (! class_exists($reg_step['class_name'])) {
-                        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(
-                            $reg_step['file_path'],
-                            true
-                        );
-                    }
-                    if (is_callable($reg_step['class_name'], 'set_hooks')) {
-                        call_user_func(array($reg_step['class_name'], 'set_hooks'));
-                    }
-                }
-            }
-        }
-        $reg_steps_loaded = true;
-    }
-
-
-    /**
-     *    get_reg_steps
-     *
-     * @return    array
-     */
-    public static function get_reg_steps()
-    {
-        $reg_steps = EE_Registry::instance()->CFG->registration->reg_steps;
-        if (empty($reg_steps)) {
-            $reg_steps = array(
-                10  => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'attendee_information',
-                    'class_name' => 'EE_SPCO_Reg_Step_Attendee_Information',
-                    'slug'       => 'attendee_information',
-                    'has_hooks'  => false,
-                ),
-                30  => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'payment_options',
-                    'class_name' => 'EE_SPCO_Reg_Step_Payment_Options',
-                    'slug'       => 'payment_options',
-                    'has_hooks'  => true,
-                ),
-                999 => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'finalize_registration',
-                    'class_name' => 'EE_SPCO_Reg_Step_Finalize_Registration',
-                    'slug'       => 'finalize_registration',
-                    'has_hooks'  => false,
-                ),
-            );
-        }
-        return $reg_steps;
-    }
-
-
-    /**
-     *    registration_checkout_for_admin
-     *
-     * @return    string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function registration_checkout_for_admin()
-    {
-        $request = EED_Single_Page_Checkout::getRequest();
-        $request->setRequestParam('step', 'attendee_information');
-        $request->setRequestParam('action', 'display_spco_reg_step');
-        $request->setRequestParam('process_form_submission', false);
-        EED_Single_Page_Checkout::instance()->_initialize();
-        EED_Single_Page_Checkout::instance()->_display_spco_reg_form();
-        return EED_Single_Page_Checkout::getResponse()->getOutput();
-    }
-
-
-    /**
-     * process_registration_from_admin
-     *
-     * @return EE_Transaction
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function process_registration_from_admin()
-    {
-        $request = EED_Single_Page_Checkout::getRequest();
-        $request->setRequestParam('step', 'attendee_information');
-        $request->setRequestParam('action', 'process_reg_step');
-        $request->setRequestParam('process_form_submission', true);
-        EED_Single_Page_Checkout::instance()->_initialize();
-        if (EED_Single_Page_Checkout::instance()->checkout->current_step->completed()) {
-            $final_reg_step = end(EED_Single_Page_Checkout::instance()->checkout->reg_steps);
-            if ($final_reg_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) {
-                EED_Single_Page_Checkout::instance()->checkout->set_reg_step_initiated($final_reg_step);
-                if ($final_reg_step->process_reg_step()) {
-                    $final_reg_step->set_completed();
-                    EED_Single_Page_Checkout::instance()->checkout->update_txn_reg_steps_array();
-                    return EED_Single_Page_Checkout::instance()->checkout->transaction;
-                }
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     *    run
-     *
-     * @param WP_Query $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-        if (
-            $WP instanceof WP_Query
-            && $WP->is_main_query()
-            && apply_filters('FHEE__EED_Single_Page_Checkout__run', true)
-            && $this->_is_reg_checkout()
-        ) {
-            $this->_initialize();
-        }
-    }
-
-
-    /**
-     * determines whether current url matches reg page url
-     *
-     * @return bool
-     */
-    protected function _is_reg_checkout()
-    {
-        // get current permalink for reg page without any extra query args
-        $reg_page_url = get_permalink(EE_Config::instance()->core->reg_page_id);
-        // get request URI for current request, but without the scheme or host
-        $current_request_uri = EEH_URL::filter_input_server_url();
-        $current_request_uri = html_entity_decode($current_request_uri);
-        // get array of query args from the current request URI
-        $query_args = EEH_URL::get_query_string($current_request_uri);
-        // grab page id if it is set
-        $page_id = isset($query_args['page_id']) ? absint($query_args['page_id']) : 0;
-        // and remove the page id from the query args (we will re-add it later)
-        unset($query_args['page_id']);
-        // now strip all query args from current request URI
-        $current_request_uri = remove_query_arg(array_keys($query_args), $current_request_uri);
-        // and re-add the page id if it was set
-        if ($page_id) {
-            $current_request_uri = add_query_arg('page_id', $page_id, $current_request_uri);
-        }
-        // remove slashes and ?
-        $current_request_uri = trim($current_request_uri, '?/');
-        // is current request URI part of the known full reg page URL ?
-        return ! empty($current_request_uri) && strpos($reg_page_url, $current_request_uri) !== false;
-    }
-
-
-    /**
-     * @param WP_Query $wp_query
-     * @return    void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function init($wp_query)
-    {
-        EED_Single_Page_Checkout::instance()->run($wp_query);
-    }
-
-
-    /**
-     *    _initialize - initial module setup
-     *
-     * @return    void
-     */
-    private function _initialize()
-    {
-        // ensure SPCO doesn't run twice
-        if (EED_Single_Page_Checkout::$_initialized) {
-            return;
-        }
-        try {
-            $this->request = EED_Single_Page_Checkout::getRequest();
-            EED_Single_Page_Checkout::load_reg_steps();
-            $this->_verify_session();
-            // setup the EE_Checkout object
-            $this->checkout = $this->_initialize_checkout();
-            // filter checkout
-            $this->checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize__checkout', $this->checkout);
-            // get the $_GET
-            $this->_get_request_vars();
-            if ($this->_block_bots()) {
-                return;
-            }
-            // filter continue_reg
-            $this->checkout->continue_reg = apply_filters(
-                'FHEE__EED_Single_Page_Checkout__init___continue_reg',
-                true,
-                $this->checkout
-            );
-            // load the reg steps array
-            if (! $this->_load_and_instantiate_reg_steps()) {
-                EED_Single_Page_Checkout::$_initialized = true;
-                return;
-            }
-            // set the current step
-            $this->checkout->set_current_step($this->checkout->step);
-            // and the next step
-            $this->checkout->set_next_step();
-            // verify that everything has been setup correctly
-            if (! ($this->_verify_transaction_and_get_registrations() && $this->_final_verifications())) {
-                EED_Single_Page_Checkout::$_initialized = true;
-                return;
-            }
-            // lock the transaction
-            $this->checkout->transaction->lock();
-            // make sure all of our cached objects are added to their respective model entity mappers
-            $this->checkout->refresh_all_entities();
-            // set amount owing
-            $this->checkout->amount_owing = $this->checkout->transaction->remaining();
-            // initialize each reg step, which gives them the chance to potentially alter the process
-            $this->_initialize_reg_steps();
-            // DEBUG LOG
-            // $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
-            // get reg form
-            if (! $this->_check_form_submission()) {
-                EED_Single_Page_Checkout::$_initialized = true;
-                return;
-            }
-            // checkout the action!!!
-            $this->_process_form_action();
-            // add some style and make it dance
-            $this->add_styles_and_scripts($this);
-            // kk... SPCO has successfully run
-            EED_Single_Page_Checkout::$_initialized = true;
-            // set no cache headers and constants
-            EE_System::do_not_cache();
-            // add anchor
-            add_action('loop_start', array($this, 'set_checkout_anchor'), 1);
-            // remove transaction lock
-            add_action('shutdown', array($this, 'unlock_transaction'), 1);
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-    /**
-     *    _verify_session
-     * checks that the session is valid and not expired
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _verify_session()
-    {
-        if (! EE_Registry::instance()->SSN instanceof EE_Session) {
-            throw new EE_Error(esc_html__('The EE_Session class could not be loaded.', 'event_espresso'));
-        }
-        $clear_session_requested = $this->request->getRequestParam('clear_session', false, 'bool');
-        // is session still valid ?
-        if (
-            $clear_session_requested
-            || (
-                EE_Registry::instance()->SSN->expired()
-                && $this->request->getRequestParam('e_reg_url_link') === ''
-            )
-        ) {
-            $this->checkout = new EE_Checkout();
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-            // EE_Registry::instance()->SSN->reset_cart();
-            // EE_Registry::instance()->SSN->reset_checkout();
-            // EE_Registry::instance()->SSN->reset_transaction();
-            if (! $clear_session_requested) {
-                EE_Error::add_attention(
-                    EE_Registry::$i18n_js_strings['registration_expiration_notice'],
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            // EE_Registry::instance()->SSN->reset_expired();
-        }
-    }
-
-
-    /**
-     *    _initialize_checkout
-     * loads and instantiates EE_Checkout
-     *
-     * @return EE_Checkout
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _initialize_checkout()
-    {
-        // look in session for existing checkout
-        /** @type EE_Checkout $checkout */
-        $checkout = EE_Registry::instance()->SSN->checkout();
-        // verify
-        if (! $checkout instanceof EE_Checkout) {
-            // instantiate EE_Checkout object for handling the properties of the current checkout process
-            $checkout = EE_Registry::instance()->load_file(
-                SPCO_INC_PATH,
-                'EE_Checkout',
-                'class',
-                array(),
-                false
-            );
-        } else {
-            if ($checkout->current_step->is_final_step() && $checkout->exit_spco() === true) {
-                $this->unlock_transaction();
-                wp_safe_redirect($checkout->redirect_url);
-                exit();
-            }
-        }
-        $checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize_checkout__checkout', $checkout);
-        // verify again
-        if (! $checkout instanceof EE_Checkout) {
-            throw new EE_Error(esc_html__('The EE_Checkout class could not be loaded.', 'event_espresso'));
-        }
-        // reset anything that needs a clean slate for each request
-        $checkout->reset_for_current_request();
-        return $checkout;
-    }
-
-
-    /**
-     *    _get_request_vars
-     *
-     * @return    void
-     */
-    private function _get_request_vars()
-    {
-        // make sure this request is marked as belonging to EE
-        /** @var CurrentPage $current_page */
-        $current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
-        $current_page->setEspressoPage(true);
-        // which step is being requested ?
-        $this->checkout->step = $this->request->getRequestParam('step', $this->_get_first_step());
-        // which step is being edited ?
-        $this->checkout->edit_step = $this->request->getRequestParam('edit_step');
-        // and what we're doing on the current step
-        $this->checkout->action = $this->request->getRequestParam('action', 'display_spco_reg_step');
-        // timestamp
-        $this->checkout->uts = $this->request->getRequestParam('uts', 0, 'int');
-        // returning to edit ?
-        $this->checkout->reg_url_link = $this->request->getRequestParam('e_reg_url_link');
-        // add reg url link to registration query params
-        if ($this->checkout->reg_url_link && strpos($this->checkout->reg_url_link, '1-') !== 0) {
-            $this->checkout->reg_cache_where_params[0]['REG_url_link'] = $this->checkout->reg_url_link;
-        }
-        // or some other kind of revisit ?
-        $this->checkout->revisit = $this->request->getRequestParam('revisit', false, 'bool');
-        // and whether or not to generate a reg form for this request
-        $this->checkout->generate_reg_form = $this->request->getRequestParam('generate_reg_form', true, 'bool');
-        // and whether or not to process a reg form submission for this request
-        $this->checkout->process_form_submission = $this->request->getRequestParam(
-            'process_form_submission',
-            $this->checkout->action === 'process_reg_step',
-            'bool'
-        );
-        $this->checkout->process_form_submission = filter_var(
-            $this->checkout->action !== 'display_spco_reg_step'
-                ? $this->checkout->process_form_submission
-                : false,
-            FILTER_VALIDATE_BOOLEAN
-        );
-        // $this->_display_request_vars();
-    }
-
-
-    /**
-     *  _display_request_vars
-     *
-     * @return    void
-     */
-    protected function _display_request_vars()
-    {
-        if (! WP_DEBUG) {
-            return;
-        }
-        EEH_Debug_Tools::printr($this->request->requestParams(), 'requestParams', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->step, '$this->checkout->step', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->edit_step, '$this->checkout->edit_step', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->action, '$this->checkout->action', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->reg_url_link, '$this->checkout->reg_url_link', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->revisit, '$this->checkout->revisit', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr(
-            $this->checkout->generate_reg_form,
-            '$this->checkout->generate_reg_form',
-            __FILE__,
-            __LINE__
-        );
-        EEH_Debug_Tools::printr(
-            $this->checkout->process_form_submission,
-            '$this->checkout->process_form_submission',
-            __FILE__,
-            __LINE__
-        );
-    }
-
-
-    /**
-     * _block_bots
-     * checks that the incoming request has either of the following set:
-     *  a uts (unix timestamp) which indicates that the request was redirected from the Ticket Selector
-     *  a REG URL Link, which indicates that the request is a return visit to SPCO for a valid TXN
-     * so if you're not coming from the Ticket Selector nor returning for a valid IP...
-     * then where you coming from man?
-     *
-     * @return boolean
-     */
-    private function _block_bots()
-    {
-        $invalid_checkout_access = EED_Invalid_Checkout_Access::getInvalidCheckoutAccess();
-        if ($invalid_checkout_access->checkoutAccessIsInvalid($this->checkout)) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     *    _get_first_step
-     *  gets slug for first step in $_reg_steps_array
-     *
-     * @return    string
-     */
-    private function _get_first_step()
-    {
-        $first_step = reset(EED_Single_Page_Checkout::$_reg_steps_array);
-        return isset($first_step['slug']) ? $first_step['slug'] : 'attendee_information';
-    }
-
-
-    /**
-     * instantiates each reg step based on the loaded reg_steps array
-     *
-     * @return    bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _load_and_instantiate_reg_steps()
-    {
-        do_action('AHEE__Single_Page_Checkout___load_and_instantiate_reg_steps__start', $this->checkout);
-        // have reg_steps already been instantiated ?
-        if (
-            empty($this->checkout->reg_steps)
-            || apply_filters('FHEE__Single_Page_Checkout__load_reg_steps__reload_reg_steps', false, $this->checkout)
-        ) {
-            // if not, then loop through raw reg steps array
-            foreach (EED_Single_Page_Checkout::$_reg_steps_array as $order => $reg_step) {
-                if (! $this->_load_and_instantiate_reg_step($reg_step, $order)) {
-                    return false;
-                }
-            }
-            if (isset($this->checkout->reg_steps['registration_confirmation'])) {
-                // skip the registration_confirmation page ?
-                if (EE_Registry::instance()->CFG->registration->skip_reg_confirmation) {
-                    // just remove it from the reg steps array
-                    $this->checkout->remove_reg_step('registration_confirmation', false);
-                } elseif (
-                    EE_Registry::instance()->CFG->registration->reg_confirmation_last
-                ) {
-                    // set the order to something big like 100
-                    $this->checkout->set_reg_step_order('registration_confirmation');
-                }
-            }
-            // filter the array for good luck
-            $this->checkout->reg_steps = apply_filters(
-                'FHEE__Single_Page_Checkout__load_reg_steps__reg_steps',
-                $this->checkout->reg_steps
-            );
-            // finally re-sort based on the reg step class order properties
-            $this->checkout->sort_reg_steps();
-        } else {
-            foreach ($this->checkout->reg_steps as $reg_step) {
-                // set all current step stati to FALSE
-                $reg_step->set_is_current_step(false);
-            }
-        }
-        if (empty($this->checkout->reg_steps)) {
-            EE_Error::add_error(
-                esc_html__('No Reg Steps were loaded..', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // make reg step details available to JS
-        $this->checkout->set_reg_step_JSON_info();
-        return true;
-    }
-
-
-    /**
-     *     _load_and_instantiate_reg_step
-     *
-     * @param array $reg_step
-     * @param int   $order
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _load_and_instantiate_reg_step($reg_step = array(), $order = 0)
-    {
-        // we need a file_path, class_name, and slug to add a reg step
-        if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
-            // if editing a specific step, but this is NOT that step... (and it's not the 'finalize_registration' step)
-            if (
-                $this->checkout->reg_url_link
-                && $this->checkout->step !== $reg_step['slug']
-                && $reg_step['slug'] !== 'finalize_registration'
-                // normally at this point we would NOT load the reg step, but this filter can change that
-                && apply_filters(
-                    'FHEE__Single_Page_Checkout___load_and_instantiate_reg_step__bypass_reg_step',
-                    true,
-                    $reg_step,
-                    $this->checkout
-                )
-            ) {
-                return true;
-            }
-
-            // instantiate step class using file path and class name
-            $reg_step_obj = EE_Registry::instance()->load_file(
-                $reg_step['file_path'],
-                $reg_step['class_name'],
-                'class',
-                [$this->checkout],
-                false
-            );
-            // did we gets the goods ?
-            if ($reg_step_obj instanceof EE_SPCO_Reg_Step) {
-                // set reg step order based on config
-                $reg_step_obj->set_order($order);
-                // add instantiated reg step object to the master reg steps array
-                $this->checkout->add_reg_step($reg_step_obj);
-            } else {
-                EE_Error::add_error(
-                    esc_html__('The current step could not be set.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        } else {
-            if (WP_DEBUG) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'A registration step could not be loaded. One or more of the following data points is invalid:%4$s%5$sFile Path: %1$s%6$s%5$sClass Name: %2$s%6$s%5$sSlug: %3$s%6$s%7$s',
-                            'event_espresso'
-                        ),
-                        isset($reg_step['file_path']) ? $reg_step['file_path'] : '',
-                        isset($reg_step['class_name']) ? $reg_step['class_name'] : '',
-                        isset($reg_step['slug']) ? $reg_step['slug'] : '',
-                        '<ul>',
-                        '<li>',
-                        '</li>',
-                        '</ul>'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * _verify_transaction_and_get_registrations
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _verify_transaction_and_get_registrations()
-    {
-        // was there already a valid transaction in the checkout from the session ?
-        if (! $this->checkout->transaction instanceof EE_Transaction) {
-            // get transaction from db or session
-            $this->checkout->transaction = $this->checkout->reg_url_link && ! is_admin()
-                ? $this->_get_transaction_and_cart_for_previous_visit()
-                : $this->_get_cart_for_current_session_and_setup_new_transaction();
-            if (! $this->checkout->transaction instanceof EE_Transaction) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'Your Registration and Transaction information could not be retrieved from the db.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $this->checkout->transaction = EE_Transaction::new_instance();
-                // add some style and make it dance
-                $this->add_styles_and_scripts($this);
-                EED_Single_Page_Checkout::$_initialized = true;
-                return false;
-            }
-            // and the registrations for the transaction
-            $this->_get_registrations($this->checkout->transaction);
-        }
-        return true;
-    }
-
-
-    /**
-     * _get_transaction_and_cart_for_previous_visit
-     *
-     * @return EE_Transaction|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_transaction_and_cart_for_previous_visit()
-    {
-        /** @var $TXN_model EEM_Transaction */
-        $TXN_model = EE_Registry::instance()->load_model('Transaction');
-        // because the reg_url_link is present in the request,
-        // this is a return visit to SPCO, so we'll get the transaction data from the db
-        $transaction = $TXN_model->get_transaction_from_reg_url_link($this->checkout->reg_url_link);
-        // verify transaction
-        if ($transaction instanceof EE_Transaction) {
-            // and get the cart that was used for that transaction
-            $this->checkout->cart = $this->_get_cart_for_transaction($transaction);
-            return $transaction;
-        }
-        EE_Error::add_error(
-            esc_html__('Your Registration and Transaction information could not be retrieved from the db.', 'event_espresso'),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return null;
-    }
-
-
-    /**
-     * _get_cart_for_transaction
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Cart
-     */
-    private function _get_cart_for_transaction($transaction)
-    {
-        return $this->checkout->get_cart_for_transaction($transaction);
-    }
-
-
-    /**
-     * get_cart_for_transaction
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Cart
-     */
-    public function get_cart_for_transaction(EE_Transaction $transaction)
-    {
-        return $this->checkout->get_cart_for_transaction($transaction);
-    }
-
-
-    /**
-     * _get_transaction_and_cart_for_current_session
-     *    generates a new EE_Transaction object and adds it to the $_transaction property.
-     *
-     * @return EE_Transaction
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_cart_for_current_session_and_setup_new_transaction()
-    {
-        //  if there's no transaction, then this is the FIRST visit to SPCO
-        // so load up the cart ( passing nothing for the TXN because it doesn't exist yet )
-        $this->checkout->cart = $this->_get_cart_for_transaction(null);
-        // and then create a new transaction
-        $transaction = $this->_initialize_transaction();
-        // verify transaction
-        if ($transaction instanceof EE_Transaction) {
-            // save it so that we have an ID for other objects to use
-            $transaction->save();
-            // and save TXN data to the cart
-            $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn($transaction->ID());
-        } else {
-            EE_Error::add_error(
-                esc_html__('A Valid Transaction could not be initialized.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $transaction;
-    }
-
-
-    /**
-     *    generates a new EE_Transaction object and adds it to the $_transaction property.
-     *
-     * @return EE_Transaction|null
-     */
-    private function _initialize_transaction()
-    {
-        try {
-            // ensure cart totals have been calculated
-            $this->checkout->cart->get_grand_total()->recalculate_total_including_taxes();
-            // grab the cart grand total
-            $cart_total = $this->checkout->cart->get_cart_grand_total();
-            // create new TXN
-            $transaction = EE_Transaction::new_instance(
-                array(
-                    'TXN_reg_steps' => $this->checkout->initialize_txn_reg_steps_array(),
-                    'TXN_total'     => $cart_total > 0 ? $cart_total : 0,
-                    'TXN_paid'      => 0,
-                    'STS_ID'        => EEM_Transaction::failed_status_code,
-                )
-            );
-            // save it so that we have an ID for other objects to use
-            $transaction->save();
-            // set cron job for following up on TXNs after their session has expired
-            EE_Cron_Tasks::schedule_expired_transaction_check(
-                EE_Registry::instance()->SSN->expiration() + 1,
-                $transaction->ID()
-            );
-            return $transaction;
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return null;
-    }
-
-
-    /**
-     * _get_registrations
-     *
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_registrations(EE_Transaction $transaction)
-    {
-        // first step: grab the registrants  { : o
-        $registrations = $transaction->registrations($this->checkout->reg_cache_where_params);
-        $this->checkout->total_ticket_count = count($registrations);
-        // verify registrations have been set
-        if (empty($registrations)) {
-            // if no cached registrations, then check the db
-            $registrations = $transaction->registrations($this->checkout->reg_cache_where_params);
-            // still nothing ? well as long as this isn't a revisit
-            if (empty($registrations) && ! $this->checkout->revisit) {
-                // generate new registrations from scratch
-                $registrations = $this->_initialize_registrations($transaction);
-            }
-        }
-        // sort by their original registration order
-        usort($registrations, array('EED_Single_Page_Checkout', 'sort_registrations_by_REG_count'));
-        // then loop thru the array
-        foreach ($registrations as $registration) {
-            // verify each registration
-            if ($registration instanceof EE_Registration) {
-                // we display all attendee info for the primary registrant
-                if (
-                    $this->checkout->reg_url_link === $registration->reg_url_link()
-                    && $registration->is_primary_registrant()
-                ) {
-                    $this->checkout->primary_revisit = true;
-                    break;
-                }
-                if ($this->checkout->revisit && $this->checkout->reg_url_link !== $registration->reg_url_link()) {
-                    // but hide info if it doesn't belong to you
-                    $transaction->clear_cache('Registration', $registration->ID());
-                    $this->checkout->total_ticket_count--;
-                }
-                $this->checkout->set_reg_status_updated($registration->ID(), false);
-            }
-        }
-    }
-
-
-    /**
-     *    adds related EE_Registration objects for each ticket in the cart to the current EE_Transaction object
-     *
-     * @param EE_Transaction $transaction
-     * @return    array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _initialize_registrations(EE_Transaction $transaction)
-    {
-        $att_nmbr = 0;
-        $registrations = array();
-        if ($transaction instanceof EE_Transaction) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            $this->checkout->total_ticket_count = $this->checkout->cart->all_ticket_quantity_count();
-            // now let's add the cart items to the $transaction
-            foreach ($this->checkout->cart->get_tickets() as $line_item) {
-                // do the following for each ticket of this type they selected
-                for ($x = 1; $x <= $line_item->quantity(); $x++) {
-                    $att_nmbr++;
-                    /** @var CreateRegistrationCommand $CreateRegistrationCommand */
-                    $CreateRegistrationCommand = EE_Registry::instance()->create(
-                        CreateRegistrationCommand::class,
-                        [
-                            $transaction,
-                            $line_item,
-                            $att_nmbr,
-                            $this->checkout->total_ticket_count,
-                        ]
-                    );
-                    // override capabilities for frontend registrations
-                    if ($this->request->isFrontend()) {
-                        $CreateRegistrationCommand->setCapCheck(
-                            new PublicCapabilities('', 'create_new_registration')
-                        );
-                    }
-                    $registration = EE_Registry::instance()->BUS->execute($CreateRegistrationCommand);
-                    if (! $registration instanceof EE_Registration) {
-                        throw new InvalidEntityException($registration, 'EE_Registration');
-                    }
-                    $registrations[ $registration->ID() ] = $registration;
-                }
-            }
-            $registration_processor->fix_reg_final_price_rounding_issue($transaction);
-        }
-        return $registrations;
-    }
-
-
-    /**
-     * sorts registrations by REG_count
-     *
-     * @param EE_Registration $reg_A
-     * @param EE_Registration $reg_B
-     * @return int
-     */
-    public static function sort_registrations_by_REG_count(EE_Registration $reg_A, EE_Registration $reg_B)
-    {
-        // this shouldn't ever happen within the same TXN, but oh well
-        if ($reg_A->count() === $reg_B->count()) {
-            return 0;
-        }
-        return ($reg_A->count() > $reg_B->count()) ? 1 : -1;
-    }
-
-
-    /**
-     *    _final_verifications
-     * just makes sure that everything is set up correctly before proceeding
-     *
-     * @return    bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _final_verifications()
-    {
-        // filter checkout
-        $this->checkout = apply_filters(
-            'FHEE__EED_Single_Page_Checkout___final_verifications__checkout',
-            $this->checkout
-        );
-        // verify that current step is still set correctly
-        if (! $this->checkout->current_step instanceof EE_SPCO_Reg_Step) {
-            EE_Error::add_error(
-                esc_html__(
-                    'We\'re sorry but the registration process can not proceed because one or more registration steps were not setup correctly. Please refresh the page and try again or contact support.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // if returning to SPCO, then verify that primary registrant is set
-        if (! empty($this->checkout->reg_url_link)) {
-            $valid_registrant = $this->checkout->transaction->primary_registration();
-            if (! $valid_registrant instanceof EE_Registration) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'We\'re sorry but there appears to be an error with the "reg_url_link" or the primary registrant for this transaction. Please refresh the page and try again or contact support.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            $valid_registrant = null;
-            foreach ($this->checkout->transaction->registrations($this->checkout->reg_cache_where_params) as $registration) {
-                if (
-                    $registration instanceof EE_Registration
-                    && $registration->reg_url_link() === $this->checkout->reg_url_link
-                ) {
-                    $valid_registrant = $registration;
-                }
-            }
-            if (! $valid_registrant instanceof EE_Registration) {
-                // hmmm... maybe we have the wrong session because the user is opening multiple tabs ?
-                if (EED_Single_Page_Checkout::$_checkout_verified) {
-                    // clear the session, mark the checkout as unverified, and try again
-                    EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-                    EED_Single_Page_Checkout::$_initialized = false;
-                    EED_Single_Page_Checkout::$_checkout_verified = false;
-                    $this->_initialize();
-                    EE_Error::reset_notices();
-                    return false;
-                }
-                EE_Error::add_error(
-                    esc_html__(
-                        'We\'re sorry but there appears to be an error with the "reg_url_link" or the transaction itself. Please refresh the page and try again or contact support.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        // now that things have been kinda sufficiently verified,
-        // let's add the checkout to the session so that it's available to other systems
-        EE_Registry::instance()->SSN->set_checkout($this->checkout);
-        return true;
-    }
-
-
-    /**
-     *    _initialize_reg_steps
-     * first makes sure that EE_Transaction_Processor::set_reg_step_initiated() is called as required
-     * then loops thru all of the active reg steps and calls the initialize_reg_step() method
-     *
-     * @param bool $reinitializing
-     * @throws EE_Error
-     */
-    private function _initialize_reg_steps($reinitializing = false)
-    {
-        $this->checkout->set_reg_step_initiated($this->checkout->current_step);
-        // loop thru all steps to call their individual "initialize" methods and set i18n strings for JS
-        foreach ($this->checkout->reg_steps as $reg_step) {
-            if (! $reg_step->initialize_reg_step()) {
-                // if not initialized then maybe this step is being removed...
-                if (! $reinitializing && $reg_step->is_current_step()) {
-                    // if it was the current step, then we need to start over here
-                    $this->_initialize_reg_steps(true);
-                    return;
-                }
-                continue;
-            }
-            // add css and JS for current step
-            $this->add_styles_and_scripts($reg_step);
-            if ($reg_step->is_current_step()) {
-                // the text that appears on the reg step form submit button
-                $reg_step->set_submit_button_text();
-            }
-        }
-        // dynamically creates hook point like: AHEE__Single_Page_Checkout___initialize_reg_step__attendee_information
-        do_action(
-            "AHEE__Single_Page_Checkout___initialize_reg_step__{$this->checkout->current_step->slug()}",
-            $this->checkout->current_step
-        );
-    }
-
-
-    /**
-     * _check_form_submission
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _check_form_submission()
-    {
-        // does this request require the reg form to be generated ?
-        if ($this->checkout->generate_reg_form) {
-            // ever heard that song by Blue Rodeo ?
-            try {
-                $this->checkout->current_step->reg_form = $this->checkout->current_step->generate_reg_form();
-                // if not displaying a form, then check for form submission
-                if (
-                    $this->checkout->process_form_submission
-                    && $this->checkout->current_step->reg_form->was_submitted()
-                ) {
-                    // clear out any old data in case this step is being run again
-                    $this->checkout->current_step->set_valid_data(array());
-                    // capture submitted form data
-                    $request_data = $this->request->requestParams();
-                    $this->checkout->current_step->reg_form->receive_form_submission(
-                        (array) apply_filters(
-                            'FHEE__Single_Page_Checkout___check_form_submission__request_params',
-                            $request_data,
-                            $this->checkout
-                        )
-                    );
-                    // validate submitted form data
-                    if (! $this->checkout->continue_reg || ! $this->checkout->current_step->reg_form->is_valid()) {
-                        // thou shall not pass !!!
-                        $this->checkout->continue_reg = false;
-                        // any form validation errors?
-                        if ($this->checkout->current_step->reg_form->submission_error_message() !== '') {
-                            EE_Error::add_error(
-                                $this->checkout->current_step->reg_form->submission_error_message(),
-                                __FILE__,
-                                __FUNCTION__,
-                                __LINE__
-                            );
-                        }
-                        // well not really... what will happen is
-                        // we'll just get redirected back to redo the current step
-                        $this->go_to_next_step();
-                        return false;
-                    }
-                }
-            } catch (EE_Error $e) {
-                $e->get_error();
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * _process_action
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _process_form_action()
-    {
-        // what cha wanna do?
-        switch ($this->checkout->action) {
-            // AJAX next step reg form
-            case 'display_spco_reg_step':
-                $this->checkout->redirect = false;
-                if ($this->request->isAjax()) {
-                    $this->checkout->json_response->set_reg_step_html(
-                        $this->checkout->current_step->display_reg_form()
-                    );
-                }
-                break;
-            default:
-                // meh... do one of those other steps first
-                if (
-                    ! empty($this->checkout->action)
-                    && is_callable(array($this->checkout->current_step, $this->checkout->action))
-                ) {
-                    // dynamically creates hook point like:
-                    //   AHEE__Single_Page_Checkout__before_attendee_information__process_reg_step
-                    do_action(
-                        "AHEE__Single_Page_Checkout__before_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
-                        $this->checkout->current_step
-                    );
-                    $process_reg_step = apply_filters(
-                        "AHEE__Single_Page_Checkout__process_reg_step__{$this->checkout->current_step->slug()}__{$this->checkout->action}",
-                        true,
-                        $this->checkout->current_step,
-                        $this
-                    );
-                    // call action on current step
-                    if ($process_reg_step && call_user_func([$this->checkout->current_step, $this->checkout->action])) {
-                        // good registrant, you get to proceed
-                        if (
-                            $this->checkout->current_step->success_message() !== ''
-                            && apply_filters(
-                                'FHEE__Single_Page_Checkout___process_form_action__display_success',
-                                false
-                            )
-                        ) {
-                            EE_Error::add_success(
-                                $this->checkout->current_step->success_message()
-                                . '<br />' . $this->checkout->next_step->_instructions()
-                            );
-                        }
-                        // pack it up, pack it in...
-                        $this->_setup_redirect();
-                    }
-                    // dynamically creates hook point like:
-                    //  AHEE__Single_Page_Checkout__after_payment_options__process_reg_step
-                    do_action(
-                        "AHEE__Single_Page_Checkout__after_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
-                        $this->checkout->current_step
-                    );
-                } else {
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                'The requested form action "%s" does not exist for the current "%s" registration step.',
-                                'event_espresso'
-                            ),
-                            $this->checkout->action,
-                            $this->checkout->current_step->name()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            // end default
-        }
-        // store our progress so far
-        $this->checkout->stash_transaction_and_checkout();
-        // advance to the next step! If you pass GO, collect $200
-        $this->go_to_next_step();
-    }
-
-
-    /**
-     * @param EED_Single_Page_Checkout|EE_SPCO_Reg_Step $target an object with the method `translate_js_strings` and
-     *                                                          `enqueue_styles_and_scripts`.
-     * @return        void
-     */
-    public function add_styles_and_scripts($target)
-    {
-        // i18n
-        $target->translate_js_strings();
-        if ($this->checkout->admin_request) {
-            add_action('admin_enqueue_scripts', array($target, 'enqueue_styles_and_scripts'), 10);
-        } else {
-            add_action('wp_enqueue_scripts', array($target, 'enqueue_styles_and_scripts'), 10);
-        }
-    }
-
-    /**
-     *        translate_js_strings
-     *
-     * @return        void
-     */
-    public function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['revisit'] = $this->checkout->revisit;
-        EE_Registry::$i18n_js_strings['e_reg_url_link'] = $this->checkout->reg_url_link;
-        EE_Registry::$i18n_js_strings['server_error'] = esc_html__(
-            'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_json_response'] = esc_html__(
-            'An invalid response was returned from the server while attempting to process your request. Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['validation_error'] = esc_html__(
-            'There appears to be a problem with the form validation configuration! Please check the admin settings or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
-            'There appears to be a problem with the payment method configuration! Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['reg_step_error'] = esc_html__(
-            'This registration step could not be completed. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_coupon'] = esc_html__(
-            'We\'re sorry but that coupon code does not appear to be valid. If this is incorrect, please contact the site administrator.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['process_registration'] = sprintf(
-            esc_html__(
-                'Please wait while we process your registration.%sDo not refresh the page or navigate away while this is happening.%sThank you for your patience.',
-                'event_espresso'
-            ),
-            '<br/>',
-            '<br/>'
-        );
-        EE_Registry::$i18n_js_strings['language'] = get_bloginfo('language');
-        EE_Registry::$i18n_js_strings['EESID'] = EE_Registry::instance()->SSN->id();
-        EE_Registry::$i18n_js_strings['currency'] = EE_Registry::instance()->CFG->currency;
-        EE_Registry::$i18n_js_strings['datepicker_yearRange'] = '-150:+20';
-        EE_Registry::$i18n_js_strings['timer_years'] = esc_html__('years', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_months'] = esc_html__('months', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_weeks'] = esc_html__('weeks', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_days'] = esc_html__('days', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_hours'] = esc_html__('hours', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_minutes'] = esc_html__('minutes', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_seconds'] = esc_html__('seconds', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_year'] = esc_html__('year', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_month'] = esc_html__('month', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_week'] = esc_html__('week', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_day'] = esc_html__('day', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_hour'] = esc_html__('hour', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_minute'] = esc_html__('minute', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_second'] = esc_html__('second', 'event_espresso');
-        EE_Registry::$i18n_js_strings['registration_expiration_notice'] = EED_Single_Page_Checkout::getRegistrationExpirationNotice(
-        );
-        EE_Registry::$i18n_js_strings['ajax_submit'] = apply_filters(
-            'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
-            true
-        );
-        EE_Registry::$i18n_js_strings['session_extension'] = absint(
-            apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS)
-        );
-        EE_Registry::$i18n_js_strings['session_expiration'] = gmdate(
-            'M d, Y H:i:s',
-            EE_Registry::instance()->SSN->expiration() + (get_option('gmt_offset') * HOUR_IN_SECONDS)
-        );
-    }
-
-
-    /**
-     *    enqueue_styles_and_scripts
-     *
-     * @return        void
-     * @throws EE_Error
-     */
-    public function enqueue_styles_and_scripts()
-    {
-        // load css
-        wp_register_style(
-            'single_page_checkout',
-            SPCO_CSS_URL . 'single_page_checkout.css',
-            array('espresso_default'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('single_page_checkout');
-        // load JS
-        wp_register_script(
-            'jquery_plugin',
-            EE_THIRD_PARTY_URL . 'jquery	.plugin.min.js',
-            array('jquery'),
-            '1.0.1',
-            true
-        );
-        wp_register_script(
-            'jquery_countdown',
-            EE_THIRD_PARTY_URL . 'jquery	.countdown.min.js',
-            array('jquery_plugin'),
-            '2.1.0',
-            true
-        );
-        wp_register_script(
-            'single_page_checkout',
-            SPCO_JS_URL . 'single_page_checkout.js',
-            array('espresso_core', 'underscore', 'ee_form_section_validation'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        if ($this->checkout->registration_form instanceof EE_Form_Section_Proper) {
-            $this->checkout->registration_form->enqueue_js();
-        }
-        if ($this->checkout->current_step->reg_form instanceof EE_Form_Section_Proper) {
-            $this->checkout->current_step->reg_form->enqueue_js();
-        }
-        wp_enqueue_script('single_page_checkout');
-        if (apply_filters('FHEE__registration_page_wrapper_template__display_time_limit', false)) {
-            wp_enqueue_script('jquery_countdown');
-        }
-        /**
-         * global action hook for enqueueing styles and scripts with
-         * spco calls.
-         */
-        do_action('AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts', $this);
-        /**
-         * dynamic action hook for enqueueing styles and scripts with spco calls.
-         * The hook will end up being something like:
-         *      AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information
-         */
-        do_action(
-            'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__' . $this->checkout->current_step->slug(),
-            $this
-        );
-    }
-
-
-    /**
-     *    display the Registration Single Page Checkout Form
-     *
-     * @return    void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _display_spco_reg_form()
-    {
-        // if registering via the admin, just display the reg form for the current step
-        if ($this->checkout->admin_request) {
-            EED_Single_Page_Checkout::getResponse()->addOutput($this->checkout->current_step->display_reg_form());
-        } else {
-            // add powered by EE msg
-            add_action('AHEE__SPCO__reg_form_footer', array('EED_Single_Page_Checkout', 'display_registration_footer'));
-            $empty_cart = count(
-                $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params)
-            ) < 1;
-            EE_Registry::$i18n_js_strings['empty_cart'] = $empty_cart;
-            $cookies_not_set_msg = '';
-            if ($empty_cart) {
-                $cookies_not_set_msg = apply_filters(
-                    'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg',
-                    sprintf(
-                        esc_html__(
-                            '%1$s%3$sIt appears your browser is not currently set to accept Cookies%4$s%5$sIn order to register for events, you need to enable cookies.%7$sIf you require assistance, then click the following link to learn how to %8$senable cookies%9$s%6$s%2$s',
-                            'event_espresso'
-                        ),
-                        '<div class="ee-attention hidden" id="ee-cookies-not-set-msg">',
-                        '</div>',
-                        '<h6 class="important-notice">',
-                        '</h6>',
-                        '<p>',
-                        '</p>',
-                        '<br />',
-                        '<a href="https://www.whatismybrowser.com/guides/how-to-enable-cookies/" target="_blank" rel="noopener noreferrer">',
-                        '</a>'
-                    )
-                );
-            }
-            $this->checkout->registration_form = new EE_Form_Section_Proper(
-                array(
-                    'name'            => 'single-page-checkout',
-                    'html_id'         => 'ee-single-page-checkout-dv',
-                    'layout_strategy' =>
-                        new EE_Template_Layout(
-                            array(
-                                'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php',
-                                'template_args'        => array(
-                                    'empty_cart'              => $empty_cart,
-                                    'revisit'                 => $this->checkout->revisit,
-                                    'reg_steps'               => $this->checkout->reg_steps,
-                                    'next_step'               => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                        ? $this->checkout->next_step->slug()
-                                        : '',
-                                    'empty_msg'               => apply_filters(
-                                        'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg',
-                                        sprintf(
-                                            esc_html__(
-                                                'You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.',
-                                                'event_espresso'
-                                            ),
-                                            '<a href="'
-                                            . get_post_type_archive_link('espresso_events')
-                                            . '" title="',
-                                            '">',
-                                            '</a>'
-                                        )
-                                    ),
-                                    'cookies_not_set_msg'     => $cookies_not_set_msg,
-                                    'registration_time_limit' => $this->checkout->get_registration_time_limit(),
-                                    'session_expiration'      => gmdate(
-                                        'M d, Y H:i:s',
-                                        EE_Registry::instance()->SSN->expiration()
-                                        + (get_option('gmt_offset') * HOUR_IN_SECONDS)
-                                    ),
-                                ),
-                            )
-                        ),
-                )
-            );
-            // load template and add to output sent that gets filtered into the_content()
-            EED_Single_Page_Checkout::getResponse()->addOutput($this->checkout->registration_form->get_html());
-        }
-    }
-
-
-    /**
-     *    add_extra_finalize_registration_inputs
-     *
-     * @param $next_step
-     * @internal  param string $label
-     * @return void
-     */
-    public function add_extra_finalize_registration_inputs($next_step)
-    {
-        if ($next_step === 'finalize_registration') {
-            echo '<div id="spco-extra-finalize_registration-inputs-dv"></div>';
-        }
-    }
-
-
-    /**
-     *    display_registration_footer
-     *
-     * @return    string
-     */
-    public static function display_registration_footer()
-    {
-        if (
-            apply_filters(
-                'FHEE__EE_Front__Controller__show_reg_footer',
-                EE_Registry::instance()->CFG->admin->show_reg_footer
-            )
-        ) {
-            add_filter(
-                'FHEE__EEH_Template__powered_by_event_espresso__url',
-                function ($url) {
-                    return apply_filters('FHEE__EE_Front_Controller__registration_footer__url', $url);
-                }
-            );
-            echo apply_filters(
-                'FHEE__EE_Front_Controller__display_registration_footer',
-                EEH_Template::powered_by_event_espresso(
-                    '',
-                    'espresso-registration-footer-dv',
-                    array('utm_content' => 'registration_checkout')
-                )
-            );
-        }
-        return '';
-    }
-
-
-    /**
-     *    unlock_transaction
-     *
-     * @return    void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function unlock_transaction()
-    {
-        if ($this->checkout->transaction instanceof EE_Transaction) {
-            $this->checkout->transaction->unlock();
-        }
-    }
-
-
-    /**
-     *        _setup_redirect
-     *
-     * @return void
-     */
-    private function _setup_redirect()
-    {
-        if ($this->checkout->continue_reg && $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            $this->checkout->redirect = true;
-            if (empty($this->checkout->redirect_url)) {
-                $this->checkout->redirect_url = $this->checkout->next_step->reg_step_url();
-            }
-            $this->checkout->redirect_url = apply_filters(
-                'FHEE__EED_Single_Page_Checkout___setup_redirect__checkout_redirect_url',
-                $this->checkout->redirect_url,
-                $this->checkout
-            );
-        }
-    }
-
-
-    /**
-     *   handle ajax message responses and redirects
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function go_to_next_step()
-    {
-        if ($this->request->isAjax()) {
-            // capture contents of output buffer we started earlier in the request, and insert into JSON response
-            $this->checkout->json_response->set_unexpected_errors(ob_get_clean());
-        }
-        $this->unlock_transaction();
-        // just return for these conditions
-        if (
-            $this->checkout->admin_request
-            || $this->checkout->action === 'redirect_form'
-            || $this->checkout->action === 'update_checkout'
-        ) {
-            return;
-        }
-        // AJAX response
-        $this->_handle_json_response();
-        // redirect to next step or the Thank You page
-        $this->_handle_html_redirects();
-        // hmmm... must be something wrong, so let's just display the form again !
-        $this->_display_spco_reg_form();
-    }
-
-
-    /**
-     *   _handle_json_response
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _handle_json_response()
-    {
-        // if this is an ajax request
-        if ($this->request->isAjax()) {
-            $this->checkout->json_response->set_registration_time_limit(
-                $this->checkout->get_registration_time_limit()
-            );
-            $this->checkout->json_response->set_payment_amount($this->checkout->amount_owing);
-            // just send the ajax (
-            $json_response = apply_filters(
-                'FHEE__EE_Single_Page_Checkout__JSON_response',
-                $this->checkout->json_response
-            );
-            echo ($json_response);
-            exit();
-        }
-    }
-
-
-    /**
-     *   _handle_redirects
-     *
-     * @return void
-     */
-    protected function _handle_html_redirects()
-    {
-        // going somewhere ?
-        if ($this->checkout->redirect && ! empty($this->checkout->redirect_url)) {
-            // store notices in a transient
-            EE_Error::get_notices(false, true);
-            wp_safe_redirect($this->checkout->redirect_url);
-            exit();
-        }
-    }
-
-
-    /**
-     *   set_checkout_anchor
-     *
-     * @return void
-     */
-    public function set_checkout_anchor()
-    {
-        echo '<a id="checkout" style="float: left; margin-left: -999em;"></a>';
-    }
-
-    /**
-     *    getRegistrationExpirationNotice
-     *
-     * @since     4.9.59.p
-     * @return    string
-     */
-    public static function getRegistrationExpirationNotice()
-    {
-        return sprintf(
-            esc_html__(
-                '%1$sWe\'re sorry, but your registration time has expired.%2$s%3$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please accept our apologies for any inconvenience this may have caused.%8$s',
-                'event_espresso'
-            ),
-            '<h4 class="important-notice">',
-            '</h4>',
-            '<br />',
-            '<p>',
-            '<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
-            '">',
-            '</a>',
-            '</p>'
-        );
-    }
+	/**
+	 * $_initialized - has the SPCO controller already been initialized ?
+	 *
+	 * @var bool $_initialized
+	 */
+	private static $_initialized = false;
+
+
+	/**
+	 * $_checkout_verified - is the EE_Checkout verified as correct for this request ?
+	 *
+	 * @var bool $_valid_checkout
+	 */
+	private static $_checkout_verified = true;
+
+	/**
+	 *    $_reg_steps_array - holds initial array of reg steps
+	 *
+	 * @var array $_reg_steps_array
+	 */
+	private static $_reg_steps_array = array();
+
+	/**
+	 *    $checkout - EE_Checkout object for handling the properties of the current checkout process
+	 *
+	 * @var EE_Checkout $checkout
+	 */
+	public $checkout;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+
+	/**
+	 * @return EED_Single_Page_Checkout|EED_Module
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance()
+	{
+		add_filter('EED_Single_Page_Checkout__SPCO_active', '__return_true');
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * @return EE_CART
+	 */
+	public function cart()
+	{
+		return $this->checkout->cart;
+	}
+
+
+	/**
+	 * @return RequestInterface
+	 * @since   4.10.14.p
+	 */
+	public static function getRequest()
+	{
+		return LoaderFactory::getLoader()->getShared(RequestInterface::class);
+	}
+
+
+	/**
+	 * @return EE_Transaction
+	 */
+	public function transaction()
+	{
+		return $this->checkout->transaction;
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function set_hooks()
+	{
+		EED_Single_Page_Checkout::set_definitions();
+	}
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function set_hooks_admin()
+	{
+		EED_Single_Page_Checkout::set_definitions();
+		if (! (defined('DOING_AJAX') && DOING_AJAX)) {
+			return;
+		}
+		// going to start an output buffer in case anything gets accidentally output
+		// that might disrupt our JSON response
+		ob_start();
+		EED_Single_Page_Checkout::load_reg_steps();
+		// set ajax hooks
+		add_action('wp_ajax_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step'));
+		add_action('wp_ajax_nopriv_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step'));
+		add_action('wp_ajax_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step'));
+		add_action('wp_ajax_nopriv_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step'));
+		add_action('wp_ajax_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step'));
+		add_action('wp_ajax_nopriv_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step'));
+	}
+
+
+	/**
+	 *    process ajax request
+	 *
+	 * @param string $ajax_action
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function process_ajax_request($ajax_action)
+	{
+		$request = EED_Single_Page_Checkout::getRequest();
+		$request->setRequestParam('action', $ajax_action);
+		EED_Single_Page_Checkout::instance()->_initialize();
+	}
+
+
+	/**
+	 * ajax display registration step
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function display_reg_step()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('display_spco_reg_step');
+	}
+
+
+	/**
+	 * ajax process registration step
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function process_reg_step()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('process_reg_step');
+	}
+
+
+	/**
+	 * ajax process registration step
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function update_reg_step()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('update_reg_step');
+	}
+
+
+	/**
+	 * update_checkout
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public static function update_checkout()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('update_checkout');
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 4.10.14.p
+	 */
+	public static function load_request_handler()
+	{
+	}
+
+
+	/**
+	 *    set_definitions
+	 *
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function set_definitions()
+	{
+		if (defined('SPCO_BASE_PATH')) {
+			return;
+		}
+		define(
+			'SPCO_BASE_PATH',
+			rtrim(str_replace(array('\\', '/'), '/', plugin_dir_path(__FILE__)), '/') . '/'
+		);
+		define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css/');
+		define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img/');
+		define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js/');
+		define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc/');
+		define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps/');
+		define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates/');
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true);
+		EE_Registry::$i18n_js_strings['registration_expiration_notice'] = EED_Single_Page_Checkout::getRegistrationExpirationNotice(
+		);
+	}
+
+
+	/**
+	 * load_reg_steps
+	 * loads and instantiates each reg step based on the EE_Registry::instance()->CFG->registration->reg_steps array
+	 *
+	 * @throws EE_Error
+	 */
+	public static function load_reg_steps()
+	{
+		static $reg_steps_loaded = false;
+		if ($reg_steps_loaded) {
+			return;
+		}
+		// filter list of reg_steps
+		$reg_steps_to_load = (array) apply_filters(
+			'AHEE__SPCO__load_reg_steps__reg_steps_to_load',
+			EED_Single_Page_Checkout::get_reg_steps()
+		);
+		// sort by key (order)
+		ksort($reg_steps_to_load);
+		// loop through folders
+		foreach ($reg_steps_to_load as $order => $reg_step) {
+			// we need a
+			if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
+				// copy over to the reg_steps_array
+				EED_Single_Page_Checkout::$_reg_steps_array[ $order ] = $reg_step;
+				// register custom key route for each reg step
+				// ie: step=>"slug" - this is the entire reason we load the reg steps array now
+				EE_Config::register_route(
+					$reg_step['slug'],
+					'EED_Single_Page_Checkout',
+					'run',
+					'step'
+				);
+				// add AJAX or other hooks
+				if (isset($reg_step['has_hooks']) && $reg_step['has_hooks']) {
+					// setup autoloaders if necessary
+					if (! class_exists($reg_step['class_name'])) {
+						EEH_Autoloader::register_autoloaders_for_each_file_in_folder(
+							$reg_step['file_path'],
+							true
+						);
+					}
+					if (is_callable($reg_step['class_name'], 'set_hooks')) {
+						call_user_func(array($reg_step['class_name'], 'set_hooks'));
+					}
+				}
+			}
+		}
+		$reg_steps_loaded = true;
+	}
+
+
+	/**
+	 *    get_reg_steps
+	 *
+	 * @return    array
+	 */
+	public static function get_reg_steps()
+	{
+		$reg_steps = EE_Registry::instance()->CFG->registration->reg_steps;
+		if (empty($reg_steps)) {
+			$reg_steps = array(
+				10  => array(
+					'file_path'  => SPCO_REG_STEPS_PATH . 'attendee_information',
+					'class_name' => 'EE_SPCO_Reg_Step_Attendee_Information',
+					'slug'       => 'attendee_information',
+					'has_hooks'  => false,
+				),
+				30  => array(
+					'file_path'  => SPCO_REG_STEPS_PATH . 'payment_options',
+					'class_name' => 'EE_SPCO_Reg_Step_Payment_Options',
+					'slug'       => 'payment_options',
+					'has_hooks'  => true,
+				),
+				999 => array(
+					'file_path'  => SPCO_REG_STEPS_PATH . 'finalize_registration',
+					'class_name' => 'EE_SPCO_Reg_Step_Finalize_Registration',
+					'slug'       => 'finalize_registration',
+					'has_hooks'  => false,
+				),
+			);
+		}
+		return $reg_steps;
+	}
+
+
+	/**
+	 *    registration_checkout_for_admin
+	 *
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function registration_checkout_for_admin()
+	{
+		$request = EED_Single_Page_Checkout::getRequest();
+		$request->setRequestParam('step', 'attendee_information');
+		$request->setRequestParam('action', 'display_spco_reg_step');
+		$request->setRequestParam('process_form_submission', false);
+		EED_Single_Page_Checkout::instance()->_initialize();
+		EED_Single_Page_Checkout::instance()->_display_spco_reg_form();
+		return EED_Single_Page_Checkout::getResponse()->getOutput();
+	}
+
+
+	/**
+	 * process_registration_from_admin
+	 *
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function process_registration_from_admin()
+	{
+		$request = EED_Single_Page_Checkout::getRequest();
+		$request->setRequestParam('step', 'attendee_information');
+		$request->setRequestParam('action', 'process_reg_step');
+		$request->setRequestParam('process_form_submission', true);
+		EED_Single_Page_Checkout::instance()->_initialize();
+		if (EED_Single_Page_Checkout::instance()->checkout->current_step->completed()) {
+			$final_reg_step = end(EED_Single_Page_Checkout::instance()->checkout->reg_steps);
+			if ($final_reg_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) {
+				EED_Single_Page_Checkout::instance()->checkout->set_reg_step_initiated($final_reg_step);
+				if ($final_reg_step->process_reg_step()) {
+					$final_reg_step->set_completed();
+					EED_Single_Page_Checkout::instance()->checkout->update_txn_reg_steps_array();
+					return EED_Single_Page_Checkout::instance()->checkout->transaction;
+				}
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 *    run
+	 *
+	 * @param WP_Query $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+		if (
+			$WP instanceof WP_Query
+			&& $WP->is_main_query()
+			&& apply_filters('FHEE__EED_Single_Page_Checkout__run', true)
+			&& $this->_is_reg_checkout()
+		) {
+			$this->_initialize();
+		}
+	}
+
+
+	/**
+	 * determines whether current url matches reg page url
+	 *
+	 * @return bool
+	 */
+	protected function _is_reg_checkout()
+	{
+		// get current permalink for reg page without any extra query args
+		$reg_page_url = get_permalink(EE_Config::instance()->core->reg_page_id);
+		// get request URI for current request, but without the scheme or host
+		$current_request_uri = EEH_URL::filter_input_server_url();
+		$current_request_uri = html_entity_decode($current_request_uri);
+		// get array of query args from the current request URI
+		$query_args = EEH_URL::get_query_string($current_request_uri);
+		// grab page id if it is set
+		$page_id = isset($query_args['page_id']) ? absint($query_args['page_id']) : 0;
+		// and remove the page id from the query args (we will re-add it later)
+		unset($query_args['page_id']);
+		// now strip all query args from current request URI
+		$current_request_uri = remove_query_arg(array_keys($query_args), $current_request_uri);
+		// and re-add the page id if it was set
+		if ($page_id) {
+			$current_request_uri = add_query_arg('page_id', $page_id, $current_request_uri);
+		}
+		// remove slashes and ?
+		$current_request_uri = trim($current_request_uri, '?/');
+		// is current request URI part of the known full reg page URL ?
+		return ! empty($current_request_uri) && strpos($reg_page_url, $current_request_uri) !== false;
+	}
+
+
+	/**
+	 * @param WP_Query $wp_query
+	 * @return    void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function init($wp_query)
+	{
+		EED_Single_Page_Checkout::instance()->run($wp_query);
+	}
+
+
+	/**
+	 *    _initialize - initial module setup
+	 *
+	 * @return    void
+	 */
+	private function _initialize()
+	{
+		// ensure SPCO doesn't run twice
+		if (EED_Single_Page_Checkout::$_initialized) {
+			return;
+		}
+		try {
+			$this->request = EED_Single_Page_Checkout::getRequest();
+			EED_Single_Page_Checkout::load_reg_steps();
+			$this->_verify_session();
+			// setup the EE_Checkout object
+			$this->checkout = $this->_initialize_checkout();
+			// filter checkout
+			$this->checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize__checkout', $this->checkout);
+			// get the $_GET
+			$this->_get_request_vars();
+			if ($this->_block_bots()) {
+				return;
+			}
+			// filter continue_reg
+			$this->checkout->continue_reg = apply_filters(
+				'FHEE__EED_Single_Page_Checkout__init___continue_reg',
+				true,
+				$this->checkout
+			);
+			// load the reg steps array
+			if (! $this->_load_and_instantiate_reg_steps()) {
+				EED_Single_Page_Checkout::$_initialized = true;
+				return;
+			}
+			// set the current step
+			$this->checkout->set_current_step($this->checkout->step);
+			// and the next step
+			$this->checkout->set_next_step();
+			// verify that everything has been setup correctly
+			if (! ($this->_verify_transaction_and_get_registrations() && $this->_final_verifications())) {
+				EED_Single_Page_Checkout::$_initialized = true;
+				return;
+			}
+			// lock the transaction
+			$this->checkout->transaction->lock();
+			// make sure all of our cached objects are added to their respective model entity mappers
+			$this->checkout->refresh_all_entities();
+			// set amount owing
+			$this->checkout->amount_owing = $this->checkout->transaction->remaining();
+			// initialize each reg step, which gives them the chance to potentially alter the process
+			$this->_initialize_reg_steps();
+			// DEBUG LOG
+			// $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
+			// get reg form
+			if (! $this->_check_form_submission()) {
+				EED_Single_Page_Checkout::$_initialized = true;
+				return;
+			}
+			// checkout the action!!!
+			$this->_process_form_action();
+			// add some style and make it dance
+			$this->add_styles_and_scripts($this);
+			// kk... SPCO has successfully run
+			EED_Single_Page_Checkout::$_initialized = true;
+			// set no cache headers and constants
+			EE_System::do_not_cache();
+			// add anchor
+			add_action('loop_start', array($this, 'set_checkout_anchor'), 1);
+			// remove transaction lock
+			add_action('shutdown', array($this, 'unlock_transaction'), 1);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+	/**
+	 *    _verify_session
+	 * checks that the session is valid and not expired
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _verify_session()
+	{
+		if (! EE_Registry::instance()->SSN instanceof EE_Session) {
+			throw new EE_Error(esc_html__('The EE_Session class could not be loaded.', 'event_espresso'));
+		}
+		$clear_session_requested = $this->request->getRequestParam('clear_session', false, 'bool');
+		// is session still valid ?
+		if (
+			$clear_session_requested
+			|| (
+				EE_Registry::instance()->SSN->expired()
+				&& $this->request->getRequestParam('e_reg_url_link') === ''
+			)
+		) {
+			$this->checkout = new EE_Checkout();
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+			// EE_Registry::instance()->SSN->reset_cart();
+			// EE_Registry::instance()->SSN->reset_checkout();
+			// EE_Registry::instance()->SSN->reset_transaction();
+			if (! $clear_session_requested) {
+				EE_Error::add_attention(
+					EE_Registry::$i18n_js_strings['registration_expiration_notice'],
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			// EE_Registry::instance()->SSN->reset_expired();
+		}
+	}
+
+
+	/**
+	 *    _initialize_checkout
+	 * loads and instantiates EE_Checkout
+	 *
+	 * @return EE_Checkout
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _initialize_checkout()
+	{
+		// look in session for existing checkout
+		/** @type EE_Checkout $checkout */
+		$checkout = EE_Registry::instance()->SSN->checkout();
+		// verify
+		if (! $checkout instanceof EE_Checkout) {
+			// instantiate EE_Checkout object for handling the properties of the current checkout process
+			$checkout = EE_Registry::instance()->load_file(
+				SPCO_INC_PATH,
+				'EE_Checkout',
+				'class',
+				array(),
+				false
+			);
+		} else {
+			if ($checkout->current_step->is_final_step() && $checkout->exit_spco() === true) {
+				$this->unlock_transaction();
+				wp_safe_redirect($checkout->redirect_url);
+				exit();
+			}
+		}
+		$checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize_checkout__checkout', $checkout);
+		// verify again
+		if (! $checkout instanceof EE_Checkout) {
+			throw new EE_Error(esc_html__('The EE_Checkout class could not be loaded.', 'event_espresso'));
+		}
+		// reset anything that needs a clean slate for each request
+		$checkout->reset_for_current_request();
+		return $checkout;
+	}
+
+
+	/**
+	 *    _get_request_vars
+	 *
+	 * @return    void
+	 */
+	private function _get_request_vars()
+	{
+		// make sure this request is marked as belonging to EE
+		/** @var CurrentPage $current_page */
+		$current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
+		$current_page->setEspressoPage(true);
+		// which step is being requested ?
+		$this->checkout->step = $this->request->getRequestParam('step', $this->_get_first_step());
+		// which step is being edited ?
+		$this->checkout->edit_step = $this->request->getRequestParam('edit_step');
+		// and what we're doing on the current step
+		$this->checkout->action = $this->request->getRequestParam('action', 'display_spco_reg_step');
+		// timestamp
+		$this->checkout->uts = $this->request->getRequestParam('uts', 0, 'int');
+		// returning to edit ?
+		$this->checkout->reg_url_link = $this->request->getRequestParam('e_reg_url_link');
+		// add reg url link to registration query params
+		if ($this->checkout->reg_url_link && strpos($this->checkout->reg_url_link, '1-') !== 0) {
+			$this->checkout->reg_cache_where_params[0]['REG_url_link'] = $this->checkout->reg_url_link;
+		}
+		// or some other kind of revisit ?
+		$this->checkout->revisit = $this->request->getRequestParam('revisit', false, 'bool');
+		// and whether or not to generate a reg form for this request
+		$this->checkout->generate_reg_form = $this->request->getRequestParam('generate_reg_form', true, 'bool');
+		// and whether or not to process a reg form submission for this request
+		$this->checkout->process_form_submission = $this->request->getRequestParam(
+			'process_form_submission',
+			$this->checkout->action === 'process_reg_step',
+			'bool'
+		);
+		$this->checkout->process_form_submission = filter_var(
+			$this->checkout->action !== 'display_spco_reg_step'
+				? $this->checkout->process_form_submission
+				: false,
+			FILTER_VALIDATE_BOOLEAN
+		);
+		// $this->_display_request_vars();
+	}
+
+
+	/**
+	 *  _display_request_vars
+	 *
+	 * @return    void
+	 */
+	protected function _display_request_vars()
+	{
+		if (! WP_DEBUG) {
+			return;
+		}
+		EEH_Debug_Tools::printr($this->request->requestParams(), 'requestParams', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->step, '$this->checkout->step', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->edit_step, '$this->checkout->edit_step', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->action, '$this->checkout->action', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->reg_url_link, '$this->checkout->reg_url_link', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->revisit, '$this->checkout->revisit', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr(
+			$this->checkout->generate_reg_form,
+			'$this->checkout->generate_reg_form',
+			__FILE__,
+			__LINE__
+		);
+		EEH_Debug_Tools::printr(
+			$this->checkout->process_form_submission,
+			'$this->checkout->process_form_submission',
+			__FILE__,
+			__LINE__
+		);
+	}
+
+
+	/**
+	 * _block_bots
+	 * checks that the incoming request has either of the following set:
+	 *  a uts (unix timestamp) which indicates that the request was redirected from the Ticket Selector
+	 *  a REG URL Link, which indicates that the request is a return visit to SPCO for a valid TXN
+	 * so if you're not coming from the Ticket Selector nor returning for a valid IP...
+	 * then where you coming from man?
+	 *
+	 * @return boolean
+	 */
+	private function _block_bots()
+	{
+		$invalid_checkout_access = EED_Invalid_Checkout_Access::getInvalidCheckoutAccess();
+		if ($invalid_checkout_access->checkoutAccessIsInvalid($this->checkout)) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 *    _get_first_step
+	 *  gets slug for first step in $_reg_steps_array
+	 *
+	 * @return    string
+	 */
+	private function _get_first_step()
+	{
+		$first_step = reset(EED_Single_Page_Checkout::$_reg_steps_array);
+		return isset($first_step['slug']) ? $first_step['slug'] : 'attendee_information';
+	}
+
+
+	/**
+	 * instantiates each reg step based on the loaded reg_steps array
+	 *
+	 * @return    bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _load_and_instantiate_reg_steps()
+	{
+		do_action('AHEE__Single_Page_Checkout___load_and_instantiate_reg_steps__start', $this->checkout);
+		// have reg_steps already been instantiated ?
+		if (
+			empty($this->checkout->reg_steps)
+			|| apply_filters('FHEE__Single_Page_Checkout__load_reg_steps__reload_reg_steps', false, $this->checkout)
+		) {
+			// if not, then loop through raw reg steps array
+			foreach (EED_Single_Page_Checkout::$_reg_steps_array as $order => $reg_step) {
+				if (! $this->_load_and_instantiate_reg_step($reg_step, $order)) {
+					return false;
+				}
+			}
+			if (isset($this->checkout->reg_steps['registration_confirmation'])) {
+				// skip the registration_confirmation page ?
+				if (EE_Registry::instance()->CFG->registration->skip_reg_confirmation) {
+					// just remove it from the reg steps array
+					$this->checkout->remove_reg_step('registration_confirmation', false);
+				} elseif (
+					EE_Registry::instance()->CFG->registration->reg_confirmation_last
+				) {
+					// set the order to something big like 100
+					$this->checkout->set_reg_step_order('registration_confirmation');
+				}
+			}
+			// filter the array for good luck
+			$this->checkout->reg_steps = apply_filters(
+				'FHEE__Single_Page_Checkout__load_reg_steps__reg_steps',
+				$this->checkout->reg_steps
+			);
+			// finally re-sort based on the reg step class order properties
+			$this->checkout->sort_reg_steps();
+		} else {
+			foreach ($this->checkout->reg_steps as $reg_step) {
+				// set all current step stati to FALSE
+				$reg_step->set_is_current_step(false);
+			}
+		}
+		if (empty($this->checkout->reg_steps)) {
+			EE_Error::add_error(
+				esc_html__('No Reg Steps were loaded..', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// make reg step details available to JS
+		$this->checkout->set_reg_step_JSON_info();
+		return true;
+	}
+
+
+	/**
+	 *     _load_and_instantiate_reg_step
+	 *
+	 * @param array $reg_step
+	 * @param int   $order
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _load_and_instantiate_reg_step($reg_step = array(), $order = 0)
+	{
+		// we need a file_path, class_name, and slug to add a reg step
+		if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
+			// if editing a specific step, but this is NOT that step... (and it's not the 'finalize_registration' step)
+			if (
+				$this->checkout->reg_url_link
+				&& $this->checkout->step !== $reg_step['slug']
+				&& $reg_step['slug'] !== 'finalize_registration'
+				// normally at this point we would NOT load the reg step, but this filter can change that
+				&& apply_filters(
+					'FHEE__Single_Page_Checkout___load_and_instantiate_reg_step__bypass_reg_step',
+					true,
+					$reg_step,
+					$this->checkout
+				)
+			) {
+				return true;
+			}
+
+			// instantiate step class using file path and class name
+			$reg_step_obj = EE_Registry::instance()->load_file(
+				$reg_step['file_path'],
+				$reg_step['class_name'],
+				'class',
+				[$this->checkout],
+				false
+			);
+			// did we gets the goods ?
+			if ($reg_step_obj instanceof EE_SPCO_Reg_Step) {
+				// set reg step order based on config
+				$reg_step_obj->set_order($order);
+				// add instantiated reg step object to the master reg steps array
+				$this->checkout->add_reg_step($reg_step_obj);
+			} else {
+				EE_Error::add_error(
+					esc_html__('The current step could not be set.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		} else {
+			if (WP_DEBUG) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'A registration step could not be loaded. One or more of the following data points is invalid:%4$s%5$sFile Path: %1$s%6$s%5$sClass Name: %2$s%6$s%5$sSlug: %3$s%6$s%7$s',
+							'event_espresso'
+						),
+						isset($reg_step['file_path']) ? $reg_step['file_path'] : '',
+						isset($reg_step['class_name']) ? $reg_step['class_name'] : '',
+						isset($reg_step['slug']) ? $reg_step['slug'] : '',
+						'<ul>',
+						'<li>',
+						'</li>',
+						'</ul>'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * _verify_transaction_and_get_registrations
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _verify_transaction_and_get_registrations()
+	{
+		// was there already a valid transaction in the checkout from the session ?
+		if (! $this->checkout->transaction instanceof EE_Transaction) {
+			// get transaction from db or session
+			$this->checkout->transaction = $this->checkout->reg_url_link && ! is_admin()
+				? $this->_get_transaction_and_cart_for_previous_visit()
+				: $this->_get_cart_for_current_session_and_setup_new_transaction();
+			if (! $this->checkout->transaction instanceof EE_Transaction) {
+				EE_Error::add_error(
+					esc_html__(
+						'Your Registration and Transaction information could not be retrieved from the db.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$this->checkout->transaction = EE_Transaction::new_instance();
+				// add some style and make it dance
+				$this->add_styles_and_scripts($this);
+				EED_Single_Page_Checkout::$_initialized = true;
+				return false;
+			}
+			// and the registrations for the transaction
+			$this->_get_registrations($this->checkout->transaction);
+		}
+		return true;
+	}
+
+
+	/**
+	 * _get_transaction_and_cart_for_previous_visit
+	 *
+	 * @return EE_Transaction|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_transaction_and_cart_for_previous_visit()
+	{
+		/** @var $TXN_model EEM_Transaction */
+		$TXN_model = EE_Registry::instance()->load_model('Transaction');
+		// because the reg_url_link is present in the request,
+		// this is a return visit to SPCO, so we'll get the transaction data from the db
+		$transaction = $TXN_model->get_transaction_from_reg_url_link($this->checkout->reg_url_link);
+		// verify transaction
+		if ($transaction instanceof EE_Transaction) {
+			// and get the cart that was used for that transaction
+			$this->checkout->cart = $this->_get_cart_for_transaction($transaction);
+			return $transaction;
+		}
+		EE_Error::add_error(
+			esc_html__('Your Registration and Transaction information could not be retrieved from the db.', 'event_espresso'),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return null;
+	}
+
+
+	/**
+	 * _get_cart_for_transaction
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Cart
+	 */
+	private function _get_cart_for_transaction($transaction)
+	{
+		return $this->checkout->get_cart_for_transaction($transaction);
+	}
+
+
+	/**
+	 * get_cart_for_transaction
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Cart
+	 */
+	public function get_cart_for_transaction(EE_Transaction $transaction)
+	{
+		return $this->checkout->get_cart_for_transaction($transaction);
+	}
+
+
+	/**
+	 * _get_transaction_and_cart_for_current_session
+	 *    generates a new EE_Transaction object and adds it to the $_transaction property.
+	 *
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_cart_for_current_session_and_setup_new_transaction()
+	{
+		//  if there's no transaction, then this is the FIRST visit to SPCO
+		// so load up the cart ( passing nothing for the TXN because it doesn't exist yet )
+		$this->checkout->cart = $this->_get_cart_for_transaction(null);
+		// and then create a new transaction
+		$transaction = $this->_initialize_transaction();
+		// verify transaction
+		if ($transaction instanceof EE_Transaction) {
+			// save it so that we have an ID for other objects to use
+			$transaction->save();
+			// and save TXN data to the cart
+			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn($transaction->ID());
+		} else {
+			EE_Error::add_error(
+				esc_html__('A Valid Transaction could not be initialized.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $transaction;
+	}
+
+
+	/**
+	 *    generates a new EE_Transaction object and adds it to the $_transaction property.
+	 *
+	 * @return EE_Transaction|null
+	 */
+	private function _initialize_transaction()
+	{
+		try {
+			// ensure cart totals have been calculated
+			$this->checkout->cart->get_grand_total()->recalculate_total_including_taxes();
+			// grab the cart grand total
+			$cart_total = $this->checkout->cart->get_cart_grand_total();
+			// create new TXN
+			$transaction = EE_Transaction::new_instance(
+				array(
+					'TXN_reg_steps' => $this->checkout->initialize_txn_reg_steps_array(),
+					'TXN_total'     => $cart_total > 0 ? $cart_total : 0,
+					'TXN_paid'      => 0,
+					'STS_ID'        => EEM_Transaction::failed_status_code,
+				)
+			);
+			// save it so that we have an ID for other objects to use
+			$transaction->save();
+			// set cron job for following up on TXNs after their session has expired
+			EE_Cron_Tasks::schedule_expired_transaction_check(
+				EE_Registry::instance()->SSN->expiration() + 1,
+				$transaction->ID()
+			);
+			return $transaction;
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return null;
+	}
+
+
+	/**
+	 * _get_registrations
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_registrations(EE_Transaction $transaction)
+	{
+		// first step: grab the registrants  { : o
+		$registrations = $transaction->registrations($this->checkout->reg_cache_where_params);
+		$this->checkout->total_ticket_count = count($registrations);
+		// verify registrations have been set
+		if (empty($registrations)) {
+			// if no cached registrations, then check the db
+			$registrations = $transaction->registrations($this->checkout->reg_cache_where_params);
+			// still nothing ? well as long as this isn't a revisit
+			if (empty($registrations) && ! $this->checkout->revisit) {
+				// generate new registrations from scratch
+				$registrations = $this->_initialize_registrations($transaction);
+			}
+		}
+		// sort by their original registration order
+		usort($registrations, array('EED_Single_Page_Checkout', 'sort_registrations_by_REG_count'));
+		// then loop thru the array
+		foreach ($registrations as $registration) {
+			// verify each registration
+			if ($registration instanceof EE_Registration) {
+				// we display all attendee info for the primary registrant
+				if (
+					$this->checkout->reg_url_link === $registration->reg_url_link()
+					&& $registration->is_primary_registrant()
+				) {
+					$this->checkout->primary_revisit = true;
+					break;
+				}
+				if ($this->checkout->revisit && $this->checkout->reg_url_link !== $registration->reg_url_link()) {
+					// but hide info if it doesn't belong to you
+					$transaction->clear_cache('Registration', $registration->ID());
+					$this->checkout->total_ticket_count--;
+				}
+				$this->checkout->set_reg_status_updated($registration->ID(), false);
+			}
+		}
+	}
+
+
+	/**
+	 *    adds related EE_Registration objects for each ticket in the cart to the current EE_Transaction object
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return    array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _initialize_registrations(EE_Transaction $transaction)
+	{
+		$att_nmbr = 0;
+		$registrations = array();
+		if ($transaction instanceof EE_Transaction) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			$this->checkout->total_ticket_count = $this->checkout->cart->all_ticket_quantity_count();
+			// now let's add the cart items to the $transaction
+			foreach ($this->checkout->cart->get_tickets() as $line_item) {
+				// do the following for each ticket of this type they selected
+				for ($x = 1; $x <= $line_item->quantity(); $x++) {
+					$att_nmbr++;
+					/** @var CreateRegistrationCommand $CreateRegistrationCommand */
+					$CreateRegistrationCommand = EE_Registry::instance()->create(
+						CreateRegistrationCommand::class,
+						[
+							$transaction,
+							$line_item,
+							$att_nmbr,
+							$this->checkout->total_ticket_count,
+						]
+					);
+					// override capabilities for frontend registrations
+					if ($this->request->isFrontend()) {
+						$CreateRegistrationCommand->setCapCheck(
+							new PublicCapabilities('', 'create_new_registration')
+						);
+					}
+					$registration = EE_Registry::instance()->BUS->execute($CreateRegistrationCommand);
+					if (! $registration instanceof EE_Registration) {
+						throw new InvalidEntityException($registration, 'EE_Registration');
+					}
+					$registrations[ $registration->ID() ] = $registration;
+				}
+			}
+			$registration_processor->fix_reg_final_price_rounding_issue($transaction);
+		}
+		return $registrations;
+	}
+
+
+	/**
+	 * sorts registrations by REG_count
+	 *
+	 * @param EE_Registration $reg_A
+	 * @param EE_Registration $reg_B
+	 * @return int
+	 */
+	public static function sort_registrations_by_REG_count(EE_Registration $reg_A, EE_Registration $reg_B)
+	{
+		// this shouldn't ever happen within the same TXN, but oh well
+		if ($reg_A->count() === $reg_B->count()) {
+			return 0;
+		}
+		return ($reg_A->count() > $reg_B->count()) ? 1 : -1;
+	}
+
+
+	/**
+	 *    _final_verifications
+	 * just makes sure that everything is set up correctly before proceeding
+	 *
+	 * @return    bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _final_verifications()
+	{
+		// filter checkout
+		$this->checkout = apply_filters(
+			'FHEE__EED_Single_Page_Checkout___final_verifications__checkout',
+			$this->checkout
+		);
+		// verify that current step is still set correctly
+		if (! $this->checkout->current_step instanceof EE_SPCO_Reg_Step) {
+			EE_Error::add_error(
+				esc_html__(
+					'We\'re sorry but the registration process can not proceed because one or more registration steps were not setup correctly. Please refresh the page and try again or contact support.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// if returning to SPCO, then verify that primary registrant is set
+		if (! empty($this->checkout->reg_url_link)) {
+			$valid_registrant = $this->checkout->transaction->primary_registration();
+			if (! $valid_registrant instanceof EE_Registration) {
+				EE_Error::add_error(
+					esc_html__(
+						'We\'re sorry but there appears to be an error with the "reg_url_link" or the primary registrant for this transaction. Please refresh the page and try again or contact support.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			$valid_registrant = null;
+			foreach ($this->checkout->transaction->registrations($this->checkout->reg_cache_where_params) as $registration) {
+				if (
+					$registration instanceof EE_Registration
+					&& $registration->reg_url_link() === $this->checkout->reg_url_link
+				) {
+					$valid_registrant = $registration;
+				}
+			}
+			if (! $valid_registrant instanceof EE_Registration) {
+				// hmmm... maybe we have the wrong session because the user is opening multiple tabs ?
+				if (EED_Single_Page_Checkout::$_checkout_verified) {
+					// clear the session, mark the checkout as unverified, and try again
+					EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+					EED_Single_Page_Checkout::$_initialized = false;
+					EED_Single_Page_Checkout::$_checkout_verified = false;
+					$this->_initialize();
+					EE_Error::reset_notices();
+					return false;
+				}
+				EE_Error::add_error(
+					esc_html__(
+						'We\'re sorry but there appears to be an error with the "reg_url_link" or the transaction itself. Please refresh the page and try again or contact support.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		// now that things have been kinda sufficiently verified,
+		// let's add the checkout to the session so that it's available to other systems
+		EE_Registry::instance()->SSN->set_checkout($this->checkout);
+		return true;
+	}
+
+
+	/**
+	 *    _initialize_reg_steps
+	 * first makes sure that EE_Transaction_Processor::set_reg_step_initiated() is called as required
+	 * then loops thru all of the active reg steps and calls the initialize_reg_step() method
+	 *
+	 * @param bool $reinitializing
+	 * @throws EE_Error
+	 */
+	private function _initialize_reg_steps($reinitializing = false)
+	{
+		$this->checkout->set_reg_step_initiated($this->checkout->current_step);
+		// loop thru all steps to call their individual "initialize" methods and set i18n strings for JS
+		foreach ($this->checkout->reg_steps as $reg_step) {
+			if (! $reg_step->initialize_reg_step()) {
+				// if not initialized then maybe this step is being removed...
+				if (! $reinitializing && $reg_step->is_current_step()) {
+					// if it was the current step, then we need to start over here
+					$this->_initialize_reg_steps(true);
+					return;
+				}
+				continue;
+			}
+			// add css and JS for current step
+			$this->add_styles_and_scripts($reg_step);
+			if ($reg_step->is_current_step()) {
+				// the text that appears on the reg step form submit button
+				$reg_step->set_submit_button_text();
+			}
+		}
+		// dynamically creates hook point like: AHEE__Single_Page_Checkout___initialize_reg_step__attendee_information
+		do_action(
+			"AHEE__Single_Page_Checkout___initialize_reg_step__{$this->checkout->current_step->slug()}",
+			$this->checkout->current_step
+		);
+	}
+
+
+	/**
+	 * _check_form_submission
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _check_form_submission()
+	{
+		// does this request require the reg form to be generated ?
+		if ($this->checkout->generate_reg_form) {
+			// ever heard that song by Blue Rodeo ?
+			try {
+				$this->checkout->current_step->reg_form = $this->checkout->current_step->generate_reg_form();
+				// if not displaying a form, then check for form submission
+				if (
+					$this->checkout->process_form_submission
+					&& $this->checkout->current_step->reg_form->was_submitted()
+				) {
+					// clear out any old data in case this step is being run again
+					$this->checkout->current_step->set_valid_data(array());
+					// capture submitted form data
+					$request_data = $this->request->requestParams();
+					$this->checkout->current_step->reg_form->receive_form_submission(
+						(array) apply_filters(
+							'FHEE__Single_Page_Checkout___check_form_submission__request_params',
+							$request_data,
+							$this->checkout
+						)
+					);
+					// validate submitted form data
+					if (! $this->checkout->continue_reg || ! $this->checkout->current_step->reg_form->is_valid()) {
+						// thou shall not pass !!!
+						$this->checkout->continue_reg = false;
+						// any form validation errors?
+						if ($this->checkout->current_step->reg_form->submission_error_message() !== '') {
+							EE_Error::add_error(
+								$this->checkout->current_step->reg_form->submission_error_message(),
+								__FILE__,
+								__FUNCTION__,
+								__LINE__
+							);
+						}
+						// well not really... what will happen is
+						// we'll just get redirected back to redo the current step
+						$this->go_to_next_step();
+						return false;
+					}
+				}
+			} catch (EE_Error $e) {
+				$e->get_error();
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * _process_action
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _process_form_action()
+	{
+		// what cha wanna do?
+		switch ($this->checkout->action) {
+			// AJAX next step reg form
+			case 'display_spco_reg_step':
+				$this->checkout->redirect = false;
+				if ($this->request->isAjax()) {
+					$this->checkout->json_response->set_reg_step_html(
+						$this->checkout->current_step->display_reg_form()
+					);
+				}
+				break;
+			default:
+				// meh... do one of those other steps first
+				if (
+					! empty($this->checkout->action)
+					&& is_callable(array($this->checkout->current_step, $this->checkout->action))
+				) {
+					// dynamically creates hook point like:
+					//   AHEE__Single_Page_Checkout__before_attendee_information__process_reg_step
+					do_action(
+						"AHEE__Single_Page_Checkout__before_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
+						$this->checkout->current_step
+					);
+					$process_reg_step = apply_filters(
+						"AHEE__Single_Page_Checkout__process_reg_step__{$this->checkout->current_step->slug()}__{$this->checkout->action}",
+						true,
+						$this->checkout->current_step,
+						$this
+					);
+					// call action on current step
+					if ($process_reg_step && call_user_func([$this->checkout->current_step, $this->checkout->action])) {
+						// good registrant, you get to proceed
+						if (
+							$this->checkout->current_step->success_message() !== ''
+							&& apply_filters(
+								'FHEE__Single_Page_Checkout___process_form_action__display_success',
+								false
+							)
+						) {
+							EE_Error::add_success(
+								$this->checkout->current_step->success_message()
+								. '<br />' . $this->checkout->next_step->_instructions()
+							);
+						}
+						// pack it up, pack it in...
+						$this->_setup_redirect();
+					}
+					// dynamically creates hook point like:
+					//  AHEE__Single_Page_Checkout__after_payment_options__process_reg_step
+					do_action(
+						"AHEE__Single_Page_Checkout__after_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
+						$this->checkout->current_step
+					);
+				} else {
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								'The requested form action "%s" does not exist for the current "%s" registration step.',
+								'event_espresso'
+							),
+							$this->checkout->action,
+							$this->checkout->current_step->name()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			// end default
+		}
+		// store our progress so far
+		$this->checkout->stash_transaction_and_checkout();
+		// advance to the next step! If you pass GO, collect $200
+		$this->go_to_next_step();
+	}
+
+
+	/**
+	 * @param EED_Single_Page_Checkout|EE_SPCO_Reg_Step $target an object with the method `translate_js_strings` and
+	 *                                                          `enqueue_styles_and_scripts`.
+	 * @return        void
+	 */
+	public function add_styles_and_scripts($target)
+	{
+		// i18n
+		$target->translate_js_strings();
+		if ($this->checkout->admin_request) {
+			add_action('admin_enqueue_scripts', array($target, 'enqueue_styles_and_scripts'), 10);
+		} else {
+			add_action('wp_enqueue_scripts', array($target, 'enqueue_styles_and_scripts'), 10);
+		}
+	}
+
+	/**
+	 *        translate_js_strings
+	 *
+	 * @return        void
+	 */
+	public function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['revisit'] = $this->checkout->revisit;
+		EE_Registry::$i18n_js_strings['e_reg_url_link'] = $this->checkout->reg_url_link;
+		EE_Registry::$i18n_js_strings['server_error'] = esc_html__(
+			'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_json_response'] = esc_html__(
+			'An invalid response was returned from the server while attempting to process your request. Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['validation_error'] = esc_html__(
+			'There appears to be a problem with the form validation configuration! Please check the admin settings or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
+			'There appears to be a problem with the payment method configuration! Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['reg_step_error'] = esc_html__(
+			'This registration step could not be completed. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_coupon'] = esc_html__(
+			'We\'re sorry but that coupon code does not appear to be valid. If this is incorrect, please contact the site administrator.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['process_registration'] = sprintf(
+			esc_html__(
+				'Please wait while we process your registration.%sDo not refresh the page or navigate away while this is happening.%sThank you for your patience.',
+				'event_espresso'
+			),
+			'<br/>',
+			'<br/>'
+		);
+		EE_Registry::$i18n_js_strings['language'] = get_bloginfo('language');
+		EE_Registry::$i18n_js_strings['EESID'] = EE_Registry::instance()->SSN->id();
+		EE_Registry::$i18n_js_strings['currency'] = EE_Registry::instance()->CFG->currency;
+		EE_Registry::$i18n_js_strings['datepicker_yearRange'] = '-150:+20';
+		EE_Registry::$i18n_js_strings['timer_years'] = esc_html__('years', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_months'] = esc_html__('months', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_weeks'] = esc_html__('weeks', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_days'] = esc_html__('days', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_hours'] = esc_html__('hours', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_minutes'] = esc_html__('minutes', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_seconds'] = esc_html__('seconds', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_year'] = esc_html__('year', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_month'] = esc_html__('month', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_week'] = esc_html__('week', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_day'] = esc_html__('day', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_hour'] = esc_html__('hour', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_minute'] = esc_html__('minute', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_second'] = esc_html__('second', 'event_espresso');
+		EE_Registry::$i18n_js_strings['registration_expiration_notice'] = EED_Single_Page_Checkout::getRegistrationExpirationNotice(
+		);
+		EE_Registry::$i18n_js_strings['ajax_submit'] = apply_filters(
+			'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
+			true
+		);
+		EE_Registry::$i18n_js_strings['session_extension'] = absint(
+			apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS)
+		);
+		EE_Registry::$i18n_js_strings['session_expiration'] = gmdate(
+			'M d, Y H:i:s',
+			EE_Registry::instance()->SSN->expiration() + (get_option('gmt_offset') * HOUR_IN_SECONDS)
+		);
+	}
+
+
+	/**
+	 *    enqueue_styles_and_scripts
+	 *
+	 * @return        void
+	 * @throws EE_Error
+	 */
+	public function enqueue_styles_and_scripts()
+	{
+		// load css
+		wp_register_style(
+			'single_page_checkout',
+			SPCO_CSS_URL . 'single_page_checkout.css',
+			array('espresso_default'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('single_page_checkout');
+		// load JS
+		wp_register_script(
+			'jquery_plugin',
+			EE_THIRD_PARTY_URL . 'jquery	.plugin.min.js',
+			array('jquery'),
+			'1.0.1',
+			true
+		);
+		wp_register_script(
+			'jquery_countdown',
+			EE_THIRD_PARTY_URL . 'jquery	.countdown.min.js',
+			array('jquery_plugin'),
+			'2.1.0',
+			true
+		);
+		wp_register_script(
+			'single_page_checkout',
+			SPCO_JS_URL . 'single_page_checkout.js',
+			array('espresso_core', 'underscore', 'ee_form_section_validation'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		if ($this->checkout->registration_form instanceof EE_Form_Section_Proper) {
+			$this->checkout->registration_form->enqueue_js();
+		}
+		if ($this->checkout->current_step->reg_form instanceof EE_Form_Section_Proper) {
+			$this->checkout->current_step->reg_form->enqueue_js();
+		}
+		wp_enqueue_script('single_page_checkout');
+		if (apply_filters('FHEE__registration_page_wrapper_template__display_time_limit', false)) {
+			wp_enqueue_script('jquery_countdown');
+		}
+		/**
+		 * global action hook for enqueueing styles and scripts with
+		 * spco calls.
+		 */
+		do_action('AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts', $this);
+		/**
+		 * dynamic action hook for enqueueing styles and scripts with spco calls.
+		 * The hook will end up being something like:
+		 *      AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information
+		 */
+		do_action(
+			'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__' . $this->checkout->current_step->slug(),
+			$this
+		);
+	}
+
+
+	/**
+	 *    display the Registration Single Page Checkout Form
+	 *
+	 * @return    void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _display_spco_reg_form()
+	{
+		// if registering via the admin, just display the reg form for the current step
+		if ($this->checkout->admin_request) {
+			EED_Single_Page_Checkout::getResponse()->addOutput($this->checkout->current_step->display_reg_form());
+		} else {
+			// add powered by EE msg
+			add_action('AHEE__SPCO__reg_form_footer', array('EED_Single_Page_Checkout', 'display_registration_footer'));
+			$empty_cart = count(
+				$this->checkout->transaction->registrations($this->checkout->reg_cache_where_params)
+			) < 1;
+			EE_Registry::$i18n_js_strings['empty_cart'] = $empty_cart;
+			$cookies_not_set_msg = '';
+			if ($empty_cart) {
+				$cookies_not_set_msg = apply_filters(
+					'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg',
+					sprintf(
+						esc_html__(
+							'%1$s%3$sIt appears your browser is not currently set to accept Cookies%4$s%5$sIn order to register for events, you need to enable cookies.%7$sIf you require assistance, then click the following link to learn how to %8$senable cookies%9$s%6$s%2$s',
+							'event_espresso'
+						),
+						'<div class="ee-attention hidden" id="ee-cookies-not-set-msg">',
+						'</div>',
+						'<h6 class="important-notice">',
+						'</h6>',
+						'<p>',
+						'</p>',
+						'<br />',
+						'<a href="https://www.whatismybrowser.com/guides/how-to-enable-cookies/" target="_blank" rel="noopener noreferrer">',
+						'</a>'
+					)
+				);
+			}
+			$this->checkout->registration_form = new EE_Form_Section_Proper(
+				array(
+					'name'            => 'single-page-checkout',
+					'html_id'         => 'ee-single-page-checkout-dv',
+					'layout_strategy' =>
+						new EE_Template_Layout(
+							array(
+								'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php',
+								'template_args'        => array(
+									'empty_cart'              => $empty_cart,
+									'revisit'                 => $this->checkout->revisit,
+									'reg_steps'               => $this->checkout->reg_steps,
+									'next_step'               => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+										? $this->checkout->next_step->slug()
+										: '',
+									'empty_msg'               => apply_filters(
+										'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg',
+										sprintf(
+											esc_html__(
+												'You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.',
+												'event_espresso'
+											),
+											'<a href="'
+											. get_post_type_archive_link('espresso_events')
+											. '" title="',
+											'">',
+											'</a>'
+										)
+									),
+									'cookies_not_set_msg'     => $cookies_not_set_msg,
+									'registration_time_limit' => $this->checkout->get_registration_time_limit(),
+									'session_expiration'      => gmdate(
+										'M d, Y H:i:s',
+										EE_Registry::instance()->SSN->expiration()
+										+ (get_option('gmt_offset') * HOUR_IN_SECONDS)
+									),
+								),
+							)
+						),
+				)
+			);
+			// load template and add to output sent that gets filtered into the_content()
+			EED_Single_Page_Checkout::getResponse()->addOutput($this->checkout->registration_form->get_html());
+		}
+	}
+
+
+	/**
+	 *    add_extra_finalize_registration_inputs
+	 *
+	 * @param $next_step
+	 * @internal  param string $label
+	 * @return void
+	 */
+	public function add_extra_finalize_registration_inputs($next_step)
+	{
+		if ($next_step === 'finalize_registration') {
+			echo '<div id="spco-extra-finalize_registration-inputs-dv"></div>';
+		}
+	}
+
+
+	/**
+	 *    display_registration_footer
+	 *
+	 * @return    string
+	 */
+	public static function display_registration_footer()
+	{
+		if (
+			apply_filters(
+				'FHEE__EE_Front__Controller__show_reg_footer',
+				EE_Registry::instance()->CFG->admin->show_reg_footer
+			)
+		) {
+			add_filter(
+				'FHEE__EEH_Template__powered_by_event_espresso__url',
+				function ($url) {
+					return apply_filters('FHEE__EE_Front_Controller__registration_footer__url', $url);
+				}
+			);
+			echo apply_filters(
+				'FHEE__EE_Front_Controller__display_registration_footer',
+				EEH_Template::powered_by_event_espresso(
+					'',
+					'espresso-registration-footer-dv',
+					array('utm_content' => 'registration_checkout')
+				)
+			);
+		}
+		return '';
+	}
+
+
+	/**
+	 *    unlock_transaction
+	 *
+	 * @return    void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function unlock_transaction()
+	{
+		if ($this->checkout->transaction instanceof EE_Transaction) {
+			$this->checkout->transaction->unlock();
+		}
+	}
+
+
+	/**
+	 *        _setup_redirect
+	 *
+	 * @return void
+	 */
+	private function _setup_redirect()
+	{
+		if ($this->checkout->continue_reg && $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			$this->checkout->redirect = true;
+			if (empty($this->checkout->redirect_url)) {
+				$this->checkout->redirect_url = $this->checkout->next_step->reg_step_url();
+			}
+			$this->checkout->redirect_url = apply_filters(
+				'FHEE__EED_Single_Page_Checkout___setup_redirect__checkout_redirect_url',
+				$this->checkout->redirect_url,
+				$this->checkout
+			);
+		}
+	}
+
+
+	/**
+	 *   handle ajax message responses and redirects
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function go_to_next_step()
+	{
+		if ($this->request->isAjax()) {
+			// capture contents of output buffer we started earlier in the request, and insert into JSON response
+			$this->checkout->json_response->set_unexpected_errors(ob_get_clean());
+		}
+		$this->unlock_transaction();
+		// just return for these conditions
+		if (
+			$this->checkout->admin_request
+			|| $this->checkout->action === 'redirect_form'
+			|| $this->checkout->action === 'update_checkout'
+		) {
+			return;
+		}
+		// AJAX response
+		$this->_handle_json_response();
+		// redirect to next step or the Thank You page
+		$this->_handle_html_redirects();
+		// hmmm... must be something wrong, so let's just display the form again !
+		$this->_display_spco_reg_form();
+	}
+
+
+	/**
+	 *   _handle_json_response
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _handle_json_response()
+	{
+		// if this is an ajax request
+		if ($this->request->isAjax()) {
+			$this->checkout->json_response->set_registration_time_limit(
+				$this->checkout->get_registration_time_limit()
+			);
+			$this->checkout->json_response->set_payment_amount($this->checkout->amount_owing);
+			// just send the ajax (
+			$json_response = apply_filters(
+				'FHEE__EE_Single_Page_Checkout__JSON_response',
+				$this->checkout->json_response
+			);
+			echo ($json_response);
+			exit();
+		}
+	}
+
+
+	/**
+	 *   _handle_redirects
+	 *
+	 * @return void
+	 */
+	protected function _handle_html_redirects()
+	{
+		// going somewhere ?
+		if ($this->checkout->redirect && ! empty($this->checkout->redirect_url)) {
+			// store notices in a transient
+			EE_Error::get_notices(false, true);
+			wp_safe_redirect($this->checkout->redirect_url);
+			exit();
+		}
+	}
+
+
+	/**
+	 *   set_checkout_anchor
+	 *
+	 * @return void
+	 */
+	public function set_checkout_anchor()
+	{
+		echo '<a id="checkout" style="float: left; margin-left: -999em;"></a>';
+	}
+
+	/**
+	 *    getRegistrationExpirationNotice
+	 *
+	 * @since     4.9.59.p
+	 * @return    string
+	 */
+	public static function getRegistrationExpirationNotice()
+	{
+		return sprintf(
+			esc_html__(
+				'%1$sWe\'re sorry, but your registration time has expired.%2$s%3$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please accept our apologies for any inconvenience this may have caused.%8$s',
+				'event_espresso'
+			),
+			'<h4 class="important-notice">',
+			'</h4>',
+			'<br />',
+			'<p>',
+			'<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
+			'">',
+			'</a>',
+			'</p>'
+		);
+	}
 }

widgets/upcoming_events/EEW_Upcoming_Events.widget.php

Indentation +594 added lines, -594 removed lines

@@ -12,109 +12,109 @@ 
  */
 class EEW_Upcoming_Events extends EspressoWidget
 {
-    /**
-     * @var string
-     */
-    private $title;
-    /**
-     * @var string
-     */
-    private $events_category;
-
-    /**
-     * @var bool
-     */
-    private $show_expired;
-
-    /**
-     * @var string
-     */
-    private $image_size;
-
-    /**
-     * @var bool
-     */
-    private $show_desc;
-
-    /**
-     * @var bool
-     */
-    private $show_dates;
-
-    /**
-     * @var string
-     */
-    private $date_limit;
-
-    /**
-     * @var string
-     */
-    private $date_range;
-
-    /**
-     * @var string
-     */
-    private $limit;
-
-    /**
-     * @var string
-     */
-    private $order;
-
-
-    /**
-     * Register widget with WordPress.
-     */
-    public function __construct()
-    {
-        parent::__construct(
-            esc_html__('Event Espresso Upcoming Events', 'event_espresso'),
-            ['description' => esc_html__('A widget to display your upcoming events.', 'event_espresso')]
-        );
-    }
-
-
-    /**
-     * Back-end widget form.
-     *
-     * @param array $instance Previously saved values from database.
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see WP_Widget::form()
-     */
-    public function form($instance)
-    {
-
-        EE_Registry::instance()->load_class('Question_Option', [], false, false, true);
-        // Set up some default widget settings.
-        $defaults = [
-            'title'           => esc_html__('Upcoming Events', 'event_espresso'),
-            'category_name'   => '',
-            'show_expired'    => 0,
-            'show_desc'       => true,
-            'show_dates'      => true,
-            'show_everywhere' => false,
-            'date_limit'      => 2,
-            'limit'           => 10,
-            'sort'            => 'ASC',
-            'date_range'      => false,
-            'image_size'      => 'medium',
-        ];
-
-        $instance = wp_parse_args((array) $instance, $defaults);
-        // don't add HTML labels for EE_Form_Fields generated inputs
-        add_filter('FHEE__EEH_Form_Fields__label_html', '__return_empty_string');
-        $yes_no_values = [
-            EE_Question_Option::new_instance(['QSO_value' => false, 'QSO_desc' => esc_html__('No', 'event_espresso')]),
-            EE_Question_Option::new_instance(['QSO_value' => true, 'QSO_desc' => esc_html__('Yes', 'event_espresso')]),
-        ];
-        $sort_values   = [
-            EE_Question_Option::new_instance(['QSO_value' => 'ASC', 'QSO_desc' => esc_html__('ASC', 'event_espresso')]),
-            EE_Question_Option::new_instance(['QSO_value' => 'DESC', 'QSO_desc' => esc_html__('DESC', 'event_espresso')]),
-        ];
-
-        ?>
+	/**
+	 * @var string
+	 */
+	private $title;
+	/**
+	 * @var string
+	 */
+	private $events_category;
+
+	/**
+	 * @var bool
+	 */
+	private $show_expired;
+
+	/**
+	 * @var string
+	 */
+	private $image_size;
+
+	/**
+	 * @var bool
+	 */
+	private $show_desc;
+
+	/**
+	 * @var bool
+	 */
+	private $show_dates;
+
+	/**
+	 * @var string
+	 */
+	private $date_limit;
+
+	/**
+	 * @var string
+	 */
+	private $date_range;
+
+	/**
+	 * @var string
+	 */
+	private $limit;
+
+	/**
+	 * @var string
+	 */
+	private $order;
+
+
+	/**
+	 * Register widget with WordPress.
+	 */
+	public function __construct()
+	{
+		parent::__construct(
+			esc_html__('Event Espresso Upcoming Events', 'event_espresso'),
+			['description' => esc_html__('A widget to display your upcoming events.', 'event_espresso')]
+		);
+	}
+
+
+	/**
+	 * Back-end widget form.
+	 *
+	 * @param array $instance Previously saved values from database.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see WP_Widget::form()
+	 */
+	public function form($instance)
+	{
+
+		EE_Registry::instance()->load_class('Question_Option', [], false, false, true);
+		// Set up some default widget settings.
+		$defaults = [
+			'title'           => esc_html__('Upcoming Events', 'event_espresso'),
+			'category_name'   => '',
+			'show_expired'    => 0,
+			'show_desc'       => true,
+			'show_dates'      => true,
+			'show_everywhere' => false,
+			'date_limit'      => 2,
+			'limit'           => 10,
+			'sort'            => 'ASC',
+			'date_range'      => false,
+			'image_size'      => 'medium',
+		];
+
+		$instance = wp_parse_args((array) $instance, $defaults);
+		// don't add HTML labels for EE_Form_Fields generated inputs
+		add_filter('FHEE__EEH_Form_Fields__label_html', '__return_empty_string');
+		$yes_no_values = [
+			EE_Question_Option::new_instance(['QSO_value' => false, 'QSO_desc' => esc_html__('No', 'event_espresso')]),
+			EE_Question_Option::new_instance(['QSO_value' => true, 'QSO_desc' => esc_html__('Yes', 'event_espresso')]),
+		];
+		$sort_values   = [
+			EE_Question_Option::new_instance(['QSO_value' => 'ASC', 'QSO_desc' => esc_html__('ASC', 'event_espresso')]),
+			EE_Question_Option::new_instance(['QSO_value' => 'DESC', 'QSO_desc' => esc_html__('DESC', 'event_espresso')]),
+		];
+
+		?>
 
         <!-- Widget Title: Text Input -->
 
@@ -151,32 +151,32 @@ 
                 <?php esc_html_e('Show Expired Events:', 'event_espresso'); ?>
             </label>
             <?php
-            $show_expired_options   = $yes_no_values;
-            $show_expired_options[] = EE_Question_Option::new_instance(
-                ['QSO_value' => 2, 'QSO_desc' => esc_html__('Show Only Expired', 'event_espresso')]
-            );
-            echo EEH_Form_Fields::select(
-                esc_html__('Show Expired Events:', 'event_espresso'),
-                $instance['show_expired'],
-                $show_expired_options,
-                $this->fieldName('show_expired'),
-                $this->fieldID('show_expired')
-            );
-            ?>
+			$show_expired_options   = $yes_no_values;
+			$show_expired_options[] = EE_Question_Option::new_instance(
+				['QSO_value' => 2, 'QSO_desc' => esc_html__('Show Only Expired', 'event_espresso')]
+			);
+			echo EEH_Form_Fields::select(
+				esc_html__('Show Expired Events:', 'event_espresso'),
+				$instance['show_expired'],
+				$show_expired_options,
+				$this->fieldName('show_expired'),
+				$this->fieldID('show_expired')
+			);
+			?>
         </p>
         <p>
             <label for="<?php echo esc_attr($this->fieldID('sort')); ?>">
                 <?php esc_html_e('Sort Events:', 'event_espresso'); ?>
             </label>
             <?php
-            echo EEH_Form_Fields::select(
-                esc_html__('Sort Events:', 'event_espresso'),
-                $instance['sort'],
-                $sort_values,
-                $this->fieldName('sort'),
-                $this->fieldID('sort')
-            );
-            ?>
+			echo EEH_Form_Fields::select(
+				esc_html__('Sort Events:', 'event_espresso'),
+				$instance['sort'],
+				$sort_values,
+				$this->fieldName('sort'),
+				$this->fieldID('sort')
+			);
+			?>
         </p>
         <p>
             <label for="<?php echo esc_attr($this->fieldID('image_size')); ?>">
@@ -190,42 +190,42 @@ 
                 <?php esc_html_e('Show Description:', 'event_espresso'); ?>
             </label>
             <?php
-            echo EEH_Form_Fields::select(
-                esc_html__('Show Description:', 'event_espresso'),
-                $instance['show_desc'],
-                $yes_no_values,
-                $this->fieldName('show_desc'),
-                $this->fieldID('show_desc')
-            );
-            ?>
+			echo EEH_Form_Fields::select(
+				esc_html__('Show Description:', 'event_espresso'),
+				$instance['show_desc'],
+				$yes_no_values,
+				$this->fieldName('show_desc'),
+				$this->fieldID('show_desc')
+			);
+			?>
         </p>
         <p>
             <label for="<?php echo esc_attr($this->fieldID('show_dates')); ?>">
                 <?php esc_html_e('Show Dates:', 'event_espresso'); ?>
             </label>
             <?php
-            echo EEH_Form_Fields::select(
-                esc_html__('Show Dates:', 'event_espresso'),
-                $instance['show_dates'],
-                $yes_no_values,
-                $this->fieldName('show_dates'),
-                $this->fieldID('show_dates')
-            );
-            ?>
+			echo EEH_Form_Fields::select(
+				esc_html__('Show Dates:', 'event_espresso'),
+				$instance['show_dates'],
+				$yes_no_values,
+				$this->fieldName('show_dates'),
+				$this->fieldID('show_dates')
+			);
+			?>
         </p>
         <p>
             <label for="<?php echo esc_attr($this->fieldID('show_everywhere')); ?>">
                 <?php esc_html_e('Show on all Pages:', 'event_espresso'); ?>
             </label>
             <?php
-            echo EEH_Form_Fields::select(
-                esc_html__('Show on all Pages:', 'event_espresso'),
-                $instance['show_everywhere'],
-                $yes_no_values,
-                $this->fieldName('show_everywhere'),
-                $this->fieldID('show_everywhere')
-            );
-            ?>
+			echo EEH_Form_Fields::select(
+				esc_html__('Show on all Pages:', 'event_espresso'),
+				$instance['show_everywhere'],
+				$yes_no_values,
+				$this->fieldName('show_everywhere'),
+				$this->fieldID('show_everywhere')
+			);
+			?>
         </p>
         <p>
             <label for="<?php echo esc_attr($this->fieldID('date_limit')); ?>">
@@ -243,278 +243,278 @@ 
                 <?php esc_html_e('Show Date Range:', 'event_espresso'); ?>
             </label>
             <?php
-            echo EEH_Form_Fields::select(
-                esc_html__('Show Date Range:', 'event_espresso'),
-                $instance['date_range'],
-                $yes_no_values,
-                $this->fieldName('date_range'),
-                $this->fieldID('date_range')
-            );
-            ?>
+			echo EEH_Form_Fields::select(
+				esc_html__('Show Date Range:', 'event_espresso'),
+				$instance['date_range'],
+				$yes_no_values,
+				$this->fieldName('date_range'),
+				$this->fieldID('date_range')
+			);
+			?>
             <span class="description">
                 <br />
                 <?php esc_html_e(
-                    'This setting will replace the list of dates in the widget.',
-                    'event_espresso'
-                ); ?>
+					'This setting will replace the list of dates in the widget.',
+					'event_espresso'
+				); ?>
             </span>
         </p>
 
         <?php
-    }
-
-
-    /**
-     * Sanitize widget form values as they are saved.
-     *
-     * @param array $new_instance Values just sent to be saved.
-     * @param array $old_instance Previously saved values from database.
-     *
-     * @return array Updated safe values to be saved.
-     * @see WP_Widget::update()
-     *
-     */
-    public function update($new_instance, $old_instance)
-    {
-        $instance                    = $old_instance;
-        $instance['title']           = ! empty($new_instance['title']) ? strip_tags((string) $new_instance['title']) : '';
-        $instance['category_name']   = $new_instance['category_name'];
-        $instance['show_expired']    = $new_instance['show_expired'];
-        $instance['limit']           = $new_instance['limit'];
-        $instance['sort']            = $new_instance['sort'];
-        $instance['image_size']      = $new_instance['image_size'];
-        $instance['show_desc']       = $new_instance['show_desc'];
-        $instance['show_dates']      = $new_instance['show_dates'];
-        $instance['show_everywhere'] = $new_instance['show_everywhere'];
-        $instance['date_limit']      = $new_instance['date_limit'];
-        $instance['date_range']      = $new_instance['date_range'];
-        return $instance;
-    }
-
-
-    /**
-     * Front-end display of widget.
-     *
-     * @param array $args     Widget arguments.
-     * @param array $instance Saved values from database.
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see WP_Widget::widget()
-     *
-     */
-    public function widget($args, $instance)
-    {
-
-        global $post;
-        // make sure there is some kinda post object
-        if ($post instanceof WP_Post) {
-            $before_widget = '';
-            $before_title  = '';
-            $after_title   = '';
-            $after_widget  = '';
-            // but NOT an events archives page, cuz that would be like two event lists on the same page
-            $show_everywhere = ! isset($instance['show_everywhere']) || absint($instance['show_everywhere']);
-            if ($show_everywhere || ! ($post->post_type == 'espresso_events' && is_archive())) {
-                // let's use some of the event helper functions'
-                // make separate vars out of attributes
-                extract($args);
-
-                // grab widget settings
-                $this->parseWidgetSettings($instance);
-                $title = $this->widgetTitle();
-
-                // Before widget (defined by themes).
-                echo wp_kses($before_widget, AllowedTags::getAllowedTags());
-                // Display the widget title if one was input (before and after defined by themes).
-                if (! empty($title)) {
-                    echo wp_kses($before_title . $title . $after_title, AllowedTags::getAllowedTags());
-                }
-                echo wp_kses($this->widgetContent($post), AllowedTags::getWithFormTags());
-                // After widget (defined by themes).
-                echo wp_kses($after_widget, AllowedTags::getAllowedTags());
-            }
-        }
-    }
-
-
-    /**
-     * make_the_title_a_link
-     * callback for widget_title filter
-     *
-     * @param $title
-     * @return string
-     */
-    public function make_the_title_a_link($title)
-    {
-        return '<a href="' . EEH_Event_View::event_archive_url() . '">' . $title . '</a>';
-    }
-
-
-    /**
-     * @param string $field_name
-     * @return string
-     * @since   4.10.14.p
-     */
-    public function fieldID($field_name)
-    {
-        return parent::get_field_id($field_name);
-    }
-
-
-    /**
-     * @param string $field_name
-     * @return string
-     * @since   4.10.14.p
-     */
-    public function fieldName($field_name)
-    {
-        return parent::get_field_name($field_name);
-    }
-
-
-    /**
-     * @param array $instance
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   4.10.14.p
-     */
-    private function eventCategoriesSelector(array $instance)
-    {
-        $event_categories = [];
-        $categories       = EEM_Term::instance()->get_all_ee_categories(true);
-        if ($categories) {
-            foreach ($categories as $category) {
-                if ($category instanceof EE_Term) {
-                    $event_categories[] =
-                        EE_Question_Option::new_instance(
-                            [
-                                'QSO_value' => $category->get('slug'),
-                                'QSO_desc'  => $category->get('name'),
-                            ]
-                        );
-                }
-            }
-        }
-        array_unshift(
-            $event_categories,
-            EE_Question_Option::new_instance(
-                [
-                    'QSO_value' => '',
-                    'QSO_desc'  => esc_html__(' - display all - ', 'event_espresso'),
-                ]
-            )
-        );
-        echo EEH_Form_Fields::select(
-            esc_html__('Event Category:', 'event_espresso'),
-            $instance['category_name'],
-            $event_categories,
-            $this->fieldName('category_name'),
-            $this->fieldID('category_name')
-        );
-    }
-
-
-    /**
-     * @param array $instance
-     * @since   4.10.14.p
-     */
-    private function imageSizeSelector(array $instance)
-    {
-        $image_sizes = [];
-        $sizes       = get_intermediate_image_sizes();
-        if ($sizes) {
-            // loop thru images and create option objects out of them
-            foreach ($sizes as $image_size) {
-                $image_size = trim($image_size);
-                // no big images plz
-                if (! in_array($image_size, ['large', 'post-thumbnail'])) {
-                    $image_sizes[] =
-                        EE_Question_Option::new_instance(['QSO_value' => $image_size, 'QSO_desc' => $image_size]);
-                }
-            }
-            $image_sizes[] =
-                EE_Question_Option::new_instance(
-                    ['QSO_value' => 'none', 'QSO_desc' => esc_html__('don\'t show images', 'event_espresso')]
-                );
-        }
-        echo EEH_Form_Fields::select(
-            esc_html__('Image Size:', 'event_espresso'),
-            $instance['image_size'],
-            $image_sizes,
-            $this->fieldName('image_size'),
-            $this->fieldID('image_size')
-        );
-    }
-
-
-    /**
-     * @param array $instance
-     * @since   4.10.14.p
-     */
-    private function parseWidgetSettings(array $instance)
-    {
-        $this->title = isset($instance['title']) && ! empty($instance['title']) ? $instance['title'] : '';
-        $this->events_category     = isset($instance['category_name']) && ! empty($instance['category_name'])
-            ? $instance['category_name']
-            : false;
-        $this->show_expired = isset($instance['show_expired'])
-            ? filter_var($instance['show_expired'], FILTER_VALIDATE_BOOLEAN)
-            : 0;
-        $this->image_size   = isset($instance['image_size']) && ! empty($instance['image_size'])
-            ? $instance['image_size']
-            : 'medium';
-        $this->show_desc    = ! isset($instance['show_desc'])
-                              || filter_var($instance['show_desc'], FILTER_VALIDATE_BOOLEAN);
-        $this->show_dates   = ! isset($instance['show_dates'])
-                              || filter_var($instance['show_dates'], FILTER_VALIDATE_BOOLEAN);
-        $this->date_limit   = isset($instance['date_limit']) && ! empty($instance['date_limit'])
-            ? $instance['date_limit']
-            : null;
-        $this->date_range   = isset($instance['date_range']) && ! empty($instance['date_range'])
-            ? $instance['date_range']
-            : false;
-        $this->limit        = isset($instance['limit']) ? absint($instance['limit']) : 10;
-        $this->order        = isset($instance['sort']) && $instance['sort'] === 'DESC'
-            ? 'DESC'
-            : 'ASC';
-    }
-
-
-    /**
-     * @return mixed|void
-     * @since   4.10.14.p
-     */
-    private function widgetTitle()
-    {
-        // add function to make the title a link
-        add_filter('widget_title', [$this, 'make_the_title_a_link'], 15);
-        // filter the title
-        $title = apply_filters('widget_title', $this->title);
-        // remove the function from the filter, so it does not affect other widgets
-        remove_filter('widget_title', [$this, 'make_the_title_a_link'], 15);
-        return $title;
-    }
-
-
-    /**
-     * @param WP_Post $post
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   4.10.14.p
-     */
-    private function widgetContent(WP_Post $post)
-    {
-        // run the query
-        $events = $this->getUpcomingEvents();
-        if (empty($events)) {
-            return '';
-        }
-        $list_items = '';
-        foreach ($events as $event) {
-            if ($event instanceof EE_Event && (! is_single() || $post->ID != $event->ID())) {
-                $event_url = $this->eventUrl($event);
-                $list_items .= '
+	}
+
+
+	/**
+	 * Sanitize widget form values as they are saved.
+	 *
+	 * @param array $new_instance Values just sent to be saved.
+	 * @param array $old_instance Previously saved values from database.
+	 *
+	 * @return array Updated safe values to be saved.
+	 * @see WP_Widget::update()
+	 *
+	 */
+	public function update($new_instance, $old_instance)
+	{
+		$instance                    = $old_instance;
+		$instance['title']           = ! empty($new_instance['title']) ? strip_tags((string) $new_instance['title']) : '';
+		$instance['category_name']   = $new_instance['category_name'];
+		$instance['show_expired']    = $new_instance['show_expired'];
+		$instance['limit']           = $new_instance['limit'];
+		$instance['sort']            = $new_instance['sort'];
+		$instance['image_size']      = $new_instance['image_size'];
+		$instance['show_desc']       = $new_instance['show_desc'];
+		$instance['show_dates']      = $new_instance['show_dates'];
+		$instance['show_everywhere'] = $new_instance['show_everywhere'];
+		$instance['date_limit']      = $new_instance['date_limit'];
+		$instance['date_range']      = $new_instance['date_range'];
+		return $instance;
+	}
+
+
+	/**
+	 * Front-end display of widget.
+	 *
+	 * @param array $args     Widget arguments.
+	 * @param array $instance Saved values from database.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see WP_Widget::widget()
+	 *
+	 */
+	public function widget($args, $instance)
+	{
+
+		global $post;
+		// make sure there is some kinda post object
+		if ($post instanceof WP_Post) {
+			$before_widget = '';
+			$before_title  = '';
+			$after_title   = '';
+			$after_widget  = '';
+			// but NOT an events archives page, cuz that would be like two event lists on the same page
+			$show_everywhere = ! isset($instance['show_everywhere']) || absint($instance['show_everywhere']);
+			if ($show_everywhere || ! ($post->post_type == 'espresso_events' && is_archive())) {
+				// let's use some of the event helper functions'
+				// make separate vars out of attributes
+				extract($args);
+
+				// grab widget settings
+				$this->parseWidgetSettings($instance);
+				$title = $this->widgetTitle();
+
+				// Before widget (defined by themes).
+				echo wp_kses($before_widget, AllowedTags::getAllowedTags());
+				// Display the widget title if one was input (before and after defined by themes).
+				if (! empty($title)) {
+					echo wp_kses($before_title . $title . $after_title, AllowedTags::getAllowedTags());
+				}
+				echo wp_kses($this->widgetContent($post), AllowedTags::getWithFormTags());
+				// After widget (defined by themes).
+				echo wp_kses($after_widget, AllowedTags::getAllowedTags());
+			}
+		}
+	}
+
+
+	/**
+	 * make_the_title_a_link
+	 * callback for widget_title filter
+	 *
+	 * @param $title
+	 * @return string
+	 */
+	public function make_the_title_a_link($title)
+	{
+		return '<a href="' . EEH_Event_View::event_archive_url() . '">' . $title . '</a>';
+	}
+
+
+	/**
+	 * @param string $field_name
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	public function fieldID($field_name)
+	{
+		return parent::get_field_id($field_name);
+	}
+
+
+	/**
+	 * @param string $field_name
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	public function fieldName($field_name)
+	{
+		return parent::get_field_name($field_name);
+	}
+
+
+	/**
+	 * @param array $instance
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   4.10.14.p
+	 */
+	private function eventCategoriesSelector(array $instance)
+	{
+		$event_categories = [];
+		$categories       = EEM_Term::instance()->get_all_ee_categories(true);
+		if ($categories) {
+			foreach ($categories as $category) {
+				if ($category instanceof EE_Term) {
+					$event_categories[] =
+						EE_Question_Option::new_instance(
+							[
+								'QSO_value' => $category->get('slug'),
+								'QSO_desc'  => $category->get('name'),
+							]
+						);
+				}
+			}
+		}
+		array_unshift(
+			$event_categories,
+			EE_Question_Option::new_instance(
+				[
+					'QSO_value' => '',
+					'QSO_desc'  => esc_html__(' - display all - ', 'event_espresso'),
+				]
+			)
+		);
+		echo EEH_Form_Fields::select(
+			esc_html__('Event Category:', 'event_espresso'),
+			$instance['category_name'],
+			$event_categories,
+			$this->fieldName('category_name'),
+			$this->fieldID('category_name')
+		);
+	}
+
+
+	/**
+	 * @param array $instance
+	 * @since   4.10.14.p
+	 */
+	private function imageSizeSelector(array $instance)
+	{
+		$image_sizes = [];
+		$sizes       = get_intermediate_image_sizes();
+		if ($sizes) {
+			// loop thru images and create option objects out of them
+			foreach ($sizes as $image_size) {
+				$image_size = trim($image_size);
+				// no big images plz
+				if (! in_array($image_size, ['large', 'post-thumbnail'])) {
+					$image_sizes[] =
+						EE_Question_Option::new_instance(['QSO_value' => $image_size, 'QSO_desc' => $image_size]);
+				}
+			}
+			$image_sizes[] =
+				EE_Question_Option::new_instance(
+					['QSO_value' => 'none', 'QSO_desc' => esc_html__('don\'t show images', 'event_espresso')]
+				);
+		}
+		echo EEH_Form_Fields::select(
+			esc_html__('Image Size:', 'event_espresso'),
+			$instance['image_size'],
+			$image_sizes,
+			$this->fieldName('image_size'),
+			$this->fieldID('image_size')
+		);
+	}
+
+
+	/**
+	 * @param array $instance
+	 * @since   4.10.14.p
+	 */
+	private function parseWidgetSettings(array $instance)
+	{
+		$this->title = isset($instance['title']) && ! empty($instance['title']) ? $instance['title'] : '';
+		$this->events_category     = isset($instance['category_name']) && ! empty($instance['category_name'])
+			? $instance['category_name']
+			: false;
+		$this->show_expired = isset($instance['show_expired'])
+			? filter_var($instance['show_expired'], FILTER_VALIDATE_BOOLEAN)
+			: 0;
+		$this->image_size   = isset($instance['image_size']) && ! empty($instance['image_size'])
+			? $instance['image_size']
+			: 'medium';
+		$this->show_desc    = ! isset($instance['show_desc'])
+							  || filter_var($instance['show_desc'], FILTER_VALIDATE_BOOLEAN);
+		$this->show_dates   = ! isset($instance['show_dates'])
+							  || filter_var($instance['show_dates'], FILTER_VALIDATE_BOOLEAN);
+		$this->date_limit   = isset($instance['date_limit']) && ! empty($instance['date_limit'])
+			? $instance['date_limit']
+			: null;
+		$this->date_range   = isset($instance['date_range']) && ! empty($instance['date_range'])
+			? $instance['date_range']
+			: false;
+		$this->limit        = isset($instance['limit']) ? absint($instance['limit']) : 10;
+		$this->order        = isset($instance['sort']) && $instance['sort'] === 'DESC'
+			? 'DESC'
+			: 'ASC';
+	}
+
+
+	/**
+	 * @return mixed|void
+	 * @since   4.10.14.p
+	 */
+	private function widgetTitle()
+	{
+		// add function to make the title a link
+		add_filter('widget_title', [$this, 'make_the_title_a_link'], 15);
+		// filter the title
+		$title = apply_filters('widget_title', $this->title);
+		// remove the function from the filter, so it does not affect other widgets
+		remove_filter('widget_title', [$this, 'make_the_title_a_link'], 15);
+		return $title;
+	}
+
+
+	/**
+	 * @param WP_Post $post
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   4.10.14.p
+	 */
+	private function widgetContent(WP_Post $post)
+	{
+		// run the query
+		$events = $this->getUpcomingEvents();
+		if (empty($events)) {
+			return '';
+		}
+		$list_items = '';
+		foreach ($events as $event) {
+			if ($event instanceof EE_Event && (! is_single() || $post->ID != $event->ID())) {
+				$event_url = $this->eventUrl($event);
+				$list_items .= '
                 <li id="ee-upcoming-events-widget-li-' . absint($event->ID()) . '" 
                     class="ee-upcoming-events-widget-li"
                 >
@@ -525,194 +525,194 @@ 
                     </h5>
                     ' . $this->eventWidgetContent($event, $event_url) . '
                 </li>';
-            }
-        }
-        return '
+			}
+		}
+		return '
             <ul class="ee-upcoming-events-widget-ul">
                 ' . $list_items . '
             </ul>';
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string|null
-     * @throws EE_Error
-     * @since   4.10.14.p
-     */
-    private function eventUrl(EE_Event $event)
-    {
-        return esc_url_raw(
-            apply_filters(
-                'FHEE_EEW_Upcoming_Events__widget__event_url',
-                $event->get_permalink(),
-                $event
-            )
-        );
-    }
-
-
-    /**
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     */
-    private function getUpcomingEvents()
-    {
-        return EEM_Event::instance()->get_all(
-            [
-                $this->queryWhereParams(),
-                'limit'    => '0,' . $this->limit,
-                'order_by' => 'Datetime.DTT_EVT_start',
-                'order'    => $this->order,
-                'group_by' => 'EVT_ID',
-            ]
-        );
-    }
-
-
-    /**
-     * @return mixed|void
-     * @throws EE_Error
-     * @since   4.10.14.p
-     */
-    private function queryWhereParams()
-    {
-        // start to build our where clause
-        $where = [
-            'status' => ['IN', ['publish', 'sold_out']],
-        ];
-        // add category
-        if ($this->events_category) {
-            $where['Term_Taxonomy.taxonomy']  = 'espresso_event_categories';
-            $where['Term_Taxonomy.Term.slug'] = $this->events_category;
-        }
-        // if NOT expired then we want events that start today or in the future
-        // if NOT show expired then we want events that start today or in the future
-        if ($this->show_expired == 0) {
-            $where['Datetime.DTT_EVT_end'] = [
-                '>=',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            ];
-        }
-        // if show ONLY expired we want events that ended prior to today
-        if ($this->show_expired == 2) {
-            $where['Datetime.DTT_EVT_end'] = [
-                '<=',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            ];
-        }
-        // allow $where to be filtered
-        return apply_filters('FHEE__EEW_Upcoming_Events__widget__where', $where, $this->events_category, $this->show_expired);
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   4.10.14.p
-     */
-    private function linkClass(EE_Event $event)
-    {
-        // how big is the event name ?
-        $name_length = strlen($event->name());
-        switch ($name_length) {
-            case $name_length > 70:
-                return ' three-line';
-            case $name_length > 35:
-                return ' two-line';
-        }
-        return ' one-line';
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @param string   $event_url
-     * @return mixed|string|void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   4.10.14.p
-     */
-    private function eventWidgetContent(EE_Event $event, $event_url = '')
-    {
-        if (post_password_required($event->ID())) {
-            return apply_filters(
-                'FHEE_EEW_Upcoming_Events__widget__password_form',
-                get_the_password_form($event->ID()),
-                $event
-            );
-        }
-
-        $content = '';
-        if (has_post_thumbnail($event->ID()) && $this->image_size != 'none') {
-            $content .= '
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string|null
+	 * @throws EE_Error
+	 * @since   4.10.14.p
+	 */
+	private function eventUrl(EE_Event $event)
+	{
+		return esc_url_raw(
+			apply_filters(
+				'FHEE_EEW_Upcoming_Events__widget__event_url',
+				$event->get_permalink(),
+				$event
+			)
+		);
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	private function getUpcomingEvents()
+	{
+		return EEM_Event::instance()->get_all(
+			[
+				$this->queryWhereParams(),
+				'limit'    => '0,' . $this->limit,
+				'order_by' => 'Datetime.DTT_EVT_start',
+				'order'    => $this->order,
+				'group_by' => 'EVT_ID',
+			]
+		);
+	}
+
+
+	/**
+	 * @return mixed|void
+	 * @throws EE_Error
+	 * @since   4.10.14.p
+	 */
+	private function queryWhereParams()
+	{
+		// start to build our where clause
+		$where = [
+			'status' => ['IN', ['publish', 'sold_out']],
+		];
+		// add category
+		if ($this->events_category) {
+			$where['Term_Taxonomy.taxonomy']  = 'espresso_event_categories';
+			$where['Term_Taxonomy.Term.slug'] = $this->events_category;
+		}
+		// if NOT expired then we want events that start today or in the future
+		// if NOT show expired then we want events that start today or in the future
+		if ($this->show_expired == 0) {
+			$where['Datetime.DTT_EVT_end'] = [
+				'>=',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			];
+		}
+		// if show ONLY expired we want events that ended prior to today
+		if ($this->show_expired == 2) {
+			$where['Datetime.DTT_EVT_end'] = [
+				'<=',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			];
+		}
+		// allow $where to be filtered
+		return apply_filters('FHEE__EEW_Upcoming_Events__widget__where', $where, $this->events_category, $this->show_expired);
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   4.10.14.p
+	 */
+	private function linkClass(EE_Event $event)
+	{
+		// how big is the event name ?
+		$name_length = strlen($event->name());
+		switch ($name_length) {
+			case $name_length > 70:
+				return ' three-line';
+			case $name_length > 35:
+				return ' two-line';
+		}
+		return ' one-line';
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @param string   $event_url
+	 * @return mixed|string|void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   4.10.14.p
+	 */
+	private function eventWidgetContent(EE_Event $event, $event_url = '')
+	{
+		if (post_password_required($event->ID())) {
+			return apply_filters(
+				'FHEE_EEW_Upcoming_Events__widget__password_form',
+				get_the_password_form($event->ID()),
+				$event
+			);
+		}
+
+		$content = '';
+		if (has_post_thumbnail($event->ID()) && $this->image_size != 'none') {
+			$content .= '
                 <div class="ee-upcoming-events-widget-img-dv">
                     <a class="ee-upcoming-events-widget-img" href="' . $event_url . '">
                         ' . get_the_post_thumbnail($event->ID(), $this->image_size) . '
                     </a>
                 </div>';
-        }
-
-        if ($this->show_dates) {
-            $content .= $this->eventDates($event);
-        }
-
-        if ($this->show_desc) {
-            $allowedtags = AllowedTags::getAllowedTags();
-            $desc    = $event->short_description(25);
-            $content .= $desc ? '<p style="margin-top: .5em">' . wp_kses($desc, $allowedtags) . '</p>' : '';
-        }
-
-        return $content;
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   4.10.14.p
-     */
-    private function eventDates(EE_Event $event)
-    {
-        $date_format        = apply_filters(
-            'FHEE__espresso_event_date_range__date_format',
-            get_option('date_format')
-        );
-        $time_format        = apply_filters(
-            'FHEE__espresso_event_date_range__time_format',
-            get_option('time_format')
-        );
-        $single_date_format = apply_filters(
-            'FHEE__espresso_event_date_range__single_date_format',
-            get_option('date_format')
-        );
-        $single_time_format = apply_filters(
-            'FHEE__espresso_event_date_range__single_time_format',
-            get_option('time_format')
-        );
-        if ($this->date_range == true) {
-            return espresso_event_date_range(
-                $date_format,
-                $time_format,
-                $single_date_format,
-                $single_time_format,
-                $event->ID(),
-                false
-            );
-        }
-        return espresso_list_of_event_dates(
-            $event->ID(),
-            $date_format,
-            $time_format,
-            false,
-            null,
-            true,
-            true,
-            $this->date_limit
-        );
-    }
+		}
+
+		if ($this->show_dates) {
+			$content .= $this->eventDates($event);
+		}
+
+		if ($this->show_desc) {
+			$allowedtags = AllowedTags::getAllowedTags();
+			$desc    = $event->short_description(25);
+			$content .= $desc ? '<p style="margin-top: .5em">' . wp_kses($desc, $allowedtags) . '</p>' : '';
+		}
+
+		return $content;
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   4.10.14.p
+	 */
+	private function eventDates(EE_Event $event)
+	{
+		$date_format        = apply_filters(
+			'FHEE__espresso_event_date_range__date_format',
+			get_option('date_format')
+		);
+		$time_format        = apply_filters(
+			'FHEE__espresso_event_date_range__time_format',
+			get_option('time_format')
+		);
+		$single_date_format = apply_filters(
+			'FHEE__espresso_event_date_range__single_date_format',
+			get_option('date_format')
+		);
+		$single_time_format = apply_filters(
+			'FHEE__espresso_event_date_range__single_time_format',
+			get_option('time_format')
+		);
+		if ($this->date_range == true) {
+			return espresso_event_date_range(
+				$date_format,
+				$time_format,
+				$single_date_format,
+				$single_time_format,
+				$event->ID(),
+				false
+			);
+		}
+		return espresso_list_of_event_dates(
+			$event->ID(),
+			$date_format,
+			$time_format,
+			false,
+			null,
+			true,
+			true,
+			$this->date_limit
+		);
+	}
 }

Spacing +19 added lines, -19 removed lines

@@ -109,7 +109,7 @@ 
             EE_Question_Option::new_instance(['QSO_value' => false, 'QSO_desc' => esc_html__('No', 'event_espresso')]),
             EE_Question_Option::new_instance(['QSO_value' => true, 'QSO_desc' => esc_html__('Yes', 'event_espresso')]),
         ];
-        $sort_values   = [
+        $sort_values = [
             EE_Question_Option::new_instance(['QSO_value' => 'ASC', 'QSO_desc' => esc_html__('ASC', 'event_espresso')]),
             EE_Question_Option::new_instance(['QSO_value' => 'DESC', 'QSO_desc' => esc_html__('DESC', 'event_espresso')]),
         ];
@@ -326,8 +326,8 @@ 
                 // Before widget (defined by themes).
                 echo wp_kses($before_widget, AllowedTags::getAllowedTags());
                 // Display the widget title if one was input (before and after defined by themes).
-                if (! empty($title)) {
-                    echo wp_kses($before_title . $title . $after_title, AllowedTags::getAllowedTags());
+                if ( ! empty($title)) {
+                    echo wp_kses($before_title.$title.$after_title, AllowedTags::getAllowedTags());
                 }
                 echo wp_kses($this->widgetContent($post), AllowedTags::getWithFormTags());
                 // After widget (defined by themes).
@@ -346,7 +346,7 @@ 
      */
     public function make_the_title_a_link($title)
     {
-        return '<a href="' . EEH_Event_View::event_archive_url() . '">' . $title . '</a>';
+        return '<a href="'.EEH_Event_View::event_archive_url().'">'.$title.'</a>';
     }
 
 
@@ -427,7 +427,7 @@ 
             foreach ($sizes as $image_size) {
                 $image_size = trim($image_size);
                 // no big images plz
-                if (! in_array($image_size, ['large', 'post-thumbnail'])) {
+                if ( ! in_array($image_size, ['large', 'post-thumbnail'])) {
                     $image_sizes[] =
                         EE_Question_Option::new_instance(['QSO_value' => $image_size, 'QSO_desc' => $image_size]);
                 }
@@ -454,7 +454,7 @@ 
     private function parseWidgetSettings(array $instance)
     {
         $this->title = isset($instance['title']) && ! empty($instance['title']) ? $instance['title'] : '';
-        $this->events_category     = isset($instance['category_name']) && ! empty($instance['category_name'])
+        $this->events_category = isset($instance['category_name']) && ! empty($instance['category_name'])
             ? $instance['category_name']
             : false;
         $this->show_expired = isset($instance['show_expired'])
@@ -512,24 +512,24 @@ 
         }
         $list_items = '';
         foreach ($events as $event) {
-            if ($event instanceof EE_Event && (! is_single() || $post->ID != $event->ID())) {
+            if ($event instanceof EE_Event && ( ! is_single() || $post->ID != $event->ID())) {
                 $event_url = $this->eventUrl($event);
                 $list_items .= '
-                <li id="ee-upcoming-events-widget-li-' . absint($event->ID()) . '" 
+                <li id="ee-upcoming-events-widget-li-' . absint($event->ID()).'" 
                     class="ee-upcoming-events-widget-li"
                 >
                     <h5 class="ee-upcoming-events-widget-title-h5">
-                        <a class="ee-widget-event-name-a' . $this->linkClass($event) . '" href="' . $event_url . '">
-                            ' . esc_html($event->name()) . '
+                        <a class="ee-widget-event-name-a' . $this->linkClass($event).'" href="'.$event_url.'">
+                            ' . esc_html($event->name()).'
                         </a>
                     </h5>
-                    ' . $this->eventWidgetContent($event, $event_url) . '
+                    ' . $this->eventWidgetContent($event, $event_url).'
                 </li>';
             }
         }
         return '
             <ul class="ee-upcoming-events-widget-ul">
-                ' . $list_items . '
+                ' . $list_items.'
             </ul>';
     }
 
@@ -561,7 +561,7 @@ 
         return EEM_Event::instance()->get_all(
             [
                 $this->queryWhereParams(),
-                'limit'    => '0,' . $this->limit,
+                'limit'    => '0,'.$this->limit,
                 'order_by' => 'Datetime.DTT_EVT_start',
                 'order'    => $this->order,
                 'group_by' => 'EVT_ID',
@@ -649,8 +649,8 @@ 
         if (has_post_thumbnail($event->ID()) && $this->image_size != 'none') {
             $content .= '
                 <div class="ee-upcoming-events-widget-img-dv">
-                    <a class="ee-upcoming-events-widget-img" href="' . $event_url . '">
-                        ' . get_the_post_thumbnail($event->ID(), $this->image_size) . '
+                    <a class="ee-upcoming-events-widget-img" href="' . $event_url.'">
+                        ' . get_the_post_thumbnail($event->ID(), $this->image_size).'
                     </a>
                 </div>';
         }
@@ -661,8 +661,8 @@ 
 
         if ($this->show_desc) {
             $allowedtags = AllowedTags::getAllowedTags();
-            $desc    = $event->short_description(25);
-            $content .= $desc ? '<p style="margin-top: .5em">' . wp_kses($desc, $allowedtags) . '</p>' : '';
+            $desc = $event->short_description(25);
+            $content .= $desc ? '<p style="margin-top: .5em">'.wp_kses($desc, $allowedtags).'</p>' : '';
         }
 
         return $content;
@@ -678,11 +678,11 @@ 
      */
     private function eventDates(EE_Event $event)
     {
-        $date_format        = apply_filters(
+        $date_format = apply_filters(
             'FHEE__espresso_event_date_range__date_format',
             get_option('date_format')
         );
-        $time_format        = apply_filters(
+        $time_format = apply_filters(
             'FHEE__espresso_event_date_range__time_format',
             get_option('time_format')
         );

espresso.php

Indentation +80 added lines, -80 removed lines

@@ -38,103 +38,103 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.6.2');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.6.2');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.10.36.rc.003');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.10.36.rc.003');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }
\ No newline at end of file