eventespresso / event-espresso-core

modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php

Indentation +627 added lines, -627 removed lines

@@ -12,631 +12,631 @@
 abstract class EE_SPCO_Reg_Step
 {
 
-    /**
-     *    $_completed - TRUE if this step has fully completed it's duties
-     *
-     * @access protected
-     * @type bool $_completed
-     */
-    protected $_completed = false;
-
-    /**
-     *    $_is_current_step - TRUE if this is the current step
-     *
-     * @access protected
-     * @type bool $_is_current_step
-     */
-    protected $_is_current_step = false;
-
-    /**
-     *    $_order - when the reg step should be run relative to other steps
-     *
-     * @access protected
-     * @type int $_template
-     */
-    protected $_order = 0;
-
-    /**
-     *    $_slug - URL param for this step
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_slug;
-
-    /**
-     *    $_name - Step Name - translatable string
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_name;
-
-    /**
-     *    $_submit_button_text - translatable string that appears on this step's submit button
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_submit_button_text;
-
-    /**
-     *    $_template - template name
-     *
-     * @access protected
-     * @type string $_template
-     */
-    protected $_template;
-
-    /**
-     *    $_reg_form_name - the form input name and id attribute
-     *
-     * @access protected
-     * @var string $_reg_form_name
-     */
-    protected $_reg_form_name;
-
-    /**
-     *    $_success_message - text to display upon successful form submission
-     *
-     * @access private
-     * @var string $_success_message
-     */
-    protected $_success_message;
-
-    /**
-     *    $_instructions - a brief description of how to complete the reg step.
-     *    Usually displayed in conjunction with the previous step's success message.
-     *
-     * @access private
-     * @var string $_instructions
-     */
-    protected $_instructions;
-
-    /**
-     *    $_valid_data - the normalized and validated data for this step
-     *
-     * @access public
-     * @var array $_valid_data
-     */
-    protected $_valid_data = array();
-
-    /**
-     *    $reg_form - the registration form for this step
-     *
-     * @access public
-     * @var EE_Form_Section_Proper $reg_form
-     */
-    public $reg_form;
-
-    /**
-     *    $checkout - EE_Checkout object for handling the properties of the current checkout process
-     *
-     * @access public
-     * @var EE_Checkout $checkout
-     */
-    public $checkout;
-
-
-    /**
-     * @return void
-     */
-    abstract public function translate_js_strings();
-
-
-    /**
-     * @return void
-     */
-    abstract public function enqueue_styles_and_scripts();
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function initialize_reg_step();
-
-
-    /**
-     * @return string
-     */
-    abstract public function generate_reg_form();
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function process_reg_step();
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function update_reg_step();
-
-
-    /**
-     * @return boolean
-     */
-    public function completed()
-    {
-        return $this->_completed;
-    }
-
-
-    /**
-     * set_completed - toggles $_completed to TRUE
-     */
-    public function set_completed()
-    {
-        // DEBUG LOG
-        // $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
-        $this->_completed = apply_filters('FHEE__EE_SPCO_Reg_Step__set_completed___completed', true, $this);
-    }
-
-
-    /**
-     * set_completed - toggles $_completed to FALSE
-     */
-    public function set_not_completed()
-    {
-        $this->_completed = false;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function name()
-    {
-        return $this->_name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->_slug;
-    }
-
-
-    /**
-     * submit_button_text
-     * the text that appears on the reg step form submit button
-     *
-     * @return string
-     */
-    public function submit_button_text()
-    {
-        return $this->_submit_button_text;
-    }
-
-
-    /**
-     * set_submit_button_text
-     * sets the text that appears on the reg step form submit button
-     *
-     * @param string $submit_button_text
-     */
-    public function set_submit_button_text($submit_button_text = '')
-    {
-        if (! empty($submit_button_text)) {
-            $this->_submit_button_text = $submit_button_text;
-        } elseif ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            if ($this->checkout->revisit) {
-                $this->_submit_button_text = sprintf(
-                    __('Update %s', 'event_espresso'),
-                    $this->checkout->current_step->name()
-                );
-            } else {
-                $this->_submit_button_text = sprintf(
-                    __('Proceed to %s', 'event_espresso'),
-                    $this->checkout->next_step->name()
-                );
-            }
-        }
-        // filters the submit button text
-        $this->_submit_button_text = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
-            $this->_submit_button_text,
-            $this->checkout
-        );
-    }
-
-
-    /**
-     * @param boolean $is_current_step
-     */
-    public function set_is_current_step($is_current_step)
-    {
-        $this->_is_current_step = $is_current_step;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function is_current_step()
-    {
-        return $this->_is_current_step;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function is_final_step()
-    {
-        return $this instanceof EE_SPCO_Reg_Step_Finalize_Registration ? true : false;
-    }
-
-
-    /**
-     * @param int $order
-     */
-    public function set_order($order)
-    {
-        $this->_order = $order;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function order()
-    {
-        return $this->_order;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function template()
-    {
-        return $this->_template;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function success_message()
-    {
-        return $this->_success_message;
-    }
-
-
-    /**
-     * _set_success_message
-     *
-     * @param string $success_message
-     */
-    protected function _set_success_message($success_message)
-    {
-        $this->_success_message = $success_message;
-    }
-
-
-    /**
-     * _reset_success_message
-     *
-     * @return void
-     */
-    protected function _reset_success_message()
-    {
-        $this->_success_message = '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function _instructions()
-    {
-        return $this->_instructions;
-    }
-
-
-    /**
-     * @param string $instructions
-     */
-    public function set_instructions($instructions)
-    {
-        $this->_instructions = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step__set_instructions__instructions',
-            $instructions,
-            $this
-        );
-    }
-
-
-    /**
-     * @param array $valid_data
-     */
-    public function set_valid_data($valid_data)
-    {
-        $this->_valid_data = $valid_data;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function valid_data()
-    {
-        if (empty($this->_valid_data)) {
-            $this->_valid_data = $this->reg_form->valid_data();
-        }
-        return $this->_valid_data;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function reg_form_name()
-    {
-        if (empty($this->_reg_form_name)) {
-            $this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
-        }
-        return $this->_reg_form_name;
-    }
-
-
-    /**
-     * @param string $reg_form_name
-     */
-    protected function set_reg_form_name($reg_form_name)
-    {
-        $this->_reg_form_name = $reg_form_name;
-    }
-
-
-    /**
-     * reg_step_url
-     *
-     * @param string $action
-     * @return string
-     */
-    public function reg_step_url($action = '')
-    {
-        $query_args = array('step' => $this->slug());
-        if (! empty($action)) {
-            $query_args['action'] = $action;
-        }
-        // final step has no display
-        if ($this instanceof EE_SPCO_Reg_Step_Finalize_Registration && $action === 'display_spco_reg_step') {
-            $query_args['action'] = 'process_reg_step';
-        }
-        if ($this->checkout->revisit) {
-            $query_args['revisit'] = true;
-        }
-        if ($this->checkout->reg_url_link) {
-            $query_args['e_reg_url_link'] = $this->checkout->reg_url_link;
-        }
-        return add_query_arg($query_args, $this->checkout->reg_page_base_url);
-    }
-
-
-    /**
-     * creates the default hidden inputs section
-     *
-     * @return EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    public function reg_step_hidden_inputs()
-    {
-        // hidden inputs for admin registrations
-        if ($this->checkout->admin_request) {
-            return new EE_Form_Section_Proper(
-                array(
-                    'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
-                    'subsections'     => array(
-                        'next_step' => new EE_Fixed_Hidden_Input(
-                            array(
-                                'html_name' => 'next_step',
-                                'html_id'   => 'spco-' . $this->slug() . '-next-step',
-                                'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                    ? $this->checkout->next_step->slug()
-                                    : '',
-                            )
-                        ),
-                    ),
-                )
-            );
-        }
-        // hidden inputs for frontend registrations
-        return new EE_Form_Section_Proper(
-            array(
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
-                'subsections'     => array(
-                    'action'         => new EE_Fixed_Hidden_Input(
-                        array(
-                            'html_name' => 'action',
-                            'html_id'   => 'spco-' . $this->slug() . '-action',
-                            'default'   => apply_filters(
-                                'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
-                                empty($this->checkout->reg_url_link)
-                                    ? 'process_reg_step'
-                                    : 'update_reg_step',
-                                $this
-                            ),
-                        )
-                    ),
-                    'next_step'      => new EE_Fixed_Hidden_Input(
-                        array(
-                            'html_name' => 'next_step',
-                            'html_id'   => 'spco-' . $this->slug() . '-next-step',
-                            'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                ? $this->checkout->next_step->slug()
-                                : '',
-                        )
-                    ),
-                    'e_reg_url_link' => new EE_Fixed_Hidden_Input(
-                        array(
-                            'html_name' => 'e_reg_url_link',
-                            'html_id'   => 'spco-reg_url_link',
-                            'default'   => $this->checkout->reg_url_link,
-                        )
-                    ),
-                    'revisit'        => new EE_Fixed_Hidden_Input(
-                        array(
-                            'html_name' => 'revisit',
-                            'html_id'   => 'spco-revisit',
-                            'default'   => $this->checkout->revisit,
-                        )
-                    ),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * generate_reg_form_for_actions
-     *
-     * @param array $actions
-     * @return void
-     */
-    public function generate_reg_form_for_actions($actions = array())
-    {
-        $actions = array_merge(
-            array(
-                'generate_reg_form',
-                'display_spco_reg_step',
-                'process_reg_step',
-                'update_reg_step',
-            ),
-            $actions
-        );
-        $this->checkout->generate_reg_form = in_array($this->checkout->action, $actions, true) ? true : false;
-    }
-
-
-    /**
-     * @return string
-     * @throws \EE_Error
-     */
-    public function display_reg_form()
-    {
-        $html = '';
-        if ($this->reg_form instanceof EE_Form_Section_Proper) {
-            do_action('AHEE__EE_SPCO_Reg_Step__display_reg_form__reg_form', $this->reg_form, $this);
-            $html .= ! $this->checkout->admin_request ? $this->reg_form->form_open($this->reg_step_url()) : '';
-            if (EE_Registry::instance()->REQ->ajax) {
-                $this->reg_form->localize_validation_rules();
-                $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
-            }
-            $html .= $this->reg_form->get_html();
-            $html .= ! $this->checkout->admin_request ? $this->reg_step_submit_button() : '';
-            $html .= ! $this->checkout->admin_request ? $this->reg_form->form_close() : '';
-        }
-        return $html;
-    }
-
-
-    /**
-     * div_class - returns nothing for current step, but a css class of "hidden" for others
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function reg_step_submit_button()
-    {
-        if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            return '';
-        }
-        ob_start();
-        do_action(
-            'AHEE__before_spco_whats_next_buttons',
-            $this->slug(),
-            $this->checkout->next_step->slug(),
-            $this->checkout
-        );
-        $html = ob_get_clean();
-        // generate submit button
-        $sbmt_btn = new EE_Submit_Input(
-            array(
-                'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-                'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-                'html_class'            => 'spco-next-step-btn',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => $this->submit_button_text(),
-            )
-        );
-        $sbmt_btn->set_button_css_attributes(true, 'large');
-        $sbmt_btn_html = $sbmt_btn->get_html_for_input();
-        $html .= EEH_HTML::div(
-            apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $sbmt_btn_html, $this),
-            'spco-' . $this->slug() . '-whats-next-buttons-dv',
-            'spco-whats-next-buttons'
-        );
-        return $html;
-    }
-
-
-    /**
-     * div_class - returns nothing for current step, but a css class of "hidden" for others
-     *
-     * @return string
-     */
-    public function div_class()
-    {
-        return $this->is_current_step() ? '' : ' hidden';
-    }
-
-
-    /**
-     * div_class - returns  a css class of "hidden" for current step, but nothing for others
-     *
-     * @return string
-     */
-    public function edit_lnk_url()
-    {
-        return add_query_arg(array('step' => $this->slug()), $this->checkout->reg_page_base_url);
-    }
-
-
-    /**
-     * div_class - returns  a css class of "hidden" for current step, but nothing for others
-     *
-     * @return string
-     */
-    public function edit_link_class()
-    {
-        return $this->is_current_step() ? ' hidden' : '';
-    }
-
-
-    /**
-     * update_checkout with changes that have been made to the cart
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public function update_checkout()
-    {
-        // grab the cart grand total and reset TXN total
-        $this->checkout->transaction->set_total($this->checkout->cart->get_cart_grand_total());
-        $this->checkout->stash_transaction_and_checkout();
-    }
-
-
-    /**
-     *    __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)), array('reg_form', 'checkout'));
-    }
+	/**
+	 *    $_completed - TRUE if this step has fully completed it's duties
+	 *
+	 * @access protected
+	 * @type bool $_completed
+	 */
+	protected $_completed = false;
+
+	/**
+	 *    $_is_current_step - TRUE if this is the current step
+	 *
+	 * @access protected
+	 * @type bool $_is_current_step
+	 */
+	protected $_is_current_step = false;
+
+	/**
+	 *    $_order - when the reg step should be run relative to other steps
+	 *
+	 * @access protected
+	 * @type int $_template
+	 */
+	protected $_order = 0;
+
+	/**
+	 *    $_slug - URL param for this step
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_slug;
+
+	/**
+	 *    $_name - Step Name - translatable string
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_name;
+
+	/**
+	 *    $_submit_button_text - translatable string that appears on this step's submit button
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_submit_button_text;
+
+	/**
+	 *    $_template - template name
+	 *
+	 * @access protected
+	 * @type string $_template
+	 */
+	protected $_template;
+
+	/**
+	 *    $_reg_form_name - the form input name and id attribute
+	 *
+	 * @access protected
+	 * @var string $_reg_form_name
+	 */
+	protected $_reg_form_name;
+
+	/**
+	 *    $_success_message - text to display upon successful form submission
+	 *
+	 * @access private
+	 * @var string $_success_message
+	 */
+	protected $_success_message;
+
+	/**
+	 *    $_instructions - a brief description of how to complete the reg step.
+	 *    Usually displayed in conjunction with the previous step's success message.
+	 *
+	 * @access private
+	 * @var string $_instructions
+	 */
+	protected $_instructions;
+
+	/**
+	 *    $_valid_data - the normalized and validated data for this step
+	 *
+	 * @access public
+	 * @var array $_valid_data
+	 */
+	protected $_valid_data = array();
+
+	/**
+	 *    $reg_form - the registration form for this step
+	 *
+	 * @access public
+	 * @var EE_Form_Section_Proper $reg_form
+	 */
+	public $reg_form;
+
+	/**
+	 *    $checkout - EE_Checkout object for handling the properties of the current checkout process
+	 *
+	 * @access public
+	 * @var EE_Checkout $checkout
+	 */
+	public $checkout;
+
+
+	/**
+	 * @return void
+	 */
+	abstract public function translate_js_strings();
+
+
+	/**
+	 * @return void
+	 */
+	abstract public function enqueue_styles_and_scripts();
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function initialize_reg_step();
+
+
+	/**
+	 * @return string
+	 */
+	abstract public function generate_reg_form();
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function process_reg_step();
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function update_reg_step();
+
+
+	/**
+	 * @return boolean
+	 */
+	public function completed()
+	{
+		return $this->_completed;
+	}
+
+
+	/**
+	 * set_completed - toggles $_completed to TRUE
+	 */
+	public function set_completed()
+	{
+		// DEBUG LOG
+		// $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
+		$this->_completed = apply_filters('FHEE__EE_SPCO_Reg_Step__set_completed___completed', true, $this);
+	}
+
+
+	/**
+	 * set_completed - toggles $_completed to FALSE
+	 */
+	public function set_not_completed()
+	{
+		$this->_completed = false;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->_name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->_slug;
+	}
+
+
+	/**
+	 * submit_button_text
+	 * the text that appears on the reg step form submit button
+	 *
+	 * @return string
+	 */
+	public function submit_button_text()
+	{
+		return $this->_submit_button_text;
+	}
+
+
+	/**
+	 * set_submit_button_text
+	 * sets the text that appears on the reg step form submit button
+	 *
+	 * @param string $submit_button_text
+	 */
+	public function set_submit_button_text($submit_button_text = '')
+	{
+		if (! empty($submit_button_text)) {
+			$this->_submit_button_text = $submit_button_text;
+		} elseif ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			if ($this->checkout->revisit) {
+				$this->_submit_button_text = sprintf(
+					__('Update %s', 'event_espresso'),
+					$this->checkout->current_step->name()
+				);
+			} else {
+				$this->_submit_button_text = sprintf(
+					__('Proceed to %s', 'event_espresso'),
+					$this->checkout->next_step->name()
+				);
+			}
+		}
+		// filters the submit button text
+		$this->_submit_button_text = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
+			$this->_submit_button_text,
+			$this->checkout
+		);
+	}
+
+
+	/**
+	 * @param boolean $is_current_step
+	 */
+	public function set_is_current_step($is_current_step)
+	{
+		$this->_is_current_step = $is_current_step;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function is_current_step()
+	{
+		return $this->_is_current_step;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function is_final_step()
+	{
+		return $this instanceof EE_SPCO_Reg_Step_Finalize_Registration ? true : false;
+	}
+
+
+	/**
+	 * @param int $order
+	 */
+	public function set_order($order)
+	{
+		$this->_order = $order;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->_order;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function template()
+	{
+		return $this->_template;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function success_message()
+	{
+		return $this->_success_message;
+	}
+
+
+	/**
+	 * _set_success_message
+	 *
+	 * @param string $success_message
+	 */
+	protected function _set_success_message($success_message)
+	{
+		$this->_success_message = $success_message;
+	}
+
+
+	/**
+	 * _reset_success_message
+	 *
+	 * @return void
+	 */
+	protected function _reset_success_message()
+	{
+		$this->_success_message = '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function _instructions()
+	{
+		return $this->_instructions;
+	}
+
+
+	/**
+	 * @param string $instructions
+	 */
+	public function set_instructions($instructions)
+	{
+		$this->_instructions = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step__set_instructions__instructions',
+			$instructions,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param array $valid_data
+	 */
+	public function set_valid_data($valid_data)
+	{
+		$this->_valid_data = $valid_data;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function valid_data()
+	{
+		if (empty($this->_valid_data)) {
+			$this->_valid_data = $this->reg_form->valid_data();
+		}
+		return $this->_valid_data;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function reg_form_name()
+	{
+		if (empty($this->_reg_form_name)) {
+			$this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
+		}
+		return $this->_reg_form_name;
+	}
+
+
+	/**
+	 * @param string $reg_form_name
+	 */
+	protected function set_reg_form_name($reg_form_name)
+	{
+		$this->_reg_form_name = $reg_form_name;
+	}
+
+
+	/**
+	 * reg_step_url
+	 *
+	 * @param string $action
+	 * @return string
+	 */
+	public function reg_step_url($action = '')
+	{
+		$query_args = array('step' => $this->slug());
+		if (! empty($action)) {
+			$query_args['action'] = $action;
+		}
+		// final step has no display
+		if ($this instanceof EE_SPCO_Reg_Step_Finalize_Registration && $action === 'display_spco_reg_step') {
+			$query_args['action'] = 'process_reg_step';
+		}
+		if ($this->checkout->revisit) {
+			$query_args['revisit'] = true;
+		}
+		if ($this->checkout->reg_url_link) {
+			$query_args['e_reg_url_link'] = $this->checkout->reg_url_link;
+		}
+		return add_query_arg($query_args, $this->checkout->reg_page_base_url);
+	}
+
+
+	/**
+	 * creates the default hidden inputs section
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	public function reg_step_hidden_inputs()
+	{
+		// hidden inputs for admin registrations
+		if ($this->checkout->admin_request) {
+			return new EE_Form_Section_Proper(
+				array(
+					'layout_strategy' => new EE_Div_Per_Section_Layout(),
+					'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+					'subsections'     => array(
+						'next_step' => new EE_Fixed_Hidden_Input(
+							array(
+								'html_name' => 'next_step',
+								'html_id'   => 'spco-' . $this->slug() . '-next-step',
+								'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+									? $this->checkout->next_step->slug()
+									: '',
+							)
+						),
+					),
+				)
+			);
+		}
+		// hidden inputs for frontend registrations
+		return new EE_Form_Section_Proper(
+			array(
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+				'subsections'     => array(
+					'action'         => new EE_Fixed_Hidden_Input(
+						array(
+							'html_name' => 'action',
+							'html_id'   => 'spco-' . $this->slug() . '-action',
+							'default'   => apply_filters(
+								'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
+								empty($this->checkout->reg_url_link)
+									? 'process_reg_step'
+									: 'update_reg_step',
+								$this
+							),
+						)
+					),
+					'next_step'      => new EE_Fixed_Hidden_Input(
+						array(
+							'html_name' => 'next_step',
+							'html_id'   => 'spco-' . $this->slug() . '-next-step',
+							'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+								? $this->checkout->next_step->slug()
+								: '',
+						)
+					),
+					'e_reg_url_link' => new EE_Fixed_Hidden_Input(
+						array(
+							'html_name' => 'e_reg_url_link',
+							'html_id'   => 'spco-reg_url_link',
+							'default'   => $this->checkout->reg_url_link,
+						)
+					),
+					'revisit'        => new EE_Fixed_Hidden_Input(
+						array(
+							'html_name' => 'revisit',
+							'html_id'   => 'spco-revisit',
+							'default'   => $this->checkout->revisit,
+						)
+					),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * generate_reg_form_for_actions
+	 *
+	 * @param array $actions
+	 * @return void
+	 */
+	public function generate_reg_form_for_actions($actions = array())
+	{
+		$actions = array_merge(
+			array(
+				'generate_reg_form',
+				'display_spco_reg_step',
+				'process_reg_step',
+				'update_reg_step',
+			),
+			$actions
+		);
+		$this->checkout->generate_reg_form = in_array($this->checkout->action, $actions, true) ? true : false;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function display_reg_form()
+	{
+		$html = '';
+		if ($this->reg_form instanceof EE_Form_Section_Proper) {
+			do_action('AHEE__EE_SPCO_Reg_Step__display_reg_form__reg_form', $this->reg_form, $this);
+			$html .= ! $this->checkout->admin_request ? $this->reg_form->form_open($this->reg_step_url()) : '';
+			if (EE_Registry::instance()->REQ->ajax) {
+				$this->reg_form->localize_validation_rules();
+				$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
+			}
+			$html .= $this->reg_form->get_html();
+			$html .= ! $this->checkout->admin_request ? $this->reg_step_submit_button() : '';
+			$html .= ! $this->checkout->admin_request ? $this->reg_form->form_close() : '';
+		}
+		return $html;
+	}
+
+
+	/**
+	 * div_class - returns nothing for current step, but a css class of "hidden" for others
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function reg_step_submit_button()
+	{
+		if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			return '';
+		}
+		ob_start();
+		do_action(
+			'AHEE__before_spco_whats_next_buttons',
+			$this->slug(),
+			$this->checkout->next_step->slug(),
+			$this->checkout
+		);
+		$html = ob_get_clean();
+		// generate submit button
+		$sbmt_btn = new EE_Submit_Input(
+			array(
+				'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+				'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+				'html_class'            => 'spco-next-step-btn',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => $this->submit_button_text(),
+			)
+		);
+		$sbmt_btn->set_button_css_attributes(true, 'large');
+		$sbmt_btn_html = $sbmt_btn->get_html_for_input();
+		$html .= EEH_HTML::div(
+			apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $sbmt_btn_html, $this),
+			'spco-' . $this->slug() . '-whats-next-buttons-dv',
+			'spco-whats-next-buttons'
+		);
+		return $html;
+	}
+
+
+	/**
+	 * div_class - returns nothing for current step, but a css class of "hidden" for others
+	 *
+	 * @return string
+	 */
+	public function div_class()
+	{
+		return $this->is_current_step() ? '' : ' hidden';
+	}
+
+
+	/**
+	 * div_class - returns  a css class of "hidden" for current step, but nothing for others
+	 *
+	 * @return string
+	 */
+	public function edit_lnk_url()
+	{
+		return add_query_arg(array('step' => $this->slug()), $this->checkout->reg_page_base_url);
+	}
+
+
+	/**
+	 * div_class - returns  a css class of "hidden" for current step, but nothing for others
+	 *
+	 * @return string
+	 */
+	public function edit_link_class()
+	{
+		return $this->is_current_step() ? ' hidden' : '';
+	}
+
+
+	/**
+	 * update_checkout with changes that have been made to the cart
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function update_checkout()
+	{
+		// grab the cart grand total and reset TXN total
+		$this->checkout->transaction->set_total($this->checkout->cart->get_cart_grand_total());
+		$this->checkout->stash_transaction_and_checkout();
+	}
+
+
+	/**
+	 *    __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)), array('reg_form', 'checkout'));
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -221,7 +221,7 @@ 
      */
     public function set_submit_button_text($submit_button_text = '')
     {
-        if (! empty($submit_button_text)) {
+        if ( ! empty($submit_button_text)) {
             $this->_submit_button_text = $submit_button_text;
         } elseif ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
             if ($this->checkout->revisit) {
@@ -379,7 +379,7 @@ 
     public function reg_form_name()
     {
         if (empty($this->_reg_form_name)) {
-            $this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
+            $this->set_reg_form_name('ee-spco-'.$this->slug().'-reg-step-form');
         }
         return $this->_reg_form_name;
     }
@@ -403,7 +403,7 @@ 
     public function reg_step_url($action = '')
     {
         $query_args = array('step' => $this->slug());
-        if (! empty($action)) {
+        if ( ! empty($action)) {
             $query_args['action'] = $action;
         }
         // final step has no display
@@ -433,12 +433,12 @@ 
             return new EE_Form_Section_Proper(
                 array(
                     'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+                    'html_id'         => 'ee-'.$this->slug().'-hidden-inputs',
                     'subsections'     => array(
                         'next_step' => new EE_Fixed_Hidden_Input(
                             array(
                                 'html_name' => 'next_step',
-                                'html_id'   => 'spco-' . $this->slug() . '-next-step',
+                                'html_id'   => 'spco-'.$this->slug().'-next-step',
                                 'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
                                     ? $this->checkout->next_step->slug()
                                     : '',
@@ -452,12 +452,12 @@ 
         return new EE_Form_Section_Proper(
             array(
                 'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+                'html_id'         => 'ee-'.$this->slug().'-hidden-inputs',
                 'subsections'     => array(
                     'action'         => new EE_Fixed_Hidden_Input(
                         array(
                             'html_name' => 'action',
-                            'html_id'   => 'spco-' . $this->slug() . '-action',
+                            'html_id'   => 'spco-'.$this->slug().'-action',
                             'default'   => apply_filters(
                                 'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
                                 empty($this->checkout->reg_url_link)
@@ -470,7 +470,7 @@ 
                     'next_step'      => new EE_Fixed_Hidden_Input(
                         array(
                             'html_name' => 'next_step',
-                            'html_id'   => 'spco-' . $this->slug() . '-next-step',
+                            'html_id'   => 'spco-'.$this->slug().'-next-step',
                             'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
                                 ? $this->checkout->next_step->slug()
                                 : '',
@@ -547,7 +547,7 @@ 
      */
     public function reg_step_submit_button()
     {
-        if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+        if ( ! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
             return '';
         }
         ob_start();
@@ -561,10 +561,10 @@ 
         // generate submit button
         $sbmt_btn = new EE_Submit_Input(
             array(
-                'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-                'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+                'html_name'             => 'spco-go-to-step-'.$this->checkout->next_step->slug(),
+                'html_id'               => 'spco-go-to-step-'.$this->checkout->next_step->slug(),
                 'html_class'            => 'spco-next-step-btn',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
+                'other_html_attributes' => ' rel="'.$this->slug().'"',
                 'default'               => $this->submit_button_text(),
             )
         );
@@ -572,7 +572,7 @@ 
         $sbmt_btn_html = $sbmt_btn->get_html_for_input();
         $html .= EEH_HTML::div(
             apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $sbmt_btn_html, $this),
-            'spco-' . $this->slug() . '-whats-next-buttons-dv',
+            'spco-'.$this->slug().'-whats-next-buttons-dv',
             'spco-whats-next-buttons'
         );
         return $html;

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

Indentation +2885 added lines, -2885 removed lines

@@ -12,2889 +12,2889 @@
 class EE_SPCO_Reg_Step_Payment_Options extends EE_SPCO_Reg_Step
 {
 
-    /**
-     * @access protected
-     * @var EE_Line_Item_Display $Line_Item_Display
-     */
-    protected $line_item_display;
-
-    /**
-     * @access protected
-     * @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',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters')
-        );
-        add_action(
-            'wp_ajax_switch_spco_billing_form',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
-        );
-        add_action(
-            'wp_ajax_nopriv_switch_spco_billing_form',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
-        );
-        add_action('wp_ajax_save_payer_details', array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details'));
-        add_action(
-            'wp_ajax_nopriv_save_payer_details',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details')
-        );
-        add_action(
-            'wp_ajax_get_transaction_details_for_gateways',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
-        );
-        add_action(
-            'wp_ajax_nopriv_get_transaction_details_for_gateways',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
-        );
-        add_filter(
-            'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'),
-            10,
-            1
-        );
-    }
-
-
-    /**
-     *    ajax switch_spco_billing_form
-     *
-     * @throws \EE_Error
-     */
-    public static function switch_spco_billing_form()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
-    }
-
-
-    /**
-     *    ajax save_payer_details
-     *
-     * @throws \EE_Error
-     */
-    public static function save_payer_details()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
-    }
-
-
-    /**
-     *    ajax get_transaction_details
-     *
-     * @throws \EE_Error
-     */
-    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 \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public static function bypass_recaptcha_for_load_payment_method()
-    {
-        return array(
-            '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->_slug = 'payment_options';
-        $this->_name = esc_html__('Payment Options', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . '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 \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    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 \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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(array($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 \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\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 = array();
-        $registrations_for_free_events = array();
-        $registrations_requiring_pre_approval = array();
-        $sold_out_events = array();
-        $insufficient_spaces_available = array();
-        $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->event()->ID() ] = $registration;
-            }
-        }
-        $subsections = array();
-        // 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,
-                        array('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(
-            array(
-                '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 \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\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 \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\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 ]);
-                continue;
-            }
-        }
-        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 \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
-    {
-        // registrations per event
-        $event_reg_count = array();
-        // spaces left per event
-        $event_spaces_remaining = array();
-        // tickets left sorted by ID
-        $tickets_remaining = array();
-        // registrations that have lost their space
-        $ejected_registrations = array();
-        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 = 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(
-            array(
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . DS
-                                                  . 'sold_out_events.template.php',
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
-                            array(
-                                '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
-     */
-    private function _insufficient_spaces_available($insufficient_spaces_events_array = 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(
-            array(
-                'subsections'     => array(
-                    'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
-                    'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
-                ),
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . DS
-                                                  . 'sold_out_events.template.php',
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
-                            array(
-                                '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 \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = array())
-    {
-        $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(
-            array(
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . DS
-                                                  . 'events_requiring_pre_approval.template.php', // layout_template
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
-                            array(
-                                '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 = array())
-    {
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'no_payment_required';
-        // generate no_payment_required form
-        return new EE_Form_Section_Proper(
-            array(
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . DS
-                                                  . 'no_payment_required.template.php', // layout_template
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
-                            array(
-                                'revisit'                       => $this->checkout->revisit,
-                                'registrations'                 => array(),
-                                'ticket_count'                  => array(),
-                                '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 \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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(
-                array(
-                    'subsections'     => array(
-                        'before_payment_options' => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
-                            new EE_Form_Section_Proper(
-                                array('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(
-                                array('layout_strategy' => new EE_Div_Per_Section_Layout())
-                            )
-                        ),
-                    ),
-                    'layout_strategy' => new EE_Template_Layout(
-                        array(
-                            'layout_template_file' => $this->_template,
-                            'template_args'        => apply_filters(
-                                'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
-                                array(
-                                    'reg_count'                 => $this->line_item_display->total_items(),
-                                    'transaction_details'       => $transaction_details,
-                                    'available_payment_methods' => array(),
-                                )
-                            ),
-                        )
-                    ),
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _extra_hidden_inputs
-     *
-     * @param bool $no_payment_required
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    private function _extra_hidden_inputs($no_payment_required = true)
-    {
-        return new EE_Form_Section_Proper(
-            array(
-                'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => array(
-                    'spco_no_payment_required' => new EE_Hidden_Input(
-                        array(
-                            '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(
-                        array(
-                            '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
-     *
-     * @access protected
-     * @param array $registrations
-     * @throws EE_Error
-     */
-    protected function _apply_registration_payments_to_amount_owing(array $registrations)
-    {
-        $payments = array();
-        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 \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _reset_selected_method_of_payment($force_reset = false)
-    {
-        $reset_payment_method = $force_reset
-            ? true
-            : sanitize_text_field(EE_Registry::instance()->REQ->get('reset_payment_method', false));
-        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 \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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(
-            array('selected_method_of_payment' => $selected_method_of_payment)
-        );
-    }
-
-
-    /**
-     * _setup_payment_options
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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 = array(
-            // display the "Payment Method" header
-            'payment_method_header' => new EE_Form_Section_HTML(
-                EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr')
-            ),
-        );
-        // the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
-        $available_payment_method_options = array();
-        $default_payment_method_option = array();
-        // additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
-        $payment_methods_billing_info = array(
-            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(
-            array(
-                '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 ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _get_available_payment_methods()
-    {
-        if (! empty($this->checkout->available_payment_methods)) {
-            return $this->checkout->available_payment_methods;
-        }
-        $available_payment_methods = array();
-        // load EEM_Payment_Method
-        EE_Registry::instance()->load_model('Payment_Method');
-        /** @type EEM_Payment_Method $EEM_Payment_Method */
-        $EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
-        // 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
-     */
-    private function _available_payment_method_inputs($available_payment_method_options = array())
-    {
-        // generate inputs
-        return new EE_Form_Section_Proper(
-            array(
-                'html_id'         => 'ee-available-payment-method-inputs',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => array(
-                    '' => new EE_Radio_Button_Input(
-                        $available_payment_method_options,
-                        array(
-                            '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 \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _payment_method_billing_info(EE_Payment_Method $payment_method)
-    {
-        $currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug()
-            ? true
-            : false;
-        // 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::p(
-            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(
-            array(
-                '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'     => array(
-                    '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
-     *
-     * @access public
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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(array('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
-     *
-     * @access private
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Billing_Info_Form|EE_Form_Section_HTML
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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,
-            array('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
-            )
-                && EE_Registry::instance()->REQ->is_set('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
-     *
-     * @access private
-     * @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 \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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 = EE_Registry::instance()->REQ->get($request_param, false);
-        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
-     *
-     * @access public
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    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(
-                array('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(array('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 \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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;
-                    break;
-                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;
-                    break;
-                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;
-                    break;
-                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 ? true : false;
-    }
-
-
-
-    /********************************************************************************************************/
-    /***************************************  SAVE PAYER DETAILS  ****************************************/
-    /********************************************************************************************************/
-    /**
-     * save_payer_details_via_ajax
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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 \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _create_attendee_from_request_data()
-    {
-        // get State ID
-        $STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['state']) : '';
-        if (! empty($STA_ID)) {
-            // can we get state object from name ?
-            EE_Registry::instance()->load_model('State');
-            $state = EEM_State::instance()->get_col(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
-            $STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
-        }
-        // get Country ISO
-        $CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['country']) : '';
-        if (! empty($CNT_ISO)) {
-            // can we get country object from name ?
-            EE_Registry::instance()->load_model('Country');
-            $country = EEM_Country::instance()->get_col(
-                array(array('CNT_name' => $CNT_ISO), 'limit' => 1),
-                'CNT_ISO'
-            );
-            $CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
-        }
-        // grab attendee data
-        $attendee_data = array(
-            'ATT_fname'    => ! empty($_REQUEST['first_name']) ? sanitize_text_field($_REQUEST['first_name']) : '',
-            'ATT_lname'    => ! empty($_REQUEST['last_name']) ? sanitize_text_field($_REQUEST['last_name']) : '',
-            'ATT_email'    => ! empty($_REQUEST['email']) ? sanitize_email($_REQUEST['email']) : '',
-            'ATT_address'  => ! empty($_REQUEST['address']) ? sanitize_text_field($_REQUEST['address']) : '',
-            'ATT_address2' => ! empty($_REQUEST['address2']) ? sanitize_text_field($_REQUEST['address2']) : '',
-            'ATT_city'     => ! empty($_REQUEST['city']) ? sanitize_text_field($_REQUEST['city']) : '',
-            'STA_ID'       => $STA_ID,
-            'CNT_ISO'      => $CNT_ISO,
-            'ATT_zip'      => ! empty($_REQUEST['zip']) ? sanitize_text_field($_REQUEST['zip']) : '',
-            'ATT_phone'    => ! empty($_REQUEST['phone']) ? sanitize_text_field($_REQUEST['phone']) : '',
-        );
-        // validate the email address since it is the most important piece of info
-        if (empty($attendee_data['ATT_email']) || $attendee_data['ATT_email'] !== $_REQUEST['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 = EE_Registry::instance()->LIB->EEM_Attendee->find_existing_attendee(
-                array(
-                    '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 \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\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;
-                break;
-
-            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;
-                break;
-
-            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;
-                break;
-
-            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_successful = $this->_process_payment();
-                if ($payment_successful) {
-                    $this->checkout->continue_reg = true;
-                    $this->_maybe_set_completed($this->checkout->payment_method);
-                } else {
-                    $this->checkout->continue_reg = false;
-                }
-                return $payment_successful;
-        }
-    }
-
-
-    /**
-     * _redirect_because_event_sold_out
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _redirect_because_event_sold_out()
-    {
-        $this->checkout->continue_reg = false;
-        // set redirect URL
-        $this->checkout->redirect_url = add_query_arg(
-            array('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);
-    }
-
-
-    /**
-     * _maybe_set_completed
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _maybe_set_completed(EE_Payment_Method $payment_method)
-    {
-        switch ($payment_method->type_obj()->payment_occurs()) {
-            case EE_PMT_Base::offsite:
-                break;
-            case EE_PMT_Base::onsite:
-            case EE_PMT_Base::offline:
-                // mark this reg step as completed
-                $this->set_completed();
-                break;
-        }
-    }
-
-
-    /**
-     *    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 \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\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(
-                array('e_reg_url_link' => $this->checkout->reg_url_link),
-                $this->checkout->thank_you_page_url
-            );
-        }
-        return $success;
-    }
-
-
-    /**
-     *    _process_payment
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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 false;
-        }
-        // 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 false;
-        }
-        // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
-            return false;
-        }
-        // setup billing form
-        if ($this->checkout->payment_method->is_on_site()) {
-            $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 false;
-            }
-        }
-        // ensure primary registrant has been fully processed
-        if (! $this->_setup_primary_registrant_prior_to_payment()) {
-            return false;
-        }
-        // 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 true;
-            } else {
-                return false;
-            }
-        } elseif ($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 true;
-        }
-        // where's my money?
-        return false;
-    }
-
-
-    /**
-     * _last_second_ticket_verifications
-     *
-     * @access public
-     * @return bool
-     * @throws EE_Error
-     */
-    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
-     *
-     * @access public
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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;
-        EE_Registry::instance()->REQ->add_output($html);
-        return true;
-    }
-
-
-    /**
-     * _billing_form_is_valid
-     *
-     * @access private
-     * @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 = array();
-                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)
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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
-     *
-     * @access public
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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');
-            /** @type EEM_Payment_Method $EEM_Payment_Method */
-            $EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
-            $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 \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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
-     *
-     * @access protected
-     * @param \Exception $e
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return string
-     * @throws \EE_Error
-     */
-    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(
-                    array(
-                        '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
-     *
-     * @access private
-     * @param EE_Payment $payment
-     * @return EE_Payment|FALSE
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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
-     *
-     * @access private
-     * @param EE_Payment|bool $payment
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _post_payment_processing($payment = null)
-    {
-        // Off-Line payment?
-        if ($payment === true) {
-            // $this->_setup_redirect_for_next_step();
-            return true;
-            // On-Site payment?
-        } elseif ($this->checkout->payment_method->is_on_site()) {
-            if (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
-                // $this->_setup_redirect_for_next_step();
-                $this->checkout->continue_reg = false;
-            }
-            // Off-Site payment?
-        } elseif ($this->checkout->payment_method->is_off_site()) {
-            // if a payment object was made and it specifies a redirect url, then we'll setup that redirect info
-            if ($payment instanceof EE_Payment && $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();
-            } else {
-                // not a payment
-                $this->checkout->continue_reg = false;
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'It appears the Off Site Payment Method was not configured properly.%sPlease try again or contact %s for assistance.',
-                            'event_espresso'
-                        ),
-                        '<br/>',
-                        EE_Registry::instance()->CFG->organization->get_pretty('email')
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } else {
-            // ummm ya... not Off-Line, not On-Site, not off-Site ????
-            $this->checkout->continue_reg = false;
-            return false;
-        }
-        return $payment;
-    }
-
-
-    /**
-     *    _process_payment_status
-     *
-     * @access private
-     * @type    EE_Payment $payment
-     * @param string       $payment_occurs
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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;
-                    break;
-                // 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;
-                    break;
-                // 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;
-                    break;
-                // 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;
-                    break;
-                // 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
-     *
-     * @access private
-     * @return EE_Payment|FALSE
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    public function process_gateway_response()
-    {
-        $payment = null;
-        // 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();
-        // DEBUG LOG
-        // $this->checkout->log(
-        //     __CLASS__,
-        //     __FUNCTION__,
-        //     __LINE__,
-        //     array(
-        //         'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
-        //         'payment_method'             => $this->checkout->payment_method,
-        //     ),
-        //     true
-        // );
-        // 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 ($gateway instanceof EE_Offsite_Gateway && ! $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
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    private function _validate_offsite_return()
-    {
-        $TXN_ID = (int) EE_Registry::instance()->REQ->get('spco_txn', 0);
-        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
-     *
-     * @access private
-     * @param \EE_Registration|null $primary_registrant
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    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 false;
-        }
-        // make sure transaction is not locked
-        $this->checkout->transaction->unlock();
-        wp_safe_redirect(
-            add_query_arg(
-                array(
-                    'e_reg_url_link' => $primary_registrant->reg_url_link(),
-                ),
-                $this->checkout->thank_you_page_url
-            )
-        );
-        exit();
-    }
-
-
-    /**
-     * _process_off_site_payment
-     *
-     * @access private
-     * @param \EE_Offsite_Gateway $gateway
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
-    {
-        try {
-            $request_data = \EE_Registry::instance()->REQ->params();
-            // 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);
-            }
-        }
-        // DEBUG LOG
-        // $this->checkout->log(
-        //     __CLASS__,
-        //     __FUNCTION__,
-        //     __LINE__,
-        //     array(
-        //         'process_ipn_payment' => $payment,
-        //         'payment_source'      => $payment_source,
-        //     )
-        // );
-        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
-     *
-     * @access private
-     * @param EE_Payment $payment
-     * @return EE_Payment | FALSE
-     * @throws \EE_Error
-     */
-    private function _process_cancelled_payments($payment = null)
-    {
-        if ($payment instanceof EE_Payment
-            && isset($_REQUEST['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 int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function get_transaction_details_for_gateways()
-    {
-        $txn_details = array();
-        // ya gotta make a choice man
-        if (empty($this->checkout->selected_method_of_payment)) {
-            $txn_details = array(
-                '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 = array(
-                '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 = array(
-                '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(array('ee_cancel_payment' => true), $return_url),
-                'notify_url'     => EE_Config::instance()->core->txn_page_url(
-                    array(
-                        '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)), array('reg_form', 'checkout', 'line_item_display'));
-    }
+	/**
+	 * @access protected
+	 * @var EE_Line_Item_Display $Line_Item_Display
+	 */
+	protected $line_item_display;
+
+	/**
+	 * @access protected
+	 * @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',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters')
+		);
+		add_action(
+			'wp_ajax_switch_spco_billing_form',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
+		);
+		add_action(
+			'wp_ajax_nopriv_switch_spco_billing_form',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
+		);
+		add_action('wp_ajax_save_payer_details', array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details'));
+		add_action(
+			'wp_ajax_nopriv_save_payer_details',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details')
+		);
+		add_action(
+			'wp_ajax_get_transaction_details_for_gateways',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
+		);
+		add_action(
+			'wp_ajax_nopriv_get_transaction_details_for_gateways',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
+		);
+		add_filter(
+			'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'),
+			10,
+			1
+		);
+	}
+
+
+	/**
+	 *    ajax switch_spco_billing_form
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function switch_spco_billing_form()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
+	}
+
+
+	/**
+	 *    ajax save_payer_details
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function save_payer_details()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
+	}
+
+
+	/**
+	 *    ajax get_transaction_details
+	 *
+	 * @throws \EE_Error
+	 */
+	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 \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public static function bypass_recaptcha_for_load_payment_method()
+	{
+		return array(
+			'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->_slug = 'payment_options';
+		$this->_name = esc_html__('Payment Options', 'event_espresso');
+		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . '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 \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	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 \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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(array($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 \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\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 = array();
+		$registrations_for_free_events = array();
+		$registrations_requiring_pre_approval = array();
+		$sold_out_events = array();
+		$insufficient_spaces_available = array();
+		$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->event()->ID() ] = $registration;
+			}
+		}
+		$subsections = array();
+		// 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,
+						array('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(
+			array(
+				'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 \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\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 \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\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 ]);
+				continue;
+			}
+		}
+		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 \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
+	{
+		// registrations per event
+		$event_reg_count = array();
+		// spaces left per event
+		$event_spaces_remaining = array();
+		// tickets left sorted by ID
+		$tickets_remaining = array();
+		// registrations that have lost their space
+		$ejected_registrations = array();
+		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 = 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(
+			array(
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . DS
+												  . 'sold_out_events.template.php',
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
+							array(
+								'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
+	 */
+	private function _insufficient_spaces_available($insufficient_spaces_events_array = 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(
+			array(
+				'subsections'     => array(
+					'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
+					'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
+				),
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . DS
+												  . 'sold_out_events.template.php',
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
+							array(
+								'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 \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = array())
+	{
+		$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(
+			array(
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . DS
+												  . 'events_requiring_pre_approval.template.php', // layout_template
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
+							array(
+								'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 = array())
+	{
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'no_payment_required';
+		// generate no_payment_required form
+		return new EE_Form_Section_Proper(
+			array(
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . DS
+												  . 'no_payment_required.template.php', // layout_template
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
+							array(
+								'revisit'                       => $this->checkout->revisit,
+								'registrations'                 => array(),
+								'ticket_count'                  => array(),
+								'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 \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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(
+				array(
+					'subsections'     => array(
+						'before_payment_options' => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
+							new EE_Form_Section_Proper(
+								array('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(
+								array('layout_strategy' => new EE_Div_Per_Section_Layout())
+							)
+						),
+					),
+					'layout_strategy' => new EE_Template_Layout(
+						array(
+							'layout_template_file' => $this->_template,
+							'template_args'        => apply_filters(
+								'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
+								array(
+									'reg_count'                 => $this->line_item_display->total_items(),
+									'transaction_details'       => $transaction_details,
+									'available_payment_methods' => array(),
+								)
+							),
+						)
+					),
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _extra_hidden_inputs
+	 *
+	 * @param bool $no_payment_required
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	private function _extra_hidden_inputs($no_payment_required = true)
+	{
+		return new EE_Form_Section_Proper(
+			array(
+				'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => array(
+					'spco_no_payment_required' => new EE_Hidden_Input(
+						array(
+							'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(
+						array(
+							'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
+	 *
+	 * @access protected
+	 * @param array $registrations
+	 * @throws EE_Error
+	 */
+	protected function _apply_registration_payments_to_amount_owing(array $registrations)
+	{
+		$payments = array();
+		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 \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _reset_selected_method_of_payment($force_reset = false)
+	{
+		$reset_payment_method = $force_reset
+			? true
+			: sanitize_text_field(EE_Registry::instance()->REQ->get('reset_payment_method', false));
+		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 \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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(
+			array('selected_method_of_payment' => $selected_method_of_payment)
+		);
+	}
+
+
+	/**
+	 * _setup_payment_options
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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 = array(
+			// display the "Payment Method" header
+			'payment_method_header' => new EE_Form_Section_HTML(
+				EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr')
+			),
+		);
+		// the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
+		$available_payment_method_options = array();
+		$default_payment_method_option = array();
+		// additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
+		$payment_methods_billing_info = array(
+			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(
+			array(
+				'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 ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _get_available_payment_methods()
+	{
+		if (! empty($this->checkout->available_payment_methods)) {
+			return $this->checkout->available_payment_methods;
+		}
+		$available_payment_methods = array();
+		// load EEM_Payment_Method
+		EE_Registry::instance()->load_model('Payment_Method');
+		/** @type EEM_Payment_Method $EEM_Payment_Method */
+		$EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
+		// 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
+	 */
+	private function _available_payment_method_inputs($available_payment_method_options = array())
+	{
+		// generate inputs
+		return new EE_Form_Section_Proper(
+			array(
+				'html_id'         => 'ee-available-payment-method-inputs',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => array(
+					'' => new EE_Radio_Button_Input(
+						$available_payment_method_options,
+						array(
+							'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 \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _payment_method_billing_info(EE_Payment_Method $payment_method)
+	{
+		$currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug()
+			? true
+			: false;
+		// 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::p(
+			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(
+			array(
+				'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'     => array(
+					'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
+	 *
+	 * @access public
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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(array('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
+	 *
+	 * @access private
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Billing_Info_Form|EE_Form_Section_HTML
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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,
+			array('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
+			)
+				&& EE_Registry::instance()->REQ->is_set('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
+	 *
+	 * @access private
+	 * @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 \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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 = EE_Registry::instance()->REQ->get($request_param, false);
+		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
+	 *
+	 * @access public
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	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(
+				array('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(array('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 \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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;
+					break;
+				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;
+					break;
+				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;
+					break;
+				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 ? true : false;
+	}
+
+
+
+	/********************************************************************************************************/
+	/***************************************  SAVE PAYER DETAILS  ****************************************/
+	/********************************************************************************************************/
+	/**
+	 * save_payer_details_via_ajax
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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 \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _create_attendee_from_request_data()
+	{
+		// get State ID
+		$STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['state']) : '';
+		if (! empty($STA_ID)) {
+			// can we get state object from name ?
+			EE_Registry::instance()->load_model('State');
+			$state = EEM_State::instance()->get_col(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
+			$STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
+		}
+		// get Country ISO
+		$CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['country']) : '';
+		if (! empty($CNT_ISO)) {
+			// can we get country object from name ?
+			EE_Registry::instance()->load_model('Country');
+			$country = EEM_Country::instance()->get_col(
+				array(array('CNT_name' => $CNT_ISO), 'limit' => 1),
+				'CNT_ISO'
+			);
+			$CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
+		}
+		// grab attendee data
+		$attendee_data = array(
+			'ATT_fname'    => ! empty($_REQUEST['first_name']) ? sanitize_text_field($_REQUEST['first_name']) : '',
+			'ATT_lname'    => ! empty($_REQUEST['last_name']) ? sanitize_text_field($_REQUEST['last_name']) : '',
+			'ATT_email'    => ! empty($_REQUEST['email']) ? sanitize_email($_REQUEST['email']) : '',
+			'ATT_address'  => ! empty($_REQUEST['address']) ? sanitize_text_field($_REQUEST['address']) : '',
+			'ATT_address2' => ! empty($_REQUEST['address2']) ? sanitize_text_field($_REQUEST['address2']) : '',
+			'ATT_city'     => ! empty($_REQUEST['city']) ? sanitize_text_field($_REQUEST['city']) : '',
+			'STA_ID'       => $STA_ID,
+			'CNT_ISO'      => $CNT_ISO,
+			'ATT_zip'      => ! empty($_REQUEST['zip']) ? sanitize_text_field($_REQUEST['zip']) : '',
+			'ATT_phone'    => ! empty($_REQUEST['phone']) ? sanitize_text_field($_REQUEST['phone']) : '',
+		);
+		// validate the email address since it is the most important piece of info
+		if (empty($attendee_data['ATT_email']) || $attendee_data['ATT_email'] !== $_REQUEST['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 = EE_Registry::instance()->LIB->EEM_Attendee->find_existing_attendee(
+				array(
+					'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 \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\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;
+				break;
+
+			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;
+				break;
+
+			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;
+				break;
+
+			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_successful = $this->_process_payment();
+				if ($payment_successful) {
+					$this->checkout->continue_reg = true;
+					$this->_maybe_set_completed($this->checkout->payment_method);
+				} else {
+					$this->checkout->continue_reg = false;
+				}
+				return $payment_successful;
+		}
+	}
+
+
+	/**
+	 * _redirect_because_event_sold_out
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _redirect_because_event_sold_out()
+	{
+		$this->checkout->continue_reg = false;
+		// set redirect URL
+		$this->checkout->redirect_url = add_query_arg(
+			array('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);
+	}
+
+
+	/**
+	 * _maybe_set_completed
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _maybe_set_completed(EE_Payment_Method $payment_method)
+	{
+		switch ($payment_method->type_obj()->payment_occurs()) {
+			case EE_PMT_Base::offsite:
+				break;
+			case EE_PMT_Base::onsite:
+			case EE_PMT_Base::offline:
+				// mark this reg step as completed
+				$this->set_completed();
+				break;
+		}
+	}
+
+
+	/**
+	 *    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 \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\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(
+				array('e_reg_url_link' => $this->checkout->reg_url_link),
+				$this->checkout->thank_you_page_url
+			);
+		}
+		return $success;
+	}
+
+
+	/**
+	 *    _process_payment
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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 false;
+		}
+		// 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 false;
+		}
+		// get EE_Payment_Method object
+		if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+			return false;
+		}
+		// setup billing form
+		if ($this->checkout->payment_method->is_on_site()) {
+			$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 false;
+			}
+		}
+		// ensure primary registrant has been fully processed
+		if (! $this->_setup_primary_registrant_prior_to_payment()) {
+			return false;
+		}
+		// 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 true;
+			} else {
+				return false;
+			}
+		} elseif ($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 true;
+		}
+		// where's my money?
+		return false;
+	}
+
+
+	/**
+	 * _last_second_ticket_verifications
+	 *
+	 * @access public
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	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
+	 *
+	 * @access public
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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;
+		EE_Registry::instance()->REQ->add_output($html);
+		return true;
+	}
+
+
+	/**
+	 * _billing_form_is_valid
+	 *
+	 * @access private
+	 * @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 = array();
+				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)
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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
+	 *
+	 * @access public
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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');
+			/** @type EEM_Payment_Method $EEM_Payment_Method */
+			$EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
+			$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 \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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
+	 *
+	 * @access protected
+	 * @param \Exception $e
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	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(
+					array(
+						'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
+	 *
+	 * @access private
+	 * @param EE_Payment $payment
+	 * @return EE_Payment|FALSE
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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
+	 *
+	 * @access private
+	 * @param EE_Payment|bool $payment
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _post_payment_processing($payment = null)
+	{
+		// Off-Line payment?
+		if ($payment === true) {
+			// $this->_setup_redirect_for_next_step();
+			return true;
+			// On-Site payment?
+		} elseif ($this->checkout->payment_method->is_on_site()) {
+			if (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
+				// $this->_setup_redirect_for_next_step();
+				$this->checkout->continue_reg = false;
+			}
+			// Off-Site payment?
+		} elseif ($this->checkout->payment_method->is_off_site()) {
+			// if a payment object was made and it specifies a redirect url, then we'll setup that redirect info
+			if ($payment instanceof EE_Payment && $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();
+			} else {
+				// not a payment
+				$this->checkout->continue_reg = false;
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'It appears the Off Site Payment Method was not configured properly.%sPlease try again or contact %s for assistance.',
+							'event_espresso'
+						),
+						'<br/>',
+						EE_Registry::instance()->CFG->organization->get_pretty('email')
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} else {
+			// ummm ya... not Off-Line, not On-Site, not off-Site ????
+			$this->checkout->continue_reg = false;
+			return false;
+		}
+		return $payment;
+	}
+
+
+	/**
+	 *    _process_payment_status
+	 *
+	 * @access private
+	 * @type    EE_Payment $payment
+	 * @param string       $payment_occurs
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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;
+					break;
+				// 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;
+					break;
+				// 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;
+					break;
+				// 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;
+					break;
+				// 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
+	 *
+	 * @access private
+	 * @return EE_Payment|FALSE
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	public function process_gateway_response()
+	{
+		$payment = null;
+		// 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();
+		// DEBUG LOG
+		// $this->checkout->log(
+		//     __CLASS__,
+		//     __FUNCTION__,
+		//     __LINE__,
+		//     array(
+		//         'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
+		//         'payment_method'             => $this->checkout->payment_method,
+		//     ),
+		//     true
+		// );
+		// 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 ($gateway instanceof EE_Offsite_Gateway && ! $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
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	private function _validate_offsite_return()
+	{
+		$TXN_ID = (int) EE_Registry::instance()->REQ->get('spco_txn', 0);
+		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
+	 *
+	 * @access private
+	 * @param \EE_Registration|null $primary_registrant
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	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 false;
+		}
+		// make sure transaction is not locked
+		$this->checkout->transaction->unlock();
+		wp_safe_redirect(
+			add_query_arg(
+				array(
+					'e_reg_url_link' => $primary_registrant->reg_url_link(),
+				),
+				$this->checkout->thank_you_page_url
+			)
+		);
+		exit();
+	}
+
+
+	/**
+	 * _process_off_site_payment
+	 *
+	 * @access private
+	 * @param \EE_Offsite_Gateway $gateway
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
+	{
+		try {
+			$request_data = \EE_Registry::instance()->REQ->params();
+			// 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);
+			}
+		}
+		// DEBUG LOG
+		// $this->checkout->log(
+		//     __CLASS__,
+		//     __FUNCTION__,
+		//     __LINE__,
+		//     array(
+		//         'process_ipn_payment' => $payment,
+		//         'payment_source'      => $payment_source,
+		//     )
+		// );
+		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
+	 *
+	 * @access private
+	 * @param EE_Payment $payment
+	 * @return EE_Payment | FALSE
+	 * @throws \EE_Error
+	 */
+	private function _process_cancelled_payments($payment = null)
+	{
+		if ($payment instanceof EE_Payment
+			&& isset($_REQUEST['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 int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function get_transaction_details_for_gateways()
+	{
+		$txn_details = array();
+		// ya gotta make a choice man
+		if (empty($this->checkout->selected_method_of_payment)) {
+			$txn_details = array(
+				'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 = array(
+				'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 = array(
+				'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(array('ee_cancel_payment' => true), $return_url),
+				'notify_url'     => EE_Config::instance()->core->txn_page_url(
+					array(
+						'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)), array('reg_form', 'checkout', 'line_item_display'));
+	}
 }

Spacing +76 added lines, -76 removed lines

@@ -129,7 +129,7 @@ 
     {
         $this->_slug = 'payment_options';
         $this->_name = esc_html__('Payment Options', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'payment_options_main.template.php';
+        $this->_template = SPCO_REG_STEPS_PATH.$this->_slug.DS.'payment_options_main.template.php';
         $this->checkout = $checkout;
         $this->_reset_success_message();
         $this->set_instructions(
@@ -212,7 +212,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 (EEM_Payment_Method::instance()->get_all_for_transaction(
@@ -304,18 +304,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(),
@@ -331,7 +331,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(),
@@ -341,38 +341,38 @@ 
             }
             // 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(),
                     $this
                 );
-            } elseif (! $this->checkout->revisit
+            } elseif ( ! $this->checkout->revisit
                       && $registration->status_ID() !== EEM_Registration::status_id_not_approved
                       && $registration->ticket()->is_free()
             ) {
-                $registrations_for_free_events[ $registration->event()->ID() ] = $registration;
+                $registrations_for_free_events[$registration->event()->ID()] = $registration;
             }
         }
         $subsections = array();
         // 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();
@@ -437,13 +437,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(
@@ -483,8 +483,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]);
                 continue;
             }
         }
@@ -534,24 +534,24 @@ 
             }
             $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');
@@ -611,7 +611,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'
                 )
@@ -667,7 +667,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')
                 );
             }
         }
@@ -716,7 +716,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(
                         '',
                         '',
@@ -857,7 +857,7 @@ 
     {
         return new EE_Form_Section_Proper(
             array(
-                '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'     => array(
                     'spco_no_payment_required' => new EE_Hidden_Input(
@@ -897,7 +897,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();
@@ -1017,23 +1017,23 @@ 
                 $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
                 // 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->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' ] = $this->_payment_method_billing_info(
+                $payment_methods_billing_info[$payment_method->slug(
+                ).'-info'] = $this->_payment_method_billing_info(
                     $payment_method
                 );
             }
@@ -1069,7 +1069,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 = array();
@@ -1084,7 +1084,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;
@@ -1179,7 +1179,7 @@ 
         );
         return new EE_Form_Section_Proper(
             array(
-                '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;',
@@ -1209,7 +1209,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 (apply_filters(
@@ -1381,7 +1381,7 @@ 
      */
     public function switch_payment_method()
     {
-        if (! $this->_verify_payment_method_is_set()) {
+        if ( ! $this->_verify_payment_method_is_set()) {
             return false;
         }
         if (apply_filters(
@@ -1516,7 +1516,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();
         }
@@ -1541,7 +1541,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
@@ -1551,7 +1551,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) {
@@ -1582,7 +1582,7 @@ 
     {
         // get State ID
         $STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['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(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
@@ -1590,7 +1590,7 @@ 
         }
         // get Country ISO
         $CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['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(
@@ -1623,7 +1623,7 @@ 
         }
         // 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'])
+        if ( ! empty($attendee_data['ATT_fname'])
             && ! empty($attendee_data['ATT_lname'])
             && ! empty($attendee_data['ATT_email'])
         ) {
@@ -1838,7 +1838,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 false;
         }
         // ya gotta make a choice man
@@ -1849,7 +1849,7 @@ 
             return false;
         }
         // 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 false;
         }
         // setup billing form
@@ -1858,12 +1858,12 @@ 
                 $this->checkout->payment_method
             );
             // bad billing form ?
-            if (! $this->_billing_form_is_valid()) {
+            if ( ! $this->_billing_form_is_valid()) {
                 return false;
             }
         }
         // ensure primary registrant has been fully processed
-        if (! $this->_setup_primary_registrant_prior_to_payment()) {
+        if ( ! $this->_setup_primary_registrant_prior_to_payment()) {
             return false;
         }
         // if session is close to expiring (under 10 minutes by default)
@@ -1918,7 +1918,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();
@@ -1984,7 +1984,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) {
@@ -2103,7 +2103,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__(
@@ -2120,7 +2120,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__(
@@ -2136,7 +2136,7 @@ 
             );
             return false;
         }
-        if (! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
+        if ( ! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
               instanceof
               EE_Attendee
         ) {
@@ -2182,8 +2182,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 {
@@ -2352,7 +2352,7 @@ 
             return true;
         }
         // verify payment object
-        if (! $payment instanceof EE_Payment) {
+        if ( ! $payment instanceof EE_Payment) {
             // not a payment
             EE_Error::add_error(
                 sprintf(
@@ -2392,7 +2392,7 @@ 
             return true;
             // On-Site payment?
         } elseif ($this->checkout->payment_method->is_on_site()) {
-            if (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
+            if ( ! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
                 // $this->_setup_redirect_for_next_step();
                 $this->checkout->continue_reg = false;
             }
@@ -2508,7 +2508,7 @@ 
                     break;
                 // bad payment
                 case EEM_Payment::status_id_failed:
-                    if (! empty($msg)) {
+                    if ( ! empty($msg)) {
                         EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
                         return false;
                     }
@@ -2569,11 +2569,11 @@ 
         // 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();
@@ -2591,7 +2591,7 @@ 
         // 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;
             }
@@ -2708,13 +2708,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__(
@@ -2784,7 +2784,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/reg_steps/attendee_information/EE_SPCO_Reg_Step_Attendee_Information.class.php

Indentation +1350 added lines, -1350 removed lines

@@ -15,1357 +15,1357 @@
 class EE_SPCO_Reg_Step_Attendee_Information extends EE_SPCO_Reg_Step
 {
 
-    /**
-     * @type bool $_print_copy_info
-     */
-    private $_print_copy_info = false;
-
-    /**
-     * @type array $_attendee_data
-     */
-    private $_attendee_data = array();
-
-    /**
-     * @type array $_required_questions
-     */
-    private $_required_questions = array();
-
-    /**
-     * @type array $_registration_answers
-     */
-    private $_registration_answers = array();
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param    EE_Checkout $checkout
-     */
-    public function __construct(EE_Checkout $checkout)
-    {
-        $this->_slug = 'attendee_information';
-        $this->_name = esc_html__('Attendee Information', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'attendee_info_main.template.php';
-        $this->checkout = $checkout;
-        $this->_reset_success_message();
-        $this->set_instructions(
-            esc_html__('Please answer the following registration questions before proceeding.', 'event_espresso')
-        );
-    }
-
-
-    public function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['required_field'] = esc_html__(
-            ' is a required question.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['required_multi_field'] = esc_html__(
-            ' is a required question. Please enter a value for at least one of the options.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['answer_required_questions'] = esc_html__(
-            'Please answer all required questions correctly before proceeding.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['attendee_info_copied'] = sprintf(
-            esc_html__(
-                'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
-                'event_espresso'
-            ),
-            '<br/>'
-        );
-        EE_Registry::$i18n_js_strings['attendee_info_copy_error'] = esc_html__(
-            'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['enter_valid_email'] = esc_html__(
-            'You must enter a valid email address.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['valid_email_and_questions'] = esc_html__(
-            'You must enter a valid email address and answer all other required questions before you can proceed.',
-            'event_espresso'
-        );
-    }
-
-
-    public function enqueue_styles_and_scripts()
-    {
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function initialize_reg_step()
-    {
-        return true;
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function generate_reg_form()
-    {
-        $this->_print_copy_info = false;
-        $primary_registrant = null;
-        // autoload Line_Item_Display classes
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        $Line_Item_Display = new EE_Line_Item_Display();
-        // calculate taxes
-        $Line_Item_Display->display_line_item(
-            $this->checkout->cart->get_grand_total(),
-            array('set_tax_rate' => true)
-        );
-        /** @var $subsections EE_Form_Section_Proper[] */
-        $subsections = array(
-            'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
-        );
-        $template_args = array(
-            'revisit'       => $this->checkout->revisit,
-            'registrations' => array(),
-            'ticket_count'  => array(),
-        );
-        // grab the saved registrations from the transaction
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        if ($registrations) {
-            foreach ($registrations as $registration) {
-                // can this registration be processed during this visit ?
-                if ($registration instanceof EE_Registration
-                    && $this->checkout->visit_allows_processing_of_this_registration($registration)
-                ) {
-                    $subsection = $this->_registrations_reg_form($registration);
-                    if (! $subsection instanceof EE_Form_Section_Proper) {
-                        continue;
-                    }
-                    $subsections[ $registration->reg_url_link() ] = $subsection;
-                    if (! $this->checkout->admin_request) {
-                        $template_args['registrations'][ $registration->reg_url_link() ] = $registration;
-                        $template_args['ticket_count'][ $registration->ticket()->ID() ] = isset(
-                            $template_args['ticket_count'][ $registration->ticket()->ID() ]
-                        )
-                            ? $template_args['ticket_count'][ $registration->ticket()->ID() ] + 1
-                            : 1;
-                        $ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-                            $this->checkout->cart->get_grand_total(),
-                            'Ticket',
-                            array($registration->ticket()->ID())
-                        );
-                        $ticket_line_item = is_array($ticket_line_item)
-                            ? reset($ticket_line_item)
-                            : $ticket_line_item;
-                        $template_args['ticket_line_item'][ $registration->ticket()->ID() ] =
-                            $Line_Item_Display->display_line_item($ticket_line_item);
-                    }
-                    if ($registration->is_primary_registrant()) {
-                        $primary_registrant = $registration->reg_url_link();
-                    }
-                }
-            }
-            // print_copy_info ?
-            if ($primary_registrant && ! $this->checkout->admin_request && count($registrations) > 1) {
-                // TODO: add admin option for toggling copy attendee info,
-                // then use that value to change $this->_print_copy_info
-                $copy_options['spco_copy_attendee_chk'] = $this->_print_copy_info
-                    ? $this->_copy_attendee_info_form()
-                    : $this->_auto_copy_attendee_info();
-                // generate hidden input
-                if (isset($subsections[ $primary_registrant ])
-                    && $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
-                ) {
-                    $subsections[ $primary_registrant ]->add_subsections(
-                        $copy_options,
-                        'primary_registrant',
-                        false
-                    );
-                }
-            }
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => $this->reg_form_name(),
-                'html_id'         => $this->reg_form_name(),
-                'subsections'     => $subsections,
-                'layout_strategy' => $this->checkout->admin_request
-                    ?
-                    new EE_Div_Per_Section_Layout()
-                    :
-                    new EE_Template_Layout(
-                        array(
-                            'layout_template_file' => $this->_template, // layout_template
-                            'template_args'        => $template_args,
-                        )
-                    ),
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return EE_Form_Section_Base
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _registrations_reg_form(EE_Registration $registration)
-    {
-        static $attendee_nmbr = 1;
-        $form_args = array();
-        // verify that registration has valid event
-        if ($registration->event() instanceof EE_Event) {
-            $question_groups = $registration->event()->question_groups(
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
-                    array(
-                        array(
-                            'Event.EVT_ID'                     => $registration->event()->ID(),
-                            'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false,
-                        ),
-                        'order_by' => array('QSG_order' => 'ASC'),
-                    ),
-                    $registration,
-                    $this
-                )
-            );
-            if ($question_groups) {
-                // array of params to pass to parent constructor
-                $form_args = array(
-                    'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
-                    'html_class'      => 'ee-reg-form-attendee-dv',
-                    'html_style'      => $this->checkout->admin_request
-                        ? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
-                        : '',
-                    'subsections'     => array(),
-                    'layout_strategy' => new EE_Fieldset_Section_Layout(
-                        array(
-                            'legend_class' => 'spco-attendee-lgnd smaller-text lt-grey-text',
-                            'legend_text'  => sprintf(__('Attendee %d', 'event_espresso'), $attendee_nmbr),
-                        )
-                    ),
-                );
-                foreach ($question_groups as $question_group) {
-                    if ($question_group instanceof EE_Question_Group) {
-                        $form_args['subsections'][ $question_group->identifier() ] = $this->_question_group_reg_form(
-                            $registration,
-                            $question_group
-                        );
-                    }
-                }
-                // add hidden input
-                $form_args['subsections']['additional_attendee_reg_info'] = $this->_additional_attendee_reg_info_input(
-                    $registration
-                );
-                // if we have question groups for additional attendees, then display the copy options
-                $this->_print_copy_info = $attendee_nmbr > 1 ? true : $this->_print_copy_info;
-                if ($registration->is_primary_registrant()) {
-                    // generate hidden input
-                    $form_args['subsections']['primary_registrant'] = $this->_additional_primary_registrant_inputs(
-                        $registration
-                    );
-                }
-            }
-        }
-        $attendee_nmbr++;
-        return ! empty($form_args) ? new EE_Form_Section_Proper($form_args) : null;
-    }
-
-
-    /**
-     * _additional_attendee_reg_info_input
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @param bool            $additional_attendee_reg_info
-     * @return    EE_Form_Input_Base
-     * @throws \EE_Error
-     */
-    private function _additional_attendee_reg_info_input(
-        EE_Registration $registration,
-        $additional_attendee_reg_info = true
-    ) {
-        // generate hidden input
-        return new EE_Hidden_Input(
-            array(
-                'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
-                'default' => $additional_attendee_reg_info,
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Registration   $registration
-     * @param EE_Question_Group $question_group
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _question_group_reg_form(EE_Registration $registration, EE_Question_Group $question_group)
-    {
-        // array of params to pass to parent constructor
-        $form_args = array(
-            'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-' . $registration->ID(),
-            'html_class'      => $this->checkout->admin_request
-                ? 'form-table ee-reg-form-qstn-grp-dv'
-                : 'ee-reg-form-qstn-grp-dv',
-            'html_label_id'   => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-'
-                                 . $registration->ID() . '-lbl',
-            'subsections'     => array(
-                'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group),
-            ),
-            'layout_strategy' => $this->checkout->admin_request
-                ? new EE_Admin_Two_Column_Layout()
-                : new EE_Div_Per_Section_Layout(),
-        );
-        // where params
-        $query_params = array('QST_deleted' => 0);
-        // don't load admin only questions on the frontend
-        if (! $this->checkout->admin_request) {
-            $query_params['QST_admin_only'] = array('!=', true);
-        }
-        $questions = $question_group->get_many_related(
-            'Question',
-            apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__related_questions_query_params',
-                array(
-                    $query_params,
-                    'order_by' => array(
-                        'Question_Group_Question.QGQ_order' => 'ASC',
-                    ),
-                ),
-                $question_group,
-                $registration,
-                $this
-            )
-        );
-        // filter for additional content before questions
-        $form_args['subsections']['reg_form_questions_before'] = new EE_Form_Section_HTML(
-            apply_filters(
-                'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
-                '',
-                $registration,
-                $question_group,
-                $this
-            )
-        );
-        // loop thru questions
-        foreach ($questions as $question) {
-            if ($question instanceof EE_Question) {
-                $identifier = $question->is_system_question()
-                    ? $question->system_ID()
-                    : $question->ID();
-                $form_args['subsections'][ $identifier ] = $this->reg_form_question($registration, $question);
-            }
-        }
-        $form_args['subsections'] = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__question_group_reg_form__subsections_array',
-            $form_args['subsections'],
-            $registration,
-            $question_group,
-            $this
-        );
-        // filter for additional content after questions
-        $form_args['subsections']['reg_form_questions_after'] = new EE_Form_Section_HTML(
-            apply_filters(
-                'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
-                '',
-                $registration,
-                $question_group,
-                $this
-            )
-        );
-        // d($form_args);
-        $question_group_reg_form = new EE_Form_Section_Proper($form_args);
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
-            $question_group_reg_form,
-            $registration,
-            $question_group,
-            $this
-        );
-    }
-
-
-    /**
-     * @access public
-     * @param EE_Question_Group $question_group
-     * @return    EE_Form_Section_HTML
-     */
-    private function _question_group_header(EE_Question_Group $question_group)
-    {
-        $html = '';
-        // group_name
-        if ($question_group->show_group_name() && $question_group->name() !== '') {
-            if ($this->checkout->admin_request) {
-                $html .= EEH_HTML::br();
-                $html .= EEH_HTML::h3(
-                    $question_group->name(),
-                    '',
-                    'ee-reg-form-qstn-grp-title title',
-                    'font-size: 1.3em; padding-left:0;'
-                );
-            } else {
-                $html .= EEH_HTML::h4(
-                    $question_group->name(),
-                    '',
-                    'ee-reg-form-qstn-grp-title section-title'
-                );
-            }
-        }
-        // group_desc
-        if ($question_group->show_group_desc() && $question_group->desc() !== '') {
-            $html .= EEH_HTML::p(
-                $question_group->desc(),
-                '',
-                $this->checkout->admin_request
-                    ? 'ee-reg-form-qstn-grp-desc-pg'
-                    : 'ee-reg-form-qstn-grp-desc-pg small-text lt-grey-text'
-            );
-        }
-        return new EE_Form_Section_HTML($html);
-    }
-
-
-    /**
-     * @access public
-     * @return    EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    private function _copy_attendee_info_form()
-    {
-        // array of params to pass to parent constructor
-        return new EE_Form_Section_Proper(
-            array(
-                'subsections'     => $this->_copy_attendee_info_inputs(),
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file'     => SPCO_REG_STEPS_PATH
-                                                      . $this->_slug
-                                                      . DS
-                                                      . 'copy_attendee_info.template.php',
-                        'begin_template_file'      => null,
-                        'input_template_file'      => null,
-                        'subsection_template_file' => null,
-                        'end_template_file'        => null,
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _auto_copy_attendee_info
-     *
-     * @access public
-     * @return EE_Form_Section_HTML
-     */
-    private function _auto_copy_attendee_info()
-    {
-        return new EE_Form_Section_HTML(
-            EEH_Template::locate_template(
-                SPCO_REG_STEPS_PATH . $this->_slug . DS . '_auto_copy_attendee_info.template.php',
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
-                    array()
-                ),
-                true,
-                true
-            )
-        );
-    }
-
-
-    /**
-     * _copy_attendee_info_inputs
-     *
-     * @access public
-     * @return array
-     * @throws \EE_Error
-     */
-    private function _copy_attendee_info_inputs()
-    {
-        $copy_attendee_info_inputs = array();
-        $prev_ticket = null;
-        // grab the saved registrations from the transaction
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        foreach ($registrations as $registration) {
-            // for all  attendees other than the primary attendee
-            if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
-                // if this is a new ticket OR if this is the very first additional attendee after the primary attendee
-                if ($registration->ticket()->ID() !== $prev_ticket) {
-                    $item_name = $registration->ticket()->name();
-                    $item_name .= $registration->ticket()->description() !== ''
-                        ? ' - ' . $registration->ticket()->description()
-                        : '';
-                    $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID(
-                    ) . ']' ] =
-                        new EE_Form_Section_HTML(
-                            '<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
-                        );
-                    $prev_ticket = $registration->ticket()->ID();
-                }
-
-                $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[' . $registration->ID() . ']' ] =
-                    new EE_Checkbox_Multi_Input(
-                        array(
-                            $registration->ID() => sprintf(
-                                esc_html__('Attendee #%s', 'event_espresso'),
-                                $registration->count()
-                            ),
-                        ),
-                        array(
-                            'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
-                            'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
-                            'display_html_label_text' => false,
-                        )
-                    );
-            }
-        }
-        return $copy_attendee_info_inputs;
-    }
-
-
-    /**
-     * _additional_primary_registrant_inputs
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @return    EE_Form_Input_Base
-     * @throws \EE_Error
-     */
-    private function _additional_primary_registrant_inputs(EE_Registration $registration)
-    {
-        // generate hidden input
-        return new EE_Hidden_Input(
-            array(
-                'html_id' => 'primary_registrant',
-                'default' => $registration->reg_url_link(),
-            )
-        );
-    }
-
-
-    /**
-     * @access public
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function reg_form_question(EE_Registration $registration, EE_Question $question)
-    {
-
-        // if this question was for an attendee detail, then check for that answer
-        $answer_value = EEM_Answer::instance()->get_attendee_property_answer_value(
-            $registration,
-            $question->system_ID()
-        );
-        $answer = $answer_value === null
-            ? EEM_Answer::instance()->get_one(
-                array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
-            )
-            : null;
-        // if NOT returning to edit an existing registration
-        // OR if this question is for an attendee property
-        // OR we still don't have an EE_Answer object
-        if ($answer_value || ! $answer instanceof EE_Answer || ! $registration->reg_url_link()) {
-            // create an EE_Answer object for storing everything in
-            $answer = EE_Answer::new_instance(
-                array(
-                    'QST_ID' => $question->ID(),
-                    'REG_ID' => $registration->ID(),
-                )
-            );
-        }
-        // verify instance
-        if ($answer instanceof EE_Answer) {
-            if (! empty($answer_value)) {
-                $answer->set('ANS_value', $answer_value);
-            }
-            $answer->cache('Question', $question);
-            // remember system ID had a bug where sometimes it could be null
-            $answer_cache_id = $question->is_system_question()
-                ? $question->system_ID() . '-' . $registration->reg_url_link()
-                : $question->ID() . '-' . $registration->reg_url_link();
-            $registration->cache('Answer', $answer, $answer_cache_id);
-        }
-        return $this->_generate_question_input($registration, $question, $answer);
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @param                 mixed EE_Answer|NULL      $answer
-     * @return EE_Form_Input_Base
-     * @throws \EE_Error
-     */
-    private function _generate_question_input(EE_Registration $registration, EE_Question $question, $answer)
-    {
-        $identifier = $question->is_system_question()
-            ? $question->system_ID()
-            : $question->ID();
-        $this->_required_questions[ $identifier ] = $question->required() ? true : false;
-        add_filter(
-            'FHEE__EE_Question__generate_form_input__country_options',
-            array($this, 'use_cached_countries_for_form_input'),
-            10,
-            4
-        );
-        add_filter(
-            'FHEE__EE_Question__generate_form_input__state_options',
-            array($this, 'use_cached_states_for_form_input'),
-            10,
-            4
-        );
-        $input_constructor_args = array(
-            'html_name'        => 'ee_reg_qstn[' . $registration->ID() . '][' . $identifier . ']',
-            'html_id'          => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
-            'html_class'       => 'ee-reg-qstn ee-reg-qstn-' . $identifier,
-            'html_label_id'    => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
-            'html_label_class' => 'ee-reg-qstn',
-        );
-        $input_constructor_args['html_label_id'] .= '-lbl';
-        if ($answer instanceof EE_Answer && $answer->ID()) {
-            $input_constructor_args['html_name'] .= '[' . $answer->ID() . ']';
-            $input_constructor_args['html_id'] .= '-' . $answer->ID();
-            $input_constructor_args['html_label_id'] .= '-' . $answer->ID();
-        }
-        $form_input = $question->generate_form_input(
-            $registration,
-            $answer,
-            $input_constructor_args
-        );
-        remove_filter(
-            'FHEE__EE_Question__generate_form_input__country_options',
-            array($this, 'use_cached_countries_for_form_input')
-        );
-        remove_filter(
-            'FHEE__EE_Question__generate_form_input__state_options',
-            array($this, 'use_cached_states_for_form_input')
-        );
-        return $form_input;
-    }
-
-
-    /**
-     * Gets the list of countries for the form input
-     *
-     * @param array|null       $countries_list
-     * @param \EE_Question     $question
-     * @param \EE_Registration $registration
-     * @param \EE_Answer       $answer
-     * @return array 2d keys are country IDs, values are their names
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function use_cached_countries_for_form_input(
-        $countries_list,
-        \EE_Question $question = null,
-        \EE_Registration $registration = null,
-        \EE_Answer $answer = null
-    ) {
-        $country_options = array('' => '');
-        // get possibly cached list of countries
-        $countries = $this->checkout->action === 'process_reg_step'
-            ? EEM_Country::instance()->get_all_countries()
-            : EEM_Country::instance()->get_all_active_countries();
-        if (! empty($countries)) {
-            foreach ($countries as $country) {
-                if ($country instanceof EE_Country) {
-                    $country_options[ $country->ID() ] = $country->name();
-                }
-            }
-        }
-        if ($question instanceof EE_Question
-            && $registration instanceof EE_Registration) {
-            $answer = EEM_Answer::instance()->get_one(
-                array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
-            );
-        } else {
-            $answer = EE_Answer::new_instance();
-        }
-        $country_options = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            $country_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-        return $country_options;
-    }
-
-
-    /**
-     * Gets the list of states for the form input
-     *
-     * @param array|null       $states_list
-     * @param \EE_Question     $question
-     * @param \EE_Registration $registration
-     * @param \EE_Answer       $answer
-     * @return array 2d keys are state IDs, values are their names
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function use_cached_states_for_form_input(
-        $states_list,
-        \EE_Question $question = null,
-        \EE_Registration $registration = null,
-        \EE_Answer $answer = null
-    ) {
-        $state_options = array('' => array('' => ''));
-        $states = $this->checkout->action === 'process_reg_step'
-            ? EEM_State::instance()->get_all_states()
-            : EEM_State::instance()->get_all_active_states();
-        if (! empty($states)) {
-            foreach ($states as $state) {
-                if ($state instanceof EE_State) {
-                    $state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
-                }
-            }
-        }
-        $state_options = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            $state_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-        return $state_options;
-    }
-
-
-
-
-
-
-    /********************************************************************************************************/
-    /****************************************  PROCESS REG STEP  ****************************************/
-    /********************************************************************************************************/
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function process_reg_step()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // grab validated data from form
-        $valid_data = $this->checkout->current_step->valid_data();
-        // EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
-        // EEH_Debug_Tools::printr( $valid_data, '$valid_data', __FILE__, __LINE__ );
-        // if we don't have any $valid_data then something went TERRIBLY WRONG !!!
-        if (empty($valid_data)) {
-            EE_Error::add_error(
-                esc_html__('No valid question responses were received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
-            EE_Error::add_error(
-                esc_html__(
-                    'A valid transaction could not be initiated for processing your registrations.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // get cached registrations
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        // verify we got the goods
-        if (empty($registrations)) {
-            // combine the old translated string with a new one, in order to not break translations
-            $error_message = esc_html__(
-                'Your form data could not be applied to any valid registrations.',
-                'event_espresso'
-            )
-                             . sprintf(
-                                 esc_html__(
-                                     '%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.',
-                                     'event_espresso'
-                                 ),
-                                 '<a href="' . get_post_type_archive_link('espresso_events') . '" >',
-                                 '</a>',
-                                 '<br />'
-                             );
-            EE_Error::add_error(
-                $error_message,
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // extract attendee info from form data and save to model objects
-        $registrations_processed = $this->_process_registrations($registrations, $valid_data);
-        // if first pass thru SPCO,
-        // then let's check processed registrations against the total number of tickets in the cart
-        if ($registrations_processed === false) {
-            // but return immediately if the previous step exited early due to errors
-            return false;
-        } elseif (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
-            // generate a correctly translated string for all possible singular/plural combinations
-            if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
-                $error_msg = sprintf(
-                    esc_html__(
-                        'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
-                        'event_espresso'
-                    ),
-                    $this->checkout->total_ticket_count,
-                    $registrations_processed
-                );
-            } elseif ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
-                $error_msg = sprintf(
-                    esc_html__(
-                        'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
-                        'event_espresso'
-                    ),
-                    $this->checkout->total_ticket_count,
-                    $registrations_processed
-                );
-            } else {
-                $error_msg = sprintf(
-                    esc_html__(
-                        'There was a total of %1$d tickets in the Event Queue, but %2$ds registrations were processed',
-                        'event_espresso'
-                    ),
-                    $this->checkout->total_ticket_count,
-                    $registrations_processed
-                );
-            }
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // mark this reg step as completed
-        $this->set_completed();
-        $this->_set_success_message(
-            esc_html__('The Attendee Information Step has been successfully completed.', 'event_espresso')
-        );
-        // do action in case a plugin wants to do something with the data submitted in step 1.
-        // passes EE_Single_Page_Checkout, and it's posted data
-        do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
-        return true;
-    }
-
-
-    /**
-     *    _process_registrations
-     *
-     * @param EE_Registration[] $registrations
-     * @param array             $valid_data
-     * @return bool|int
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _process_registrations($registrations = array(), $valid_data = array())
-    {
-        // load resources and set some defaults
-        EE_Registry::instance()->load_model('Attendee');
-        // holder for primary registrant attendee object
-        $this->checkout->primary_attendee_obj = null;
-        // array for tracking reg form data for the primary registrant
-        $primary_registrant = array(
-            'line_item_id' => null,
-        );
-        $copy_primary = false;
-        // reg form sections that do not contain inputs
-        $non_input_form_sections = array(
-            'primary_registrant',
-            'additional_attendee_reg_info',
-            'spco_copy_attendee_chk',
-        );
-        // attendee counter
-        $att_nmbr = 0;
-        // grab the saved registrations from the transaction
-        foreach ($registrations as $registration) {
-            // verify EE_Registration object
-            if (! $registration instanceof EE_Registration) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'An invalid Registration object was discovered when attempting to process your registration information.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            /** @var string $reg_url_link */
-            $reg_url_link = $registration->reg_url_link();
-            // reg_url_link exists ?
-            if (! empty($reg_url_link)) {
-                // should this registration be processed during this visit ?
-                if ($this->checkout->visit_allows_processing_of_this_registration($registration)) {
-                    // if NOT revisiting, then let's save the registration now,
-                    // so that we have a REG_ID to use when generating other objects
-                    if (! $this->checkout->revisit) {
-                        $registration->save();
-                    }
-                    /**
-                     * This allows plugins to trigger a fail on processing of a
-                     * registration for any conditions they may have for it to pass.
-                     *
-                     * @var bool   if true is returned by the plugin then the
-                     *            registration processing is halted.
-                     */
-                    if (apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
-                        false,
-                        $att_nmbr,
-                        $registration,
-                        $registrations,
-                        $valid_data,
-                        $this
-                    )) {
-                        return false;
-                    }
-
-                    // Houston, we have a registration!
-                    $att_nmbr++;
-                    $this->_attendee_data[ $reg_url_link ] = array();
-                    // grab any existing related answer objects
-                    $this->_registration_answers = $registration->answers();
-                    // unset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] );
-                    if (isset($valid_data[ $reg_url_link ])) {
-                        // do we need to copy basic info from primary attendee ?
-                        $copy_primary = isset($valid_data[ $reg_url_link ]['additional_attendee_reg_info'])
-                                        && absint($valid_data[ $reg_url_link ]['additional_attendee_reg_info']) === 0
-                            ? true
-                            : false;
-                        // filter form input data for this registration
-                        $valid_data[ $reg_url_link ] = (array) apply_filters(
-                            'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-                            $valid_data[ $reg_url_link ]
-                        );
-                        if (isset($valid_data['primary_attendee'])) {
-                            $primary_registrant['line_item_id'] = ! empty($valid_data['primary_attendee'])
-                                ? $valid_data['primary_attendee']
-                                : false;
-                            unset($valid_data['primary_attendee']);
-                        }
-                        // now loop through our array of valid post data && process attendee reg forms
-                        foreach ($valid_data[ $reg_url_link ] as $form_section => $form_inputs) {
-                            if (! in_array($form_section, $non_input_form_sections)) {
-                                foreach ($form_inputs as $form_input => $input_value) {
-                                    // \EEH_Debug_Tools::printr( $input_value, $form_input, __FILE__, __LINE__ );
-                                    // check for critical inputs
-                                    if (! $this->_verify_critical_attendee_details_are_set_and_validate_email(
-                                        $form_input,
-                                        $input_value
-                                    )
-                                    ) {
-                                        return false;
-                                    }
-                                    // store a bit of data about the primary attendee
-                                    if ($att_nmbr === 1
-                                        && ! empty($input_value)
-                                        && $reg_url_link === $primary_registrant['line_item_id']
-                                    ) {
-                                        $primary_registrant[ $form_input ] = $input_value;
-                                    } elseif ($copy_primary
-                                              && $input_value === null
-                                              && isset($primary_registrant[ $form_input ])
-                                    ) {
-                                        $input_value = $primary_registrant[ $form_input ];
-                                    }
-                                    // now attempt to save the input data
-                                    if (! $this->_save_registration_form_input(
-                                        $registration,
-                                        $form_input,
-                                        $input_value
-                                    )
-                                    ) {
-                                        EE_Error::add_error(
-                                            sprintf(
-                                                esc_html__(
-                                                    'Unable to save registration form data for the form input: "%1$s" with the submitted value: "%2$s"',
-                                                    'event_espresso'
-                                                ),
-                                                $form_input,
-                                                $input_value
-                                            ),
-                                            __FILE__,
-                                            __FUNCTION__,
-                                            __LINE__
-                                        );
-                                        return false;
-                                    }
-                                }
-                            }
-                        }  // end of foreach ( $valid_data[ $reg_url_link ] as $form_section => $form_inputs )
-                    }
-                    // EEH_Debug_Tools::printr( $this->_attendee_data, '$this->_attendee_data', __FILE__, __LINE__ );
-                    // this registration does not require additional attendee information ?
-                    if ($copy_primary
-                        && $att_nmbr > 1
-                        && $this->checkout->primary_attendee_obj instanceof EE_Attendee
-                    ) {
-                        // just copy the primary registrant
-                        $attendee = $this->checkout->primary_attendee_obj;
-                    } else {
-                        // ensure critical details are set for additional attendees
-                        $this->_attendee_data[ $reg_url_link ] = $att_nmbr > 1
-                            ? $this->_copy_critical_attendee_details_from_primary_registrant(
-                                $this->_attendee_data[ $reg_url_link ]
-                            )
-                            : $this->_attendee_data[ $reg_url_link ];
-                        // execute create attendee command (which may return an existing attendee)
-                        $attendee = EE_Registry::instance()->BUS->execute(
-                            new CreateAttendeeCommand(
-                                $this->_attendee_data[ $reg_url_link ],
-                                $registration
-                            )
-                        );
-                        // who's #1 ?
-                        if ($att_nmbr === 1) {
-                            $this->checkout->primary_attendee_obj = $attendee;
-                        }
-                    }
-                    // EEH_Debug_Tools::printr( $attendee, '$attendee', __FILE__, __LINE__ );
-                    // add relation to registration, set attendee ID, and cache attendee
-                    $this->_associate_attendee_with_registration($registration, $attendee);
-                    // \EEH_Debug_Tools::printr( $registration, '$registration', __FILE__, __LINE__ );
-                    if (! $registration->attendee() instanceof EE_Attendee) {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'Registration %s has an invalid or missing Attendee object.',
-                                    'event_espresso'
-                                ),
-                                $reg_url_link
-                            ),
-                            __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(
-                        $registration,
-                        false,
-                        new Context(
-                            'spco_reg_step_attendee_information_process_registrations',
-                            esc_html__(
-                                'Finished populating registration with details from the registration form after submitting the Attendee Information Reg Step.',
-                                'event_espresso'
-                            )
-                        )
-                    );
-                    // 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();
-                    // if we've gotten this far, then let's save what we have
-                    $registration->save();
-                    // add relation between TXN and registration
-                    $this->_associate_registration_with_transaction($registration);
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'An invalid or missing line item ID was encountered while attempting to process the registration form.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                // remove malformed data
-                unset($valid_data[ $reg_url_link ]);
-                return false;
-            }
-        } // end of foreach ( $this->checkout->transaction->registrations()  as $registration )
-        return $att_nmbr;
-    }
-
-
-    /**
-     *    _save_registration_form_input
-     *
-     * @param EE_Registration $registration
-     * @param string          $form_input
-     * @param string          $input_value
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _save_registration_form_input(
-        EE_Registration $registration,
-        $form_input = '',
-        $input_value = ''
-    ) {
-        // \EEH_Debug_Tools::printr( __FUNCTION__, __CLASS__, __FILE__, __LINE__, 2 );
-        // \EEH_Debug_Tools::printr( $form_input, '$form_input', __FILE__, __LINE__ );
-        // \EEH_Debug_Tools::printr( $input_value, '$input_value', __FILE__, __LINE__ );
-        // allow for plugins to hook in and do their own processing of the form input.
-        // For plugins to bypass normal processing here, they just need to return a boolean value.
-        if (apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
-            false,
-            $registration,
-            $form_input,
-            $input_value,
-            $this
-        )) {
-            return true;
-        }
-        /*
+	/**
+	 * @type bool $_print_copy_info
+	 */
+	private $_print_copy_info = false;
+
+	/**
+	 * @type array $_attendee_data
+	 */
+	private $_attendee_data = array();
+
+	/**
+	 * @type array $_required_questions
+	 */
+	private $_required_questions = array();
+
+	/**
+	 * @type array $_registration_answers
+	 */
+	private $_registration_answers = array();
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param    EE_Checkout $checkout
+	 */
+	public function __construct(EE_Checkout $checkout)
+	{
+		$this->_slug = 'attendee_information';
+		$this->_name = esc_html__('Attendee Information', 'event_espresso');
+		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'attendee_info_main.template.php';
+		$this->checkout = $checkout;
+		$this->_reset_success_message();
+		$this->set_instructions(
+			esc_html__('Please answer the following registration questions before proceeding.', 'event_espresso')
+		);
+	}
+
+
+	public function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['required_field'] = esc_html__(
+			' is a required question.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['required_multi_field'] = esc_html__(
+			' is a required question. Please enter a value for at least one of the options.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['answer_required_questions'] = esc_html__(
+			'Please answer all required questions correctly before proceeding.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['attendee_info_copied'] = sprintf(
+			esc_html__(
+				'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
+				'event_espresso'
+			),
+			'<br/>'
+		);
+		EE_Registry::$i18n_js_strings['attendee_info_copy_error'] = esc_html__(
+			'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['enter_valid_email'] = esc_html__(
+			'You must enter a valid email address.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['valid_email_and_questions'] = esc_html__(
+			'You must enter a valid email address and answer all other required questions before you can proceed.',
+			'event_espresso'
+		);
+	}
+
+
+	public function enqueue_styles_and_scripts()
+	{
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function initialize_reg_step()
+	{
+		return true;
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function generate_reg_form()
+	{
+		$this->_print_copy_info = false;
+		$primary_registrant = null;
+		// autoload Line_Item_Display classes
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		$Line_Item_Display = new EE_Line_Item_Display();
+		// calculate taxes
+		$Line_Item_Display->display_line_item(
+			$this->checkout->cart->get_grand_total(),
+			array('set_tax_rate' => true)
+		);
+		/** @var $subsections EE_Form_Section_Proper[] */
+		$subsections = array(
+			'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
+		);
+		$template_args = array(
+			'revisit'       => $this->checkout->revisit,
+			'registrations' => array(),
+			'ticket_count'  => array(),
+		);
+		// grab the saved registrations from the transaction
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		if ($registrations) {
+			foreach ($registrations as $registration) {
+				// can this registration be processed during this visit ?
+				if ($registration instanceof EE_Registration
+					&& $this->checkout->visit_allows_processing_of_this_registration($registration)
+				) {
+					$subsection = $this->_registrations_reg_form($registration);
+					if (! $subsection instanceof EE_Form_Section_Proper) {
+						continue;
+					}
+					$subsections[ $registration->reg_url_link() ] = $subsection;
+					if (! $this->checkout->admin_request) {
+						$template_args['registrations'][ $registration->reg_url_link() ] = $registration;
+						$template_args['ticket_count'][ $registration->ticket()->ID() ] = isset(
+							$template_args['ticket_count'][ $registration->ticket()->ID() ]
+						)
+							? $template_args['ticket_count'][ $registration->ticket()->ID() ] + 1
+							: 1;
+						$ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+							$this->checkout->cart->get_grand_total(),
+							'Ticket',
+							array($registration->ticket()->ID())
+						);
+						$ticket_line_item = is_array($ticket_line_item)
+							? reset($ticket_line_item)
+							: $ticket_line_item;
+						$template_args['ticket_line_item'][ $registration->ticket()->ID() ] =
+							$Line_Item_Display->display_line_item($ticket_line_item);
+					}
+					if ($registration->is_primary_registrant()) {
+						$primary_registrant = $registration->reg_url_link();
+					}
+				}
+			}
+			// print_copy_info ?
+			if ($primary_registrant && ! $this->checkout->admin_request && count($registrations) > 1) {
+				// TODO: add admin option for toggling copy attendee info,
+				// then use that value to change $this->_print_copy_info
+				$copy_options['spco_copy_attendee_chk'] = $this->_print_copy_info
+					? $this->_copy_attendee_info_form()
+					: $this->_auto_copy_attendee_info();
+				// generate hidden input
+				if (isset($subsections[ $primary_registrant ])
+					&& $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
+				) {
+					$subsections[ $primary_registrant ]->add_subsections(
+						$copy_options,
+						'primary_registrant',
+						false
+					);
+				}
+			}
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => $this->reg_form_name(),
+				'html_id'         => $this->reg_form_name(),
+				'subsections'     => $subsections,
+				'layout_strategy' => $this->checkout->admin_request
+					?
+					new EE_Div_Per_Section_Layout()
+					:
+					new EE_Template_Layout(
+						array(
+							'layout_template_file' => $this->_template, // layout_template
+							'template_args'        => $template_args,
+						)
+					),
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return EE_Form_Section_Base
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _registrations_reg_form(EE_Registration $registration)
+	{
+		static $attendee_nmbr = 1;
+		$form_args = array();
+		// verify that registration has valid event
+		if ($registration->event() instanceof EE_Event) {
+			$question_groups = $registration->event()->question_groups(
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
+					array(
+						array(
+							'Event.EVT_ID'                     => $registration->event()->ID(),
+							'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false,
+						),
+						'order_by' => array('QSG_order' => 'ASC'),
+					),
+					$registration,
+					$this
+				)
+			);
+			if ($question_groups) {
+				// array of params to pass to parent constructor
+				$form_args = array(
+					'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
+					'html_class'      => 'ee-reg-form-attendee-dv',
+					'html_style'      => $this->checkout->admin_request
+						? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
+						: '',
+					'subsections'     => array(),
+					'layout_strategy' => new EE_Fieldset_Section_Layout(
+						array(
+							'legend_class' => 'spco-attendee-lgnd smaller-text lt-grey-text',
+							'legend_text'  => sprintf(__('Attendee %d', 'event_espresso'), $attendee_nmbr),
+						)
+					),
+				);
+				foreach ($question_groups as $question_group) {
+					if ($question_group instanceof EE_Question_Group) {
+						$form_args['subsections'][ $question_group->identifier() ] = $this->_question_group_reg_form(
+							$registration,
+							$question_group
+						);
+					}
+				}
+				// add hidden input
+				$form_args['subsections']['additional_attendee_reg_info'] = $this->_additional_attendee_reg_info_input(
+					$registration
+				);
+				// if we have question groups for additional attendees, then display the copy options
+				$this->_print_copy_info = $attendee_nmbr > 1 ? true : $this->_print_copy_info;
+				if ($registration->is_primary_registrant()) {
+					// generate hidden input
+					$form_args['subsections']['primary_registrant'] = $this->_additional_primary_registrant_inputs(
+						$registration
+					);
+				}
+			}
+		}
+		$attendee_nmbr++;
+		return ! empty($form_args) ? new EE_Form_Section_Proper($form_args) : null;
+	}
+
+
+	/**
+	 * _additional_attendee_reg_info_input
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param bool            $additional_attendee_reg_info
+	 * @return    EE_Form_Input_Base
+	 * @throws \EE_Error
+	 */
+	private function _additional_attendee_reg_info_input(
+		EE_Registration $registration,
+		$additional_attendee_reg_info = true
+	) {
+		// generate hidden input
+		return new EE_Hidden_Input(
+			array(
+				'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
+				'default' => $additional_attendee_reg_info,
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration   $registration
+	 * @param EE_Question_Group $question_group
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _question_group_reg_form(EE_Registration $registration, EE_Question_Group $question_group)
+	{
+		// array of params to pass to parent constructor
+		$form_args = array(
+			'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-' . $registration->ID(),
+			'html_class'      => $this->checkout->admin_request
+				? 'form-table ee-reg-form-qstn-grp-dv'
+				: 'ee-reg-form-qstn-grp-dv',
+			'html_label_id'   => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-'
+								 . $registration->ID() . '-lbl',
+			'subsections'     => array(
+				'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group),
+			),
+			'layout_strategy' => $this->checkout->admin_request
+				? new EE_Admin_Two_Column_Layout()
+				: new EE_Div_Per_Section_Layout(),
+		);
+		// where params
+		$query_params = array('QST_deleted' => 0);
+		// don't load admin only questions on the frontend
+		if (! $this->checkout->admin_request) {
+			$query_params['QST_admin_only'] = array('!=', true);
+		}
+		$questions = $question_group->get_many_related(
+			'Question',
+			apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__related_questions_query_params',
+				array(
+					$query_params,
+					'order_by' => array(
+						'Question_Group_Question.QGQ_order' => 'ASC',
+					),
+				),
+				$question_group,
+				$registration,
+				$this
+			)
+		);
+		// filter for additional content before questions
+		$form_args['subsections']['reg_form_questions_before'] = new EE_Form_Section_HTML(
+			apply_filters(
+				'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
+				'',
+				$registration,
+				$question_group,
+				$this
+			)
+		);
+		// loop thru questions
+		foreach ($questions as $question) {
+			if ($question instanceof EE_Question) {
+				$identifier = $question->is_system_question()
+					? $question->system_ID()
+					: $question->ID();
+				$form_args['subsections'][ $identifier ] = $this->reg_form_question($registration, $question);
+			}
+		}
+		$form_args['subsections'] = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__question_group_reg_form__subsections_array',
+			$form_args['subsections'],
+			$registration,
+			$question_group,
+			$this
+		);
+		// filter for additional content after questions
+		$form_args['subsections']['reg_form_questions_after'] = new EE_Form_Section_HTML(
+			apply_filters(
+				'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
+				'',
+				$registration,
+				$question_group,
+				$this
+			)
+		);
+		// d($form_args);
+		$question_group_reg_form = new EE_Form_Section_Proper($form_args);
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
+			$question_group_reg_form,
+			$registration,
+			$question_group,
+			$this
+		);
+	}
+
+
+	/**
+	 * @access public
+	 * @param EE_Question_Group $question_group
+	 * @return    EE_Form_Section_HTML
+	 */
+	private function _question_group_header(EE_Question_Group $question_group)
+	{
+		$html = '';
+		// group_name
+		if ($question_group->show_group_name() && $question_group->name() !== '') {
+			if ($this->checkout->admin_request) {
+				$html .= EEH_HTML::br();
+				$html .= EEH_HTML::h3(
+					$question_group->name(),
+					'',
+					'ee-reg-form-qstn-grp-title title',
+					'font-size: 1.3em; padding-left:0;'
+				);
+			} else {
+				$html .= EEH_HTML::h4(
+					$question_group->name(),
+					'',
+					'ee-reg-form-qstn-grp-title section-title'
+				);
+			}
+		}
+		// group_desc
+		if ($question_group->show_group_desc() && $question_group->desc() !== '') {
+			$html .= EEH_HTML::p(
+				$question_group->desc(),
+				'',
+				$this->checkout->admin_request
+					? 'ee-reg-form-qstn-grp-desc-pg'
+					: 'ee-reg-form-qstn-grp-desc-pg small-text lt-grey-text'
+			);
+		}
+		return new EE_Form_Section_HTML($html);
+	}
+
+
+	/**
+	 * @access public
+	 * @return    EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	private function _copy_attendee_info_form()
+	{
+		// array of params to pass to parent constructor
+		return new EE_Form_Section_Proper(
+			array(
+				'subsections'     => $this->_copy_attendee_info_inputs(),
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file'     => SPCO_REG_STEPS_PATH
+													  . $this->_slug
+													  . DS
+													  . 'copy_attendee_info.template.php',
+						'begin_template_file'      => null,
+						'input_template_file'      => null,
+						'subsection_template_file' => null,
+						'end_template_file'        => null,
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _auto_copy_attendee_info
+	 *
+	 * @access public
+	 * @return EE_Form_Section_HTML
+	 */
+	private function _auto_copy_attendee_info()
+	{
+		return new EE_Form_Section_HTML(
+			EEH_Template::locate_template(
+				SPCO_REG_STEPS_PATH . $this->_slug . DS . '_auto_copy_attendee_info.template.php',
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
+					array()
+				),
+				true,
+				true
+			)
+		);
+	}
+
+
+	/**
+	 * _copy_attendee_info_inputs
+	 *
+	 * @access public
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	private function _copy_attendee_info_inputs()
+	{
+		$copy_attendee_info_inputs = array();
+		$prev_ticket = null;
+		// grab the saved registrations from the transaction
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		foreach ($registrations as $registration) {
+			// for all  attendees other than the primary attendee
+			if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
+				// if this is a new ticket OR if this is the very first additional attendee after the primary attendee
+				if ($registration->ticket()->ID() !== $prev_ticket) {
+					$item_name = $registration->ticket()->name();
+					$item_name .= $registration->ticket()->description() !== ''
+						? ' - ' . $registration->ticket()->description()
+						: '';
+					$copy_attendee_info_inputs[ 'spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID(
+					) . ']' ] =
+						new EE_Form_Section_HTML(
+							'<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
+						);
+					$prev_ticket = $registration->ticket()->ID();
+				}
+
+				$copy_attendee_info_inputs[ 'spco_copy_attendee_chk[' . $registration->ID() . ']' ] =
+					new EE_Checkbox_Multi_Input(
+						array(
+							$registration->ID() => sprintf(
+								esc_html__('Attendee #%s', 'event_espresso'),
+								$registration->count()
+							),
+						),
+						array(
+							'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
+							'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
+							'display_html_label_text' => false,
+						)
+					);
+			}
+		}
+		return $copy_attendee_info_inputs;
+	}
+
+
+	/**
+	 * _additional_primary_registrant_inputs
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @return    EE_Form_Input_Base
+	 * @throws \EE_Error
+	 */
+	private function _additional_primary_registrant_inputs(EE_Registration $registration)
+	{
+		// generate hidden input
+		return new EE_Hidden_Input(
+			array(
+				'html_id' => 'primary_registrant',
+				'default' => $registration->reg_url_link(),
+			)
+		);
+	}
+
+
+	/**
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function reg_form_question(EE_Registration $registration, EE_Question $question)
+	{
+
+		// if this question was for an attendee detail, then check for that answer
+		$answer_value = EEM_Answer::instance()->get_attendee_property_answer_value(
+			$registration,
+			$question->system_ID()
+		);
+		$answer = $answer_value === null
+			? EEM_Answer::instance()->get_one(
+				array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
+			)
+			: null;
+		// if NOT returning to edit an existing registration
+		// OR if this question is for an attendee property
+		// OR we still don't have an EE_Answer object
+		if ($answer_value || ! $answer instanceof EE_Answer || ! $registration->reg_url_link()) {
+			// create an EE_Answer object for storing everything in
+			$answer = EE_Answer::new_instance(
+				array(
+					'QST_ID' => $question->ID(),
+					'REG_ID' => $registration->ID(),
+				)
+			);
+		}
+		// verify instance
+		if ($answer instanceof EE_Answer) {
+			if (! empty($answer_value)) {
+				$answer->set('ANS_value', $answer_value);
+			}
+			$answer->cache('Question', $question);
+			// remember system ID had a bug where sometimes it could be null
+			$answer_cache_id = $question->is_system_question()
+				? $question->system_ID() . '-' . $registration->reg_url_link()
+				: $question->ID() . '-' . $registration->reg_url_link();
+			$registration->cache('Answer', $answer, $answer_cache_id);
+		}
+		return $this->_generate_question_input($registration, $question, $answer);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @param                 mixed EE_Answer|NULL      $answer
+	 * @return EE_Form_Input_Base
+	 * @throws \EE_Error
+	 */
+	private function _generate_question_input(EE_Registration $registration, EE_Question $question, $answer)
+	{
+		$identifier = $question->is_system_question()
+			? $question->system_ID()
+			: $question->ID();
+		$this->_required_questions[ $identifier ] = $question->required() ? true : false;
+		add_filter(
+			'FHEE__EE_Question__generate_form_input__country_options',
+			array($this, 'use_cached_countries_for_form_input'),
+			10,
+			4
+		);
+		add_filter(
+			'FHEE__EE_Question__generate_form_input__state_options',
+			array($this, 'use_cached_states_for_form_input'),
+			10,
+			4
+		);
+		$input_constructor_args = array(
+			'html_name'        => 'ee_reg_qstn[' . $registration->ID() . '][' . $identifier . ']',
+			'html_id'          => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
+			'html_class'       => 'ee-reg-qstn ee-reg-qstn-' . $identifier,
+			'html_label_id'    => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
+			'html_label_class' => 'ee-reg-qstn',
+		);
+		$input_constructor_args['html_label_id'] .= '-lbl';
+		if ($answer instanceof EE_Answer && $answer->ID()) {
+			$input_constructor_args['html_name'] .= '[' . $answer->ID() . ']';
+			$input_constructor_args['html_id'] .= '-' . $answer->ID();
+			$input_constructor_args['html_label_id'] .= '-' . $answer->ID();
+		}
+		$form_input = $question->generate_form_input(
+			$registration,
+			$answer,
+			$input_constructor_args
+		);
+		remove_filter(
+			'FHEE__EE_Question__generate_form_input__country_options',
+			array($this, 'use_cached_countries_for_form_input')
+		);
+		remove_filter(
+			'FHEE__EE_Question__generate_form_input__state_options',
+			array($this, 'use_cached_states_for_form_input')
+		);
+		return $form_input;
+	}
+
+
+	/**
+	 * Gets the list of countries for the form input
+	 *
+	 * @param array|null       $countries_list
+	 * @param \EE_Question     $question
+	 * @param \EE_Registration $registration
+	 * @param \EE_Answer       $answer
+	 * @return array 2d keys are country IDs, values are their names
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function use_cached_countries_for_form_input(
+		$countries_list,
+		\EE_Question $question = null,
+		\EE_Registration $registration = null,
+		\EE_Answer $answer = null
+	) {
+		$country_options = array('' => '');
+		// get possibly cached list of countries
+		$countries = $this->checkout->action === 'process_reg_step'
+			? EEM_Country::instance()->get_all_countries()
+			: EEM_Country::instance()->get_all_active_countries();
+		if (! empty($countries)) {
+			foreach ($countries as $country) {
+				if ($country instanceof EE_Country) {
+					$country_options[ $country->ID() ] = $country->name();
+				}
+			}
+		}
+		if ($question instanceof EE_Question
+			&& $registration instanceof EE_Registration) {
+			$answer = EEM_Answer::instance()->get_one(
+				array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
+			);
+		} else {
+			$answer = EE_Answer::new_instance();
+		}
+		$country_options = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			$country_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+		return $country_options;
+	}
+
+
+	/**
+	 * Gets the list of states for the form input
+	 *
+	 * @param array|null       $states_list
+	 * @param \EE_Question     $question
+	 * @param \EE_Registration $registration
+	 * @param \EE_Answer       $answer
+	 * @return array 2d keys are state IDs, values are their names
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function use_cached_states_for_form_input(
+		$states_list,
+		\EE_Question $question = null,
+		\EE_Registration $registration = null,
+		\EE_Answer $answer = null
+	) {
+		$state_options = array('' => array('' => ''));
+		$states = $this->checkout->action === 'process_reg_step'
+			? EEM_State::instance()->get_all_states()
+			: EEM_State::instance()->get_all_active_states();
+		if (! empty($states)) {
+			foreach ($states as $state) {
+				if ($state instanceof EE_State) {
+					$state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
+				}
+			}
+		}
+		$state_options = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			$state_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+		return $state_options;
+	}
+
+
+
+
+
+
+	/********************************************************************************************************/
+	/****************************************  PROCESS REG STEP  ****************************************/
+	/********************************************************************************************************/
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function process_reg_step()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// grab validated data from form
+		$valid_data = $this->checkout->current_step->valid_data();
+		// EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
+		// EEH_Debug_Tools::printr( $valid_data, '$valid_data', __FILE__, __LINE__ );
+		// if we don't have any $valid_data then something went TERRIBLY WRONG !!!
+		if (empty($valid_data)) {
+			EE_Error::add_error(
+				esc_html__('No valid question responses were received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
+			EE_Error::add_error(
+				esc_html__(
+					'A valid transaction could not be initiated for processing your registrations.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// get cached registrations
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		// verify we got the goods
+		if (empty($registrations)) {
+			// combine the old translated string with a new one, in order to not break translations
+			$error_message = esc_html__(
+				'Your form data could not be applied to any valid registrations.',
+				'event_espresso'
+			)
+							 . sprintf(
+								 esc_html__(
+									 '%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.',
+									 'event_espresso'
+								 ),
+								 '<a href="' . get_post_type_archive_link('espresso_events') . '" >',
+								 '</a>',
+								 '<br />'
+							 );
+			EE_Error::add_error(
+				$error_message,
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// extract attendee info from form data and save to model objects
+		$registrations_processed = $this->_process_registrations($registrations, $valid_data);
+		// if first pass thru SPCO,
+		// then let's check processed registrations against the total number of tickets in the cart
+		if ($registrations_processed === false) {
+			// but return immediately if the previous step exited early due to errors
+			return false;
+		} elseif (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
+			// generate a correctly translated string for all possible singular/plural combinations
+			if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
+				$error_msg = sprintf(
+					esc_html__(
+						'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
+						'event_espresso'
+					),
+					$this->checkout->total_ticket_count,
+					$registrations_processed
+				);
+			} elseif ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
+				$error_msg = sprintf(
+					esc_html__(
+						'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
+						'event_espresso'
+					),
+					$this->checkout->total_ticket_count,
+					$registrations_processed
+				);
+			} else {
+				$error_msg = sprintf(
+					esc_html__(
+						'There was a total of %1$d tickets in the Event Queue, but %2$ds registrations were processed',
+						'event_espresso'
+					),
+					$this->checkout->total_ticket_count,
+					$registrations_processed
+				);
+			}
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// mark this reg step as completed
+		$this->set_completed();
+		$this->_set_success_message(
+			esc_html__('The Attendee Information Step has been successfully completed.', 'event_espresso')
+		);
+		// do action in case a plugin wants to do something with the data submitted in step 1.
+		// passes EE_Single_Page_Checkout, and it's posted data
+		do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
+		return true;
+	}
+
+
+	/**
+	 *    _process_registrations
+	 *
+	 * @param EE_Registration[] $registrations
+	 * @param array             $valid_data
+	 * @return bool|int
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _process_registrations($registrations = array(), $valid_data = array())
+	{
+		// load resources and set some defaults
+		EE_Registry::instance()->load_model('Attendee');
+		// holder for primary registrant attendee object
+		$this->checkout->primary_attendee_obj = null;
+		// array for tracking reg form data for the primary registrant
+		$primary_registrant = array(
+			'line_item_id' => null,
+		);
+		$copy_primary = false;
+		// reg form sections that do not contain inputs
+		$non_input_form_sections = array(
+			'primary_registrant',
+			'additional_attendee_reg_info',
+			'spco_copy_attendee_chk',
+		);
+		// attendee counter
+		$att_nmbr = 0;
+		// grab the saved registrations from the transaction
+		foreach ($registrations as $registration) {
+			// verify EE_Registration object
+			if (! $registration instanceof EE_Registration) {
+				EE_Error::add_error(
+					esc_html__(
+						'An invalid Registration object was discovered when attempting to process your registration information.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			/** @var string $reg_url_link */
+			$reg_url_link = $registration->reg_url_link();
+			// reg_url_link exists ?
+			if (! empty($reg_url_link)) {
+				// should this registration be processed during this visit ?
+				if ($this->checkout->visit_allows_processing_of_this_registration($registration)) {
+					// if NOT revisiting, then let's save the registration now,
+					// so that we have a REG_ID to use when generating other objects
+					if (! $this->checkout->revisit) {
+						$registration->save();
+					}
+					/**
+					 * This allows plugins to trigger a fail on processing of a
+					 * registration for any conditions they may have for it to pass.
+					 *
+					 * @var bool   if true is returned by the plugin then the
+					 *            registration processing is halted.
+					 */
+					if (apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
+						false,
+						$att_nmbr,
+						$registration,
+						$registrations,
+						$valid_data,
+						$this
+					)) {
+						return false;
+					}
+
+					// Houston, we have a registration!
+					$att_nmbr++;
+					$this->_attendee_data[ $reg_url_link ] = array();
+					// grab any existing related answer objects
+					$this->_registration_answers = $registration->answers();
+					// unset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] );
+					if (isset($valid_data[ $reg_url_link ])) {
+						// do we need to copy basic info from primary attendee ?
+						$copy_primary = isset($valid_data[ $reg_url_link ]['additional_attendee_reg_info'])
+										&& absint($valid_data[ $reg_url_link ]['additional_attendee_reg_info']) === 0
+							? true
+							: false;
+						// filter form input data for this registration
+						$valid_data[ $reg_url_link ] = (array) apply_filters(
+							'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
+							$valid_data[ $reg_url_link ]
+						);
+						if (isset($valid_data['primary_attendee'])) {
+							$primary_registrant['line_item_id'] = ! empty($valid_data['primary_attendee'])
+								? $valid_data['primary_attendee']
+								: false;
+							unset($valid_data['primary_attendee']);
+						}
+						// now loop through our array of valid post data && process attendee reg forms
+						foreach ($valid_data[ $reg_url_link ] as $form_section => $form_inputs) {
+							if (! in_array($form_section, $non_input_form_sections)) {
+								foreach ($form_inputs as $form_input => $input_value) {
+									// \EEH_Debug_Tools::printr( $input_value, $form_input, __FILE__, __LINE__ );
+									// check for critical inputs
+									if (! $this->_verify_critical_attendee_details_are_set_and_validate_email(
+										$form_input,
+										$input_value
+									)
+									) {
+										return false;
+									}
+									// store a bit of data about the primary attendee
+									if ($att_nmbr === 1
+										&& ! empty($input_value)
+										&& $reg_url_link === $primary_registrant['line_item_id']
+									) {
+										$primary_registrant[ $form_input ] = $input_value;
+									} elseif ($copy_primary
+											  && $input_value === null
+											  && isset($primary_registrant[ $form_input ])
+									) {
+										$input_value = $primary_registrant[ $form_input ];
+									}
+									// now attempt to save the input data
+									if (! $this->_save_registration_form_input(
+										$registration,
+										$form_input,
+										$input_value
+									)
+									) {
+										EE_Error::add_error(
+											sprintf(
+												esc_html__(
+													'Unable to save registration form data for the form input: "%1$s" with the submitted value: "%2$s"',
+													'event_espresso'
+												),
+												$form_input,
+												$input_value
+											),
+											__FILE__,
+											__FUNCTION__,
+											__LINE__
+										);
+										return false;
+									}
+								}
+							}
+						}  // end of foreach ( $valid_data[ $reg_url_link ] as $form_section => $form_inputs )
+					}
+					// EEH_Debug_Tools::printr( $this->_attendee_data, '$this->_attendee_data', __FILE__, __LINE__ );
+					// this registration does not require additional attendee information ?
+					if ($copy_primary
+						&& $att_nmbr > 1
+						&& $this->checkout->primary_attendee_obj instanceof EE_Attendee
+					) {
+						// just copy the primary registrant
+						$attendee = $this->checkout->primary_attendee_obj;
+					} else {
+						// ensure critical details are set for additional attendees
+						$this->_attendee_data[ $reg_url_link ] = $att_nmbr > 1
+							? $this->_copy_critical_attendee_details_from_primary_registrant(
+								$this->_attendee_data[ $reg_url_link ]
+							)
+							: $this->_attendee_data[ $reg_url_link ];
+						// execute create attendee command (which may return an existing attendee)
+						$attendee = EE_Registry::instance()->BUS->execute(
+							new CreateAttendeeCommand(
+								$this->_attendee_data[ $reg_url_link ],
+								$registration
+							)
+						);
+						// who's #1 ?
+						if ($att_nmbr === 1) {
+							$this->checkout->primary_attendee_obj = $attendee;
+						}
+					}
+					// EEH_Debug_Tools::printr( $attendee, '$attendee', __FILE__, __LINE__ );
+					// add relation to registration, set attendee ID, and cache attendee
+					$this->_associate_attendee_with_registration($registration, $attendee);
+					// \EEH_Debug_Tools::printr( $registration, '$registration', __FILE__, __LINE__ );
+					if (! $registration->attendee() instanceof EE_Attendee) {
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'Registration %s has an invalid or missing Attendee object.',
+									'event_espresso'
+								),
+								$reg_url_link
+							),
+							__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(
+						$registration,
+						false,
+						new Context(
+							'spco_reg_step_attendee_information_process_registrations',
+							esc_html__(
+								'Finished populating registration with details from the registration form after submitting the Attendee Information Reg Step.',
+								'event_espresso'
+							)
+						)
+					);
+					// 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();
+					// if we've gotten this far, then let's save what we have
+					$registration->save();
+					// add relation between TXN and registration
+					$this->_associate_registration_with_transaction($registration);
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'An invalid or missing line item ID was encountered while attempting to process the registration form.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				// remove malformed data
+				unset($valid_data[ $reg_url_link ]);
+				return false;
+			}
+		} // end of foreach ( $this->checkout->transaction->registrations()  as $registration )
+		return $att_nmbr;
+	}
+
+
+	/**
+	 *    _save_registration_form_input
+	 *
+	 * @param EE_Registration $registration
+	 * @param string          $form_input
+	 * @param string          $input_value
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _save_registration_form_input(
+		EE_Registration $registration,
+		$form_input = '',
+		$input_value = ''
+	) {
+		// \EEH_Debug_Tools::printr( __FUNCTION__, __CLASS__, __FILE__, __LINE__, 2 );
+		// \EEH_Debug_Tools::printr( $form_input, '$form_input', __FILE__, __LINE__ );
+		// \EEH_Debug_Tools::printr( $input_value, '$input_value', __FILE__, __LINE__ );
+		// allow for plugins to hook in and do their own processing of the form input.
+		// For plugins to bypass normal processing here, they just need to return a boolean value.
+		if (apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
+			false,
+			$registration,
+			$form_input,
+			$input_value,
+			$this
+		)) {
+			return true;
+		}
+		/*
          * $answer_cache_id is the key used to find the EE_Answer we want
          * @see https://events.codebasehq.com/projects/event-espresso/tickets/10477
          */
-        $answer_cache_id = $this->checkout->reg_url_link
-            ? $form_input . '-' . $registration->reg_url_link()
-            : $form_input;
-        $answer_is_obj = isset($this->_registration_answers[ $answer_cache_id ])
-                         && $this->_registration_answers[ $answer_cache_id ] instanceof EE_Answer
-            ? true
-            : false;
-        // rename form_inputs if they are EE_Attendee properties
-        switch ((string) $form_input) {
-            case 'state':
-            case 'STA_ID':
-                $attendee_property = true;
-                $form_input = 'STA_ID';
-                break;
-
-            case 'country':
-            case 'CNT_ISO':
-                $attendee_property = true;
-                $form_input = 'CNT_ISO';
-                break;
-
-            default:
-                $ATT_input = 'ATT_' . $form_input;
-                // EEH_Debug_Tools::printr( $ATT_input, '$ATT_input', __FILE__, __LINE__ );
-                $attendee_property = EEM_Attendee::instance()->has_field($ATT_input) ? true : false;
-                $form_input = $attendee_property ? 'ATT_' . $form_input : $form_input;
-        }
-        // EEH_Debug_Tools::printr( $answer_cache_id, '$answer_cache_id', __FILE__, __LINE__ );
-        // EEH_Debug_Tools::printr( $attendee_property, '$attendee_property', __FILE__, __LINE__ );
-        // EEH_Debug_Tools::printr( $answer_is_obj, '$answer_is_obj', __FILE__, __LINE__ );
-        // if this form input has a corresponding attendee property
-        if ($attendee_property) {
-            $this->_attendee_data[ $registration->reg_url_link() ][ $form_input ] = $input_value;
-            if ($answer_is_obj) {
-                // and delete the corresponding answer since we won't be storing this data in that object
-                $registration->_remove_relation_to($this->_registration_answers[ $answer_cache_id ], 'Answer');
-                $this->_registration_answers[ $answer_cache_id ]->delete_permanently();
-            }
-            return true;
-        } elseif ($answer_is_obj) {
-            // save this data to the answer object
-            $this->_registration_answers[ $answer_cache_id ]->set_value($input_value);
-            $result = $this->_registration_answers[ $answer_cache_id ]->save();
-            return $result !== false ? true : false;
-        } else {
-            foreach ($this->_registration_answers as $answer) {
-                if ($answer instanceof EE_Answer && $answer->question_ID() === $answer_cache_id) {
-                    $answer->set_value($input_value);
-                    $result = $answer->save();
-                    return $result !== false ? true : false;
-                }
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     *    _verify_critical_attendee_details_are_set
-     *
-     * @param string $form_input
-     * @param string $input_value
-     * @return boolean
-     */
-    private function _verify_critical_attendee_details_are_set_and_validate_email(
-        $form_input = '',
-        $input_value = ''
-    ) {
-        if (empty($input_value)) {
-            // if the form input isn't marked as being required, then just return
-            if (! isset($this->_required_questions[ $form_input ]) || ! $this->_required_questions[ $form_input ]) {
-                return true;
-            }
-            switch ($form_input) {
-                case 'fname':
-                    EE_Error::add_error(
-                        esc_html__('First Name is a required value.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                    break;
-                case 'lname':
-                    EE_Error::add_error(
-                        esc_html__('Last Name is a required value.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                    break;
-                case 'email':
-                    EE_Error::add_error(
-                        esc_html__('Please enter a valid email address.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                    break;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     *    _associate_attendee_with_registration
-     *
-     * @param EE_Registration $registration
-     * @param EE_Attendee     $attendee
-     * @return void
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    private function _associate_attendee_with_registration(EE_Registration $registration, EE_Attendee $attendee)
-    {
-        // add relation to attendee
-        $registration->_add_relation_to($attendee, 'Attendee');
-        $registration->set_attendee_id($attendee->ID());
-        $registration->update_cache_after_object_save('Attendee', $attendee);
-    }
-
-
-    /**
-     *    _associate_registration_with_transaction
-     *
-     * @param EE_Registration $registration
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _associate_registration_with_transaction(EE_Registration $registration)
-    {
-        // add relation to registration
-        $this->checkout->transaction->_add_relation_to($registration, 'Registration');
-        $this->checkout->transaction->update_cache_after_object_save('Registration', $registration);
-    }
-
-
-    /**
-     *    _copy_critical_attendee_details_from_primary_registrant
-     *    ensures that all attendees at least have data for first name, last name, and email address
-     *
-     * @param array $attendee_data
-     * @return array
-     * @throws \EE_Error
-     */
-    private function _copy_critical_attendee_details_from_primary_registrant($attendee_data = array())
-    {
-        // bare minimum critical details include first name, last name, email address
-        $critical_attendee_details = array('ATT_fname', 'ATT_lname', 'ATT_email');
-        // add address info to critical details?
-        if (apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
-            false
-        )) {
-            $address_details = array(
-                'ATT_address',
-                'ATT_address2',
-                'ATT_city',
-                'STA_ID',
-                'CNT_ISO',
-                'ATT_zip',
-                'ATT_phone',
-            );
-            $critical_attendee_details = array_merge($critical_attendee_details, $address_details);
-        }
-        foreach ($critical_attendee_details as $critical_attendee_detail) {
-            if (! isset($attendee_data[ $critical_attendee_detail ])
-                || empty($attendee_data[ $critical_attendee_detail ])
-            ) {
-                $attendee_data[ $critical_attendee_detail ] = $this->checkout->primary_attendee_obj->get(
-                    $critical_attendee_detail
-                );
-            }
-        }
-        return $attendee_data;
-    }
-
-
-    /**
-     *    update_reg_step
-     *    this is the final step after a user  revisits the site to edit their attendee information
-     *    this gets called AFTER the process_reg_step() method above
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function update_reg_step()
-    {
-        // save everything
-        if ($this->process_reg_step()) {
-            $this->checkout->redirect = true;
-            $this->checkout->redirect_url = add_query_arg(
-                array(
-                    'e_reg_url_link' => $this->checkout->reg_url_link,
-                    'revisit'        => true,
-                ),
-                $this->checkout->thank_you_page_url
-            );
-            $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-            return true;
-        }
-        return false;
-    }
+		$answer_cache_id = $this->checkout->reg_url_link
+			? $form_input . '-' . $registration->reg_url_link()
+			: $form_input;
+		$answer_is_obj = isset($this->_registration_answers[ $answer_cache_id ])
+						 && $this->_registration_answers[ $answer_cache_id ] instanceof EE_Answer
+			? true
+			: false;
+		// rename form_inputs if they are EE_Attendee properties
+		switch ((string) $form_input) {
+			case 'state':
+			case 'STA_ID':
+				$attendee_property = true;
+				$form_input = 'STA_ID';
+				break;
+
+			case 'country':
+			case 'CNT_ISO':
+				$attendee_property = true;
+				$form_input = 'CNT_ISO';
+				break;
+
+			default:
+				$ATT_input = 'ATT_' . $form_input;
+				// EEH_Debug_Tools::printr( $ATT_input, '$ATT_input', __FILE__, __LINE__ );
+				$attendee_property = EEM_Attendee::instance()->has_field($ATT_input) ? true : false;
+				$form_input = $attendee_property ? 'ATT_' . $form_input : $form_input;
+		}
+		// EEH_Debug_Tools::printr( $answer_cache_id, '$answer_cache_id', __FILE__, __LINE__ );
+		// EEH_Debug_Tools::printr( $attendee_property, '$attendee_property', __FILE__, __LINE__ );
+		// EEH_Debug_Tools::printr( $answer_is_obj, '$answer_is_obj', __FILE__, __LINE__ );
+		// if this form input has a corresponding attendee property
+		if ($attendee_property) {
+			$this->_attendee_data[ $registration->reg_url_link() ][ $form_input ] = $input_value;
+			if ($answer_is_obj) {
+				// and delete the corresponding answer since we won't be storing this data in that object
+				$registration->_remove_relation_to($this->_registration_answers[ $answer_cache_id ], 'Answer');
+				$this->_registration_answers[ $answer_cache_id ]->delete_permanently();
+			}
+			return true;
+		} elseif ($answer_is_obj) {
+			// save this data to the answer object
+			$this->_registration_answers[ $answer_cache_id ]->set_value($input_value);
+			$result = $this->_registration_answers[ $answer_cache_id ]->save();
+			return $result !== false ? true : false;
+		} else {
+			foreach ($this->_registration_answers as $answer) {
+				if ($answer instanceof EE_Answer && $answer->question_ID() === $answer_cache_id) {
+					$answer->set_value($input_value);
+					$result = $answer->save();
+					return $result !== false ? true : false;
+				}
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 *    _verify_critical_attendee_details_are_set
+	 *
+	 * @param string $form_input
+	 * @param string $input_value
+	 * @return boolean
+	 */
+	private function _verify_critical_attendee_details_are_set_and_validate_email(
+		$form_input = '',
+		$input_value = ''
+	) {
+		if (empty($input_value)) {
+			// if the form input isn't marked as being required, then just return
+			if (! isset($this->_required_questions[ $form_input ]) || ! $this->_required_questions[ $form_input ]) {
+				return true;
+			}
+			switch ($form_input) {
+				case 'fname':
+					EE_Error::add_error(
+						esc_html__('First Name is a required value.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+					break;
+				case 'lname':
+					EE_Error::add_error(
+						esc_html__('Last Name is a required value.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+					break;
+				case 'email':
+					EE_Error::add_error(
+						esc_html__('Please enter a valid email address.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+					break;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 *    _associate_attendee_with_registration
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Attendee     $attendee
+	 * @return void
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	private function _associate_attendee_with_registration(EE_Registration $registration, EE_Attendee $attendee)
+	{
+		// add relation to attendee
+		$registration->_add_relation_to($attendee, 'Attendee');
+		$registration->set_attendee_id($attendee->ID());
+		$registration->update_cache_after_object_save('Attendee', $attendee);
+	}
+
+
+	/**
+	 *    _associate_registration_with_transaction
+	 *
+	 * @param EE_Registration $registration
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _associate_registration_with_transaction(EE_Registration $registration)
+	{
+		// add relation to registration
+		$this->checkout->transaction->_add_relation_to($registration, 'Registration');
+		$this->checkout->transaction->update_cache_after_object_save('Registration', $registration);
+	}
+
+
+	/**
+	 *    _copy_critical_attendee_details_from_primary_registrant
+	 *    ensures that all attendees at least have data for first name, last name, and email address
+	 *
+	 * @param array $attendee_data
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	private function _copy_critical_attendee_details_from_primary_registrant($attendee_data = array())
+	{
+		// bare minimum critical details include first name, last name, email address
+		$critical_attendee_details = array('ATT_fname', 'ATT_lname', 'ATT_email');
+		// add address info to critical details?
+		if (apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
+			false
+		)) {
+			$address_details = array(
+				'ATT_address',
+				'ATT_address2',
+				'ATT_city',
+				'STA_ID',
+				'CNT_ISO',
+				'ATT_zip',
+				'ATT_phone',
+			);
+			$critical_attendee_details = array_merge($critical_attendee_details, $address_details);
+		}
+		foreach ($critical_attendee_details as $critical_attendee_detail) {
+			if (! isset($attendee_data[ $critical_attendee_detail ])
+				|| empty($attendee_data[ $critical_attendee_detail ])
+			) {
+				$attendee_data[ $critical_attendee_detail ] = $this->checkout->primary_attendee_obj->get(
+					$critical_attendee_detail
+				);
+			}
+		}
+		return $attendee_data;
+	}
+
+
+	/**
+	 *    update_reg_step
+	 *    this is the final step after a user  revisits the site to edit their attendee information
+	 *    this gets called AFTER the process_reg_step() method above
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function update_reg_step()
+	{
+		// save everything
+		if ($this->process_reg_step()) {
+			$this->checkout->redirect = true;
+			$this->checkout->redirect_url = add_query_arg(
+				array(
+					'e_reg_url_link' => $this->checkout->reg_url_link,
+					'revisit'        => true,
+				),
+				$this->checkout->thank_you_page_url
+			);
+			$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+			return true;
+		}
+		return false;
+	}
 }

Spacing +81 added lines, -81 removed lines

@@ -46,7 +46,7 @@ 
     {
         $this->_slug = 'attendee_information';
         $this->_name = esc_html__('Attendee Information', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'attendee_info_main.template.php';
+        $this->_template = SPCO_REG_STEPS_PATH.$this->_slug.DS.'attendee_info_main.template.php';
         $this->checkout = $checkout;
         $this->_reset_success_message();
         $this->set_instructions(
@@ -143,16 +143,16 @@ 
                     && $this->checkout->visit_allows_processing_of_this_registration($registration)
                 ) {
                     $subsection = $this->_registrations_reg_form($registration);
-                    if (! $subsection instanceof EE_Form_Section_Proper) {
+                    if ( ! $subsection instanceof EE_Form_Section_Proper) {
                         continue;
                     }
-                    $subsections[ $registration->reg_url_link() ] = $subsection;
-                    if (! $this->checkout->admin_request) {
-                        $template_args['registrations'][ $registration->reg_url_link() ] = $registration;
-                        $template_args['ticket_count'][ $registration->ticket()->ID() ] = isset(
-                            $template_args['ticket_count'][ $registration->ticket()->ID() ]
+                    $subsections[$registration->reg_url_link()] = $subsection;
+                    if ( ! $this->checkout->admin_request) {
+                        $template_args['registrations'][$registration->reg_url_link()] = $registration;
+                        $template_args['ticket_count'][$registration->ticket()->ID()] = isset(
+                            $template_args['ticket_count'][$registration->ticket()->ID()]
                         )
-                            ? $template_args['ticket_count'][ $registration->ticket()->ID() ] + 1
+                            ? $template_args['ticket_count'][$registration->ticket()->ID()] + 1
                             : 1;
                         $ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
                             $this->checkout->cart->get_grand_total(),
@@ -162,7 +162,7 @@ 
                         $ticket_line_item = is_array($ticket_line_item)
                             ? reset($ticket_line_item)
                             : $ticket_line_item;
-                        $template_args['ticket_line_item'][ $registration->ticket()->ID() ] =
+                        $template_args['ticket_line_item'][$registration->ticket()->ID()] =
                             $Line_Item_Display->display_line_item($ticket_line_item);
                     }
                     if ($registration->is_primary_registrant()) {
@@ -178,10 +178,10 @@ 
                     ? $this->_copy_attendee_info_form()
                     : $this->_auto_copy_attendee_info();
                 // generate hidden input
-                if (isset($subsections[ $primary_registrant ])
-                    && $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
+                if (isset($subsections[$primary_registrant])
+                    && $subsections[$primary_registrant] instanceof EE_Form_Section_Proper
                 ) {
-                    $subsections[ $primary_registrant ]->add_subsections(
+                    $subsections[$primary_registrant]->add_subsections(
                         $copy_options,
                         'primary_registrant',
                         false
@@ -241,7 +241,7 @@ 
             if ($question_groups) {
                 // array of params to pass to parent constructor
                 $form_args = array(
-                    'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
+                    'html_id'         => 'ee-registration-'.$registration->reg_url_link(),
                     'html_class'      => 'ee-reg-form-attendee-dv',
                     'html_style'      => $this->checkout->admin_request
                         ? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
@@ -256,7 +256,7 @@ 
                 );
                 foreach ($question_groups as $question_group) {
                     if ($question_group instanceof EE_Question_Group) {
-                        $form_args['subsections'][ $question_group->identifier() ] = $this->_question_group_reg_form(
+                        $form_args['subsections'][$question_group->identifier()] = $this->_question_group_reg_form(
                             $registration,
                             $question_group
                         );
@@ -297,7 +297,7 @@ 
         // generate hidden input
         return new EE_Hidden_Input(
             array(
-                'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
+                'html_id' => 'additional-attendee-reg-info-'.$registration->reg_url_link(),
                 'default' => $additional_attendee_reg_info,
             )
         );
@@ -317,12 +317,12 @@ 
     {
         // array of params to pass to parent constructor
         $form_args = array(
-            'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-' . $registration->ID(),
+            'html_id'         => 'ee-reg-form-qstn-grp-'.$question_group->identifier().'-'.$registration->ID(),
             'html_class'      => $this->checkout->admin_request
                 ? 'form-table ee-reg-form-qstn-grp-dv'
                 : 'ee-reg-form-qstn-grp-dv',
-            'html_label_id'   => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-'
-                                 . $registration->ID() . '-lbl',
+            'html_label_id'   => 'ee-reg-form-qstn-grp-'.$question_group->identifier().'-'
+                                 . $registration->ID().'-lbl',
             'subsections'     => array(
                 'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group),
             ),
@@ -333,7 +333,7 @@ 
         // where params
         $query_params = array('QST_deleted' => 0);
         // don't load admin only questions on the frontend
-        if (! $this->checkout->admin_request) {
+        if ( ! $this->checkout->admin_request) {
             $query_params['QST_admin_only'] = array('!=', true);
         }
         $questions = $question_group->get_many_related(
@@ -367,7 +367,7 @@ 
                 $identifier = $question->is_system_question()
                     ? $question->system_ID()
                     : $question->ID();
-                $form_args['subsections'][ $identifier ] = $this->reg_form_question($registration, $question);
+                $form_args['subsections'][$identifier] = $this->reg_form_question($registration, $question);
             }
         }
         $form_args['subsections'] = apply_filters(
@@ -477,7 +477,7 @@ 
     {
         return new EE_Form_Section_HTML(
             EEH_Template::locate_template(
-                SPCO_REG_STEPS_PATH . $this->_slug . DS . '_auto_copy_attendee_info.template.php',
+                SPCO_REG_STEPS_PATH.$this->_slug.DS.'_auto_copy_attendee_info.template.php',
                 apply_filters(
                     'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
                     array()
@@ -509,17 +509,17 @@ 
                 if ($registration->ticket()->ID() !== $prev_ticket) {
                     $item_name = $registration->ticket()->name();
                     $item_name .= $registration->ticket()->description() !== ''
-                        ? ' - ' . $registration->ticket()->description()
+                        ? ' - '.$registration->ticket()->description()
                         : '';
-                    $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID(
-                    ) . ']' ] =
+                    $copy_attendee_info_inputs['spco_copy_attendee_chk[ticket-'.$registration->ticket()->ID(
+                    ).']'] =
                         new EE_Form_Section_HTML(
-                            '<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
+                            '<h6 class="spco-copy-attendee-event-hdr">'.$item_name.'</h6>'
                         );
                     $prev_ticket = $registration->ticket()->ID();
                 }
 
-                $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[' . $registration->ID() . ']' ] =
+                $copy_attendee_info_inputs['spco_copy_attendee_chk['.$registration->ID().']'] =
                     new EE_Checkbox_Multi_Input(
                         array(
                             $registration->ID() => sprintf(
@@ -528,7 +528,7 @@ 
                             ),
                         ),
                         array(
-                            'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
+                            'html_id'                 => 'spco-copy-attendee-chk-'.$registration->reg_url_link(),
                             'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
                             'display_html_label_text' => false,
                         )
@@ -596,14 +596,14 @@ 
         }
         // verify instance
         if ($answer instanceof EE_Answer) {
-            if (! empty($answer_value)) {
+            if ( ! empty($answer_value)) {
                 $answer->set('ANS_value', $answer_value);
             }
             $answer->cache('Question', $question);
             // remember system ID had a bug where sometimes it could be null
             $answer_cache_id = $question->is_system_question()
-                ? $question->system_ID() . '-' . $registration->reg_url_link()
-                : $question->ID() . '-' . $registration->reg_url_link();
+                ? $question->system_ID().'-'.$registration->reg_url_link()
+                : $question->ID().'-'.$registration->reg_url_link();
             $registration->cache('Answer', $answer, $answer_cache_id);
         }
         return $this->_generate_question_input($registration, $question, $answer);
@@ -622,7 +622,7 @@ 
         $identifier = $question->is_system_question()
             ? $question->system_ID()
             : $question->ID();
-        $this->_required_questions[ $identifier ] = $question->required() ? true : false;
+        $this->_required_questions[$identifier] = $question->required() ? true : false;
         add_filter(
             'FHEE__EE_Question__generate_form_input__country_options',
             array($this, 'use_cached_countries_for_form_input'),
@@ -636,17 +636,17 @@ 
             4
         );
         $input_constructor_args = array(
-            'html_name'        => 'ee_reg_qstn[' . $registration->ID() . '][' . $identifier . ']',
-            'html_id'          => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
-            'html_class'       => 'ee-reg-qstn ee-reg-qstn-' . $identifier,
-            'html_label_id'    => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
+            'html_name'        => 'ee_reg_qstn['.$registration->ID().']['.$identifier.']',
+            'html_id'          => 'ee_reg_qstn-'.$registration->ID().'-'.$identifier,
+            'html_class'       => 'ee-reg-qstn ee-reg-qstn-'.$identifier,
+            'html_label_id'    => 'ee_reg_qstn-'.$registration->ID().'-'.$identifier,
             'html_label_class' => 'ee-reg-qstn',
         );
         $input_constructor_args['html_label_id'] .= '-lbl';
         if ($answer instanceof EE_Answer && $answer->ID()) {
-            $input_constructor_args['html_name'] .= '[' . $answer->ID() . ']';
-            $input_constructor_args['html_id'] .= '-' . $answer->ID();
-            $input_constructor_args['html_label_id'] .= '-' . $answer->ID();
+            $input_constructor_args['html_name'] .= '['.$answer->ID().']';
+            $input_constructor_args['html_id'] .= '-'.$answer->ID();
+            $input_constructor_args['html_label_id'] .= '-'.$answer->ID();
         }
         $form_input = $question->generate_form_input(
             $registration,
@@ -689,10 +689,10 @@ 
         $countries = $this->checkout->action === 'process_reg_step'
             ? EEM_Country::instance()->get_all_countries()
             : EEM_Country::instance()->get_all_active_countries();
-        if (! empty($countries)) {
+        if ( ! empty($countries)) {
             foreach ($countries as $country) {
                 if ($country instanceof EE_Country) {
-                    $country_options[ $country->ID() ] = $country->name();
+                    $country_options[$country->ID()] = $country->name();
                 }
             }
         }
@@ -739,10 +739,10 @@ 
         $states = $this->checkout->action === 'process_reg_step'
             ? EEM_State::instance()->get_all_states()
             : EEM_State::instance()->get_all_active_states();
-        if (! empty($states)) {
+        if ( ! empty($states)) {
             foreach ($states as $state) {
                 if ($state instanceof EE_State) {
-                    $state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
+                    $state_options[$state->country()->name()][$state->ID()] = $state->name();
                 }
             }
         }
@@ -791,7 +791,7 @@ 
             );
             return false;
         }
-        if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
+        if ( ! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
             EE_Error::add_error(
                 esc_html__(
                     'A valid transaction could not be initiated for processing your registrations.',
@@ -817,7 +817,7 @@ 
                                      '%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.',
                                      'event_espresso'
                                  ),
-                                 '<a href="' . get_post_type_archive_link('espresso_events') . '" >',
+                                 '<a href="'.get_post_type_archive_link('espresso_events').'" >',
                                  '</a>',
                                  '<br />'
                              );
@@ -836,7 +836,7 @@ 
         if ($registrations_processed === false) {
             // but return immediately if the previous step exited early due to errors
             return false;
-        } elseif (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
+        } elseif ( ! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
             // generate a correctly translated string for all possible singular/plural combinations
             if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
                 $error_msg = sprintf(
@@ -917,7 +917,7 @@ 
         // grab the saved registrations from the transaction
         foreach ($registrations as $registration) {
             // verify EE_Registration object
-            if (! $registration instanceof EE_Registration) {
+            if ( ! $registration instanceof EE_Registration) {
                 EE_Error::add_error(
                     esc_html__(
                         'An invalid Registration object was discovered when attempting to process your registration information.',
@@ -932,12 +932,12 @@ 
             /** @var string $reg_url_link */
             $reg_url_link = $registration->reg_url_link();
             // reg_url_link exists ?
-            if (! empty($reg_url_link)) {
+            if ( ! empty($reg_url_link)) {
                 // should this registration be processed during this visit ?
                 if ($this->checkout->visit_allows_processing_of_this_registration($registration)) {
                     // if NOT revisiting, then let's save the registration now,
                     // so that we have a REG_ID to use when generating other objects
-                    if (! $this->checkout->revisit) {
+                    if ( ! $this->checkout->revisit) {
                         $registration->save();
                     }
                     /**
@@ -961,20 +961,20 @@ 
 
                     // Houston, we have a registration!
                     $att_nmbr++;
-                    $this->_attendee_data[ $reg_url_link ] = array();
+                    $this->_attendee_data[$reg_url_link] = array();
                     // grab any existing related answer objects
                     $this->_registration_answers = $registration->answers();
                     // unset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] );
-                    if (isset($valid_data[ $reg_url_link ])) {
+                    if (isset($valid_data[$reg_url_link])) {
                         // do we need to copy basic info from primary attendee ?
-                        $copy_primary = isset($valid_data[ $reg_url_link ]['additional_attendee_reg_info'])
-                                        && absint($valid_data[ $reg_url_link ]['additional_attendee_reg_info']) === 0
+                        $copy_primary = isset($valid_data[$reg_url_link]['additional_attendee_reg_info'])
+                                        && absint($valid_data[$reg_url_link]['additional_attendee_reg_info']) === 0
                             ? true
                             : false;
                         // filter form input data for this registration
-                        $valid_data[ $reg_url_link ] = (array) apply_filters(
+                        $valid_data[$reg_url_link] = (array) apply_filters(
                             'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-                            $valid_data[ $reg_url_link ]
+                            $valid_data[$reg_url_link]
                         );
                         if (isset($valid_data['primary_attendee'])) {
                             $primary_registrant['line_item_id'] = ! empty($valid_data['primary_attendee'])
@@ -983,12 +983,12 @@ 
                             unset($valid_data['primary_attendee']);
                         }
                         // now loop through our array of valid post data && process attendee reg forms
-                        foreach ($valid_data[ $reg_url_link ] as $form_section => $form_inputs) {
-                            if (! in_array($form_section, $non_input_form_sections)) {
+                        foreach ($valid_data[$reg_url_link] as $form_section => $form_inputs) {
+                            if ( ! in_array($form_section, $non_input_form_sections)) {
                                 foreach ($form_inputs as $form_input => $input_value) {
                                     // \EEH_Debug_Tools::printr( $input_value, $form_input, __FILE__, __LINE__ );
                                     // check for critical inputs
-                                    if (! $this->_verify_critical_attendee_details_are_set_and_validate_email(
+                                    if ( ! $this->_verify_critical_attendee_details_are_set_and_validate_email(
                                         $form_input,
                                         $input_value
                                     )
@@ -1000,15 +1000,15 @@ 
                                         && ! empty($input_value)
                                         && $reg_url_link === $primary_registrant['line_item_id']
                                     ) {
-                                        $primary_registrant[ $form_input ] = $input_value;
+                                        $primary_registrant[$form_input] = $input_value;
                                     } elseif ($copy_primary
                                               && $input_value === null
-                                              && isset($primary_registrant[ $form_input ])
+                                              && isset($primary_registrant[$form_input])
                                     ) {
-                                        $input_value = $primary_registrant[ $form_input ];
+                                        $input_value = $primary_registrant[$form_input];
                                     }
                                     // now attempt to save the input data
-                                    if (! $this->_save_registration_form_input(
+                                    if ( ! $this->_save_registration_form_input(
                                         $registration,
                                         $form_input,
                                         $input_value
@@ -1043,15 +1043,15 @@ 
                         $attendee = $this->checkout->primary_attendee_obj;
                     } else {
                         // ensure critical details are set for additional attendees
-                        $this->_attendee_data[ $reg_url_link ] = $att_nmbr > 1
+                        $this->_attendee_data[$reg_url_link] = $att_nmbr > 1
                             ? $this->_copy_critical_attendee_details_from_primary_registrant(
-                                $this->_attendee_data[ $reg_url_link ]
+                                $this->_attendee_data[$reg_url_link]
                             )
-                            : $this->_attendee_data[ $reg_url_link ];
+                            : $this->_attendee_data[$reg_url_link];
                         // execute create attendee command (which may return an existing attendee)
                         $attendee = EE_Registry::instance()->BUS->execute(
                             new CreateAttendeeCommand(
-                                $this->_attendee_data[ $reg_url_link ],
+                                $this->_attendee_data[$reg_url_link],
                                 $registration
                             )
                         );
@@ -1064,7 +1064,7 @@ 
                     // add relation to registration, set attendee ID, and cache attendee
                     $this->_associate_attendee_with_registration($registration, $attendee);
                     // \EEH_Debug_Tools::printr( $registration, '$registration', __FILE__, __LINE__ );
-                    if (! $registration->attendee() instanceof EE_Attendee) {
+                    if ( ! $registration->attendee() instanceof EE_Attendee) {
                         EE_Error::add_error(
                             sprintf(
                                 esc_html__(
@@ -1113,7 +1113,7 @@ 
                     __LINE__
                 );
                 // remove malformed data
-                unset($valid_data[ $reg_url_link ]);
+                unset($valid_data[$reg_url_link]);
                 return false;
             }
         } // end of foreach ( $this->checkout->transaction->registrations()  as $registration )
@@ -1158,10 +1158,10 @@ 
          * @see https://events.codebasehq.com/projects/event-espresso/tickets/10477
          */
         $answer_cache_id = $this->checkout->reg_url_link
-            ? $form_input . '-' . $registration->reg_url_link()
+            ? $form_input.'-'.$registration->reg_url_link()
             : $form_input;
-        $answer_is_obj = isset($this->_registration_answers[ $answer_cache_id ])
-                         && $this->_registration_answers[ $answer_cache_id ] instanceof EE_Answer
+        $answer_is_obj = isset($this->_registration_answers[$answer_cache_id])
+                         && $this->_registration_answers[$answer_cache_id] instanceof EE_Answer
             ? true
             : false;
         // rename form_inputs if they are EE_Attendee properties
@@ -1179,27 +1179,27 @@ 
                 break;
 
             default:
-                $ATT_input = 'ATT_' . $form_input;
+                $ATT_input = 'ATT_'.$form_input;
                 // EEH_Debug_Tools::printr( $ATT_input, '$ATT_input', __FILE__, __LINE__ );
                 $attendee_property = EEM_Attendee::instance()->has_field($ATT_input) ? true : false;
-                $form_input = $attendee_property ? 'ATT_' . $form_input : $form_input;
+                $form_input = $attendee_property ? 'ATT_'.$form_input : $form_input;
         }
         // EEH_Debug_Tools::printr( $answer_cache_id, '$answer_cache_id', __FILE__, __LINE__ );
         // EEH_Debug_Tools::printr( $attendee_property, '$attendee_property', __FILE__, __LINE__ );
         // EEH_Debug_Tools::printr( $answer_is_obj, '$answer_is_obj', __FILE__, __LINE__ );
         // if this form input has a corresponding attendee property
         if ($attendee_property) {
-            $this->_attendee_data[ $registration->reg_url_link() ][ $form_input ] = $input_value;
+            $this->_attendee_data[$registration->reg_url_link()][$form_input] = $input_value;
             if ($answer_is_obj) {
                 // and delete the corresponding answer since we won't be storing this data in that object
-                $registration->_remove_relation_to($this->_registration_answers[ $answer_cache_id ], 'Answer');
-                $this->_registration_answers[ $answer_cache_id ]->delete_permanently();
+                $registration->_remove_relation_to($this->_registration_answers[$answer_cache_id], 'Answer');
+                $this->_registration_answers[$answer_cache_id]->delete_permanently();
             }
             return true;
         } elseif ($answer_is_obj) {
             // save this data to the answer object
-            $this->_registration_answers[ $answer_cache_id ]->set_value($input_value);
-            $result = $this->_registration_answers[ $answer_cache_id ]->save();
+            $this->_registration_answers[$answer_cache_id]->set_value($input_value);
+            $result = $this->_registration_answers[$answer_cache_id]->save();
             return $result !== false ? true : false;
         } else {
             foreach ($this->_registration_answers as $answer) {
@@ -1227,7 +1227,7 @@ 
     ) {
         if (empty($input_value)) {
             // if the form input isn't marked as being required, then just return
-            if (! isset($this->_required_questions[ $form_input ]) || ! $this->_required_questions[ $form_input ]) {
+            if ( ! isset($this->_required_questions[$form_input]) || ! $this->_required_questions[$form_input]) {
                 return true;
             }
             switch ($form_input) {
@@ -1326,10 +1326,10 @@ 
             $critical_attendee_details = array_merge($critical_attendee_details, $address_details);
         }
         foreach ($critical_attendee_details as $critical_attendee_detail) {
-            if (! isset($attendee_data[ $critical_attendee_detail ])
-                || empty($attendee_data[ $critical_attendee_detail ])
+            if ( ! isset($attendee_data[$critical_attendee_detail])
+                || empty($attendee_data[$critical_attendee_detail])
             ) {
-                $attendee_data[ $critical_attendee_detail ] = $this->checkout->primary_attendee_obj->get(
+                $attendee_data[$critical_attendee_detail] = $this->checkout->primary_attendee_obj->get(
                     $critical_attendee_detail
                 );
             }

modules/single_page_checkout/reg_steps/finalize_registration/EE_SPCO_Reg_Step_Finalize_Registration.class.php

Indentation +232 added lines, -232 removed lines

@@ -12,236 +12,236 @@
 class EE_SPCO_Reg_Step_Finalize_Registration extends EE_SPCO_Reg_Step
 {
 
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param    EE_Checkout $checkout
-     */
-    public function __construct(EE_Checkout $checkout)
-    {
-        $this->_slug = 'finalize_registration';
-        $this->_name = __('Finalize Registration', 'event_espresso');
-        $this->_submit_button_text = $this->_name;
-        $this->_template = '';
-        $this->checkout = $checkout;
-    }
-
-
-    public function translate_js_strings()
-    {
-    }
-
-
-    public function enqueue_styles_and_scripts()
-    {
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function initialize_reg_step()
-    {
-        // there's actually no reg form to process if this is the final step
-        if ($this->is_current_step()) {
-            $this->checkout->step = $_REQUEST['step'] = $this->slug();
-            $this->checkout->action = $_REQUEST['action'] = 'process_reg_step';
-            $this->checkout->generate_reg_form = false;
-        }
-        return true;
-    }
-
-
-    /**
-     * @return string
-     * @throws \EE_Error
-     */
-    public function generate_reg_form()
-    {
-        // create empty form so that things don't break
-        $this->reg_form = new EE_Form_Section_Proper();
-        return '';
-    }
-
-
-    /**
-     * @return boolean
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
-    public function process_reg_step()
-    {
-        // ensure all data gets refreshed from the db
-        $this->checkout->refresh_all_entities(true);
-        // ensures that all details and statuses for transaction, registration, and payments are updated
-        $txn_update_params = $this->_finalize_transaction();
-        // maybe send messages
-        $this->_set_notification_triggers();
-        // send messages
-        /** @type EE_Registration_Processor $registration_processor */
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-        $registration_processor->trigger_registration_update_notifications(
-            $this->checkout->transaction->primary_registration(),
-            $txn_update_params
-        );
-        // set a hook point
-        do_action(
-            'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed',
-            $this->checkout,
-            $txn_update_params
-        );
-        // check if transaction has a primary registrant and that it has a related Attendee object
-        if (! $this->_validate_primary_registrant()) {
-            return false;
-        }
-        // you don't have to go home but you can't stay here !
-        $this->checkout->redirect = true;
-        $this->checkout->continue_reg = true;
-        $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-        if (! (
-            $this->checkout->payment_method instanceof EE_Payment_Method
-            && $this->checkout->payment_method->is_off_site()
-        )) {
-            // mark this reg step as completed
-            $this->set_completed();
-        }
-        $this->checkout->set_exit_spco();
-        return true;
-    }
-
-
-    /**
-     * _finalize_transaction
-     * ensures that all details and statuses for transaction, registration, and payments are updated
-     *
-     * @return array
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
-    protected function _finalize_transaction()
-    {
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        // set revisit flag in txn processor
-        $transaction_processor->set_revisit($this->checkout->revisit);
-        // at this point we'll consider a TXN to not have been abandoned
-        $this->checkout->transaction->toggle_abandoned_transaction_status();
-        if ($this->checkout->cart instanceof EE_Cart) {
-            // save TXN data to the cart
-            $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
-                $this->checkout->transaction->ID()
-            );
-        }
-        // maybe update status, but don't save transaction just yet
-        $this->checkout->transaction->update_status_based_on_total_paid(false);
-        // this will result in the base session properties getting saved to the TXN_Session_data field
-        $this->checkout->transaction->set_txn_session_data(
-            EE_Registry::instance()->SSN->get_session_data(null, true)
-        );
-        // update the TXN if payment conditions have changed, but do NOT trigger notifications,
-        // because we will do that in process_reg_step() after setting some more triggers
-        return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
-            $this->checkout->transaction,
-            $this->checkout->payment,
-            $this->checkout->reg_cache_where_params,
-            false
-        );
-    }
-
-
-    /**
-     * If request is not a revisit, and an Off-Site gateway using IPNs has NOT been selected...
-     * OR
-     * if it IS a revisit and the TXN and/or one or more REG statuses have changed...
-     * then trigger notifications
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _set_notification_triggers()
-    {
-
-        if ($this->checkout->payment_method instanceof EE_Payment_Method) {
-            // let's start with the assumption that we need to trigger notifications
-            // then toggle this to false for conditions where we know we don't need to
-            $deliver_notifications = true;
-            if (// if SPCO revisit
-                filter_var($this->checkout->revisit, FILTER_VALIDATE_BOOLEAN)
-                // and TXN or REG statuses have NOT changed due to a payment
-                && ! (
-                    $this->checkout->transaction->txn_status_updated()
-                    || $this->checkout->any_reg_status_updated()
-                )
-            ) {
-                $deliver_notifications = false;
-            }
-            if ($this->checkout->payment_method->is_off_site()) {
-                /** @var EE_Gateway $gateway */
-                $gateway = $this->checkout->payment_method->type_obj()->get_gateway();
-                // and the gateway uses a separate request to process the IPN
-                if ($gateway instanceof EE_Offsite_Gateway
-                    && $gateway->handle_IPN_in_this_request(\EE_Registry::instance()->REQ->params(), true)
-                ) {
-                    // IPN request will handle triggering notifications
-                    $deliver_notifications = false;
-                    // no really... don't send any notices in this request
-                    remove_all_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications');
-                    add_filter(
-                        'FHEE__EED_Messages___maybe_registration__deliver_notifications',
-                        '__return_false',
-                        15
-                    );
-                }
-            }
-            if ($deliver_notifications) {
-                // send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
-            }
-        }
-    }
-
-
-    /**
-     * check if transaction has a primary registrant and that it has a related Attendee object
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    protected function _validate_primary_registrant()
-    {
-        if (! $this->checkout->transaction_has_primary_registrant()) {
-            EE_Error::add_error(
-                __('A valid Primary Registration for this Transaction could not be found.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->checkout->redirect = false;
-            $this->checkout->continue_reg = false;
-            return false;
-        }
-        // setup URL for redirect
-        $this->checkout->redirect_url = add_query_arg(
-            array('e_reg_url_link' => $this->checkout->transaction->primary_registration()->reg_url_link()),
-            $this->checkout->thank_you_page_url
-        );
-        return true;
-    }
-
-
-    /**
-     * @return void
-     */
-    public function update_reg_step()
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FILE__,
-            __(
-                'Can not call update_reg_step() on the Finalize Registration reg step.',
-                'event_espresso'
-            ),
-            '4.6.0'
-        );
-    }
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param    EE_Checkout $checkout
+	 */
+	public function __construct(EE_Checkout $checkout)
+	{
+		$this->_slug = 'finalize_registration';
+		$this->_name = __('Finalize Registration', 'event_espresso');
+		$this->_submit_button_text = $this->_name;
+		$this->_template = '';
+		$this->checkout = $checkout;
+	}
+
+
+	public function translate_js_strings()
+	{
+	}
+
+
+	public function enqueue_styles_and_scripts()
+	{
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function initialize_reg_step()
+	{
+		// there's actually no reg form to process if this is the final step
+		if ($this->is_current_step()) {
+			$this->checkout->step = $_REQUEST['step'] = $this->slug();
+			$this->checkout->action = $_REQUEST['action'] = 'process_reg_step';
+			$this->checkout->generate_reg_form = false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function generate_reg_form()
+	{
+		// create empty form so that things don't break
+		$this->reg_form = new EE_Form_Section_Proper();
+		return '';
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
+	public function process_reg_step()
+	{
+		// ensure all data gets refreshed from the db
+		$this->checkout->refresh_all_entities(true);
+		// ensures that all details and statuses for transaction, registration, and payments are updated
+		$txn_update_params = $this->_finalize_transaction();
+		// maybe send messages
+		$this->_set_notification_triggers();
+		// send messages
+		/** @type EE_Registration_Processor $registration_processor */
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+		$registration_processor->trigger_registration_update_notifications(
+			$this->checkout->transaction->primary_registration(),
+			$txn_update_params
+		);
+		// set a hook point
+		do_action(
+			'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed',
+			$this->checkout,
+			$txn_update_params
+		);
+		// check if transaction has a primary registrant and that it has a related Attendee object
+		if (! $this->_validate_primary_registrant()) {
+			return false;
+		}
+		// you don't have to go home but you can't stay here !
+		$this->checkout->redirect = true;
+		$this->checkout->continue_reg = true;
+		$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+		if (! (
+			$this->checkout->payment_method instanceof EE_Payment_Method
+			&& $this->checkout->payment_method->is_off_site()
+		)) {
+			// mark this reg step as completed
+			$this->set_completed();
+		}
+		$this->checkout->set_exit_spco();
+		return true;
+	}
+
+
+	/**
+	 * _finalize_transaction
+	 * ensures that all details and statuses for transaction, registration, and payments are updated
+	 *
+	 * @return array
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
+	protected function _finalize_transaction()
+	{
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		// set revisit flag in txn processor
+		$transaction_processor->set_revisit($this->checkout->revisit);
+		// at this point we'll consider a TXN to not have been abandoned
+		$this->checkout->transaction->toggle_abandoned_transaction_status();
+		if ($this->checkout->cart instanceof EE_Cart) {
+			// save TXN data to the cart
+			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
+				$this->checkout->transaction->ID()
+			);
+		}
+		// maybe update status, but don't save transaction just yet
+		$this->checkout->transaction->update_status_based_on_total_paid(false);
+		// this will result in the base session properties getting saved to the TXN_Session_data field
+		$this->checkout->transaction->set_txn_session_data(
+			EE_Registry::instance()->SSN->get_session_data(null, true)
+		);
+		// update the TXN if payment conditions have changed, but do NOT trigger notifications,
+		// because we will do that in process_reg_step() after setting some more triggers
+		return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
+			$this->checkout->transaction,
+			$this->checkout->payment,
+			$this->checkout->reg_cache_where_params,
+			false
+		);
+	}
+
+
+	/**
+	 * If request is not a revisit, and an Off-Site gateway using IPNs has NOT been selected...
+	 * OR
+	 * if it IS a revisit and the TXN and/or one or more REG statuses have changed...
+	 * then trigger notifications
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _set_notification_triggers()
+	{
+
+		if ($this->checkout->payment_method instanceof EE_Payment_Method) {
+			// let's start with the assumption that we need to trigger notifications
+			// then toggle this to false for conditions where we know we don't need to
+			$deliver_notifications = true;
+			if (// if SPCO revisit
+				filter_var($this->checkout->revisit, FILTER_VALIDATE_BOOLEAN)
+				// and TXN or REG statuses have NOT changed due to a payment
+				&& ! (
+					$this->checkout->transaction->txn_status_updated()
+					|| $this->checkout->any_reg_status_updated()
+				)
+			) {
+				$deliver_notifications = false;
+			}
+			if ($this->checkout->payment_method->is_off_site()) {
+				/** @var EE_Gateway $gateway */
+				$gateway = $this->checkout->payment_method->type_obj()->get_gateway();
+				// and the gateway uses a separate request to process the IPN
+				if ($gateway instanceof EE_Offsite_Gateway
+					&& $gateway->handle_IPN_in_this_request(\EE_Registry::instance()->REQ->params(), true)
+				) {
+					// IPN request will handle triggering notifications
+					$deliver_notifications = false;
+					// no really... don't send any notices in this request
+					remove_all_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications');
+					add_filter(
+						'FHEE__EED_Messages___maybe_registration__deliver_notifications',
+						'__return_false',
+						15
+					);
+				}
+			}
+			if ($deliver_notifications) {
+				// send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
+			}
+		}
+	}
+
+
+	/**
+	 * check if transaction has a primary registrant and that it has a related Attendee object
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	protected function _validate_primary_registrant()
+	{
+		if (! $this->checkout->transaction_has_primary_registrant()) {
+			EE_Error::add_error(
+				__('A valid Primary Registration for this Transaction could not be found.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->checkout->redirect = false;
+			$this->checkout->continue_reg = false;
+			return false;
+		}
+		// setup URL for redirect
+		$this->checkout->redirect_url = add_query_arg(
+			array('e_reg_url_link' => $this->checkout->transaction->primary_registration()->reg_url_link()),
+			$this->checkout->thank_you_page_url
+		);
+		return true;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function update_reg_step()
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FILE__,
+			__(
+				'Can not call update_reg_step() on the Finalize Registration reg step.',
+				'event_espresso'
+			),
+			'4.6.0'
+		);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -92,14 +92,14 @@ 
             $txn_update_params
         );
         // check if transaction has a primary registrant and that it has a related Attendee object
-        if (! $this->_validate_primary_registrant()) {
+        if ( ! $this->_validate_primary_registrant()) {
             return false;
         }
         // you don't have to go home but you can't stay here !
         $this->checkout->redirect = true;
         $this->checkout->continue_reg = true;
         $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-        if (! (
+        if ( ! (
             $this->checkout->payment_method instanceof EE_Payment_Method
             && $this->checkout->payment_method->is_off_site()
         )) {
@@ -210,7 +210,7 @@ 
      */
     protected function _validate_primary_registrant()
     {
-        if (! $this->checkout->transaction_has_primary_registrant()) {
+        if ( ! $this->checkout->transaction_has_primary_registrant()) {
             EE_Error::add_error(
                 __('A valid Primary Registration for this Transaction could not be found.', 'event_espresso'),
                 __FILE__,
@@ -236,7 +236,7 @@ 
     public function update_reg_step()
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FILE__,
+            __CLASS__.'::'.__FILE__,
             __(
                 'Can not call update_reg_step() on the Finalize Registration reg step.',
                 'event_espresso'

modules/gateways/Invoice/lib/Invoice.class.php

Indentation +365 added lines, -365 removed lines

@@ -9,398 +9,398 @@
 class Invoice
 {
 
-    /**
-     *
-     * @var EE_Registration
-     */
-    private $registration;
-    /**
-     *
-     * @var EE_Transaction
-     */
-    private $transaction;
-    /**
-     *
-     * @var EE_Payment_Method
-     */
-    private $invoice_payment_method;
-    private $EE;
+	/**
+	 *
+	 * @var EE_Registration
+	 */
+	private $registration;
+	/**
+	 *
+	 * @var EE_Transaction
+	 */
+	private $transaction;
+	/**
+	 *
+	 * @var EE_Payment_Method
+	 */
+	private $invoice_payment_method;
+	private $EE;
 
 
-    /**
-     * Invoice constructor.
-     *
-     * @deprecated 4.9.13
-     * @param int $url_link
-     */
-    public function __construct($url_link = 0)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__,
-            esc_html__(
-                'This class has been deprecated and replaced by the new Messages library.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        if ($this->registration = EE_Registry::instance()->load_model(
-            'Registration'
-        )->get_registration_for_reg_url_link($url_link)) {
-            $this->transaction = $this->registration->transaction();
-            // get_user_meta(EE_Registry::instance()->CFG->wp_user, 'payment_settings', TRUE);
-            $payment_settings = EE_Config::instance()->gateway->payment_settings;
-            $this->invoice_payment_method = EEM_Payment_Method::instance()->get_one_of_type('Invoice');
-        } else {
-            EE_Error::add_error(
-                __(
-                    'Your request appears to be missing some required data, and no information for your transaction could be retrieved.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
+	/**
+	 * Invoice constructor.
+	 *
+	 * @deprecated 4.9.13
+	 * @param int $url_link
+	 */
+	public function __construct($url_link = 0)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__,
+			esc_html__(
+				'This class has been deprecated and replaced by the new Messages library.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		if ($this->registration = EE_Registry::instance()->load_model(
+			'Registration'
+		)->get_registration_for_reg_url_link($url_link)) {
+			$this->transaction = $this->registration->transaction();
+			// get_user_meta(EE_Registry::instance()->CFG->wp_user, 'payment_settings', TRUE);
+			$payment_settings = EE_Config::instance()->gateway->payment_settings;
+			$this->invoice_payment_method = EEM_Payment_Method::instance()->get_one_of_type('Invoice');
+		} else {
+			EE_Error::add_error(
+				__(
+					'Your request appears to be missing some required data, and no information for your transaction could be retrieved.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
 
-    public function send_invoice($download = false)
-    {
-        $template_args = array();
-        $EE = EE_Registry::instance();
+	public function send_invoice($download = false)
+	{
+		$template_args = array();
+		$EE = EE_Registry::instance();
 
-        // allow the request to override the default theme defined in the invoice settings
-        $theme_requested = (isset($_REQUEST['theme']) && $_REQUEST['theme'] > 0 && $_REQUEST['theme'] < 8) ? absint(
-            $_REQUEST['theme']
-        ) : null;
-        $themes = array(
-            1 => "simple.css",
-            2 => "bauhaus.css",
-            3 => "ejs.css",
-            4 => "horizon.css",
-            5 => "lola.css",
-            6 => "tranquility.css",
-            7 => "union.css",
-        );
-        // Get the CSS file
-        if (isset($themes[ $theme_requested ])) {
-            $template_args['invoice_css'] = $themes[ $theme_requested ];
-        } else {
-            $template_args['invoice_css'] = $this->invoice_payment_method->get_extra_meta(
-                'legacy_invoice_css',
-                true,
-                'simple.css'
-            );
-        }
+		// allow the request to override the default theme defined in the invoice settings
+		$theme_requested = (isset($_REQUEST['theme']) && $_REQUEST['theme'] > 0 && $_REQUEST['theme'] < 8) ? absint(
+			$_REQUEST['theme']
+		) : null;
+		$themes = array(
+			1 => "simple.css",
+			2 => "bauhaus.css",
+			3 => "ejs.css",
+			4 => "horizon.css",
+			5 => "lola.css",
+			6 => "tranquility.css",
+			7 => "union.css",
+		);
+		// Get the CSS file
+		if (isset($themes[ $theme_requested ])) {
+			$template_args['invoice_css'] = $themes[ $theme_requested ];
+		} else {
+			$template_args['invoice_css'] = $this->invoice_payment_method->get_extra_meta(
+				'legacy_invoice_css',
+				true,
+				'simple.css'
+			);
+		}
 
-        if (is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice')) {
-            $template_args['base_url'] = EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/';
-        } else {
-            $template_args['base_url'] = EE_GATEWAYS . '/Invoice/lib/templates/';
-        }
-        $primary_attendee = $this->transaction->primary_registration()->attendee();
+		if (is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice')) {
+			$template_args['base_url'] = EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/';
+		} else {
+			$template_args['base_url'] = EE_GATEWAYS . '/Invoice/lib/templates/';
+		}
+		$primary_attendee = $this->transaction->primary_registration()->attendee();
 
-        $template_args['organization'] = $EE->CFG->organization->get_pretty('name');
-        $template_args['street'] = empty($EE->CFG->organization->address_2) ? $EE->CFG->organization->get_pretty(
-            'address_1'
-        ) : $EE->CFG->organization->get_pretty('address_1') . '<br>' . $EE->CFG->organization->get_pretty('address_2');
-        $template_args['city'] = $EE->CFG->organization->get_pretty('city');
-        $template_args['state'] = EE_Registry::instance()->load_model('State')->get_one_by_ID(
-            $EE->CFG->organization->STA_ID
-        );
-        $template_args['country'] = EE_Registry::instance()->load_model('Country')->get_one_by_ID(
-            $EE->CFG->organization->CNT_ISO
-        );
-        $template_args['zip'] = $EE->CFG->organization->get_pretty('zip');
-        $template_args['email'] = $EE->CFG->organization->get_pretty('email');
+		$template_args['organization'] = $EE->CFG->organization->get_pretty('name');
+		$template_args['street'] = empty($EE->CFG->organization->address_2) ? $EE->CFG->organization->get_pretty(
+			'address_1'
+		) : $EE->CFG->organization->get_pretty('address_1') . '<br>' . $EE->CFG->organization->get_pretty('address_2');
+		$template_args['city'] = $EE->CFG->organization->get_pretty('city');
+		$template_args['state'] = EE_Registry::instance()->load_model('State')->get_one_by_ID(
+			$EE->CFG->organization->STA_ID
+		);
+		$template_args['country'] = EE_Registry::instance()->load_model('Country')->get_one_by_ID(
+			$EE->CFG->organization->CNT_ISO
+		);
+		$template_args['zip'] = $EE->CFG->organization->get_pretty('zip');
+		$template_args['email'] = $EE->CFG->organization->get_pretty('email');
 
-        $template_args['registration_code'] = $this->registration->reg_code();
-        $template_args['registration_date'] = $this->registration->date();
-        $template_args['name'] = $primary_attendee->full_name();
-        $template_args['attendee_address'] = $primary_attendee->address();
-        $template_args['attendee_address2'] = $primary_attendee->address2();
-        $template_args['attendee_city'] = $primary_attendee->city();
-        $attendee_state = $primary_attendee->state_obj();
-        if ($attendee_state) {
-            $attendee_state_name = $attendee_state->name();
-        } else {
-            $attendee_state_name = '';
-        }
-        $template_args['attendee_state'] = $attendee_state_name;
-        $template_args['attendee_zip'] = $primary_attendee->zip();
+		$template_args['registration_code'] = $this->registration->reg_code();
+		$template_args['registration_date'] = $this->registration->date();
+		$template_args['name'] = $primary_attendee->full_name();
+		$template_args['attendee_address'] = $primary_attendee->address();
+		$template_args['attendee_address2'] = $primary_attendee->address2();
+		$template_args['attendee_city'] = $primary_attendee->city();
+		$attendee_state = $primary_attendee->state_obj();
+		if ($attendee_state) {
+			$attendee_state_name = $attendee_state->name();
+		} else {
+			$attendee_state_name = '';
+		}
+		$template_args['attendee_state'] = $attendee_state_name;
+		$template_args['attendee_zip'] = $primary_attendee->zip();
 
-        $template_args['ship_name'] = $template_args['name'];
-        $template_args['ship_address'] = $template_args['attendee_address'];
-        $template_args['ship_city'] = $template_args['attendee_city'];
-        $template_args['ship_state'] = $template_args['attendee_state'];
-        $template_args['ship_zip'] = $template_args['attendee_zip'];
+		$template_args['ship_name'] = $template_args['name'];
+		$template_args['ship_address'] = $template_args['attendee_address'];
+		$template_args['ship_city'] = $template_args['attendee_city'];
+		$template_args['ship_state'] = $template_args['attendee_state'];
+		$template_args['ship_zip'] = $template_args['attendee_zip'];
 
-        $template_args['total_cost'] = number_format($this->transaction->total(), 2, '.', '');
-        $template_args['transaction'] = $this->transaction;
-        $template_args['amount_pd'] = $this->transaction->paid();
-        $template_args['amount_owed'] = $this->transaction->total() - $this->transaction->paid();
-        $template_args['payments'] = $this->transaction->approved_payments();
-        $template_args['net_total'] = '';
-        $template_args['edit_reg_info_url'] = $this->registration->edit_attendee_information_url();
-        $template_args['retry_payment_url'] = $this->registration->payment_overview_url();
-        $template_args['show_line_item_description'] = $this->check_if_any_line_items_have_a_description(
-            $this->transaction->total_line_item()
-        );
-        if ($template_args['amount_pd'] != $template_args['total_cost']) {
-            // $template_args['net_total'] = $this->espressoInvoiceTotals( __('SubTotal', 'event_espresso'), $this->transaction->total());//$this->session_data['cart']['REG']['sub_total']);
-            $tax_items = $this->transaction->tax_items();
-            if (! empty($tax_items)) {
-                foreach ($tax_items as $tax) {
-                    $template_args['net_total'] .= $this->espressoInvoiceTotals($tax->name(), $tax->total());
-                }
-            }
+		$template_args['total_cost'] = number_format($this->transaction->total(), 2, '.', '');
+		$template_args['transaction'] = $this->transaction;
+		$template_args['amount_pd'] = $this->transaction->paid();
+		$template_args['amount_owed'] = $this->transaction->total() - $this->transaction->paid();
+		$template_args['payments'] = $this->transaction->approved_payments();
+		$template_args['net_total'] = '';
+		$template_args['edit_reg_info_url'] = $this->registration->edit_attendee_information_url();
+		$template_args['retry_payment_url'] = $this->registration->payment_overview_url();
+		$template_args['show_line_item_description'] = $this->check_if_any_line_items_have_a_description(
+			$this->transaction->total_line_item()
+		);
+		if ($template_args['amount_pd'] != $template_args['total_cost']) {
+			// $template_args['net_total'] = $this->espressoInvoiceTotals( __('SubTotal', 'event_espresso'), $this->transaction->total());//$this->session_data['cart']['REG']['sub_total']);
+			$tax_items = $this->transaction->tax_items();
+			if (! empty($tax_items)) {
+				foreach ($tax_items as $tax) {
+					$template_args['net_total'] .= $this->espressoInvoiceTotals($tax->name(), $tax->total());
+				}
+			}
 
-            $difference = $template_args['amount_pd'] - $template_args['total_cost'];
-            if ($difference < 0) {
-                $text = __('Discount', 'event_espresso');
-            } else {
-                $text = __('Extra', 'event_espresso');
-            }
-            $template_args['discount'] = $this->espressoInvoiceTotals($text, $difference);
-        }
+			$difference = $template_args['amount_pd'] - $template_args['total_cost'];
+			if ($difference < 0) {
+				$text = __('Discount', 'event_espresso');
+			} else {
+				$text = __('Extra', 'event_espresso');
+			}
+			$template_args['discount'] = $this->espressoInvoiceTotals($text, $difference);
+		}
 
-        $template_args['currency_symbol'] = $EE->CFG->currency->sign;
-        $template_args['template_payment_instructions'] = wpautop(
-            stripslashes_deep(
-                html_entity_decode($this->invoice_payment_method->get_extra_meta('pdf_instructions', true), ENT_QUOTES)
-            )
-        );
-        $template_args['shameless_plug'] = apply_filters('FHEE_Invoice__send_invoice__shameless_plug', true);
-        if (isset($_GET['receipt'])) {
-            // receipt-specific stuff
-            $events_for_txn = EEM_Event::instance()->get_all(
-                array(array('Registration.TXN_ID' => $this->transaction->ID()))
-            );
-            $ticket_line_items_per_event = array();
-            $registrations_per_line_item = array();
-            $venues_for_events = array();
-            foreach ($events_for_txn as $event_id => $event) {
-                $line_items_for_this_event = EEM_Line_Item::instance()->get_all(
-                    array(array('Ticket.Datetime.EVT_ID' => $event_id, 'TXN_ID' => $this->transaction->ID()))
-                );
-                $ticket_line_items_per_event[ $event_id ] = $line_items_for_this_event;
-                foreach ($line_items_for_this_event as $line_item_id => $line_item) {
-                    $ticket = $line_item->ticket();
-                    $registrations_for_this_ticket = EEM_Registration::instance()->get_all(
-                        array(array('TKT_ID' => $ticket->ID(), 'TXN_ID' => $this->transaction->ID()))
-                    );
-                    $registrations_per_line_item[ $line_item_id ] = $registrations_for_this_ticket;
-                }
-                $venues_for_events = array_merge($venues_for_events, $event->venues());
-            }
-            $tax_total_line_item = EEM_Line_Item::instance()->get_one(
-                array(array('TXN_ID' => $this->transaction->ID(), 'LIN_type' => EEM_Line_Item::type_tax_sub_total))
-            );
-            $questions_to_skip = array(
-                EEM_Attendee::system_question_fname,
-                EEM_Attendee::system_question_lname,
-                EEM_Attendee::system_question_email,
-            );
+		$template_args['currency_symbol'] = $EE->CFG->currency->sign;
+		$template_args['template_payment_instructions'] = wpautop(
+			stripslashes_deep(
+				html_entity_decode($this->invoice_payment_method->get_extra_meta('pdf_instructions', true), ENT_QUOTES)
+			)
+		);
+		$template_args['shameless_plug'] = apply_filters('FHEE_Invoice__send_invoice__shameless_plug', true);
+		if (isset($_GET['receipt'])) {
+			// receipt-specific stuff
+			$events_for_txn = EEM_Event::instance()->get_all(
+				array(array('Registration.TXN_ID' => $this->transaction->ID()))
+			);
+			$ticket_line_items_per_event = array();
+			$registrations_per_line_item = array();
+			$venues_for_events = array();
+			foreach ($events_for_txn as $event_id => $event) {
+				$line_items_for_this_event = EEM_Line_Item::instance()->get_all(
+					array(array('Ticket.Datetime.EVT_ID' => $event_id, 'TXN_ID' => $this->transaction->ID()))
+				);
+				$ticket_line_items_per_event[ $event_id ] = $line_items_for_this_event;
+				foreach ($line_items_for_this_event as $line_item_id => $line_item) {
+					$ticket = $line_item->ticket();
+					$registrations_for_this_ticket = EEM_Registration::instance()->get_all(
+						array(array('TKT_ID' => $ticket->ID(), 'TXN_ID' => $this->transaction->ID()))
+					);
+					$registrations_per_line_item[ $line_item_id ] = $registrations_for_this_ticket;
+				}
+				$venues_for_events = array_merge($venues_for_events, $event->venues());
+			}
+			$tax_total_line_item = EEM_Line_Item::instance()->get_one(
+				array(array('TXN_ID' => $this->transaction->ID(), 'LIN_type' => EEM_Line_Item::type_tax_sub_total))
+			);
+			$questions_to_skip = array(
+				EEM_Attendee::system_question_fname,
+				EEM_Attendee::system_question_lname,
+				EEM_Attendee::system_question_email,
+			);
 
 
-            $template_args['events_for_txn'] = $events_for_txn;
-            $template_args['ticket_line_items_per_event'] = $ticket_line_items_per_event;
-            $template_args['registrations_per_line_item'] = $registrations_per_line_item;
-            $template_args['venues_for_events'] = $venues_for_events;
-            $template_args['tax_total_line_item'] = $tax_total_line_item;
-            $template_args['questions_to_skip'] = $questions_to_skip;
-            // d($template_args);
-            $template_args['download_link'] = $this->registration->receipt_url('download');
-        } else {
-            // it's just an invoice we're accessing
-            $template_args['download_link'] = $this->registration->invoice_url('download');
-        }
+			$template_args['events_for_txn'] = $events_for_txn;
+			$template_args['ticket_line_items_per_event'] = $ticket_line_items_per_event;
+			$template_args['registrations_per_line_item'] = $registrations_per_line_item;
+			$template_args['venues_for_events'] = $venues_for_events;
+			$template_args['tax_total_line_item'] = $tax_total_line_item;
+			$template_args['questions_to_skip'] = $questions_to_skip;
+			// d($template_args);
+			$template_args['download_link'] = $this->registration->receipt_url('download');
+		} else {
+			// it's just an invoice we're accessing
+			$template_args['download_link'] = $this->registration->invoice_url('download');
+		}
 
-        // Get the HTML as an object
-        $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
-        $template_header = EEH_Template::locate_template(
-            $templates_relative_path . 'invoice_header.template.php',
-            $template_args,
-            true,
-            true
-        );
-        if (isset($_GET['receipt'])) {
-            $template_body = EEH_Template::locate_template(
-                $templates_relative_path . 'receipt_body.template.php',
-                $template_args,
-                true,
-                true
-            );
-        } else {
-            $template_body = EEH_Template::locate_template(
-                $templates_relative_path . 'invoice_body.template.php',
-                $template_args,
-                true,
-                true
-            );
-        }
+		// Get the HTML as an object
+		$templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
+		$template_header = EEH_Template::locate_template(
+			$templates_relative_path . 'invoice_header.template.php',
+			$template_args,
+			true,
+			true
+		);
+		if (isset($_GET['receipt'])) {
+			$template_body = EEH_Template::locate_template(
+				$templates_relative_path . 'receipt_body.template.php',
+				$template_args,
+				true,
+				true
+			);
+		} else {
+			$template_body = EEH_Template::locate_template(
+				$templates_relative_path . 'invoice_body.template.php',
+				$template_args,
+				true,
+				true
+			);
+		}
 
 
-        $template_footer = EEH_Template::locate_template(
-            $templates_relative_path . 'invoice_footer.template.php',
-            $template_args,
-            true,
-            true
-        );
+		$template_footer = EEH_Template::locate_template(
+			$templates_relative_path . 'invoice_footer.template.php',
+			$template_args,
+			true,
+			true
+		);
 
-        $copies = ! empty($_REQUEST['copies']) ? $_REQUEST['copies'] : 1;
+		$copies = ! empty($_REQUEST['copies']) ? $_REQUEST['copies'] : 1;
 
-        $content = $this->espresso_replace_invoice_shortcodes($template_header);
-        for ($x = 1; $x <= $copies; $x++) {
-            $content .= $this->espresso_replace_invoice_shortcodes($template_body);
-        }
-        $content .= $this->espresso_replace_invoice_shortcodes($template_footer);
+		$content = $this->espresso_replace_invoice_shortcodes($template_header);
+		for ($x = 1; $x <= $copies; $x++) {
+			$content .= $this->espresso_replace_invoice_shortcodes($template_body);
+		}
+		$content .= $this->espresso_replace_invoice_shortcodes($template_footer);
 
-        // Check if debugging or mobile is set
-        if (! empty($_REQUEST['html'])) {
-            echo $content;
-            exit(0);
-        }
-        $invoice_name = $template_args['organization'] . ' ' . __(
-            'Invoice #',
-            'event_espresso'
-        ) . $template_args['registration_code'] . __(' for ', 'event_espresso') . $template_args['name'];
-        $invoice_name = str_replace(' ', '_', $invoice_name);
-        // Create the PDF
-        if (array_key_exists('html', $_GET)) {
-            echo $content;
-        } else {
-            // only load dompdf if nobody else has yet...
-            if (! defined('DOMPDF_DIR')) {
-                define('DOMPDF_ENABLE_REMOTE', true);
-                define('DOMPDF_ENABLE_JAVASCRIPT', false);
-                define('DOMPDF_ENABLE_CSS_FLOAT', true);
-                require_once(EE_THIRD_PARTY . 'dompdf/dompdf_config.inc.php');
-            }
-            $dompdf = new DOMPDF();
-            $dompdf->load_html($content);
-            $dompdf->render();
-            $dompdf->stream($invoice_name . ".pdf", array('Attachment' => $download));
-        }
-        exit(0);
-    }
+		// Check if debugging or mobile is set
+		if (! empty($_REQUEST['html'])) {
+			echo $content;
+			exit(0);
+		}
+		$invoice_name = $template_args['organization'] . ' ' . __(
+			'Invoice #',
+			'event_espresso'
+		) . $template_args['registration_code'] . __(' for ', 'event_espresso') . $template_args['name'];
+		$invoice_name = str_replace(' ', '_', $invoice_name);
+		// Create the PDF
+		if (array_key_exists('html', $_GET)) {
+			echo $content;
+		} else {
+			// only load dompdf if nobody else has yet...
+			if (! defined('DOMPDF_DIR')) {
+				define('DOMPDF_ENABLE_REMOTE', true);
+				define('DOMPDF_ENABLE_JAVASCRIPT', false);
+				define('DOMPDF_ENABLE_CSS_FLOAT', true);
+				require_once(EE_THIRD_PARTY . 'dompdf/dompdf_config.inc.php');
+			}
+			$dompdf = new DOMPDF();
+			$dompdf->load_html($content);
+			$dompdf->render();
+			$dompdf->stream($invoice_name . ".pdf", array('Attachment' => $download));
+		}
+		exit(0);
+	}
 
-    /**
-     * Checks if this line item, or any of its children, actually has a description.
-     * If none do, then the template can decide to not show any description column
-     *
-     * @param EE_Line_Item $line_item
-     * @return boolean
-     */
-    public function check_if_any_line_items_have_a_description(EE_Line_Item $line_item)
-    {
-        if ($line_item->desc()) {
-            return true;
-        } else {
-            foreach ($line_item->children() as $child_line_item) {
-                if ($this->check_if_any_line_items_have_a_description($child_line_item)) {
-                    return true;
-                }
-            }
-            // well, if I and my children don't have descriptions, I guess not
-            return false;
-        }
-    }
+	/**
+	 * Checks if this line item, or any of its children, actually has a description.
+	 * If none do, then the template can decide to not show any description column
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return boolean
+	 */
+	public function check_if_any_line_items_have_a_description(EE_Line_Item $line_item)
+	{
+		if ($line_item->desc()) {
+			return true;
+		} else {
+			foreach ($line_item->children() as $child_line_item) {
+				if ($this->check_if_any_line_items_have_a_description($child_line_item)) {
+					return true;
+				}
+			}
+			// well, if I and my children don't have descriptions, I guess not
+			return false;
+		}
+	}
 
 // Perform the shortcode replacement
-    public function espresso_replace_invoice_shortcodes($content)
-    {
+	public function espresso_replace_invoice_shortcodes($content)
+	{
 
-        $EE = EE_Registry::instance();
-        // Create the logo
-        $invoice_logo_url = $this->invoice_payment_method->get_extra_meta(
-            'pdf_logo_image',
-            true,
-            $EE->CFG->organization->logo_url
-        );
-        if (! empty($invoice_logo_url)) {
-            $image_size = getimagesize($invoice_logo_url);
-            $invoice_logo_image = '<img class="logo screen" src="' . $invoice_logo_url . '" ' . $image_size[3] . ' alt="logo" /> ';
-        } else {
-            $invoice_logo_image = '';
-        }
-        $SearchValues = array(
-            "[organization]",
-            "[registration_code]",
-            "[transaction_id]",
-            "[name]",
-            "[base_url]",
-            "[download_link]",
-            "[invoice_logo_image]",
-            "[street]",
-            "[city]",
-            "[state]",
-            "[zip]",
-            "[email]",
-            "[vat]",
-            "[registration_date]",
-            "[instructions]",
-        );
-        $primary_attendee = $this->transaction->primary_registration()->attendee();
-        $org_state = EE_Registry::instance()->load_model('State')->get_one_by_ID($EE->CFG->organization->STA_ID);
-        if ($org_state) {
-            $org_state_name = $org_state->name();
-        } else {
-            $org_state_name = '';
-        }
-        $ReplaceValues = array(
-            $EE->CFG->organization->get_pretty('name'),
-            $this->registration->reg_code(),
-            $this->transaction->ID(),
-            $primary_attendee->full_name(),
-            (is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice')) ? EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/'
-                : EE_GATEWAYS_URL . 'Invoice/lib/templates/',
-            $this->registration->invoice_url(),
-            // home_url() . '/?download_invoice=true&amp;id=' . $this->registration->reg_url_link(),
-            $invoice_logo_image,
-            empty($EE->CFG->organization->address_2)
-                ? $EE->CFG->organization->get_pretty('address_1')
-                : $EE->CFG->organization->get_pretty('address_1') . '<br>' . $EE->CFG->organization->get_pretty(
-                    'address_2'
-                ),
-            $EE->CFG->organization->get_pretty('city'),
-            $org_state_name,
-            $EE->CFG->organization->get_pretty('zip'),
-            $EE->CFG->organization->get_pretty('email'),
-            $EE->CFG->organization->vat,
-            $this->registration->get_i18n_datetime('REG_date', get_option('date_format')),
-            $this->invoice_payment_method->get_extra_meta('pdf_instructions', true),
-        );
+		$EE = EE_Registry::instance();
+		// Create the logo
+		$invoice_logo_url = $this->invoice_payment_method->get_extra_meta(
+			'pdf_logo_image',
+			true,
+			$EE->CFG->organization->logo_url
+		);
+		if (! empty($invoice_logo_url)) {
+			$image_size = getimagesize($invoice_logo_url);
+			$invoice_logo_image = '<img class="logo screen" src="' . $invoice_logo_url . '" ' . $image_size[3] . ' alt="logo" /> ';
+		} else {
+			$invoice_logo_image = '';
+		}
+		$SearchValues = array(
+			"[organization]",
+			"[registration_code]",
+			"[transaction_id]",
+			"[name]",
+			"[base_url]",
+			"[download_link]",
+			"[invoice_logo_image]",
+			"[street]",
+			"[city]",
+			"[state]",
+			"[zip]",
+			"[email]",
+			"[vat]",
+			"[registration_date]",
+			"[instructions]",
+		);
+		$primary_attendee = $this->transaction->primary_registration()->attendee();
+		$org_state = EE_Registry::instance()->load_model('State')->get_one_by_ID($EE->CFG->organization->STA_ID);
+		if ($org_state) {
+			$org_state_name = $org_state->name();
+		} else {
+			$org_state_name = '';
+		}
+		$ReplaceValues = array(
+			$EE->CFG->organization->get_pretty('name'),
+			$this->registration->reg_code(),
+			$this->transaction->ID(),
+			$primary_attendee->full_name(),
+			(is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice')) ? EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/'
+				: EE_GATEWAYS_URL . 'Invoice/lib/templates/',
+			$this->registration->invoice_url(),
+			// home_url() . '/?download_invoice=true&amp;id=' . $this->registration->reg_url_link(),
+			$invoice_logo_image,
+			empty($EE->CFG->organization->address_2)
+				? $EE->CFG->organization->get_pretty('address_1')
+				: $EE->CFG->organization->get_pretty('address_1') . '<br>' . $EE->CFG->organization->get_pretty(
+					'address_2'
+				),
+			$EE->CFG->organization->get_pretty('city'),
+			$org_state_name,
+			$EE->CFG->organization->get_pretty('zip'),
+			$EE->CFG->organization->get_pretty('email'),
+			$EE->CFG->organization->vat,
+			$this->registration->get_i18n_datetime('REG_date', get_option('date_format')),
+			$this->invoice_payment_method->get_extra_meta('pdf_instructions', true),
+		);
 
-        return str_replace($SearchValues, $ReplaceValues, $content);
-    }
+		return str_replace($SearchValues, $ReplaceValues, $content);
+	}
 
-    public function espressoLoadData($items)
-    {
-        $lines = $items;
-        $data = array();
-        foreach ($lines as $line) {
-            $data[] = explode(';', chop($line));
-        }
+	public function espressoLoadData($items)
+	{
+		$lines = $items;
+		$data = array();
+		foreach ($lines as $line) {
+			$data[] = explode(';', chop($line));
+		}
 
-        return $data;
-    }
+		return $data;
+	}
 
 
-    public function espressoInvoiceTotals($text, $total_cost)
-    {
+	public function espressoInvoiceTotals($text, $total_cost)
+	{
 
-        $html = '';
-        if ($total_cost < 0) {
-            $total_cost = (-1) * $total_cost;
-        }
-        $find = array(' ');
-        $replace = array('-');
-        $row_id = strtolower(str_replace($find, $replace, $text));
-        $html .= '<tr id="' . $row_id . '-tr"><td colspan="4">&nbsp;</td>';
-        $html .= '<td class="item_r">' . $text . '</td>';
-        $html .= '<td class="item_r">' . $total_cost . '</td>';
-        $html .= '</tr>';
-        return $html;
-    }
+		$html = '';
+		if ($total_cost < 0) {
+			$total_cost = (-1) * $total_cost;
+		}
+		$find = array(' ');
+		$replace = array('-');
+		$row_id = strtolower(str_replace($find, $replace, $text));
+		$html .= '<tr id="' . $row_id . '-tr"><td colspan="4">&nbsp;</td>';
+		$html .= '<td class="item_r">' . $text . '</td>';
+		$html .= '<td class="item_r">' . $total_cost . '</td>';
+		$html .= '</tr>';
+		return $html;
+	}
 }

Spacing +27 added lines, -27 removed lines

@@ -83,8 +83,8 @@ 
             7 => "union.css",
         );
         // Get the CSS file
-        if (isset($themes[ $theme_requested ])) {
-            $template_args['invoice_css'] = $themes[ $theme_requested ];
+        if (isset($themes[$theme_requested])) {
+            $template_args['invoice_css'] = $themes[$theme_requested];
         } else {
             $template_args['invoice_css'] = $this->invoice_payment_method->get_extra_meta(
                 'legacy_invoice_css',
@@ -93,17 +93,17 @@ 
             );
         }
 
-        if (is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice')) {
-            $template_args['base_url'] = EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/';
+        if (is_dir(EVENT_ESPRESSO_GATEWAY_DIR.'/invoice')) {
+            $template_args['base_url'] = EVENT_ESPRESSO_GATEWAY_URL.'Invoice/lib/templates/';
         } else {
-            $template_args['base_url'] = EE_GATEWAYS . '/Invoice/lib/templates/';
+            $template_args['base_url'] = EE_GATEWAYS.'/Invoice/lib/templates/';
         }
         $primary_attendee = $this->transaction->primary_registration()->attendee();
 
         $template_args['organization'] = $EE->CFG->organization->get_pretty('name');
         $template_args['street'] = empty($EE->CFG->organization->address_2) ? $EE->CFG->organization->get_pretty(
             'address_1'
-        ) : $EE->CFG->organization->get_pretty('address_1') . '<br>' . $EE->CFG->organization->get_pretty('address_2');
+        ) : $EE->CFG->organization->get_pretty('address_1').'<br>'.$EE->CFG->organization->get_pretty('address_2');
         $template_args['city'] = $EE->CFG->organization->get_pretty('city');
         $template_args['state'] = EE_Registry::instance()->load_model('State')->get_one_by_ID(
             $EE->CFG->organization->STA_ID
@@ -149,7 +149,7 @@ 
         if ($template_args['amount_pd'] != $template_args['total_cost']) {
             // $template_args['net_total'] = $this->espressoInvoiceTotals( __('SubTotal', 'event_espresso'), $this->transaction->total());//$this->session_data['cart']['REG']['sub_total']);
             $tax_items = $this->transaction->tax_items();
-            if (! empty($tax_items)) {
+            if ( ! empty($tax_items)) {
                 foreach ($tax_items as $tax) {
                     $template_args['net_total'] .= $this->espressoInvoiceTotals($tax->name(), $tax->total());
                 }
@@ -183,13 +183,13 @@ 
                 $line_items_for_this_event = EEM_Line_Item::instance()->get_all(
                     array(array('Ticket.Datetime.EVT_ID' => $event_id, 'TXN_ID' => $this->transaction->ID()))
                 );
-                $ticket_line_items_per_event[ $event_id ] = $line_items_for_this_event;
+                $ticket_line_items_per_event[$event_id] = $line_items_for_this_event;
                 foreach ($line_items_for_this_event as $line_item_id => $line_item) {
                     $ticket = $line_item->ticket();
                     $registrations_for_this_ticket = EEM_Registration::instance()->get_all(
                         array(array('TKT_ID' => $ticket->ID(), 'TXN_ID' => $this->transaction->ID()))
                     );
-                    $registrations_per_line_item[ $line_item_id ] = $registrations_for_this_ticket;
+                    $registrations_per_line_item[$line_item_id] = $registrations_for_this_ticket;
                 }
                 $venues_for_events = array_merge($venues_for_events, $event->venues());
             }
@@ -219,21 +219,21 @@ 
         // Get the HTML as an object
         $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
         $template_header = EEH_Template::locate_template(
-            $templates_relative_path . 'invoice_header.template.php',
+            $templates_relative_path.'invoice_header.template.php',
             $template_args,
             true,
             true
         );
         if (isset($_GET['receipt'])) {
             $template_body = EEH_Template::locate_template(
-                $templates_relative_path . 'receipt_body.template.php',
+                $templates_relative_path.'receipt_body.template.php',
                 $template_args,
                 true,
                 true
             );
         } else {
             $template_body = EEH_Template::locate_template(
-                $templates_relative_path . 'invoice_body.template.php',
+                $templates_relative_path.'invoice_body.template.php',
                 $template_args,
                 true,
                 true
@@ -242,7 +242,7 @@ 
 
 
         $template_footer = EEH_Template::locate_template(
-            $templates_relative_path . 'invoice_footer.template.php',
+            $templates_relative_path.'invoice_footer.template.php',
             $template_args,
             true,
             true
@@ -257,30 +257,30 @@ 
         $content .= $this->espresso_replace_invoice_shortcodes($template_footer);
 
         // Check if debugging or mobile is set
-        if (! empty($_REQUEST['html'])) {
+        if ( ! empty($_REQUEST['html'])) {
             echo $content;
             exit(0);
         }
-        $invoice_name = $template_args['organization'] . ' ' . __(
+        $invoice_name = $template_args['organization'].' '.__(
             'Invoice #',
             'event_espresso'
-        ) . $template_args['registration_code'] . __(' for ', 'event_espresso') . $template_args['name'];
+        ).$template_args['registration_code'].__(' for ', 'event_espresso').$template_args['name'];
         $invoice_name = str_replace(' ', '_', $invoice_name);
         // Create the PDF
         if (array_key_exists('html', $_GET)) {
             echo $content;
         } else {
             // only load dompdf if nobody else has yet...
-            if (! defined('DOMPDF_DIR')) {
+            if ( ! defined('DOMPDF_DIR')) {
                 define('DOMPDF_ENABLE_REMOTE', true);
                 define('DOMPDF_ENABLE_JAVASCRIPT', false);
                 define('DOMPDF_ENABLE_CSS_FLOAT', true);
-                require_once(EE_THIRD_PARTY . 'dompdf/dompdf_config.inc.php');
+                require_once(EE_THIRD_PARTY.'dompdf/dompdf_config.inc.php');
             }
             $dompdf = new DOMPDF();
             $dompdf->load_html($content);
             $dompdf->render();
-            $dompdf->stream($invoice_name . ".pdf", array('Attachment' => $download));
+            $dompdf->stream($invoice_name.".pdf", array('Attachment' => $download));
         }
         exit(0);
     }
@@ -318,9 +318,9 @@ 
             true,
             $EE->CFG->organization->logo_url
         );
-        if (! empty($invoice_logo_url)) {
+        if ( ! empty($invoice_logo_url)) {
             $image_size = getimagesize($invoice_logo_url);
-            $invoice_logo_image = '<img class="logo screen" src="' . $invoice_logo_url . '" ' . $image_size[3] . ' alt="logo" /> ';
+            $invoice_logo_image = '<img class="logo screen" src="'.$invoice_logo_url.'" '.$image_size[3].' alt="logo" /> ';
         } else {
             $invoice_logo_image = '';
         }
@@ -353,14 +353,14 @@ 
             $this->registration->reg_code(),
             $this->transaction->ID(),
             $primary_attendee->full_name(),
-            (is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice')) ? EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/'
-                : EE_GATEWAYS_URL . 'Invoice/lib/templates/',
+            (is_dir(EVENT_ESPRESSO_GATEWAY_DIR.'/invoice')) ? EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/'
+                : EE_GATEWAYS_URL.'Invoice/lib/templates/',
             $this->registration->invoice_url(),
             // home_url() . '/?download_invoice=true&amp;id=' . $this->registration->reg_url_link(),
             $invoice_logo_image,
             empty($EE->CFG->organization->address_2)
                 ? $EE->CFG->organization->get_pretty('address_1')
-                : $EE->CFG->organization->get_pretty('address_1') . '<br>' . $EE->CFG->organization->get_pretty(
+                : $EE->CFG->organization->get_pretty('address_1').'<br>'.$EE->CFG->organization->get_pretty(
                     'address_2'
                 ),
             $EE->CFG->organization->get_pretty('city'),
@@ -397,9 +397,9 @@ 
         $find = array(' ');
         $replace = array('-');
         $row_id = strtolower(str_replace($find, $replace, $text));
-        $html .= '<tr id="' . $row_id . '-tr"><td colspan="4">&nbsp;</td>';
-        $html .= '<td class="item_r">' . $text . '</td>';
-        $html .= '<td class="item_r">' . $total_cost . '</td>';
+        $html .= '<tr id="'.$row_id.'-tr"><td colspan="4">&nbsp;</td>';
+        $html .= '<td class="item_r">'.$text.'</td>';
+        $html .= '<td class="item_r">'.$total_cost.'</td>';
         $html .= '</tr>';
         return $html;
     }

admin_pages/registrations/EE_Attendee_Contact_List_Table.class.php

Indentation +370 added lines, -370 removed lines

@@ -12,374 +12,374 @@
  */
 class EE_Attendee_Contact_List_Table extends EE_Admin_List_Table
 {
-    /**
-     * Initial setup of data (called by parent).
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->_view !== 'trash'
-            ? $this->_admin_page->get_attendees($this->_per_page)
-            : $this->_admin_page->get_attendees($this->_per_page, false, true);
-        $this->_all_data_count = $this->_view !== 'trash'
-            ? $this->_admin_page->get_attendees($this->_per_page, true)
-            : $this->_admin_page->get_attendees($this->_per_page, true, true);
-    }
-
-
-    /**
-     * Initial setup of properties.
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('attendee', 'event_espresso'),
-            'plural'   => esc_html__('attendees', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-
-        $this->_columns = array(
-            'cb'                 => '<input type="checkbox" />', // Render a checkbox instead of text
-            'ATT_ID'             => esc_html__('ID', 'event_espresso'),
-            'ATT_fname'          => esc_html__('First Name', 'event_espresso'),
-            'ATT_lname'          => esc_html__('Last Name', 'event_espresso'),
-            'ATT_email'          => esc_html__('Email Address', 'event_espresso'),
-            'Registration_Count' => esc_html__('# Registrations', 'event_espresso'),
-            'ATT_phone'          => esc_html__('Phone', 'event_espresso'),
-            'ATT_address'        => esc_html__('Address', 'event_espresso'),
-            'ATT_city'           => esc_html__('City', 'event_espresso'),
-            'STA_ID'             => esc_html__('State/Province', 'event_espresso'),
-            'CNT_ISO'            => esc_html__('Country', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            'ATT_ID'             => array('ATT_ID' => false),
-            'ATT_lname'          => array('ATT_lname' => true), // true means its already sorted
-            'ATT_fname'          => array('ATT_fname' => false),
-            'ATT_email'          => array('ATT_email' => false),
-            'Registration_Count' => array('Registration_Count' => false),
-            'ATT_city'           => array('ATT_city' => false),
-            'STA_ID'             => array('STA_ID' => false),
-            'CNT_ISO'            => array('CNT_ISO' => false),
-        );
-
-        $this->_hidden_columns = array(
-            'ATT_phone',
-            'ATT_address',
-            'ATT_city',
-            'STA_ID',
-            'CNT_ISO',
-        );
-    }
-
-
-    /**
-     * Initial setup of filters
-     *
-     * @return array
-     */
-    protected function _get_table_filters()
-    {
-        return array();
-    }
-
-
-    /**
-     * Initial setup of counts for views
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_view_counts()
-    {
-        $this->_views['in_use']['count'] = $this->_admin_page->get_attendees($this->_per_page, true);
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_contacts',
-            'espresso_registrations_delete_registration'
-        )) {
-            $this->_views['trash']['count'] = $this->_admin_page->get_attendees($this->_per_page, true, true);
-        }
-    }
-
-
-    /**
-     * Get count of attendees.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_attendees_count()
-    {
-        return EEM_Attendee::instance()->count();
-    }
-
-
-    /**
-     * Checkbox column
-     *
-     * @param EE_Attendee $attendee Unable to typehint this method because overrides parent.
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_cb($attendee)
-    {
-        if (! $attendee instanceof EE_Attendee) {
-            return '';
-        }
-        return sprintf(
-            '<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
-            $attendee->ID()
-        );
-    }
-
-
-    /**
-     * ATT_ID column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_ATT_ID(EE_Attendee $attendee)
-    {
-        $content = $attendee->ID();
-        $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
-        $content .= '  <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
-        return $content;
-    }
-
-
-    /**
-     * ATT_lname column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     */
-    public function column_ATT_lname(EE_Attendee $attendee)
-    {
-        // edit attendee link
-        $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'edit_attendee',
-                'post'   => $attendee->ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        $name_link = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_contacts',
-            'espresso_registrations_edit_attendee'
-        )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Contact', 'event_espresso') . '">'
-              . $attendee->lname() . '</a>'
-            : $attendee->lname();
-        return $name_link;
-    }
-
-
-    /**
-     * ATT_fname column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     */
-    public function column_ATT_fname(EE_Attendee $attendee)
-    {
-        // Build row actions
-        $actions = array();
-        // edit attendee link
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_contacts',
-            'espresso_registrations_edit_attendee'
-        )) {
-            $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action' => 'edit_attendee',
-                    'post'   => $attendee->ID(),
-                ),
-                REG_ADMIN_URL
-            );
-            $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
-                               . esc_attr__('Edit Contact', 'event_espresso') . '">'
-                               . esc_html__('Edit', 'event_espresso') . '</a>';
-        }
-
-        if ($this->_view === 'in_use') {
-            // trash attendee link
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_contacts',
-                'espresso_registrations_trash_attendees'
-            )) {
-                $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action' => 'trash_attendee',
-                        'ATT_ID' => $attendee->ID(),
-                    ),
-                    REG_ADMIN_URL
-                );
-                $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
-                                    . esc_attr__('Move Contact to Trash', 'event_espresso')
-                                    . '">' . esc_html__('Trash', 'event_espresso') . '</a>';
-            }
-        } else {
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_contacts',
-                'espresso_registrations_restore_attendees'
-            )) {
-                // restore attendee link
-                $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action' => 'restore_attendees',
-                        'ATT_ID' => $attendee->ID(),
-                    ),
-                    REG_ADMIN_URL
-                );
-                $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
-                                      . esc_attr__('Restore Contact', 'event_espresso') . '">'
-                                      . esc_html__('Restore', 'event_espresso') . '</a>';
-            }
-        }
-
-        $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'edit_attendee',
-                'post'   => $attendee->ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        $name_link = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_contacts',
-            'espresso_registrations_edit_attendee'
-        )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>'
-            : $attendee->fname();
-
-        // Return the name contents
-        return sprintf('%1$s %2$s', $name_link, $this->row_actions($actions));
-    }
-
-
-    /**
-     * Email Column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_ATT_email(EE_Attendee $attendee)
-    {
-        return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>';
-    }
-
-
-    /**
-     * Column displaying count of registrations attached to Attendee.
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_Registration_Count(EE_Attendee $attendee)
-    {
-        $link = EEH_URL::add_query_args_and_nonce(
-            array(
-                'action' => 'default',
-                'ATT_ID' => $attendee->ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>';
-    }
-
-
-    /**
-     * ATT_address column
-     *
-     * @param EE_Attendee $attendee
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function column_ATT_address(EE_Attendee $attendee)
-    {
-        return $attendee->address();
-    }
-
-
-    /**
-     * ATT_city column
-     *
-     * @param EE_Attendee $attendee
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function column_ATT_city(EE_Attendee $attendee)
-    {
-        return $attendee->city();
-    }
-
-
-    /**
-     * State Column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_STA_ID(EE_Attendee $attendee)
-    {
-        $states = EEM_State::instance()->get_all_states();
-        $state = isset($states[ $attendee->state_ID() ])
-            ? $states[ $attendee->state_ID() ]->get('STA_name')
-            : $attendee->state_ID();
-        return ! is_numeric($state) ? $state : '';
-    }
-
-
-    /**
-     * Country Column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_CNT_ISO(EE_Attendee $attendee)
-    {
-        $countries = EEM_Country::instance()->get_all_countries();
-        $country = isset($countries[ $attendee->country_ID() ])
-            ? $countries[ $attendee->country_ID() ]->get('CNT_name')
-            : $attendee->country_ID();
-        return ! is_numeric($country) ? $country : '';
-    }
-
-
-    /**
-     * Phone Number column
-     *
-     * @param EE_Attendee $attendee
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function column_ATT_phone(EE_Attendee $attendee)
-    {
-        return $attendee->phone();
-    }
+	/**
+	 * Initial setup of data (called by parent).
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->_view !== 'trash'
+			? $this->_admin_page->get_attendees($this->_per_page)
+			: $this->_admin_page->get_attendees($this->_per_page, false, true);
+		$this->_all_data_count = $this->_view !== 'trash'
+			? $this->_admin_page->get_attendees($this->_per_page, true)
+			: $this->_admin_page->get_attendees($this->_per_page, true, true);
+	}
+
+
+	/**
+	 * Initial setup of properties.
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('attendee', 'event_espresso'),
+			'plural'   => esc_html__('attendees', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+
+		$this->_columns = array(
+			'cb'                 => '<input type="checkbox" />', // Render a checkbox instead of text
+			'ATT_ID'             => esc_html__('ID', 'event_espresso'),
+			'ATT_fname'          => esc_html__('First Name', 'event_espresso'),
+			'ATT_lname'          => esc_html__('Last Name', 'event_espresso'),
+			'ATT_email'          => esc_html__('Email Address', 'event_espresso'),
+			'Registration_Count' => esc_html__('# Registrations', 'event_espresso'),
+			'ATT_phone'          => esc_html__('Phone', 'event_espresso'),
+			'ATT_address'        => esc_html__('Address', 'event_espresso'),
+			'ATT_city'           => esc_html__('City', 'event_espresso'),
+			'STA_ID'             => esc_html__('State/Province', 'event_espresso'),
+			'CNT_ISO'            => esc_html__('Country', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			'ATT_ID'             => array('ATT_ID' => false),
+			'ATT_lname'          => array('ATT_lname' => true), // true means its already sorted
+			'ATT_fname'          => array('ATT_fname' => false),
+			'ATT_email'          => array('ATT_email' => false),
+			'Registration_Count' => array('Registration_Count' => false),
+			'ATT_city'           => array('ATT_city' => false),
+			'STA_ID'             => array('STA_ID' => false),
+			'CNT_ISO'            => array('CNT_ISO' => false),
+		);
+
+		$this->_hidden_columns = array(
+			'ATT_phone',
+			'ATT_address',
+			'ATT_city',
+			'STA_ID',
+			'CNT_ISO',
+		);
+	}
+
+
+	/**
+	 * Initial setup of filters
+	 *
+	 * @return array
+	 */
+	protected function _get_table_filters()
+	{
+		return array();
+	}
+
+
+	/**
+	 * Initial setup of counts for views
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_view_counts()
+	{
+		$this->_views['in_use']['count'] = $this->_admin_page->get_attendees($this->_per_page, true);
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_contacts',
+			'espresso_registrations_delete_registration'
+		)) {
+			$this->_views['trash']['count'] = $this->_admin_page->get_attendees($this->_per_page, true, true);
+		}
+	}
+
+
+	/**
+	 * Get count of attendees.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_attendees_count()
+	{
+		return EEM_Attendee::instance()->count();
+	}
+
+
+	/**
+	 * Checkbox column
+	 *
+	 * @param EE_Attendee $attendee Unable to typehint this method because overrides parent.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_cb($attendee)
+	{
+		if (! $attendee instanceof EE_Attendee) {
+			return '';
+		}
+		return sprintf(
+			'<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
+			$attendee->ID()
+		);
+	}
+
+
+	/**
+	 * ATT_ID column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_ATT_ID(EE_Attendee $attendee)
+	{
+		$content = $attendee->ID();
+		$attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
+		$content .= '  <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
+		return $content;
+	}
+
+
+	/**
+	 * ATT_lname column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 */
+	public function column_ATT_lname(EE_Attendee $attendee)
+	{
+		// edit attendee link
+		$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'edit_attendee',
+				'post'   => $attendee->ID(),
+			),
+			REG_ADMIN_URL
+		);
+		$name_link = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_contacts',
+			'espresso_registrations_edit_attendee'
+		)
+			? '<a href="' . $edit_lnk_url . '" title="'
+			  . esc_attr__('Edit Contact', 'event_espresso') . '">'
+			  . $attendee->lname() . '</a>'
+			: $attendee->lname();
+		return $name_link;
+	}
+
+
+	/**
+	 * ATT_fname column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 */
+	public function column_ATT_fname(EE_Attendee $attendee)
+	{
+		// Build row actions
+		$actions = array();
+		// edit attendee link
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_contacts',
+			'espresso_registrations_edit_attendee'
+		)) {
+			$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action' => 'edit_attendee',
+					'post'   => $attendee->ID(),
+				),
+				REG_ADMIN_URL
+			);
+			$actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
+							   . esc_attr__('Edit Contact', 'event_espresso') . '">'
+							   . esc_html__('Edit', 'event_espresso') . '</a>';
+		}
+
+		if ($this->_view === 'in_use') {
+			// trash attendee link
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_contacts',
+				'espresso_registrations_trash_attendees'
+			)) {
+				$trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action' => 'trash_attendee',
+						'ATT_ID' => $attendee->ID(),
+					),
+					REG_ADMIN_URL
+				);
+				$actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
+									. esc_attr__('Move Contact to Trash', 'event_espresso')
+									. '">' . esc_html__('Trash', 'event_espresso') . '</a>';
+			}
+		} else {
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_contacts',
+				'espresso_registrations_restore_attendees'
+			)) {
+				// restore attendee link
+				$restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action' => 'restore_attendees',
+						'ATT_ID' => $attendee->ID(),
+					),
+					REG_ADMIN_URL
+				);
+				$actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
+									  . esc_attr__('Restore Contact', 'event_espresso') . '">'
+									  . esc_html__('Restore', 'event_espresso') . '</a>';
+			}
+		}
+
+		$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'edit_attendee',
+				'post'   => $attendee->ID(),
+			),
+			REG_ADMIN_URL
+		);
+		$name_link = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_contacts',
+			'espresso_registrations_edit_attendee'
+		)
+			? '<a href="' . $edit_lnk_url . '" title="'
+			  . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>'
+			: $attendee->fname();
+
+		// Return the name contents
+		return sprintf('%1$s %2$s', $name_link, $this->row_actions($actions));
+	}
+
+
+	/**
+	 * Email Column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_ATT_email(EE_Attendee $attendee)
+	{
+		return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>';
+	}
+
+
+	/**
+	 * Column displaying count of registrations attached to Attendee.
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_Registration_Count(EE_Attendee $attendee)
+	{
+		$link = EEH_URL::add_query_args_and_nonce(
+			array(
+				'action' => 'default',
+				'ATT_ID' => $attendee->ID(),
+			),
+			REG_ADMIN_URL
+		);
+		return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>';
+	}
+
+
+	/**
+	 * ATT_address column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function column_ATT_address(EE_Attendee $attendee)
+	{
+		return $attendee->address();
+	}
+
+
+	/**
+	 * ATT_city column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function column_ATT_city(EE_Attendee $attendee)
+	{
+		return $attendee->city();
+	}
+
+
+	/**
+	 * State Column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_STA_ID(EE_Attendee $attendee)
+	{
+		$states = EEM_State::instance()->get_all_states();
+		$state = isset($states[ $attendee->state_ID() ])
+			? $states[ $attendee->state_ID() ]->get('STA_name')
+			: $attendee->state_ID();
+		return ! is_numeric($state) ? $state : '';
+	}
+
+
+	/**
+	 * Country Column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_CNT_ISO(EE_Attendee $attendee)
+	{
+		$countries = EEM_Country::instance()->get_all_countries();
+		$country = isset($countries[ $attendee->country_ID() ])
+			? $countries[ $attendee->country_ID() ]->get('CNT_name')
+			: $attendee->country_ID();
+		return ! is_numeric($country) ? $country : '';
+	}
+
+
+	/**
+	 * Phone Number column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function column_ATT_phone(EE_Attendee $attendee)
+	{
+		return $attendee->phone();
+	}
 }

Spacing +21 added lines, -21 removed lines

@@ -127,7 +127,7 @@ 
      */
     public function column_cb($attendee)
     {
-        if (! $attendee instanceof EE_Attendee) {
+        if ( ! $attendee instanceof EE_Attendee) {
             return '';
         }
         return sprintf(
@@ -148,7 +148,7 @@ 
     {
         $content = $attendee->ID();
         $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
-        $content .= '  <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
+        $content .= '  <span class="show-on-mobile-view-only">'.$attendee_name.'</span>';
         return $content;
     }
 
@@ -177,9 +177,9 @@ 
             'ee_edit_contacts',
             'espresso_registrations_edit_attendee'
         )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Contact', 'event_espresso') . '">'
-              . $attendee->lname() . '</a>'
+            ? '<a href="'.$edit_lnk_url.'" title="'
+              . esc_attr__('Edit Contact', 'event_espresso').'">'
+              . $attendee->lname().'</a>'
             : $attendee->lname();
         return $name_link;
     }
@@ -211,9 +211,9 @@ 
                 ),
                 REG_ADMIN_URL
             );
-            $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
-                               . esc_attr__('Edit Contact', 'event_espresso') . '">'
-                               . esc_html__('Edit', 'event_espresso') . '</a>';
+            $actions['edit'] = '<a href="'.$edit_lnk_url.'" title="'
+                               . esc_attr__('Edit Contact', 'event_espresso').'">'
+                               . esc_html__('Edit', 'event_espresso').'</a>';
         }
 
         if ($this->_view === 'in_use') {
@@ -229,9 +229,9 @@ 
                     ),
                     REG_ADMIN_URL
                 );
-                $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
+                $actions['trash'] = '<a href="'.$trash_lnk_url.'" title="'
                                     . esc_attr__('Move Contact to Trash', 'event_espresso')
-                                    . '">' . esc_html__('Trash', 'event_espresso') . '</a>';
+                                    . '">'.esc_html__('Trash', 'event_espresso').'</a>';
             }
         } else {
             if (EE_Registry::instance()->CAP->current_user_can(
@@ -246,9 +246,9 @@ 
                     ),
                     REG_ADMIN_URL
                 );
-                $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
-                                      . esc_attr__('Restore Contact', 'event_espresso') . '">'
-                                      . esc_html__('Restore', 'event_espresso') . '</a>';
+                $actions['restore'] = '<a href="'.$restore_lnk_url.'" title="'
+                                      . esc_attr__('Restore Contact', 'event_espresso').'">'
+                                      . esc_html__('Restore', 'event_espresso').'</a>';
             }
         }
 
@@ -263,8 +263,8 @@ 
             'ee_edit_contacts',
             'espresso_registrations_edit_attendee'
         )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>'
+            ? '<a href="'.$edit_lnk_url.'" title="'
+              . esc_attr__('Edit Contact', 'event_espresso').'">'.$attendee->fname().'</a>'
             : $attendee->fname();
 
         // Return the name contents
@@ -281,7 +281,7 @@ 
      */
     public function column_ATT_email(EE_Attendee $attendee)
     {
-        return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>';
+        return '<a href="mailto:'.$attendee->email().'">'.$attendee->email().'</a>';
     }
 
 
@@ -301,7 +301,7 @@ 
             ),
             REG_ADMIN_URL
         );
-        return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>';
+        return '<a href="'.$link.'">'.$attendee->getCustomSelect('Registration_Count').'</a>';
     }
 
 
@@ -344,8 +344,8 @@ 
     public function column_STA_ID(EE_Attendee $attendee)
     {
         $states = EEM_State::instance()->get_all_states();
-        $state = isset($states[ $attendee->state_ID() ])
-            ? $states[ $attendee->state_ID() ]->get('STA_name')
+        $state = isset($states[$attendee->state_ID()])
+            ? $states[$attendee->state_ID()]->get('STA_name')
             : $attendee->state_ID();
         return ! is_numeric($state) ? $state : '';
     }
@@ -364,8 +364,8 @@ 
     public function column_CNT_ISO(EE_Attendee $attendee)
     {
         $countries = EEM_Country::instance()->get_all_countries();
-        $country = isset($countries[ $attendee->country_ID() ])
-            ? $countries[ $attendee->country_ID() ]->get('CNT_name')
+        $country = isset($countries[$attendee->country_ID()])
+            ? $countries[$attendee->country_ID()]->get('CNT_name')
             : $attendee->country_ID();
         return ! is_numeric($country) ? $country : '';
     }

admin_pages/registrations/help_tours/Event_Checkin_Help_Tour.class.php

Indentation +266 added lines, -266 removed lines

@@ -15,289 +15,289 @@
 class Event_Checkin_Help_Tour extends EE_Help_Tour
 {
 
-    protected function _set_tour_properties()
-    {
-        $this->_label = __('Event Check-in Tour', 'event_espresso');
-        if (isset($this->_req_data['event_id'])) {
-            $this->_slug = 'event-checkin-overview-joyride';
-        } else {
-            $this->_slug = 'all-event-checkin-overview-joyride';
-        }
-    }
+	protected function _set_tour_properties()
+	{
+		$this->_label = __('Event Check-in Tour', 'event_espresso');
+		if (isset($this->_req_data['event_id'])) {
+			$this->_slug = 'event-checkin-overview-joyride';
+		} else {
+			$this->_slug = 'all-event-checkin-overview-joyride';
+		}
+	}
 
 
-    protected function _set_tour_stops()
-    {
-        $this->_stops = array(
-            10  => array(
-                'content' => $this->_start(),
-            ),
-            20  => array(
-                'id'      => '_REG_count',
-                'content' => $this->_reg_count_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -20,
-                ),
-            ),
-            30  => array(
-                'id'      => 'ATT_name',
-                'content' => $this->_attendee_name_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -20,
-                ),
-            ),
-            40  => array(
-                'id'      => 'ATT_email',
-                'content' => $this->_attendee_email_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -20,
-                ),
-            ),
-            50  => array(
-                'id'      => '_REG_date',
-                'content' => $this->_reg_date_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -20,
-                ),
-            ),
-            60  => array(
-                'id'      => '_REG_code',
-                'content' => $this->_reg_code_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -20,
-                ),
-            ),
-            80  => array(
-                'id'      => '_REG_final_price',
-                'content' => $this->_reg_final_price_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -20,
-                ),
-            ),
-            90  => array(
-                'id'      => 'TXN_paid',
-                'content' => $this->_txn_paid_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentX' => 0,
-                    'tipAdjustmentY' => -50,
-                ),
-            ),
-            100 => array(
-                'id'      => 'TXN_total',
-                'content' => $this->_txn_total_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentX' => 0,
-                    'tipAdjustmentY' => -50,
-                ),
-            ),
-            110 => array(
-                'id'      => 'PRC_name',
-                'content' => $this->_prc_name_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentX' => 0,
-                    'tipAdjustmentY' => -50,
-                ),
-            ),
-            115 => array(
-                'id'      => 'actions',
-                'content' => $this->_actions_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentX' => 0,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            120 => array(
-                'class'   => 'ee-list-table-legend-container',
-                'content' => $this->_legend_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 15,
-                    'tipAdjustmentY' => -40,
-                ),
-            ),
-            125 => array(
-                'class'   => 'bulkactions',
-                'content' => $this->_bulkactions_stop(),
-                'options' => array(
-                    'tipLocation'    => 'bottom',
-                    'tipAdjustmentY' => -30,
-                    'tipAdjustmentX' => 15,
-                ),
-            ),
-            130 => array(
-                'id'      => 'event_id',
-                'content' => $this->_event_selector_stop(),
-                'options' => array(
-                    'tipLocation'    => 'right',
-                    'tipAdjustmentY' => -50,
-                    'tipAdjustmentX' => 25,
-                ),
-            ),
-            135 => array(
-                'id'      => 'DTT_ID',
-                'content' => $this->_dtt_selector_stop(),
-                'options' => array(
-                    'tipLocation'    => 'bottom',
-                    'tipAdjustmentY' => -30,
-                    'tipAdjustmentX' => 15,
-                ),
-            ),
-            140 => array(
-                'id'      => 'event-espresso_page_espresso_registrations-search-input',
-                'content' => $this->_search_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentY' => -50,
-                    'tipAdjustmentX' => -15,
-                ),
-            ),
-        );
-    }
+	protected function _set_tour_stops()
+	{
+		$this->_stops = array(
+			10  => array(
+				'content' => $this->_start(),
+			),
+			20  => array(
+				'id'      => '_REG_count',
+				'content' => $this->_reg_count_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -20,
+				),
+			),
+			30  => array(
+				'id'      => 'ATT_name',
+				'content' => $this->_attendee_name_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -20,
+				),
+			),
+			40  => array(
+				'id'      => 'ATT_email',
+				'content' => $this->_attendee_email_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -20,
+				),
+			),
+			50  => array(
+				'id'      => '_REG_date',
+				'content' => $this->_reg_date_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -20,
+				),
+			),
+			60  => array(
+				'id'      => '_REG_code',
+				'content' => $this->_reg_code_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -20,
+				),
+			),
+			80  => array(
+				'id'      => '_REG_final_price',
+				'content' => $this->_reg_final_price_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -20,
+				),
+			),
+			90  => array(
+				'id'      => 'TXN_paid',
+				'content' => $this->_txn_paid_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentX' => 0,
+					'tipAdjustmentY' => -50,
+				),
+			),
+			100 => array(
+				'id'      => 'TXN_total',
+				'content' => $this->_txn_total_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentX' => 0,
+					'tipAdjustmentY' => -50,
+				),
+			),
+			110 => array(
+				'id'      => 'PRC_name',
+				'content' => $this->_prc_name_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentX' => 0,
+					'tipAdjustmentY' => -50,
+				),
+			),
+			115 => array(
+				'id'      => 'actions',
+				'content' => $this->_actions_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentX' => 0,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			120 => array(
+				'class'   => 'ee-list-table-legend-container',
+				'content' => $this->_legend_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 15,
+					'tipAdjustmentY' => -40,
+				),
+			),
+			125 => array(
+				'class'   => 'bulkactions',
+				'content' => $this->_bulkactions_stop(),
+				'options' => array(
+					'tipLocation'    => 'bottom',
+					'tipAdjustmentY' => -30,
+					'tipAdjustmentX' => 15,
+				),
+			),
+			130 => array(
+				'id'      => 'event_id',
+				'content' => $this->_event_selector_stop(),
+				'options' => array(
+					'tipLocation'    => 'right',
+					'tipAdjustmentY' => -50,
+					'tipAdjustmentX' => 25,
+				),
+			),
+			135 => array(
+				'id'      => 'DTT_ID',
+				'content' => $this->_dtt_selector_stop(),
+				'options' => array(
+					'tipLocation'    => 'bottom',
+					'tipAdjustmentY' => -30,
+					'tipAdjustmentX' => 15,
+				),
+			),
+			140 => array(
+				'id'      => 'event-espresso_page_espresso_registrations-search-input',
+				'content' => $this->_search_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentY' => -50,
+					'tipAdjustmentX' => -15,
+				),
+			),
+		);
+	}
 
 
-    protected function _start()
-    {
-        $content = '<h3>' . __('Event Check-in', 'event_espresso') . '</h3>';
-        if (isset($this->_req_data['event_id'])) {
-            $content .= '<p>'
-                        . __(
-                            'This tour of the Event Check-in page will go over different areas of the screen to help you understand what they are used for.<br /><br /> Note: You are currently viewing the check-in for a specific event so you can toggle the check-in status for attendees.',
-                            'event_espresso'
-                        ) . '</p>';
-        } else {
-            $content .= '<p>'
-                        . __(
-                            'This tour of the event check-in page will go over different areas of the screen to help you understand what they are used for. <br /><br /> Note: You must select an event from the dropdown menu before you can toggle the check-in status for an attendee.',
-                            'event_espresso'
-                        ) . '</p>';
-        }
-        return $content;
-    }
+	protected function _start()
+	{
+		$content = '<h3>' . __('Event Check-in', 'event_espresso') . '</h3>';
+		if (isset($this->_req_data['event_id'])) {
+			$content .= '<p>'
+						. __(
+							'This tour of the Event Check-in page will go over different areas of the screen to help you understand what they are used for.<br /><br /> Note: You are currently viewing the check-in for a specific event so you can toggle the check-in status for attendees.',
+							'event_espresso'
+						) . '</p>';
+		} else {
+			$content .= '<p>'
+						. __(
+							'This tour of the event check-in page will go over different areas of the screen to help you understand what they are used for. <br /><br /> Note: You must select an event from the dropdown menu before you can toggle the check-in status for an attendee.',
+							'event_espresso'
+						) . '</p>';
+		}
+		return $content;
+	}
 
-    protected function _reg_count_stop()
-    {
-        return '<p>' . __('View registration number.', 'event_espresso') . '</p>';
-    }
+	protected function _reg_count_stop()
+	{
+		return '<p>' . __('View registration number.', 'event_espresso') . '</p>';
+	}
 
-    protected function _attendee_name_stop()
-    {
-        return '<p>'
-               . __(
-                   'View name of registrant. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _attendee_name_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View name of registrant. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _attendee_email_stop()
-    {
-        return '<p>' . __('View email address for a registrant.', 'event_espresso') . '</p>';
-    }
+	protected function _attendee_email_stop()
+	{
+		return '<p>' . __('View email address for a registrant.', 'event_espresso') . '</p>';
+	}
 
-    protected function _reg_date_stop()
-    {
-        return '<p>'
-               . __(
-                   'View registration date. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _reg_date_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View registration date. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _reg_code_stop()
-    {
-        return '<p>'
-               . __(
-                   'View registration code. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _reg_code_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View registration code. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _reg_final_price_stop()
-    {
-        return '<p>' . __('View price for ticket.', 'event_espresso') . '</p>';
-    }
+	protected function _reg_final_price_stop()
+	{
+		return '<p>' . __('View price for ticket.', 'event_espresso') . '</p>';
+	}
 
-    protected function _txn_paid_stop()
-    {
-        return '<p>' . __('View if registrant has paid for ticket.', 'event_espresso') . '</p>';
-    }
+	protected function _txn_paid_stop()
+	{
+		return '<p>' . __('View if registrant has paid for ticket.', 'event_espresso') . '</p>';
+	}
 
-    protected function _txn_total_stop()
-    {
-        return '<p>' . __('View total amount paid.', 'event_espresso') . '</p>';
-    }
+	protected function _txn_total_stop()
+	{
+		return '<p>' . __('View total amount paid.', 'event_espresso') . '</p>';
+	}
 
-    protected function _prc_name_stop()
-    {
-        return '<p>' . __('View type of ticket.', 'event_espresso') . '</p>';
-    }
+	protected function _prc_name_stop()
+	{
+		return '<p>' . __('View type of ticket.', 'event_espresso') . '</p>';
+	}
 
-    protected function _actions_stop()
-    {
-        return '<p>'
-               . __(
-                   'Perform an action to a registration. See legend in bottom left corner.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _actions_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Perform an action to a registration. See legend in bottom left corner.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _legend_stop()
-    {
-        return '<p>'
-               . __(
-                   'This is the legend that describes the different check-in statuses. Also shows available status for registrations.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _legend_stop()
+	{
+		return '<p>'
+			   . __(
+				   'This is the legend that describes the different check-in statuses. Also shows available status for registrations.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _bulkactions_stop()
-    {
-        return '<p>'
-               . __(
-                   'Perform a bulk action to multiple registrations (only available when viewing check-in for a specific event).',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _bulkactions_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Perform a bulk action to multiple registrations (only available when viewing check-in for a specific event).',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _event_selector_stop()
-    {
-        return '<p>'
-               . __(
-                   'Select an event from this dropdown and click the filter button to see the check-in registration list for a specific event. You will then be able to toggle the check-in status for a registration.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _event_selector_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Select an event from this dropdown and click the filter button to see the check-in registration list for a specific event. You will then be able to toggle the check-in status for a registration.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _dtt_selector_stop()
-    {
-        return '<p>'
-               . __(
-                   'This dropdown shows you the date and time that a displayed registration is attached to. You can switch to a different event by selecting another date and clicking on the filter button. You can also switch out of this view by clicking on the reset filters button.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _dtt_selector_stop()
+	{
+		return '<p>'
+			   . __(
+				   'This dropdown shows you the date and time that a displayed registration is attached to. You can switch to a different event by selecting another date and clicking on the filter button. You can also switch out of this view by clicking on the reset filters button.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _search_stop()
-    {
-        return '<p>'
-               . __(
-                   'Search through registrations. The following sources will be searched: Event Name, Event Description, First Name, Last Name, Biography, Email Address, Address, Comments, Notes, Registration Final Price, Registration Code, Registration Group Size, Ticket Name, and Ticket Description.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _search_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Search through registrations. The following sources will be searched: Event Name, Event Description, First Name, Last Name, Biography, Email Address, Address, Comments, Notes, Registration Final Price, Registration Code, Registration Group Size, Ticket Name, and Ticket Description.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 }

Spacing +18 added lines, -18 removed lines

@@ -173,26 +173,26 @@ 
 
     protected function _start()
     {
-        $content = '<h3>' . __('Event Check-in', 'event_espresso') . '</h3>';
+        $content = '<h3>'.__('Event Check-in', 'event_espresso').'</h3>';
         if (isset($this->_req_data['event_id'])) {
             $content .= '<p>'
                         . __(
                             'This tour of the Event Check-in page will go over different areas of the screen to help you understand what they are used for.<br /><br /> Note: You are currently viewing the check-in for a specific event so you can toggle the check-in status for attendees.',
                             'event_espresso'
-                        ) . '</p>';
+                        ).'</p>';
         } else {
             $content .= '<p>'
                         . __(
                             'This tour of the event check-in page will go over different areas of the screen to help you understand what they are used for. <br /><br /> Note: You must select an event from the dropdown menu before you can toggle the check-in status for an attendee.',
                             'event_espresso'
-                        ) . '</p>';
+                        ).'</p>';
         }
         return $content;
     }
 
     protected function _reg_count_stop()
     {
-        return '<p>' . __('View registration number.', 'event_espresso') . '</p>';
+        return '<p>'.__('View registration number.', 'event_espresso').'</p>';
     }
 
     protected function _attendee_name_stop()
@@ -201,12 +201,12 @@ 
                . __(
                    'View name of registrant. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _attendee_email_stop()
     {
-        return '<p>' . __('View email address for a registrant.', 'event_espresso') . '</p>';
+        return '<p>'.__('View email address for a registrant.', 'event_espresso').'</p>';
     }
 
     protected function _reg_date_stop()
@@ -215,7 +215,7 @@ 
                . __(
                    'View registration date. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _reg_code_stop()
@@ -224,27 +224,27 @@ 
                . __(
                    'View registration code. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _reg_final_price_stop()
     {
-        return '<p>' . __('View price for ticket.', 'event_espresso') . '</p>';
+        return '<p>'.__('View price for ticket.', 'event_espresso').'</p>';
     }
 
     protected function _txn_paid_stop()
     {
-        return '<p>' . __('View if registrant has paid for ticket.', 'event_espresso') . '</p>';
+        return '<p>'.__('View if registrant has paid for ticket.', 'event_espresso').'</p>';
     }
 
     protected function _txn_total_stop()
     {
-        return '<p>' . __('View total amount paid.', 'event_espresso') . '</p>';
+        return '<p>'.__('View total amount paid.', 'event_espresso').'</p>';
     }
 
     protected function _prc_name_stop()
     {
-        return '<p>' . __('View type of ticket.', 'event_espresso') . '</p>';
+        return '<p>'.__('View type of ticket.', 'event_espresso').'</p>';
     }
 
     protected function _actions_stop()
@@ -253,7 +253,7 @@ 
                . __(
                    'Perform an action to a registration. See legend in bottom left corner.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _legend_stop()
@@ -262,7 +262,7 @@ 
                . __(
                    'This is the legend that describes the different check-in statuses. Also shows available status for registrations.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _bulkactions_stop()
@@ -271,7 +271,7 @@ 
                . __(
                    'Perform a bulk action to multiple registrations (only available when viewing check-in for a specific event).',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _event_selector_stop()
@@ -280,7 +280,7 @@ 
                . __(
                    'Select an event from this dropdown and click the filter button to see the check-in registration list for a specific event. You will then be able to toggle the check-in status for a registration.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _dtt_selector_stop()
@@ -289,7 +289,7 @@ 
                . __(
                    'This dropdown shows you the date and time that a displayed registration is attached to. You can switch to a different event by selecting another date and clicking on the filter button. You can also switch out of this view by clicking on the reset filters button.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _search_stop()
@@ -298,6 +298,6 @@ 
                . __(
                    'Search through registrations. The following sources will be searched: Event Name, Event Description, First Name, Last Name, Biography, Email Address, Address, Comments, Notes, Registration Final Price, Registration Code, Registration Group Size, Ticket Name, and Ticket Description.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 }

admin_pages/registrations/help_tours/Contact_List_Help_Tour.class.php

Indentation +223 added lines, -223 removed lines

@@ -15,227 +15,227 @@
 class Contact_List_Help_Tour extends EE_Help_Tour
 {
 
-    protected function _set_tour_properties()
-    {
-        $this->_label = __('Contact List Tour', 'event_espresso');
-        $this->_slug = 'contact-list-overview-joyride';
-    }
-
-
-    protected function _set_tour_stops()
-    {
-        $this->_stops = array(
-            10  => array(
-                'content' => $this->_start(),
-            ),
-            15  => array(
-                'id'      => 'ATT_ID',
-                'content' => $this->_attendee_id_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -20,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            20  => array(
-                'id'      => 'ATT_fname',
-                'content' => $this->_attendee_name_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 5,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            30  => array(
-                'id'      => 'ATT_lname',
-                'content' => $this->_att_lname_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 5,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            40  => array(
-                'id'      => 'ATT_email',
-                'content' => $this->_att_email_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 10,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            50  => array(
-                'id'      => 'ATT_phone',
-                'content' => $this->_att_phone_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            60  => array(
-                'id'      => 'ATT_address',
-                'content' => $this->_att_address_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 0,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            70  => array(
-                'id'      => 'ATT_city',
-                'content' => $this->_att_city_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentX' => 0,
-                    'tipAdjustmentY' => -50,
-                ),
-            ),
-            80  => array(
-                'id'      => 'STA_ID',
-                'content' => $this->_sta_id_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentX' => 0,
-                    'tipAdjustmentY' => -50,
-                ),
-            ),
-            90  => array(
-                'id'      => 'CNT_ISO',
-                'content' => $this->_cnt_iso_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentX' => 0,
-                    'tipAdjustmentY' => -50,
-                ),
-            ),
-            100 => array(
-                'class'   => 'bulkactions',
-                'content' => $this->_bulkactions_stop(),
-                'options' => array(
-                    'tipLocation'    => 'bottom',
-                    'tipAdjustmentY' => -30,
-                    'tipAdjustmentX' => 15,
-                ),
-            ),
-            110 => array(
-                'id'      => 'event-espresso_page_espresso_registrations-search-input',
-                'content' => $this->_search_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentY' => -50,
-                    'tipAdjustmentX' => -15,
-                ),
-            ),
-            120 => array(
-                'id'      => 'contact-list-csv-export',
-                'content' => $this->_contact_list_csv_export_stop(),
-                'options' => array(
-                    'tipLocation'    => 'right',
-                    'tipAdjustmentY' => -50,
-                    'tipAdjustmentX' => 25,
-                ),
-            ),
-        );
-    }
-
-
-    protected function _start()
-    {
-        $content = '<h3>' . __('Contact List', 'event_espresso') . '</h3>';
-        $content .= '<p>'
-                    . __(
-                        'This tour of the Contact List page will go over different areas of the screen to help you understand what they are used for.',
-                        'event_espresso'
-                    ) . '</p>';
-        return $content;
-    }
-
-    protected function _attendee_id_stop()
-    {
-        return '<p>'
-               . __(
-                   'View ID for registrants. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
-
-    protected function _attendee_name_stop()
-    {
-        return '<p>'
-               . __(
-                   'View first name for registrants. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
-
-    protected function _att_lname_stop()
-    {
-        return '<p>'
-               . __(
-                   'View last name for registrants. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
-
-    protected function _att_email_stop()
-    {
-        return '<p>'
-               . __(
-                   'View email address for registrants. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
-
-    protected function _att_phone_stop()
-    {
-        return '<p>' . __('View phone number for registrants.', 'event_espresso') . '</p>';
-    }
-
-    protected function _att_address_stop()
-    {
-        return '<p>' . __('View address for registrants.', 'event_espresso') . '</p>';
-    }
-
-    protected function _att_city_stop()
-    {
-        return '<p>' . __('View city for registrants.', 'event_espresso') . '</p>';
-    }
-
-    protected function _sta_id_stop()
-    {
-        return '<p>'
-               . __(
-                   'View state/province for registrants. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
-
-    protected function _cnt_iso_stop()
-    {
-        return '<p>'
-               . __(
-                   'View country for registrants. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
-
-    protected function _bulkactions_stop()
-    {
-        return '<p>' . __('Perform a bulk action to multiple registrants.', 'event_espresso') . '</p>';
-    }
-
-    protected function _search_stop()
-    {
-        return '<p>'
-               . __(
-                   'Search through contacts. The following sources will be searched: Event Name, Event Description, First Name, Last Name, Biography, Email Address, Address, Comments, Notes, Registration Final Price, and Registration Code.',
-                   'event_espresso'
-               ) . '</p>';
-    }
-
-    protected function _contact_list_csv_export_stop()
-    {
-        return '<p>' . __('Export your contact list to a CSV file.', 'event_espresso') . '</p>';
-    }
+	protected function _set_tour_properties()
+	{
+		$this->_label = __('Contact List Tour', 'event_espresso');
+		$this->_slug = 'contact-list-overview-joyride';
+	}
+
+
+	protected function _set_tour_stops()
+	{
+		$this->_stops = array(
+			10  => array(
+				'content' => $this->_start(),
+			),
+			15  => array(
+				'id'      => 'ATT_ID',
+				'content' => $this->_attendee_id_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -20,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			20  => array(
+				'id'      => 'ATT_fname',
+				'content' => $this->_attendee_name_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 5,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			30  => array(
+				'id'      => 'ATT_lname',
+				'content' => $this->_att_lname_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 5,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			40  => array(
+				'id'      => 'ATT_email',
+				'content' => $this->_att_email_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 10,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			50  => array(
+				'id'      => 'ATT_phone',
+				'content' => $this->_att_phone_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			60  => array(
+				'id'      => 'ATT_address',
+				'content' => $this->_att_address_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 0,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			70  => array(
+				'id'      => 'ATT_city',
+				'content' => $this->_att_city_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentX' => 0,
+					'tipAdjustmentY' => -50,
+				),
+			),
+			80  => array(
+				'id'      => 'STA_ID',
+				'content' => $this->_sta_id_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentX' => 0,
+					'tipAdjustmentY' => -50,
+				),
+			),
+			90  => array(
+				'id'      => 'CNT_ISO',
+				'content' => $this->_cnt_iso_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentX' => 0,
+					'tipAdjustmentY' => -50,
+				),
+			),
+			100 => array(
+				'class'   => 'bulkactions',
+				'content' => $this->_bulkactions_stop(),
+				'options' => array(
+					'tipLocation'    => 'bottom',
+					'tipAdjustmentY' => -30,
+					'tipAdjustmentX' => 15,
+				),
+			),
+			110 => array(
+				'id'      => 'event-espresso_page_espresso_registrations-search-input',
+				'content' => $this->_search_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentY' => -50,
+					'tipAdjustmentX' => -15,
+				),
+			),
+			120 => array(
+				'id'      => 'contact-list-csv-export',
+				'content' => $this->_contact_list_csv_export_stop(),
+				'options' => array(
+					'tipLocation'    => 'right',
+					'tipAdjustmentY' => -50,
+					'tipAdjustmentX' => 25,
+				),
+			),
+		);
+	}
+
+
+	protected function _start()
+	{
+		$content = '<h3>' . __('Contact List', 'event_espresso') . '</h3>';
+		$content .= '<p>'
+					. __(
+						'This tour of the Contact List page will go over different areas of the screen to help you understand what they are used for.',
+						'event_espresso'
+					) . '</p>';
+		return $content;
+	}
+
+	protected function _attendee_id_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View ID for registrants. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
+
+	protected function _attendee_name_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View first name for registrants. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
+
+	protected function _att_lname_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View last name for registrants. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
+
+	protected function _att_email_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View email address for registrants. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
+
+	protected function _att_phone_stop()
+	{
+		return '<p>' . __('View phone number for registrants.', 'event_espresso') . '</p>';
+	}
+
+	protected function _att_address_stop()
+	{
+		return '<p>' . __('View address for registrants.', 'event_espresso') . '</p>';
+	}
+
+	protected function _att_city_stop()
+	{
+		return '<p>' . __('View city for registrants.', 'event_espresso') . '</p>';
+	}
+
+	protected function _sta_id_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View state/province for registrants. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
+
+	protected function _cnt_iso_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View country for registrants. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
+
+	protected function _bulkactions_stop()
+	{
+		return '<p>' . __('Perform a bulk action to multiple registrants.', 'event_espresso') . '</p>';
+	}
+
+	protected function _search_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Search through contacts. The following sources will be searched: Event Name, Event Description, First Name, Last Name, Biography, Email Address, Address, Comments, Notes, Registration Final Price, and Registration Code.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
+
+	protected function _contact_list_csv_export_stop()
+	{
+		return '<p>' . __('Export your contact list to a CSV file.', 'event_espresso') . '</p>';
+	}
 }

Spacing +14 added lines, -14 removed lines

@@ -142,12 +142,12 @@ 
 
     protected function _start()
     {
-        $content = '<h3>' . __('Contact List', 'event_espresso') . '</h3>';
+        $content = '<h3>'.__('Contact List', 'event_espresso').'</h3>';
         $content .= '<p>'
                     . __(
                         'This tour of the Contact List page will go over different areas of the screen to help you understand what they are used for.',
                         'event_espresso'
-                    ) . '</p>';
+                    ).'</p>';
         return $content;
     }
 
@@ -157,7 +157,7 @@ 
                . __(
                    'View ID for registrants. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _attendee_name_stop()
@@ -166,7 +166,7 @@ 
                . __(
                    'View first name for registrants. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _att_lname_stop()
@@ -175,7 +175,7 @@ 
                . __(
                    'View last name for registrants. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _att_email_stop()
@@ -184,22 +184,22 @@ 
                . __(
                    'View email address for registrants. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _att_phone_stop()
     {
-        return '<p>' . __('View phone number for registrants.', 'event_espresso') . '</p>';
+        return '<p>'.__('View phone number for registrants.', 'event_espresso').'</p>';
     }
 
     protected function _att_address_stop()
     {
-        return '<p>' . __('View address for registrants.', 'event_espresso') . '</p>';
+        return '<p>'.__('View address for registrants.', 'event_espresso').'</p>';
     }
 
     protected function _att_city_stop()
     {
-        return '<p>' . __('View city for registrants.', 'event_espresso') . '</p>';
+        return '<p>'.__('View city for registrants.', 'event_espresso').'</p>';
     }
 
     protected function _sta_id_stop()
@@ -208,7 +208,7 @@ 
                . __(
                    'View state/province for registrants. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _cnt_iso_stop()
@@ -217,12 +217,12 @@ 
                . __(
                    'View country for registrants. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _bulkactions_stop()
     {
-        return '<p>' . __('Perform a bulk action to multiple registrants.', 'event_espresso') . '</p>';
+        return '<p>'.__('Perform a bulk action to multiple registrants.', 'event_espresso').'</p>';
     }
 
     protected function _search_stop()
@@ -231,11 +231,11 @@ 
                . __(
                    'Search through contacts. The following sources will be searched: Event Name, Event Description, First Name, Last Name, Biography, Email Address, Address, Comments, Notes, Registration Final Price, and Registration Code.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _contact_list_csv_export_stop()
     {
-        return '<p>' . __('Export your contact list to a CSV file.', 'event_espresso') . '</p>';
+        return '<p>'.__('Export your contact list to a CSV file.', 'event_espresso').'</p>';
     }
 }

admin_pages/registrations/help_tours/Registration_Overview_Help_Tour.class.php

Indentation +253 added lines, -253 removed lines

@@ -15,275 +15,275 @@
 class Registration_Overview_Help_Tour extends EE_Help_Tour
 {
 
-    protected function _set_tour_properties()
-    {
-        $this->_label = __('Registrations Overview Tour', 'event_espresso');
-        if (isset($this->_req_data['event_id'])) {
-            $this->_slug = 'registration-per-event-overview-joyride';
-        } else {
-            $this->_slug = 'registration-overview-joyride';
-        }
-    }
+	protected function _set_tour_properties()
+	{
+		$this->_label = __('Registrations Overview Tour', 'event_espresso');
+		if (isset($this->_req_data['event_id'])) {
+			$this->_slug = 'registration-per-event-overview-joyride';
+		} else {
+			$this->_slug = 'registration-overview-joyride';
+		}
+	}
 
 
-    protected function _set_tour_stops()
-    {
-        $this->_stops = array(
-            10  => array(
-                'content' => $this->_start(),
-            ),
-            20  => array(
-                'id'      => '_REG_ID',
-                'content' => $this->_reg_id_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -20,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            30  => array(
-                'id'      => '_REG_count',
-                'content' => $this->_reg_count_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            40  => array(
-                'id'      => 'ATT_fname',
-                'content' => $this->_attendee_name_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            50  => array(
-                'id'      => '_REG_date',
-                'content' => $this->_reg_date_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 5,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            60  => array(
-                'id'      => 'event_name',
-                'content' => $this->_event_name_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            70  => array(
-                'id'      => 'DTT_EVT_start',
-                'content' => $this->_dtt_evt_start_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 5,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            80  => array(
-                'id'      => '_REG_code',
-                'content' => $this->_reg_code_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 0,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            90  => array(
-                'id'      => '_REG_final_price',
-                'content' => $this->_txn_total_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentX' => 5,
-                    'tipAdjustmentY' => -50,
-                ),
-            ),
-            100 => array(
-                'id'      => 'actions',
-                'content' => $this->_actions_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentX' => 0,
-                    'tipAdjustmentY' => -50,
-                ),
-            ),
-            110 => array(
-                'class'   => 'ee-list-table-legend-container',
-                'content' => $this->_legend_stop(),
-                'options' => array(
-                    'tipLocation'    => 'right',
-                    'tipAdjustmentX' => 15,
-                    'tipAdjustmentY' => -40,
-                ),
-            ),
-            120 => array(
-                'class'   => 'subsubsub',
-                'content' => $this->_views_stop(),
-                'options' => array(
-                    'tipLocation'    => 'right',
-                    'tipAdjustmentY' => -50,
-                    'tipAdjustmentX' => 15,
-                ),
-            ),
-            130 => array(
-                'class'   => 'bulkactions',
-                'content' => $this->_bulkactions_stop(),
-                'options' => array(
-                    'tipLocation'    => 'bottom',
-                    'tipAdjustmentY' => -30,
-                    'tipAdjustmentX' => 15,
-                ),
-            ),
-            140 => array(
-                'id'      => 'EVT_CAT',
-                'content' => $this->_stop_about_filters(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentY' => -40,
-                    'tipAdjustmentX' => 25,
-                ),
-            ),
-            150 => array(
-                'id'      => 'event-espresso_page_espresso_registrations-search-input',
-                'content' => $this->_search_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentY' => -50,
-                    'tipAdjustmentX' => -15,
-                ),
-            ),
-        );
-    }
+	protected function _set_tour_stops()
+	{
+		$this->_stops = array(
+			10  => array(
+				'content' => $this->_start(),
+			),
+			20  => array(
+				'id'      => '_REG_ID',
+				'content' => $this->_reg_id_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -20,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			30  => array(
+				'id'      => '_REG_count',
+				'content' => $this->_reg_count_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			40  => array(
+				'id'      => 'ATT_fname',
+				'content' => $this->_attendee_name_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			50  => array(
+				'id'      => '_REG_date',
+				'content' => $this->_reg_date_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 5,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			60  => array(
+				'id'      => 'event_name',
+				'content' => $this->_event_name_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			70  => array(
+				'id'      => 'DTT_EVT_start',
+				'content' => $this->_dtt_evt_start_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 5,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			80  => array(
+				'id'      => '_REG_code',
+				'content' => $this->_reg_code_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 0,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			90  => array(
+				'id'      => '_REG_final_price',
+				'content' => $this->_txn_total_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentX' => 5,
+					'tipAdjustmentY' => -50,
+				),
+			),
+			100 => array(
+				'id'      => 'actions',
+				'content' => $this->_actions_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentX' => 0,
+					'tipAdjustmentY' => -50,
+				),
+			),
+			110 => array(
+				'class'   => 'ee-list-table-legend-container',
+				'content' => $this->_legend_stop(),
+				'options' => array(
+					'tipLocation'    => 'right',
+					'tipAdjustmentX' => 15,
+					'tipAdjustmentY' => -40,
+				),
+			),
+			120 => array(
+				'class'   => 'subsubsub',
+				'content' => $this->_views_stop(),
+				'options' => array(
+					'tipLocation'    => 'right',
+					'tipAdjustmentY' => -50,
+					'tipAdjustmentX' => 15,
+				),
+			),
+			130 => array(
+				'class'   => 'bulkactions',
+				'content' => $this->_bulkactions_stop(),
+				'options' => array(
+					'tipLocation'    => 'bottom',
+					'tipAdjustmentY' => -30,
+					'tipAdjustmentX' => 15,
+				),
+			),
+			140 => array(
+				'id'      => 'EVT_CAT',
+				'content' => $this->_stop_about_filters(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentY' => -40,
+					'tipAdjustmentX' => 25,
+				),
+			),
+			150 => array(
+				'id'      => 'event-espresso_page_espresso_registrations-search-input',
+				'content' => $this->_search_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentY' => -50,
+					'tipAdjustmentX' => -15,
+				),
+			),
+		);
+	}
 
 
-    protected function _start()
-    {
-        $content = '<h3>' . __('Registration Overview', 'event_espresso') . '</h3>';
-        if (isset($this->_req_data['event_id'])) {
-            $content .= '<p>'
-                        . __(
-                            'An introduction to the Registration Overview page for a single event. This view is pretty much the same as the default overview registration page except you are only seeing registrations for a specific event.  There are also some changes to the available columns in this view.',
-                            'event_espresso'
-                        ) . '</p>';
-        } else {
-            $content .= '<p>'
-                        . __(
-                            'This tour of the Registration Overview page will go over different areas of the screen to help you understand what they are used for.',
-                            'event_espresso'
-                        ) . '</p>';
-        }
-        return $content;
-    }
+	protected function _start()
+	{
+		$content = '<h3>' . __('Registration Overview', 'event_espresso') . '</h3>';
+		if (isset($this->_req_data['event_id'])) {
+			$content .= '<p>'
+						. __(
+							'An introduction to the Registration Overview page for a single event. This view is pretty much the same as the default overview registration page except you are only seeing registrations for a specific event.  There are also some changes to the available columns in this view.',
+							'event_espresso'
+						) . '</p>';
+		} else {
+			$content .= '<p>'
+						. __(
+							'This tour of the Registration Overview page will go over different areas of the screen to help you understand what they are used for.',
+							'event_espresso'
+						) . '</p>';
+		}
+		return $content;
+	}
 
-    protected function _reg_id_stop()
-    {
-        return '<p>'
-               . __(
-                   'View the registration ID. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _reg_id_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View the registration ID. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _reg_count_stop()
-    {
-        return '<p>' . __('View registration number.', 'event_espresso') . '</p>';
-    }
+	protected function _reg_count_stop()
+	{
+		return '<p>' . __('View registration number.', 'event_espresso') . '</p>';
+	}
 
-    protected function _attendee_name_stop()
-    {
-        return '<p>'
-               . __(
-                   'View the name of the registrant. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _attendee_name_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View the name of the registrant. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _reg_date_stop()
-    {
-        return '<p>'
-               . __(
-                   'View registration date. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _reg_date_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View registration date. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _event_name_stop()
-    {
-        return '<p>'
-               . __(
-                   'View the name of the event. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _event_name_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View the name of the event. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _dtt_evt_start_stop()
-    {
-        return '<p>'
-               . __(
-                   'View the date of the event. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _dtt_evt_start_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View the date of the event. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _reg_code_stop()
-    {
-        return '<p>' . __('View registration code for a registrant.', 'event_espresso') . '</p>';
-    }
+	protected function _reg_code_stop()
+	{
+		return '<p>' . __('View registration code for a registrant.', 'event_espresso') . '</p>';
+	}
 
-    protected function _txn_total_stop()
-    {
-        return '<p>' . __('View price of registration.', 'event_espresso') . '</p>';
-    }
+	protected function _txn_total_stop()
+	{
+		return '<p>' . __('View price of registration.', 'event_espresso') . '</p>';
+	}
 
-    protected function _actions_stop()
-    {
-        return '<p>'
-               . __(
-                   'Perform an action to a registration. See legend in bottom left corner.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _actions_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Perform an action to a registration. See legend in bottom left corner.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _legend_stop()
-    {
-        return '<p>'
-               . __(
-                   'This is the legend that describes the actions available in the actions column. Also shows available statuses for a registration.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _legend_stop()
+	{
+		return '<p>'
+			   . __(
+				   'This is the legend that describes the actions available in the actions column. Also shows available statuses for a registration.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _views_stop()
-    {
-        return '<p>'
-               . __(
-                   'You can select different views by time period or look at registrations which have been moved to the trash.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _views_stop()
+	{
+		return '<p>'
+			   . __(
+				   'You can select different views by time period or look at registrations which have been moved to the trash.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _bulkactions_stop()
-    {
-        return '<p>' . __('Perform a bulk action to multiple registrations.', 'event_espresso') . '</p>';
-    }
+	protected function _bulkactions_stop()
+	{
+		return '<p>' . __('Perform a bulk action to multiple registrations.', 'event_espresso') . '</p>';
+	}
 
-    protected function _stop_about_filters()
-    {
-        return '<p>' . __('Registrations can be filtered by date, categories, or status.', 'event_espresso') . '</p>';
-    }
+	protected function _stop_about_filters()
+	{
+		return '<p>' . __('Registrations can be filtered by date, categories, or status.', 'event_espresso') . '</p>';
+	}
 
-    protected function _search_stop()
-    {
-        return '<p>'
-               . __(
-                   'Search through registrations. The following sources will be searched: Event Name, Event Description, First Name, Last Name, Biography, Email Address, Address, Comments, Notes, Registration Final Price, Registration Code, Registration Group Size, Ticket Name, and Ticket Description.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _search_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Search through registrations. The following sources will be searched: Event Name, Event Description, First Name, Last Name, Biography, Email Address, Address, Comments, Notes, Registration Final Price, Registration Code, Registration Group Size, Ticket Name, and Ticket Description.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 }

Spacing +17 added lines, -17 removed lines

@@ -164,19 +164,19 @@ 
 
     protected function _start()
     {
-        $content = '<h3>' . __('Registration Overview', 'event_espresso') . '</h3>';
+        $content = '<h3>'.__('Registration Overview', 'event_espresso').'</h3>';
         if (isset($this->_req_data['event_id'])) {
             $content .= '<p>'
                         . __(
                             'An introduction to the Registration Overview page for a single event. This view is pretty much the same as the default overview registration page except you are only seeing registrations for a specific event.  There are also some changes to the available columns in this view.',
                             'event_espresso'
-                        ) . '</p>';
+                        ).'</p>';
         } else {
             $content .= '<p>'
                         . __(
                             'This tour of the Registration Overview page will go over different areas of the screen to help you understand what they are used for.',
                             'event_espresso'
-                        ) . '</p>';
+                        ).'</p>';
         }
         return $content;
     }
@@ -187,12 +187,12 @@ 
                . __(
                    'View the registration ID. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _reg_count_stop()
     {
-        return '<p>' . __('View registration number.', 'event_espresso') . '</p>';
+        return '<p>'.__('View registration number.', 'event_espresso').'</p>';
     }
 
     protected function _attendee_name_stop()
@@ -201,7 +201,7 @@ 
                . __(
                    'View the name of the registrant. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _reg_date_stop()
@@ -210,7 +210,7 @@ 
                . __(
                    'View registration date. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _event_name_stop()
@@ -219,7 +219,7 @@ 
                . __(
                    'View the name of the event. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _dtt_evt_start_stop()
@@ -228,17 +228,17 @@ 
                . __(
                    'View the date of the event. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _reg_code_stop()
     {
-        return '<p>' . __('View registration code for a registrant.', 'event_espresso') . '</p>';
+        return '<p>'.__('View registration code for a registrant.', 'event_espresso').'</p>';
     }
 
     protected function _txn_total_stop()
     {
-        return '<p>' . __('View price of registration.', 'event_espresso') . '</p>';
+        return '<p>'.__('View price of registration.', 'event_espresso').'</p>';
     }
 
     protected function _actions_stop()
@@ -247,7 +247,7 @@ 
                . __(
                    'Perform an action to a registration. See legend in bottom left corner.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _legend_stop()
@@ -256,7 +256,7 @@ 
                . __(
                    'This is the legend that describes the actions available in the actions column. Also shows available statuses for a registration.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _views_stop()
@@ -265,17 +265,17 @@ 
                . __(
                    'You can select different views by time period or look at registrations which have been moved to the trash.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _bulkactions_stop()
     {
-        return '<p>' . __('Perform a bulk action to multiple registrations.', 'event_espresso') . '</p>';
+        return '<p>'.__('Perform a bulk action to multiple registrations.', 'event_espresso').'</p>';
     }
 
     protected function _stop_about_filters()
     {
-        return '<p>' . __('Registrations can be filtered by date, categories, or status.', 'event_espresso') . '</p>';
+        return '<p>'.__('Registrations can be filtered by date, categories, or status.', 'event_espresso').'</p>';
     }
 
     protected function _search_stop()
@@ -284,6 +284,6 @@ 
                . __(
                    'Search through registrations. The following sources will be searched: Event Name, Event Description, First Name, Last Name, Biography, Email Address, Address, Comments, Notes, Registration Final Price, Registration Code, Registration Group Size, Ticket Name, and Ticket Description.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 }