eventespresso / event-espresso-core

caffeinated/admin/new/tickets/Tickets_Admin_Page_Init.core.php

Indentation +40 added lines, -40 removed lines

@@ -15,48 +15,48 @@
  */
 class Tickets_Admin_Page_Init extends EE_Admin_Page_Init
 {
-    /**
-     *        constructor
-     *
-     * @Constructor
-     * @access public
-     * @return void
-     */
-    public function __construct()
-    {
-        if (! defined('TICKETS_PG_SLUG')) {
-            define('TICKETS_PG_SLUG', 'tickets');
-            define('TICKETS_LABEL', esc_html__('Default Tickets', 'event_espresso'));
-            define('TICKETS_ADMIN', EE_CORE_CAF_ADMIN . 'new/' . TICKETS_PG_SLUG . '/');
-            define('TICKETS_ADMIN_URL', admin_url('admin.php?page=' . TICKETS_PG_SLUG));
-            define('TICKETS_ASSETS_PATH', TICKETS_ADMIN . 'assets/');
-            define('TICKETS_ASSETS_URL', EE_CORE_CAF_ADMIN_URL . 'new/' . TICKETS_PG_SLUG . '/assets/');
-            define('TICKETS_TEMPLATE_PATH', TICKETS_ADMIN . 'templates/');
-            define('TICKETS_TEMPLATE_URL', EE_CORE_CAF_ADMIN_URL . 'new/' . TICKETS_PG_SLUG . '/templates/');
-        }
-        parent::__construct();
-        $this->_folder_path = EE_CORE_CAF_ADMIN . 'new/' . $this->_folder_name . DS;
-    }
+	/**
+	 *        constructor
+	 *
+	 * @Constructor
+	 * @access public
+	 * @return void
+	 */
+	public function __construct()
+	{
+		if (! defined('TICKETS_PG_SLUG')) {
+			define('TICKETS_PG_SLUG', 'tickets');
+			define('TICKETS_LABEL', esc_html__('Default Tickets', 'event_espresso'));
+			define('TICKETS_ADMIN', EE_CORE_CAF_ADMIN . 'new/' . TICKETS_PG_SLUG . '/');
+			define('TICKETS_ADMIN_URL', admin_url('admin.php?page=' . TICKETS_PG_SLUG));
+			define('TICKETS_ASSETS_PATH', TICKETS_ADMIN . 'assets/');
+			define('TICKETS_ASSETS_URL', EE_CORE_CAF_ADMIN_URL . 'new/' . TICKETS_PG_SLUG . '/assets/');
+			define('TICKETS_TEMPLATE_PATH', TICKETS_ADMIN . 'templates/');
+			define('TICKETS_TEMPLATE_URL', EE_CORE_CAF_ADMIN_URL . 'new/' . TICKETS_PG_SLUG . '/templates/');
+		}
+		parent::__construct();
+		$this->_folder_path = EE_CORE_CAF_ADMIN . 'new/' . $this->_folder_name . DS;
+	}
 
 
-    protected function _set_init_properties()
-    {
-        $this->label = TICKETS_LABEL;
-    }
+	protected function _set_init_properties()
+	{
+		$this->label = TICKETS_LABEL;
+	}
 
 
-    public function getMenuProperties(): array
-    {
-        return [
-            'menu_type'       => AdminMenuItem::TYPE_MENU_SUB_ITEM,
-            'menu_group'      => AdminMenuGroup::MENU_SLUG_MANAGEMENT,
-            'menu_order'      => 15,
-            'show_on_menu'    => AdminMenuItem::DISPLAY_NONE,
-            'parent_slug'     => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
-            'menu_slug'       => TICKETS_PG_SLUG,
-            'menu_label'      => TICKETS_LABEL,
-            'capability'      => 'manage_options',
-            'admin_init_page' => $this,
-        ];
-    }
+	public function getMenuProperties(): array
+	{
+		return [
+			'menu_type'       => AdminMenuItem::TYPE_MENU_SUB_ITEM,
+			'menu_group'      => AdminMenuGroup::MENU_SLUG_MANAGEMENT,
+			'menu_order'      => 15,
+			'show_on_menu'    => AdminMenuItem::DISPLAY_NONE,
+			'parent_slug'     => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
+			'menu_slug'       => TICKETS_PG_SLUG,
+			'menu_label'      => TICKETS_LABEL,
+			'capability'      => 'manage_options',
+			'admin_init_page' => $this,
+		];
+	}
 }

modules/event_single/EED_Event_Single.module.php

Indentation +471 added lines, -471 removed lines

@@ -14,476 +14,476 @@ 
  */
 class EED_Event_Single extends EED_Module
 {
-    const EVENT_DETAILS_PRIORITY = 100;
-    const EVENT_DATETIMES_PRIORITY = 110;
-    const EVENT_TICKETS_PRIORITY = 120;
-    const EVENT_VENUES_PRIORITY = 130;
-
-    /**
-     * @type bool $using_get_the_excerpt
-     */
-    protected static $using_get_the_excerpt = false;
-
-
-    /**
-     * @type EE_Template_Part_Manager $template_parts
-     */
-    protected $template_parts;
-
-
-    /**
-     * @return EED_Module|EED_Event_Single
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function set_hooks()
-    {
-        add_filter('FHEE_run_EE_wp', '__return_true');
-        add_action('wp_loaded', array('EED_Event_Single', 'set_definitions'), 2);
-        /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_type_definitions */
-        $custom_post_type_definitions = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-        );
-        $custom_post_types = $custom_post_type_definitions->getDefinitions();
-        EED_Module::registerRoute(
-            $custom_post_types[ EspressoPostType::EVENTS ]['singular_slug'],
-            'Event_Single',
-            'run'
-        );
-    }
-
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('wp_loaded', array('EED_Event_Single', 'set_definitions'), 2);
-    }
-
-
-    /**
-     * set_definitions
-     *
-     * @static
-     * @return void
-     */
-    public static function set_definitions()
-    {
-        define('EVENT_SINGLE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define('EVENT_SINGLE_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
-    }
-
-
-    /**
-     * set_config
-     *
-     * @void
-     */
-    protected function set_config()
-    {
-        $this->set_config_section('template_settings');
-        $this->set_config_class('EE_Event_Single_Config');
-        $this->set_config_name('EED_Event_Single');
-    }
-
-
-    /**
-     * initialize_template_parts
-     *
-     * @param EE_Config_Base|EE_Event_Single_Config $config
-     * @return EE_Template_Part_Manager
-     * @throws EE_Error
-     */
-    public function initialize_template_parts(EE_Event_Single_Config $config = null)
-    {
-        /** @type EE_Event_Single_Config $config */
-        $config = $config instanceof EE_Event_Single_Config ? $config : $this->config();
-        EEH_Autoloader::register_template_part_autoloaders();
-        $template_parts = new EE_Template_Part_Manager();
-        $template_parts->add_template_part(
-            'tickets',
-            esc_html__('Ticket Selector', 'event_espresso'),
-            'content-espresso_events-tickets.php',
-            $config->display_order_tickets
-        );
-        $template_parts->add_template_part(
-            'datetimes',
-            esc_html__('Dates and Times', 'event_espresso'),
-            'content-espresso_events-datetimes.php',
-            $config->display_order_datetimes
-        );
-        $template_parts->add_template_part(
-            'event',
-            esc_html__('Event Description', 'event_espresso'),
-            'content-espresso_events-details.php',
-            $config->display_order_event
-        );
-        $template_parts->add_template_part(
-            'venue',
-            esc_html__('Venue Information', 'event_espresso'),
-            'content-espresso_events-venues.php',
-            $config->display_order_venue
-        );
-        do_action('AHEE__EED_Event_Single__initialize_template_parts', $template_parts);
-        return $template_parts;
-    }
-
-
-    /**
-     * run - initial module setup
-     *
-     * @param WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-        // ensure valid EE_Events_Single_Config() object exists
-        $this->set_config();
-        // check what template is loaded
-        add_filter('template_include', array($this, 'template_include'), 999, 1);
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        // load css
-        add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
-    }
-
-
-    /**
-     * template_include
-     *
-     * @param    string $template
-     * @return    string
-     */
-    public function template_include($template)
-    {
-        global $post;
-        /** @type EE_Event_Single_Config $config */
-        $config = $this->config();
-        if ($config->display_status_banner_single) {
-            add_filter('the_title', array('EED_Event_Single', 'the_title'), 100, 2);
-        }
-        // not a custom template?
-        if (
-            ! post_password_required($post)
-            && (
-                apply_filters('FHEE__EED_Event_Single__template_include__allow_custom_selected_template', false)
-                || EE_Registry::instance()
-                              ->load_core('Front_Controller')
-                              ->get_selected_template() !== 'single-espresso_events.php'
-            )
-        ) {
-            EEH_Template::load_espresso_theme_functions();
-            // then add extra event data via hooks
-            add_action('loop_start', array('EED_Event_Single', 'loop_start'));
-            add_filter('get_the_excerpt', array('EED_Event_Single', 'get_the_excerpt'), 1, 1);
-            add_filter(
-                'the_content',
-                array('EED_Event_Single', 'event_details'),
-                EED_Event_Single::EVENT_DETAILS_PRIORITY
-            );
-            add_action('loop_end', array('EED_Event_Single', 'loop_end'));
-            // don't display entry meta because the existing theme will take car of that
-            add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
-        }
-        return $template;
-    }
-
-
-    /**
-     * @param WP_Query $query
-     * @return void
-     */
-    public static function loop_start(WP_Query $query)
-    {
-        if (! $query->is_main_query()) {
-            return;
-        }
-        global $post;
-        do_action('AHEE_event_details_before_post', $post, $query);
-    }
-
-
-    /**
-     * the_title
-     *
-     * @param    string $title
-     * @param    int    $id
-     * @return    string
-     */
-    public static function the_title($title = '', $id = 0)
-    {
-        global $post;
-        return ((function_exists('wp_is_block_theme') && wp_is_block_theme()) || in_the_loop()) && $post->ID === (int) $id
-            ? espresso_event_status_banner($post->ID) . $title
-            : $title;
-    }
-
-
-    /**
-     * get_the_excerpt
-     * kinda hacky, but if a theme is using get_the_excerpt(),
-     * then we need to remove our filters on the_content()
-     *
-     * @param        string $excerpt
-     * @return        string
-     */
-    public static function get_the_excerpt($excerpt = '')
-    {
-        EED_Event_Single::$using_get_the_excerpt = true;
-        add_filter('wp_trim_excerpt', array('EED_Event_Single', 'end_get_the_excerpt'), 999, 1);
-        return $excerpt;
-    }
-
-
-    /**
-     * end_get_the_excerpt
-     *
-     * @param  string $text
-     * @return string
-     */
-    public static function end_get_the_excerpt($text = '')
-    {
-        EED_Event_Single::$using_get_the_excerpt = false;
-        return $text;
-    }
-
-
-    /**
-     * event_details
-     *
-     * @param    string $content
-     * @return    string
-     */
-    public static function event_details($content)
-    {
-        global $post;
-        static $current_post_ID = 0;
-        if (
-            $current_post_ID !== $post->ID
-            && $post->post_type === EspressoPostType::EVENTS
-            && ! EED_Event_Single::$using_get_the_excerpt
-            && ! post_password_required()
-        ) {
-            // Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
-            // Reason being is that some plugins, like Yoast, need to run through a copy of the loop early
-            // BEFORE headers are sent in order to examine the post content and generate content for the HTML header.
-            // We want to allow those plugins to still do their thing and have access to our content, but depending on
-            // how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
-            // so the following allows this filter to be applied multiple times, but only once for real
-            $current_post_ID = did_action('loop_start') ? $post->ID : 0;
-            if (EE_Registry::instance()->CFG->template_settings->EED_Event_Single->use_sortable_display_order) {
-                // we need to first remove this callback from being applied to the_content()
-                // (otherwise it will recurse and blow up the interweb)
-                remove_filter(
-                    'the_content',
-                    array('EED_Event_Single', 'event_details'),
-                    EED_Event_Single::EVENT_DETAILS_PRIORITY
-                );
-                EED_Event_Single::instance()->template_parts = EED_Event_Single::instance()->initialize_template_parts(
-                );
-                $content = EEH_Template::locate_template('content-espresso_events-details.php');
-                $content = EED_Event_Single::instance()->template_parts->apply_template_part_filters($content);
-                add_filter(
-                    'the_content',
-                    array('EED_Event_Single', 'event_details'),
-                    EED_Event_Single::EVENT_DETAILS_PRIORITY
-                );
-            } else {
-                $content = EED_Event_Single::use_filterable_display_order();
-            }
-        }
-        return $content;
-    }
-
-
-    /**
-     * use_filterable_display_order
-     *
-     * @return string
-     */
-    protected static function use_filterable_display_order()
-    {
-        // since the 'content-espresso_events-details.php' template might be used directly from within a theme,
-        // it uses the_content() for displaying the $post->post_content
-        // so in order to load a template that uses the_content()
-        // from within a callback being used to filter the_content(),
-        // we need to first remove this callback from being applied to the_content()
-        // (otherwise it will recurse and blow up the interweb)
-        remove_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_details'),
-            EED_Event_Single::EVENT_DETAILS_PRIORITY
-        );
-        // now add additional content
-        add_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_datetimes'),
-            EED_Event_Single::EVENT_DATETIMES_PRIORITY,
-            1
-        );
-        add_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_tickets'),
-            EED_Event_Single::EVENT_TICKETS_PRIORITY,
-            1
-        );
-        add_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_venues'),
-            EED_Event_Single::EVENT_VENUES_PRIORITY,
-            1
-        );
-        do_action('AHEE__EED_Event_Single__use_filterable_display_order__after_add_filters');
-        // now load our template
-        $content = EEH_Template::locate_template('content-espresso_events-details.php');
-        // now add our filter back in, plus some others
-        add_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_details'),
-            EED_Event_Single::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_datetimes'),
-            EED_Event_Single::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_tickets'),
-            EED_Event_Single::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_venues'),
-            EED_Event_Single::EVENT_VENUES_PRIORITY
-        );
-        do_action('AHEE__EED_Event_Single__use_filterable_display_order__after_remove_filters');
-        // we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
-        return $content;
-    }
-
-
-    /**
-     * event_datetimes - adds datetimes ABOVE content
-     *
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_datetimes($content)
-    {
-        return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
-    }
-
-
-    /**
-     * event_tickets - adds tickets ABOVE content (which includes datetimes)
-     *
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_tickets($content)
-    {
-        return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
-    }
-
-
-    /**
-     * event_venues
-     *
-     * @param    string $content
-     * @return    string
-     */
-    public static function event_venue($content)
-    {
-        return EED_Event_Single::event_venues($content);
-    }
-
-
-    /**
-     * event_venues - adds venues BELOW content
-     *
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_venues($content)
-    {
-        return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
-    }
-
-
-    /**
-     * loop_end
-     *
-     * @param        array $wp_query_array an array containing the WP_Query object
-     * @return        void
-     */
-    public static function loop_end($wp_query_array)
-    {
-        global $post;
-        do_action('AHEE_event_details_after_post', $post, $wp_query_array);
-    }
-
-
-    /**
-     * wp_enqueue_scripts
-     *
-     * @return    void
-     */
-    public function wp_enqueue_scripts()
-    {
-        // get some style
-        if (
-            apply_filters('FHEE_enable_default_espresso_css', true)
-            && apply_filters('FHEE__EED_Event_Single__wp_enqueue_scripts__enable_css', true)
-        ) {
-            // first check uploads folder
-            if (is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
-                wp_register_style(
-                    $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
-                    array('dashicons', 'espresso_default')
-                );
-            } else {
-                wp_register_style(
-                    $this->theme,
-                    EE_TEMPLATES_URL . $this->theme . '/style.css',
-                    array('dashicons', 'espresso_default')
-                );
-            }
-            wp_enqueue_script($this->theme);
-            if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
-                add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
-            }
-        }
-    }
-
-
-    /**
-     * display_venue
-     *
-     * @return    bool
-     */
-    public static function display_venue()
-    {
-        /** @type EE_Event_Single_Config $config */
-        $config = EED_Event_Single::instance()->config();
-        $display_venue = $config->display_venue === null ? true : $config->display_venue;
-        $venue_name = EEH_Venue_View::venue_name();
-        return $display_venue && ! empty($venue_name);
-    }
+	const EVENT_DETAILS_PRIORITY = 100;
+	const EVENT_DATETIMES_PRIORITY = 110;
+	const EVENT_TICKETS_PRIORITY = 120;
+	const EVENT_VENUES_PRIORITY = 130;
+
+	/**
+	 * @type bool $using_get_the_excerpt
+	 */
+	protected static $using_get_the_excerpt = false;
+
+
+	/**
+	 * @type EE_Template_Part_Manager $template_parts
+	 */
+	protected $template_parts;
+
+
+	/**
+	 * @return EED_Module|EED_Event_Single
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function set_hooks()
+	{
+		add_filter('FHEE_run_EE_wp', '__return_true');
+		add_action('wp_loaded', array('EED_Event_Single', 'set_definitions'), 2);
+		/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_type_definitions */
+		$custom_post_type_definitions = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+		);
+		$custom_post_types = $custom_post_type_definitions->getDefinitions();
+		EED_Module::registerRoute(
+			$custom_post_types[ EspressoPostType::EVENTS ]['singular_slug'],
+			'Event_Single',
+			'run'
+		);
+	}
+
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('wp_loaded', array('EED_Event_Single', 'set_definitions'), 2);
+	}
+
+
+	/**
+	 * set_definitions
+	 *
+	 * @static
+	 * @return void
+	 */
+	public static function set_definitions()
+	{
+		define('EVENT_SINGLE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+		define('EVENT_SINGLE_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
+	}
+
+
+	/**
+	 * set_config
+	 *
+	 * @void
+	 */
+	protected function set_config()
+	{
+		$this->set_config_section('template_settings');
+		$this->set_config_class('EE_Event_Single_Config');
+		$this->set_config_name('EED_Event_Single');
+	}
+
+
+	/**
+	 * initialize_template_parts
+	 *
+	 * @param EE_Config_Base|EE_Event_Single_Config $config
+	 * @return EE_Template_Part_Manager
+	 * @throws EE_Error
+	 */
+	public function initialize_template_parts(EE_Event_Single_Config $config = null)
+	{
+		/** @type EE_Event_Single_Config $config */
+		$config = $config instanceof EE_Event_Single_Config ? $config : $this->config();
+		EEH_Autoloader::register_template_part_autoloaders();
+		$template_parts = new EE_Template_Part_Manager();
+		$template_parts->add_template_part(
+			'tickets',
+			esc_html__('Ticket Selector', 'event_espresso'),
+			'content-espresso_events-tickets.php',
+			$config->display_order_tickets
+		);
+		$template_parts->add_template_part(
+			'datetimes',
+			esc_html__('Dates and Times', 'event_espresso'),
+			'content-espresso_events-datetimes.php',
+			$config->display_order_datetimes
+		);
+		$template_parts->add_template_part(
+			'event',
+			esc_html__('Event Description', 'event_espresso'),
+			'content-espresso_events-details.php',
+			$config->display_order_event
+		);
+		$template_parts->add_template_part(
+			'venue',
+			esc_html__('Venue Information', 'event_espresso'),
+			'content-espresso_events-venues.php',
+			$config->display_order_venue
+		);
+		do_action('AHEE__EED_Event_Single__initialize_template_parts', $template_parts);
+		return $template_parts;
+	}
+
+
+	/**
+	 * run - initial module setup
+	 *
+	 * @param WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+		// ensure valid EE_Events_Single_Config() object exists
+		$this->set_config();
+		// check what template is loaded
+		add_filter('template_include', array($this, 'template_include'), 999, 1);
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		// load css
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
+	}
+
+
+	/**
+	 * template_include
+	 *
+	 * @param    string $template
+	 * @return    string
+	 */
+	public function template_include($template)
+	{
+		global $post;
+		/** @type EE_Event_Single_Config $config */
+		$config = $this->config();
+		if ($config->display_status_banner_single) {
+			add_filter('the_title', array('EED_Event_Single', 'the_title'), 100, 2);
+		}
+		// not a custom template?
+		if (
+			! post_password_required($post)
+			&& (
+				apply_filters('FHEE__EED_Event_Single__template_include__allow_custom_selected_template', false)
+				|| EE_Registry::instance()
+							  ->load_core('Front_Controller')
+							  ->get_selected_template() !== 'single-espresso_events.php'
+			)
+		) {
+			EEH_Template::load_espresso_theme_functions();
+			// then add extra event data via hooks
+			add_action('loop_start', array('EED_Event_Single', 'loop_start'));
+			add_filter('get_the_excerpt', array('EED_Event_Single', 'get_the_excerpt'), 1, 1);
+			add_filter(
+				'the_content',
+				array('EED_Event_Single', 'event_details'),
+				EED_Event_Single::EVENT_DETAILS_PRIORITY
+			);
+			add_action('loop_end', array('EED_Event_Single', 'loop_end'));
+			// don't display entry meta because the existing theme will take car of that
+			add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
+		}
+		return $template;
+	}
+
+
+	/**
+	 * @param WP_Query $query
+	 * @return void
+	 */
+	public static function loop_start(WP_Query $query)
+	{
+		if (! $query->is_main_query()) {
+			return;
+		}
+		global $post;
+		do_action('AHEE_event_details_before_post', $post, $query);
+	}
+
+
+	/**
+	 * the_title
+	 *
+	 * @param    string $title
+	 * @param    int    $id
+	 * @return    string
+	 */
+	public static function the_title($title = '', $id = 0)
+	{
+		global $post;
+		return ((function_exists('wp_is_block_theme') && wp_is_block_theme()) || in_the_loop()) && $post->ID === (int) $id
+			? espresso_event_status_banner($post->ID) . $title
+			: $title;
+	}
+
+
+	/**
+	 * get_the_excerpt
+	 * kinda hacky, but if a theme is using get_the_excerpt(),
+	 * then we need to remove our filters on the_content()
+	 *
+	 * @param        string $excerpt
+	 * @return        string
+	 */
+	public static function get_the_excerpt($excerpt = '')
+	{
+		EED_Event_Single::$using_get_the_excerpt = true;
+		add_filter('wp_trim_excerpt', array('EED_Event_Single', 'end_get_the_excerpt'), 999, 1);
+		return $excerpt;
+	}
+
+
+	/**
+	 * end_get_the_excerpt
+	 *
+	 * @param  string $text
+	 * @return string
+	 */
+	public static function end_get_the_excerpt($text = '')
+	{
+		EED_Event_Single::$using_get_the_excerpt = false;
+		return $text;
+	}
+
+
+	/**
+	 * event_details
+	 *
+	 * @param    string $content
+	 * @return    string
+	 */
+	public static function event_details($content)
+	{
+		global $post;
+		static $current_post_ID = 0;
+		if (
+			$current_post_ID !== $post->ID
+			&& $post->post_type === EspressoPostType::EVENTS
+			&& ! EED_Event_Single::$using_get_the_excerpt
+			&& ! post_password_required()
+		) {
+			// Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
+			// Reason being is that some plugins, like Yoast, need to run through a copy of the loop early
+			// BEFORE headers are sent in order to examine the post content and generate content for the HTML header.
+			// We want to allow those plugins to still do their thing and have access to our content, but depending on
+			// how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
+			// so the following allows this filter to be applied multiple times, but only once for real
+			$current_post_ID = did_action('loop_start') ? $post->ID : 0;
+			if (EE_Registry::instance()->CFG->template_settings->EED_Event_Single->use_sortable_display_order) {
+				// we need to first remove this callback from being applied to the_content()
+				// (otherwise it will recurse and blow up the interweb)
+				remove_filter(
+					'the_content',
+					array('EED_Event_Single', 'event_details'),
+					EED_Event_Single::EVENT_DETAILS_PRIORITY
+				);
+				EED_Event_Single::instance()->template_parts = EED_Event_Single::instance()->initialize_template_parts(
+				);
+				$content = EEH_Template::locate_template('content-espresso_events-details.php');
+				$content = EED_Event_Single::instance()->template_parts->apply_template_part_filters($content);
+				add_filter(
+					'the_content',
+					array('EED_Event_Single', 'event_details'),
+					EED_Event_Single::EVENT_DETAILS_PRIORITY
+				);
+			} else {
+				$content = EED_Event_Single::use_filterable_display_order();
+			}
+		}
+		return $content;
+	}
+
+
+	/**
+	 * use_filterable_display_order
+	 *
+	 * @return string
+	 */
+	protected static function use_filterable_display_order()
+	{
+		// since the 'content-espresso_events-details.php' template might be used directly from within a theme,
+		// it uses the_content() for displaying the $post->post_content
+		// so in order to load a template that uses the_content()
+		// from within a callback being used to filter the_content(),
+		// we need to first remove this callback from being applied to the_content()
+		// (otherwise it will recurse and blow up the interweb)
+		remove_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_details'),
+			EED_Event_Single::EVENT_DETAILS_PRIORITY
+		);
+		// now add additional content
+		add_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_datetimes'),
+			EED_Event_Single::EVENT_DATETIMES_PRIORITY,
+			1
+		);
+		add_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_tickets'),
+			EED_Event_Single::EVENT_TICKETS_PRIORITY,
+			1
+		);
+		add_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_venues'),
+			EED_Event_Single::EVENT_VENUES_PRIORITY,
+			1
+		);
+		do_action('AHEE__EED_Event_Single__use_filterable_display_order__after_add_filters');
+		// now load our template
+		$content = EEH_Template::locate_template('content-espresso_events-details.php');
+		// now add our filter back in, plus some others
+		add_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_details'),
+			EED_Event_Single::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_datetimes'),
+			EED_Event_Single::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_tickets'),
+			EED_Event_Single::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_venues'),
+			EED_Event_Single::EVENT_VENUES_PRIORITY
+		);
+		do_action('AHEE__EED_Event_Single__use_filterable_display_order__after_remove_filters');
+		// we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
+		return $content;
+	}
+
+
+	/**
+	 * event_datetimes - adds datetimes ABOVE content
+	 *
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_datetimes($content)
+	{
+		return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
+	}
+
+
+	/**
+	 * event_tickets - adds tickets ABOVE content (which includes datetimes)
+	 *
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_tickets($content)
+	{
+		return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
+	}
+
+
+	/**
+	 * event_venues
+	 *
+	 * @param    string $content
+	 * @return    string
+	 */
+	public static function event_venue($content)
+	{
+		return EED_Event_Single::event_venues($content);
+	}
+
+
+	/**
+	 * event_venues - adds venues BELOW content
+	 *
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_venues($content)
+	{
+		return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
+	}
+
+
+	/**
+	 * loop_end
+	 *
+	 * @param        array $wp_query_array an array containing the WP_Query object
+	 * @return        void
+	 */
+	public static function loop_end($wp_query_array)
+	{
+		global $post;
+		do_action('AHEE_event_details_after_post', $post, $wp_query_array);
+	}
+
+
+	/**
+	 * wp_enqueue_scripts
+	 *
+	 * @return    void
+	 */
+	public function wp_enqueue_scripts()
+	{
+		// get some style
+		if (
+			apply_filters('FHEE_enable_default_espresso_css', true)
+			&& apply_filters('FHEE__EED_Event_Single__wp_enqueue_scripts__enable_css', true)
+		) {
+			// first check uploads folder
+			if (is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+				wp_register_style(
+					$this->theme,
+					get_stylesheet_directory_uri() . $this->theme . '/style.css',
+					array('dashicons', 'espresso_default')
+				);
+			} else {
+				wp_register_style(
+					$this->theme,
+					EE_TEMPLATES_URL . $this->theme . '/style.css',
+					array('dashicons', 'espresso_default')
+				);
+			}
+			wp_enqueue_script($this->theme);
+			if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
+				add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
+			}
+		}
+	}
+
+
+	/**
+	 * display_venue
+	 *
+	 * @return    bool
+	 */
+	public static function display_venue()
+	{
+		/** @type EE_Event_Single_Config $config */
+		$config = EED_Event_Single::instance()->config();
+		$display_venue = $config->display_venue === null ? true : $config->display_venue;
+		$venue_name = EEH_Venue_View::venue_name();
+		return $display_venue && ! empty($venue_name);
+	}
 }
 
 
@@ -495,5 +495,5 @@ 
  */
 function espresso_display_venue_in_event_details()
 {
-    return EED_Event_Single::display_venue();
+	return EED_Event_Single::display_venue();
 }

Spacing +11 added lines, -11 removed lines

@@ -58,7 +58,7 @@ 
         );
         $custom_post_types = $custom_post_type_definitions->getDefinitions();
         EED_Module::registerRoute(
-            $custom_post_types[ EspressoPostType::EVENTS ]['singular_slug'],
+            $custom_post_types[EspressoPostType::EVENTS]['singular_slug'],
             'Event_Single',
             'run'
         );
@@ -83,8 +83,8 @@ 
      */
     public static function set_definitions()
     {
-        define('EVENT_SINGLE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define('EVENT_SINGLE_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
+        define('EVENT_SINGLE_ASSETS_URL', plugin_dir_url(__FILE__).'assets/');
+        define('EVENT_SINGLE_TEMPLATES_PATH', plugin_dir_path(__FILE__).'templates/');
     }
 
 
@@ -208,7 +208,7 @@ 
      */
     public static function loop_start(WP_Query $query)
     {
-        if (! $query->is_main_query()) {
+        if ( ! $query->is_main_query()) {
             return;
         }
         global $post;
@@ -227,7 +227,7 @@ 
     {
         global $post;
         return ((function_exists('wp_is_block_theme') && wp_is_block_theme()) || in_the_loop()) && $post->ID === (int) $id
-            ? espresso_event_status_banner($post->ID) . $title
+            ? espresso_event_status_banner($post->ID).$title
             : $title;
     }
 
@@ -384,7 +384,7 @@ 
      */
     public static function event_datetimes($content)
     {
-        return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
+        return EEH_Template::locate_template('content-espresso_events-datetimes.php').$content;
     }
 
 
@@ -396,7 +396,7 @@ 
      */
     public static function event_tickets($content)
     {
-        return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
+        return EEH_Template::locate_template('content-espresso_events-tickets.php').$content;
     }
 
 
@@ -420,7 +420,7 @@ 
      */
     public static function event_venues($content)
     {
-        return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
+        return $content.EEH_Template::locate_template('content-espresso_events-venues.php');
     }
 
 
@@ -450,16 +450,16 @@ 
             && apply_filters('FHEE__EED_Event_Single__wp_enqueue_scripts__enable_css', true)
         ) {
             // first check uploads folder
-            if (is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+            if (is_readable(get_stylesheet_directory().$this->theme.'/style.css')) {
                 wp_register_style(
                     $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
+                    get_stylesheet_directory_uri().$this->theme.'/style.css',
                     array('dashicons', 'espresso_default')
                 );
             } else {
                 wp_register_style(
                     $this->theme,
-                    EE_TEMPLATES_URL . $this->theme . '/style.css',
+                    EE_TEMPLATES_URL.$this->theme.'/style.css',
                     array('dashicons', 'espresso_default')
                 );
             }

modules/single_page_checkout/EED_Single_Page_Checkout.module.php

Indentation +1679 added lines, -1679 removed lines

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

Spacing +50 added lines, -50 removed lines

@@ -51,7 +51,7 @@ 
 
     public ?EE_Session $session = null;
 
-    private bool $debug = false;    //  true    false
+    private bool $debug = false; //  true    false
 
 
     /**
@@ -115,7 +115,7 @@ 
     public static function set_hooks_admin()
     {
         EED_Single_Page_Checkout::set_definitions();
-        if (! (defined('DOING_AJAX') && DOING_AJAX)) {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX)) {
             return;
         }
         // going to start an output buffer in case anything gets accidentally output
@@ -209,14 +209,14 @@ 
         }
         define(
             'SPCO_BASE_PATH',
-            rtrim(str_replace(['\\', '/'], '/', plugin_dir_path(__FILE__)), '/') . '/'
+            rtrim(str_replace(['\\', '/'], '/', plugin_dir_path(__FILE__)), '/').'/'
         );
-        define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css/');
-        define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img/');
-        define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js/');
-        define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc/');
-        define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps/');
-        define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates/');
+        define('SPCO_CSS_URL', plugin_dir_url(__FILE__).'css/');
+        define('SPCO_IMG_URL', plugin_dir_url(__FILE__).'img/');
+        define('SPCO_JS_URL', plugin_dir_url(__FILE__).'js/');
+        define('SPCO_INC_PATH', SPCO_BASE_PATH.'inc/');
+        define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH.'reg_steps/');
+        define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH.'templates/');
         EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true);
         EE_Registry::$i18n_js_strings['registration_expiration_notice'] =
             EED_Single_Page_Checkout::getRegistrationExpirationNotice();
@@ -247,7 +247,7 @@ 
             // we need a
             if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
                 // copy over to the reg_steps_array
-                EED_Single_Page_Checkout::$_reg_steps_array[ $order ] = $reg_step;
+                EED_Single_Page_Checkout::$_reg_steps_array[$order] = $reg_step;
                 // register custom key route for each reg step
                 // ie: step=>"slug" - this is the entire reason we load the reg steps array now
                 EED_Module::registerRoute(
@@ -259,7 +259,7 @@ 
                 // add AJAX or other hooks
                 if (isset($reg_step['has_hooks']) && $reg_step['has_hooks']) {
                     // setup autoloaders if necessary
-                    if (! class_exists($reg_step['class_name'])) {
+                    if ( ! class_exists($reg_step['class_name'])) {
                         EEH_Autoloader::register_autoloaders_for_each_file_in_folder(
                             $reg_step['file_path'],
                             true
@@ -286,19 +286,19 @@ 
         if (empty($reg_steps)) {
             $reg_steps = [
                 10  => [
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'attendee_information',
+                    'file_path'  => SPCO_REG_STEPS_PATH.'attendee_information',
                     'class_name' => 'EE_SPCO_Reg_Step_Attendee_Information',
                     'slug'       => 'attendee_information',
                     'has_hooks'  => false,
                 ],
                 30  => [
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'payment_options',
+                    'file_path'  => SPCO_REG_STEPS_PATH.'payment_options',
                     'class_name' => 'EE_SPCO_Reg_Step_Payment_Options',
                     'slug'       => 'payment_options',
                     'has_hooks'  => true,
                 ],
                 999 => [
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'finalize_registration',
+                    'file_path'  => SPCO_REG_STEPS_PATH.'finalize_registration',
                     'class_name' => 'EE_SPCO_Reg_Step_Finalize_Registration',
                     'slug'       => 'finalize_registration',
                     'has_hooks'  => false,
@@ -444,7 +444,7 @@ 
                 $this->checkout
             );
             // load the reg steps array
-            if (! $this->_load_and_instantiate_reg_steps()) {
+            if ( ! $this->_load_and_instantiate_reg_steps()) {
                 EED_Single_Page_Checkout::$_initialized = true;
                 return;
             }
@@ -453,7 +453,7 @@ 
             // and the next step
             $this->checkout->set_next_step();
             // verify that everything has been set up correctly
-            if (! ($this->_verify_transaction_and_get_registrations() && $this->_final_verifications())) {
+            if ( ! ($this->_verify_transaction_and_get_registrations() && $this->_final_verifications())) {
                 EED_Single_Page_Checkout::$_initialized = true;
                 return;
             }
@@ -468,7 +468,7 @@ 
             // DEBUG LOG
             // $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
             // get reg form
-            if (! $this->_check_form_submission()) {
+            if ( ! $this->_check_form_submission()) {
                 EED_Single_Page_Checkout::$_initialized = true;
                 return;
             }
@@ -496,9 +496,9 @@ 
      */
     private function _verify_session()
     {
-        if (! $this->session instanceof EE_Session) {
+        if ( ! $this->session instanceof EE_Session) {
             $this->session = LoaderFactory::getShared(EE_Session::class);
-            if (! $this->session instanceof EE_Session) {
+            if ( ! $this->session instanceof EE_Session) {
                 throw new EE_Error(esc_html__('The EE_Session class could not be loaded.', 'event_espresso'));
             }
         }
@@ -513,7 +513,7 @@ 
         ) {
             $this->checkout = new EE_Checkout();
             $this->session->clear_session(__CLASS__, __FUNCTION__);
-            if (! $clear_session_requested) {
+            if ( ! $clear_session_requested) {
                 EE_Error::add_attention(
                     EE_Registry::$i18n_js_strings['registration_expiration_notice'],
                     __FILE__,
@@ -538,7 +538,7 @@ 
         /** @type EE_Checkout $checkout */
         $checkout = $this->session->checkout();
         // verify
-        if (! $checkout instanceof EE_Checkout) {
+        if ( ! $checkout instanceof EE_Checkout) {
             // instantiate EE_Checkout object for handling the properties of the current checkout process
             $checkout = EE_Registry::instance()->load_file(
                 SPCO_INC_PATH,
@@ -556,7 +556,7 @@ 
         }
         $checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize_checkout__checkout', $checkout);
         // verify again
-        if (! $checkout instanceof EE_Checkout) {
+        if ( ! $checkout instanceof EE_Checkout) {
             throw new EE_Error(esc_html__('The EE_Checkout class could not be loaded.', 'event_espresso'));
         }
         // reset anything that needs a clean slate for each request
@@ -613,7 +613,7 @@ 
      */
     protected function _display_request_vars()
     {
-        if (! ($this->debug && defined('WP_DEBUG') && WP_DEBUG)) {
+        if ( ! ($this->debug && defined('WP_DEBUG') && WP_DEBUG)) {
             return;
         }
         EEH_Debug_Tools::printr($this->request->requestParams(), 'requestParams', __FILE__, __LINE__);
@@ -685,7 +685,7 @@ 
         ) {
             // if not, then loop through raw reg steps array
             foreach (EED_Single_Page_Checkout::$_reg_steps_array as $order => $reg_step) {
-                if (! $this->_load_and_instantiate_reg_step($reg_step, $order)) {
+                if ( ! $this->_load_and_instantiate_reg_step($reg_step, $order)) {
                     return false;
                 }
             }
@@ -807,12 +807,12 @@ 
     private function _verify_transaction_and_get_registrations(): bool
     {
         // was there already a valid transaction in the checkout from the session ?
-        if (! $this->checkout->transaction instanceof EE_Transaction) {
+        if ( ! $this->checkout->transaction instanceof EE_Transaction) {
             // get transaction from db or session
             $this->checkout->transaction = $this->checkout->reg_url_link && ! is_admin()
                 ? $this->_get_transaction_and_cart_for_previous_visit()
                 : $this->_get_cart_for_current_session_and_setup_new_transaction();
-            if (! $this->checkout->transaction instanceof EE_Transaction) {
+            if ( ! $this->checkout->transaction instanceof EE_Transaction) {
                 EE_Error::add_error(
                     esc_html__(
                         'Your Registration and Transaction information could not be retrieved from the db.',
@@ -1037,10 +1037,10 @@ 
                     );
                 }
                 $registration = EE_Registry::instance()->BUS->execute($CreateRegistrationCommand);
-                if (! $registration instanceof EE_Registration) {
+                if ( ! $registration instanceof EE_Registration) {
                     throw new InvalidEntityException($registration, 'EE_Registration');
                 }
-                $registrations[ $registration->ID() ] = $registration;
+                $registrations[$registration->ID()] = $registration;
             }
         }
         $registration_processor->fix_reg_final_price_rounding_issue($transaction);
@@ -1080,7 +1080,7 @@ 
             $this->checkout
         );
         // verify that current step is still set correctly
-        if (! $this->checkout->current_step instanceof EE_SPCO_Reg_Step) {
+        if ( ! $this->checkout->current_step instanceof EE_SPCO_Reg_Step) {
             EE_Error::add_error(
                 esc_html__(
                     'We\'re sorry but the registration process can not proceed because one or more registration steps were not setup correctly. Please refresh the page and try again or contact support.',
@@ -1093,9 +1093,9 @@ 
             return false;
         }
         // if returning to SPCO, then verify that primary registrant is set
-        if (! empty($this->checkout->reg_url_link)) {
+        if ( ! empty($this->checkout->reg_url_link)) {
             $valid_registrant = $this->checkout->transaction->primary_registration();
-            if (! $valid_registrant instanceof EE_Registration) {
+            if ( ! $valid_registrant instanceof EE_Registration) {
                 EE_Error::add_error(
                     esc_html__(
                         'We\'re sorry but there appears to be an error with the "reg_url_link" or the primary registrant for this transaction. Please refresh the page and try again or contact support.',
@@ -1120,7 +1120,7 @@ 
                     $valid_registrant = $registration;
                 }
             }
-            if (! $valid_registrant instanceof EE_Registration) {
+            if ( ! $valid_registrant instanceof EE_Registration) {
                 // hmmm... maybe we have the wrong session because the user is opening multiple tabs ?
                 if (EED_Single_Page_Checkout::$_checkout_verified) {
                     // clear the session, mark the checkout as unverified, and try again
@@ -1163,9 +1163,9 @@ 
         $this->checkout->set_reg_step_initiated($this->checkout->current_step);
         // loop thru all steps to call their individual "initialize" methods and set i18n strings for JS
         foreach ($this->checkout->reg_steps as $reg_step) {
-            if (! $reg_step->initialize_reg_step()) {
+            if ( ! $reg_step->initialize_reg_step()) {
                 // if not initialized then maybe this step is being removed...
-                if (! $reinitializing && $reg_step->is_current_step()) {
+                if ( ! $reinitializing && $reg_step->is_current_step()) {
                     // if it was the current step, then we need to start over here
                     $this->_initialize_reg_steps(true);
                     return;
@@ -1224,7 +1224,7 @@ 
                         )
                     );
                     // validate submitted form data
-                    if (! $this->checkout->continue_reg || ! $this->checkout->current_step->reg_form->is_valid()) {
+                    if ( ! $this->checkout->continue_reg || ! $this->checkout->current_step->reg_form->is_valid()) {
                         // thou shall not pass !!!
                         $this->checkout->continue_reg = false;
                         // any form validation errors?
@@ -1298,7 +1298,7 @@ 
                         ) {
                             EE_Error::add_success(
                                 $this->checkout->current_step->success_message()
-                                . '<br />' . $this->checkout->next_step->_instructions()
+                                . '<br />'.$this->checkout->next_step->_instructions()
                             );
                         }
                         // pack it up, pack it in...
@@ -1362,27 +1362,27 @@ 
             'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['invalid_json_response']          = esc_html__(
+        EE_Registry::$i18n_js_strings['invalid_json_response'] = esc_html__(
             'An invalid response was returned from the server while attempting to process your request. Please refresh the page and try again or contact support.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['validation_error']               = esc_html__(
+        EE_Registry::$i18n_js_strings['validation_error'] = esc_html__(
             'There appears to be a problem with the form validation configuration! Please check the admin settings or contact support.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['invalid_payment_method']         = esc_html__(
+        EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
             'There appears to be a problem with the payment method configuration! Please refresh the page and try again or contact support.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['reg_step_error']                 = esc_html__(
+        EE_Registry::$i18n_js_strings['reg_step_error'] = esc_html__(
             'This registration step could not be completed. Please refresh the page and try again.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['invalid_coupon']                 = esc_html__(
+        EE_Registry::$i18n_js_strings['invalid_coupon'] = esc_html__(
             'We\'re sorry but that coupon code does not appear to be valid. If this is incorrect, please contact the site administrator.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['process_registration']           = sprintf(
+        EE_Registry::$i18n_js_strings['process_registration'] = sprintf(
             esc_html__(
                 'Please wait while we process your registration.%sDo not refresh the page or navigate away while this is happening.%sThank you for your patience.',
                 'event_espresso'
@@ -1414,7 +1414,7 @@ 
             'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
             true
         );
-        EE_Registry::$i18n_js_strings['session_extension']              = absint(
+        EE_Registry::$i18n_js_strings['session_extension'] = absint(
             apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS)
         );
         EE_Registry::$i18n_js_strings['session_expiration']    = $this->session->expiration();
@@ -1432,7 +1432,7 @@ 
         // load css
         wp_register_style(
             'single_page_checkout',
-            SPCO_CSS_URL . 'single_page_checkout.css',
+            SPCO_CSS_URL.'single_page_checkout.css',
             ['espresso_default'],
             EVENT_ESPRESSO_VERSION
         );
@@ -1440,7 +1440,7 @@ 
         // load JS
         wp_register_script(
             'single_page_checkout',
-            SPCO_JS_URL . 'single_page_checkout.js',
+            SPCO_JS_URL.'single_page_checkout.js',
             ['espresso_core', 'underscore', 'ee_form_section_validation'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -1463,7 +1463,7 @@ 
          *      AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information
          */
         do_action(
-            'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__' . $this->checkout->current_step->slug(),
+            'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__'.$this->checkout->current_step->slug(),
             $this
         );
     }
@@ -1529,7 +1529,7 @@ 
         ) {
             add_filter(
                 'FHEE__EEH_Template__powered_by_event_espresso__url',
-                function ($url) {
+                function($url) {
                     return apply_filters('FHEE__EE_Front_Controller__registration_footer__url', $url);
                 }
             );
@@ -1559,7 +1559,7 @@ 
             add_action('shutdown', [$this, 'unlock_transaction'], 1);
             add_filter(
                 'wp_redirect',
-                function (string $location) {
+                function(string $location) {
                     // this is hacky, but WP doesn't supply an action to hook into before the redirect
                     $this->unlock_transaction();
                     return $location;
@@ -1675,7 +1675,7 @@ 
      */
     public function set_checkout_anchor(WP_Query $query)
     {
-        if (! $query->is_main_query()) {
+        if ( ! $query->is_main_query()) {
             return;
         }
         echo '<a id="checkout" class="screen-reader-text"></a>';
@@ -1697,7 +1697,7 @@ 
             '</h4>',
             '<br />',
             '<p>',
-            '<a href="' . get_post_type_archive_link(EspressoPostType::EVENTS) . '" title="',
+            '<a href="'.get_post_type_archive_link(EspressoPostType::EVENTS).'" title="',
             '">',
             '</a>',
             '</p>'

modules/single_page_checkout/inc/EE_Checkout.class.php

Indentation +1432 added lines, -1432 removed lines

@@ -14,1437 +14,1437 @@
  */
 class EE_Checkout
 {
-    /**
-     *    whether current request originated from the EE admin
-     *
-     * @var bool
-     */
-    public $admin_request = false;
-
-    /**
-     * whether returning to edit attendee information or to retry a payment
-     *
-     * @var bool
-     */
-    public $revisit = false;
-
-    /**
-     * whether the primary registrant is returning to edit attendee information or to retry a payment
-     *
-     * @var bool
-     */
-    public $primary_revisit = false;
-
-    /**
-     * is registration allowed to progress or halted for some reason such as failing to pass recaptcha?
-     *
-     * @var bool
-     */
-    public $continue_reg = true;
-
-    /**
-     * redirect to thank you page ?
-     *
-     * @var bool
-     */
-    public $redirect = false;
-
-    /**
-     * generate the reg form or not ?
-     *
-     * @var bool
-     */
-    public $generate_reg_form = true;
-
-    /**
-     * process a reg form submission or not ?
-     *
-     * @var bool
-     */
-    public $process_form_submission = false;
-
-    /**
-     * tracks whether the TXN status modified during this checkout
-     *
-     * @var bool
-     */
-    public $txn_status_updated = false;
-
-    /**
-     * only triggered to true after absolutely everything has finished.
-     *
-     * @var bool
-     */
-    protected $exit_spco = false;
-
-    /**
-     * tracks whether any of the TXN's Registrations statuses modified during this checkout
-     * indexed by registration ID
-     *
-     * @var array
-     */
-    protected $reg_status_updated = array();
-
-    /**
-     * timestamp when redirected from Ticket Selector to the checkout
-     *
-     * @var int
-     */
-    public $uts = 0;
-
-    /**
-     * total number of tickets that were in the cart
-     *
-     * @var int
-     */
-    public $total_ticket_count = 0;
-
-    /**
-     * corresponds loosely to EE_Transaction::remaining()
-     * but can be modified by SPCO
-     *
-     * @var float
-     */
-    public $amount_owing = 0;
-
-    /**
-     * the reg step slug from the incoming request
-     *
-     * @var string
-     */
-    public $step = '';
-
-    /**
-     * the reg step slug for a step being edited
-     *
-     * @var string
-     */
-    public $edit_step = '';
-
-    /**
-     * the action being performed on the current step
-     *
-     * @var string
-     */
-    public $action = '';
-
-    /**
-     * reg_url_link for a previously saved registration
-     *
-     * @var string
-     */
-    public $reg_url_link = '';
-
-    /**
-     * string slug for the payment method that was selected during the payment options step
-     *
-     * @var string
-     */
-    public $selected_method_of_payment = '';
-
-    /**
-     * base url for the site's registration checkout page - additional url params will be added to this
-     *
-     * @var string
-     */
-    public $reg_page_base_url = '';
-
-    /**
-     * base url for the site's registration cancelled page - additional url params will be added to this
-     *
-     * @var string
-     */
-    public $cancel_page_url = '';
-
-    /**
-     * base url for the site's thank you page - additional url params will be added to this
-     *
-     * @var string
-     */
-    public $thank_you_page_url = '';
-
-    /**
-     * base url for any redirects - additional url params will be added to this
-     *
-     * @var string
-     */
-    public $redirect_url = '';
-
-    /**
-     * form of POST data for use with off-site gateways
-     *
-     * @var string
-     */
-    public $redirect_form = '';
-
-    /**
-     * array of query where params to use when retrieving cached registrations from $this->checkout->transaction
-     *
-     * @var array
-     */
-    public $reg_cache_where_params = array();
-
-    /**
-     * a class for managing and creating the JSON encoded array of data that gets passed back to the client during AJAX
-     * requests
-     *
-     * @var EE_SPCO_JSON_Response
-     */
-    public $json_response;
-
-    /**
-     * where we are going next in the reg process
-     *
-     * @var EE_SPCO_Reg_Step
-     */
-    public $next_step;
-
-    /**
-     * where we are in the reg process
-     *
-     * @var EE_SPCO_Reg_Step
-     */
-    public $current_step;
-
-    /**
-     *    $_cart - the current cart object
-     *
-     * @var EE_CART
-     */
-    public $cart;
-
-    /**
-     *    $_transaction - the current transaction object
-     *
-     * @var EE_Transaction
-     */
-    public $transaction;
-
-    /**
-     *    the related attendee object for the primary registrant
-     *
-     * @var EE_Attendee
-     */
-    public $primary_attendee_obj;
-
-    /**
-     *    $payment_method - the payment method object for the selected method of payment
-     *
-     * @var EE_Payment_Method
-     */
-    public $payment_method;
-
-    /**
-     *    $payment - if a payment was successfully made during the reg process,
-     *    then here it is !!!
-     *
-     * @var EE_Payment
-     */
-    public $payment;
-
-    /**
-     *    if a payment method was selected that uses an on-site gateway, then this is the billing form
-     *
-     * @var EE_Billing_Info_Form|EE_Billing_Attendee_Info_Form
-     */
-    public $billing_form;
-
-    /**
-     *    the entire registration form composed of ALL of the subsections generated by the various reg steps
-     *
-     * @var EE_Form_Section_Proper
-     */
-    public $registration_form;
-
-    /**
-     * array of EE_SPCO_Reg_Step objects
-     *
-     * @var EE_SPCO_Reg_Step[]
-     */
-    public $reg_steps = array();
-
-    /**
-     * array of EE_Payment_Method objects
-     *
-     * @var EE_Payment_Method[]
-     */
-    public $available_payment_methods = array();
-
-    public ?EE_Payment_Method $default_payment_method = null;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        $this->reg_page_base_url = EE_Registry::instance()->CFG->core->reg_page_url();
-        $this->thank_you_page_url = EE_Registry::instance()->CFG->core->thank_you_page_url();
-        $this->cancel_page_url = EE_Registry::instance()->CFG->core->cancel_page_url();
-        $this->continue_reg = apply_filters('FHEE__EE_Checkout___construct___continue_reg', true);
-
-        $this->admin_request = is_admin() && ! EED_Single_Page_Checkout::getRequest()->isAjax();
-        $this->reg_cache_where_params = array(
-            0          => array('REG_deleted' => false),
-            'order_by' => array('REG_count' => 'ASC'),
-        );
-    }
-
-
-    /**
-     * returns true if ANY reg status was updated during checkout
-     *
-     * @return boolean
-     */
-    public function any_reg_status_updated()
-    {
-        foreach ($this->reg_status_updated as $reg_status) {
-            if ($reg_status) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * @param $REG_ID
-     * @return boolean
-     */
-    public function reg_status_updated($REG_ID)
-    {
-        return isset($this->reg_status_updated[ $REG_ID ]) ? $this->reg_status_updated[ $REG_ID ] : false;
-    }
-
-
-    /**
-     * @param $REG_ID
-     * @param $reg_status
-     */
-    public function set_reg_status_updated($REG_ID, $reg_status)
-    {
-        $this->reg_status_updated[ $REG_ID ] = filter_var($reg_status, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * exit_spco
-     *
-     * @return bool
-     */
-    public function exit_spco()
-    {
-        return $this->exit_spco;
-    }
-
-
-    /**
-     * set_exit_spco
-     * can ONLY be set by the  Finalize_Registration reg step
-     */
-    public function set_exit_spco()
-    {
-        if ($this->current_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) {
-            $this->exit_spco = true;
-        }
-    }
-
-
-    /**
-     *    reset_for_current_request
-     *
-     * @access    public
-     * @return    void
-     */
-    public function reset_for_current_request()
-    {
-        $this->process_form_submission = false;
-        $this->continue_reg = apply_filters('FHEE__EE_Checkout___construct___continue_reg', true);
-        $this->admin_request = is_admin() && ! EED_Single_Page_Checkout::getRequest()->isFrontAjax();
-        $this->continue_reg = true;
-        $this->redirect = false;
-        // don't reset the cached redirect form if we're about to be asked to display it !!!
-        $action = EED_Single_Page_Checkout::getRequest()->getRequestParam('action', 'display_spco_reg_step');
-        if ($action !== 'redirect_form') {
-            $this->redirect_form = '';
-        }
-        $this->redirect_url = '';
-        $this->json_response = new EE_SPCO_JSON_Response();
-        EE_Form_Section_Proper::reset_js_localization();
-    }
-
-
-    /**
-     *    add_reg_step
-     *
-     * @access    public
-     * @param EE_SPCO_Reg_Step $reg_step_obj
-     * @return    void
-     */
-    public function add_reg_step(EE_SPCO_Reg_Step $reg_step_obj)
-    {
-        $this->reg_steps[ $reg_step_obj->slug() ] = $reg_step_obj;
-    }
-
-
-    /**
-     * skip_reg_step
-     * if the current reg step does not need to run for some reason,
-     * then this will advance SPCO to the next reg step,
-     * and mark the skipped step as completed
-     *
-     * @access    public
-     * @param string $reg_step_slug
-     * @return    void
-     * @throws \EE_Error
-     */
-    public function skip_reg_step($reg_step_slug = '')
-    {
-        $step_to_skip = $this->find_reg_step($reg_step_slug);
-        if ($step_to_skip instanceof EE_SPCO_Reg_Step && $step_to_skip->is_current_step()) {
-            $step_to_skip->set_is_current_step(false);
-            $step_to_skip->set_completed();
-            // advance to the next step
-            $this->set_current_step($this->next_step->slug());
-            // also reset the step param in the request in case any other code references that directly
-            EED_Single_Page_Checkout::getRequest()->setRequestParam('step', $this->current_step->slug());
-            // since we are skipping a step and setting the current step to be what was previously the next step,
-            // we need to check that the next step is now correct, and not still set to the current step.
-            if ($this->current_step->slug() === $this->next_step->slug()) {
-                // correctly setup the next step
-                $this->set_next_step();
-            }
-            $this->set_reg_step_initiated($this->current_step);
-        }
-    }
-
-
-    /**
-     *    remove_reg_step
-     *
-     * @access    public
-     * @param string $reg_step_slug
-     * @param bool   $reset whether to reset reg steps after removal
-     * @throws EE_Error
-     */
-    public function remove_reg_step($reg_step_slug = '', $reset = true)
-    {
-        unset($this->reg_steps[ $reg_step_slug ]);
-        if ($this->transaction instanceof EE_Transaction) {
-            // now remove reg step from TXN and save
-            $this->transaction->remove_reg_step($reg_step_slug);
-            $this->transaction->save();
-        }
-        if ($reset) {
-            $this->reset_reg_steps();
-        }
-    }
-
-
-    /**
-     *    set_reg_step_order
-     *
-     * @access    public
-     * @param string $reg_step_slug
-     * @param int    $order
-     * @return    void
-     */
-    public function set_reg_step_order($reg_step_slug = '', $order = 100)
-    {
-        if (isset($this->reg_steps[ $reg_step_slug ])) {
-            $this->reg_steps[ $reg_step_slug ]->set_order($order);
-        }
-    }
-
-
-    /**
-     * @param string $current_step
-     * @return void
-     */
-    public function set_current_step(string $current_step)
-    {
-        // grab what step we're on
-        $this->current_step = $this->reg_steps[ $current_step ] ?? reset($this->reg_steps);
-        // verify instance
-        if (! $this->current_step instanceof EE_SPCO_Reg_Step) {
-            EE_Error::add_error(
-                esc_html__('The current step could not be set.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // we don't want to repeat completed steps if this is the first time through SPCO
-        if ($this->continue_reg && ! $this->revisit && $this->current_step->completed()) {
-            // so advance to the next step
-            $this->set_next_step();
-            if ($this->next_step instanceof EE_SPCO_Reg_Step) {
-                // and attempt to set it as the current step
-                $this->set_current_step($this->next_step->slug());
-            }
-            return;
-        }
-        $this->current_step->set_is_current_step(true);
-        $this->current_step->setRequest(EED_Single_Page_Checkout::getRequest());
-    }
-
-
-    /**
-     *    set_next_step
-     * advances the reg_steps array pointer and sets the next step, then reverses pointer back to the current step
-     *
-     * @access    public
-     * @return    void
-     */
-    public function set_next_step()
-    {
-        // set pointer to start of array
-        reset($this->reg_steps);
-        // if there is more than one step
-        if (count($this->reg_steps) > 1) {
-            // advance to the current step and set pointer
-            while (key($this->reg_steps) !== $this->current_step->slug() && key($this->reg_steps) !== '') {
-                next($this->reg_steps);
-            }
-        }
-        // advance one more spot ( if it exists )
-        $this->next_step = next($this->reg_steps);
-        // verify instance
-        $this->next_step = $this->next_step instanceof EE_SPCO_Reg_Step ? $this->next_step : null;
-        // then back to current step to reset
-        prev($this->reg_steps);
-    }
-
-
-    /**
-     *    get_next_reg_step
-     *    this simply returns the next step from reg_steps array
-     *
-     * @access    public
-     * @return    EE_SPCO_Reg_Step | null
-     */
-    public function get_next_reg_step()
-    {
-        $next = next($this->reg_steps);
-        prev($this->reg_steps);
-        return $next instanceof EE_SPCO_Reg_Step ? $next : null;
-    }
-
-
-    /**
-     * get_prev_reg_step
-     *    this simply returns the previous step from reg_steps array
-     *
-     * @access    public
-     * @return    EE_SPCO_Reg_Step | null
-     */
-    public function get_prev_reg_step()
-    {
-        $prev = prev($this->reg_steps);
-        next($this->reg_steps);
-        return $prev instanceof EE_SPCO_Reg_Step ? $prev : null;
-    }
-
-
-    /**
-     * sort_reg_steps
-     *
-     * @access public
-     * @return void
-     */
-    public function sort_reg_steps()
-    {
-        $reg_step_sorting_callback = apply_filters(
-            'FHEE__EE_Checkout__sort_reg_steps__reg_step_sorting_callback',
-            'reg_step_sorting_callback'
-        );
-        uasort($this->reg_steps, array($this, $reg_step_sorting_callback));
-    }
-
-
-    /**
-     * find_reg_step
-     * finds a reg step by the given slug
-     *
-     * @access    public
-     * @param string $reg_step_slug
-     * @return EE_SPCO_Reg_Step|null
-     */
-    public function find_reg_step($reg_step_slug = '')
-    {
-        if (! empty($reg_step_slug)) {
-            // copy reg step array
-            $reg_steps = $this->reg_steps;
-            // set pointer to start of array
-            reset($reg_steps);
-            // if there is more than one step
-            if (count($reg_steps) > 1) {
-                // advance to the current step and set pointer
-                while (key($reg_steps) !== $reg_step_slug && key($reg_steps) !== '') {
-                    next($reg_steps);
-                }
-                return current($reg_steps);
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * reg_step_sorting_callback
-     *
-     * @access public
-     * @param EE_SPCO_Reg_Step $reg_step_A
-     * @param EE_SPCO_Reg_Step $reg_step_B
-     * @return int
-     */
-    public function reg_step_sorting_callback(EE_SPCO_Reg_Step $reg_step_A, EE_SPCO_Reg_Step $reg_step_B)
-    {
-        // send finalize_registration step to the end of the array
-        if ($reg_step_A->slug() === 'finalize_registration') {
-            return 1;
-        } elseif ($reg_step_B->slug() === 'finalize_registration') {
-            return -1;
-        }
-        if ($reg_step_A->order() === $reg_step_B->order()) {
-            return 0;
-        }
-        return ($reg_step_A->order() > $reg_step_B->order()) ? 1 : -1;
-    }
-
-
-    /**
-     * set_reg_step_initiated
-     *
-     * @access    public
-     * @param    EE_SPCO_Reg_Step $reg_step
-     * @throws \EE_Error
-     */
-    public function set_reg_step_initiated(EE_SPCO_Reg_Step $reg_step)
-    {
-        // call set_reg_step_initiated ???
-        if (
+	/**
+	 *    whether current request originated from the EE admin
+	 *
+	 * @var bool
+	 */
+	public $admin_request = false;
+
+	/**
+	 * whether returning to edit attendee information or to retry a payment
+	 *
+	 * @var bool
+	 */
+	public $revisit = false;
+
+	/**
+	 * whether the primary registrant is returning to edit attendee information or to retry a payment
+	 *
+	 * @var bool
+	 */
+	public $primary_revisit = false;
+
+	/**
+	 * is registration allowed to progress or halted for some reason such as failing to pass recaptcha?
+	 *
+	 * @var bool
+	 */
+	public $continue_reg = true;
+
+	/**
+	 * redirect to thank you page ?
+	 *
+	 * @var bool
+	 */
+	public $redirect = false;
+
+	/**
+	 * generate the reg form or not ?
+	 *
+	 * @var bool
+	 */
+	public $generate_reg_form = true;
+
+	/**
+	 * process a reg form submission or not ?
+	 *
+	 * @var bool
+	 */
+	public $process_form_submission = false;
+
+	/**
+	 * tracks whether the TXN status modified during this checkout
+	 *
+	 * @var bool
+	 */
+	public $txn_status_updated = false;
+
+	/**
+	 * only triggered to true after absolutely everything has finished.
+	 *
+	 * @var bool
+	 */
+	protected $exit_spco = false;
+
+	/**
+	 * tracks whether any of the TXN's Registrations statuses modified during this checkout
+	 * indexed by registration ID
+	 *
+	 * @var array
+	 */
+	protected $reg_status_updated = array();
+
+	/**
+	 * timestamp when redirected from Ticket Selector to the checkout
+	 *
+	 * @var int
+	 */
+	public $uts = 0;
+
+	/**
+	 * total number of tickets that were in the cart
+	 *
+	 * @var int
+	 */
+	public $total_ticket_count = 0;
+
+	/**
+	 * corresponds loosely to EE_Transaction::remaining()
+	 * but can be modified by SPCO
+	 *
+	 * @var float
+	 */
+	public $amount_owing = 0;
+
+	/**
+	 * the reg step slug from the incoming request
+	 *
+	 * @var string
+	 */
+	public $step = '';
+
+	/**
+	 * the reg step slug for a step being edited
+	 *
+	 * @var string
+	 */
+	public $edit_step = '';
+
+	/**
+	 * the action being performed on the current step
+	 *
+	 * @var string
+	 */
+	public $action = '';
+
+	/**
+	 * reg_url_link for a previously saved registration
+	 *
+	 * @var string
+	 */
+	public $reg_url_link = '';
+
+	/**
+	 * string slug for the payment method that was selected during the payment options step
+	 *
+	 * @var string
+	 */
+	public $selected_method_of_payment = '';
+
+	/**
+	 * base url for the site's registration checkout page - additional url params will be added to this
+	 *
+	 * @var string
+	 */
+	public $reg_page_base_url = '';
+
+	/**
+	 * base url for the site's registration cancelled page - additional url params will be added to this
+	 *
+	 * @var string
+	 */
+	public $cancel_page_url = '';
+
+	/**
+	 * base url for the site's thank you page - additional url params will be added to this
+	 *
+	 * @var string
+	 */
+	public $thank_you_page_url = '';
+
+	/**
+	 * base url for any redirects - additional url params will be added to this
+	 *
+	 * @var string
+	 */
+	public $redirect_url = '';
+
+	/**
+	 * form of POST data for use with off-site gateways
+	 *
+	 * @var string
+	 */
+	public $redirect_form = '';
+
+	/**
+	 * array of query where params to use when retrieving cached registrations from $this->checkout->transaction
+	 *
+	 * @var array
+	 */
+	public $reg_cache_where_params = array();
+
+	/**
+	 * a class for managing and creating the JSON encoded array of data that gets passed back to the client during AJAX
+	 * requests
+	 *
+	 * @var EE_SPCO_JSON_Response
+	 */
+	public $json_response;
+
+	/**
+	 * where we are going next in the reg process
+	 *
+	 * @var EE_SPCO_Reg_Step
+	 */
+	public $next_step;
+
+	/**
+	 * where we are in the reg process
+	 *
+	 * @var EE_SPCO_Reg_Step
+	 */
+	public $current_step;
+
+	/**
+	 *    $_cart - the current cart object
+	 *
+	 * @var EE_CART
+	 */
+	public $cart;
+
+	/**
+	 *    $_transaction - the current transaction object
+	 *
+	 * @var EE_Transaction
+	 */
+	public $transaction;
+
+	/**
+	 *    the related attendee object for the primary registrant
+	 *
+	 * @var EE_Attendee
+	 */
+	public $primary_attendee_obj;
+
+	/**
+	 *    $payment_method - the payment method object for the selected method of payment
+	 *
+	 * @var EE_Payment_Method
+	 */
+	public $payment_method;
+
+	/**
+	 *    $payment - if a payment was successfully made during the reg process,
+	 *    then here it is !!!
+	 *
+	 * @var EE_Payment
+	 */
+	public $payment;
+
+	/**
+	 *    if a payment method was selected that uses an on-site gateway, then this is the billing form
+	 *
+	 * @var EE_Billing_Info_Form|EE_Billing_Attendee_Info_Form
+	 */
+	public $billing_form;
+
+	/**
+	 *    the entire registration form composed of ALL of the subsections generated by the various reg steps
+	 *
+	 * @var EE_Form_Section_Proper
+	 */
+	public $registration_form;
+
+	/**
+	 * array of EE_SPCO_Reg_Step objects
+	 *
+	 * @var EE_SPCO_Reg_Step[]
+	 */
+	public $reg_steps = array();
+
+	/**
+	 * array of EE_Payment_Method objects
+	 *
+	 * @var EE_Payment_Method[]
+	 */
+	public $available_payment_methods = array();
+
+	public ?EE_Payment_Method $default_payment_method = null;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		$this->reg_page_base_url = EE_Registry::instance()->CFG->core->reg_page_url();
+		$this->thank_you_page_url = EE_Registry::instance()->CFG->core->thank_you_page_url();
+		$this->cancel_page_url = EE_Registry::instance()->CFG->core->cancel_page_url();
+		$this->continue_reg = apply_filters('FHEE__EE_Checkout___construct___continue_reg', true);
+
+		$this->admin_request = is_admin() && ! EED_Single_Page_Checkout::getRequest()->isAjax();
+		$this->reg_cache_where_params = array(
+			0          => array('REG_deleted' => false),
+			'order_by' => array('REG_count' => 'ASC'),
+		);
+	}
+
+
+	/**
+	 * returns true if ANY reg status was updated during checkout
+	 *
+	 * @return boolean
+	 */
+	public function any_reg_status_updated()
+	{
+		foreach ($this->reg_status_updated as $reg_status) {
+			if ($reg_status) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param $REG_ID
+	 * @return boolean
+	 */
+	public function reg_status_updated($REG_ID)
+	{
+		return isset($this->reg_status_updated[ $REG_ID ]) ? $this->reg_status_updated[ $REG_ID ] : false;
+	}
+
+
+	/**
+	 * @param $REG_ID
+	 * @param $reg_status
+	 */
+	public function set_reg_status_updated($REG_ID, $reg_status)
+	{
+		$this->reg_status_updated[ $REG_ID ] = filter_var($reg_status, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * exit_spco
+	 *
+	 * @return bool
+	 */
+	public function exit_spco()
+	{
+		return $this->exit_spco;
+	}
+
+
+	/**
+	 * set_exit_spco
+	 * can ONLY be set by the  Finalize_Registration reg step
+	 */
+	public function set_exit_spco()
+	{
+		if ($this->current_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) {
+			$this->exit_spco = true;
+		}
+	}
+
+
+	/**
+	 *    reset_for_current_request
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function reset_for_current_request()
+	{
+		$this->process_form_submission = false;
+		$this->continue_reg = apply_filters('FHEE__EE_Checkout___construct___continue_reg', true);
+		$this->admin_request = is_admin() && ! EED_Single_Page_Checkout::getRequest()->isFrontAjax();
+		$this->continue_reg = true;
+		$this->redirect = false;
+		// don't reset the cached redirect form if we're about to be asked to display it !!!
+		$action = EED_Single_Page_Checkout::getRequest()->getRequestParam('action', 'display_spco_reg_step');
+		if ($action !== 'redirect_form') {
+			$this->redirect_form = '';
+		}
+		$this->redirect_url = '';
+		$this->json_response = new EE_SPCO_JSON_Response();
+		EE_Form_Section_Proper::reset_js_localization();
+	}
+
+
+	/**
+	 *    add_reg_step
+	 *
+	 * @access    public
+	 * @param EE_SPCO_Reg_Step $reg_step_obj
+	 * @return    void
+	 */
+	public function add_reg_step(EE_SPCO_Reg_Step $reg_step_obj)
+	{
+		$this->reg_steps[ $reg_step_obj->slug() ] = $reg_step_obj;
+	}
+
+
+	/**
+	 * skip_reg_step
+	 * if the current reg step does not need to run for some reason,
+	 * then this will advance SPCO to the next reg step,
+	 * and mark the skipped step as completed
+	 *
+	 * @access    public
+	 * @param string $reg_step_slug
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	public function skip_reg_step($reg_step_slug = '')
+	{
+		$step_to_skip = $this->find_reg_step($reg_step_slug);
+		if ($step_to_skip instanceof EE_SPCO_Reg_Step && $step_to_skip->is_current_step()) {
+			$step_to_skip->set_is_current_step(false);
+			$step_to_skip->set_completed();
+			// advance to the next step
+			$this->set_current_step($this->next_step->slug());
+			// also reset the step param in the request in case any other code references that directly
+			EED_Single_Page_Checkout::getRequest()->setRequestParam('step', $this->current_step->slug());
+			// since we are skipping a step and setting the current step to be what was previously the next step,
+			// we need to check that the next step is now correct, and not still set to the current step.
+			if ($this->current_step->slug() === $this->next_step->slug()) {
+				// correctly setup the next step
+				$this->set_next_step();
+			}
+			$this->set_reg_step_initiated($this->current_step);
+		}
+	}
+
+
+	/**
+	 *    remove_reg_step
+	 *
+	 * @access    public
+	 * @param string $reg_step_slug
+	 * @param bool   $reset whether to reset reg steps after removal
+	 * @throws EE_Error
+	 */
+	public function remove_reg_step($reg_step_slug = '', $reset = true)
+	{
+		unset($this->reg_steps[ $reg_step_slug ]);
+		if ($this->transaction instanceof EE_Transaction) {
+			// now remove reg step from TXN and save
+			$this->transaction->remove_reg_step($reg_step_slug);
+			$this->transaction->save();
+		}
+		if ($reset) {
+			$this->reset_reg_steps();
+		}
+	}
+
+
+	/**
+	 *    set_reg_step_order
+	 *
+	 * @access    public
+	 * @param string $reg_step_slug
+	 * @param int    $order
+	 * @return    void
+	 */
+	public function set_reg_step_order($reg_step_slug = '', $order = 100)
+	{
+		if (isset($this->reg_steps[ $reg_step_slug ])) {
+			$this->reg_steps[ $reg_step_slug ]->set_order($order);
+		}
+	}
+
+
+	/**
+	 * @param string $current_step
+	 * @return void
+	 */
+	public function set_current_step(string $current_step)
+	{
+		// grab what step we're on
+		$this->current_step = $this->reg_steps[ $current_step ] ?? reset($this->reg_steps);
+		// verify instance
+		if (! $this->current_step instanceof EE_SPCO_Reg_Step) {
+			EE_Error::add_error(
+				esc_html__('The current step could not be set.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// we don't want to repeat completed steps if this is the first time through SPCO
+		if ($this->continue_reg && ! $this->revisit && $this->current_step->completed()) {
+			// so advance to the next step
+			$this->set_next_step();
+			if ($this->next_step instanceof EE_SPCO_Reg_Step) {
+				// and attempt to set it as the current step
+				$this->set_current_step($this->next_step->slug());
+			}
+			return;
+		}
+		$this->current_step->set_is_current_step(true);
+		$this->current_step->setRequest(EED_Single_Page_Checkout::getRequest());
+	}
+
+
+	/**
+	 *    set_next_step
+	 * advances the reg_steps array pointer and sets the next step, then reverses pointer back to the current step
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function set_next_step()
+	{
+		// set pointer to start of array
+		reset($this->reg_steps);
+		// if there is more than one step
+		if (count($this->reg_steps) > 1) {
+			// advance to the current step and set pointer
+			while (key($this->reg_steps) !== $this->current_step->slug() && key($this->reg_steps) !== '') {
+				next($this->reg_steps);
+			}
+		}
+		// advance one more spot ( if it exists )
+		$this->next_step = next($this->reg_steps);
+		// verify instance
+		$this->next_step = $this->next_step instanceof EE_SPCO_Reg_Step ? $this->next_step : null;
+		// then back to current step to reset
+		prev($this->reg_steps);
+	}
+
+
+	/**
+	 *    get_next_reg_step
+	 *    this simply returns the next step from reg_steps array
+	 *
+	 * @access    public
+	 * @return    EE_SPCO_Reg_Step | null
+	 */
+	public function get_next_reg_step()
+	{
+		$next = next($this->reg_steps);
+		prev($this->reg_steps);
+		return $next instanceof EE_SPCO_Reg_Step ? $next : null;
+	}
+
+
+	/**
+	 * get_prev_reg_step
+	 *    this simply returns the previous step from reg_steps array
+	 *
+	 * @access    public
+	 * @return    EE_SPCO_Reg_Step | null
+	 */
+	public function get_prev_reg_step()
+	{
+		$prev = prev($this->reg_steps);
+		next($this->reg_steps);
+		return $prev instanceof EE_SPCO_Reg_Step ? $prev : null;
+	}
+
+
+	/**
+	 * sort_reg_steps
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function sort_reg_steps()
+	{
+		$reg_step_sorting_callback = apply_filters(
+			'FHEE__EE_Checkout__sort_reg_steps__reg_step_sorting_callback',
+			'reg_step_sorting_callback'
+		);
+		uasort($this->reg_steps, array($this, $reg_step_sorting_callback));
+	}
+
+
+	/**
+	 * find_reg_step
+	 * finds a reg step by the given slug
+	 *
+	 * @access    public
+	 * @param string $reg_step_slug
+	 * @return EE_SPCO_Reg_Step|null
+	 */
+	public function find_reg_step($reg_step_slug = '')
+	{
+		if (! empty($reg_step_slug)) {
+			// copy reg step array
+			$reg_steps = $this->reg_steps;
+			// set pointer to start of array
+			reset($reg_steps);
+			// if there is more than one step
+			if (count($reg_steps) > 1) {
+				// advance to the current step and set pointer
+				while (key($reg_steps) !== $reg_step_slug && key($reg_steps) !== '') {
+					next($reg_steps);
+				}
+				return current($reg_steps);
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * reg_step_sorting_callback
+	 *
+	 * @access public
+	 * @param EE_SPCO_Reg_Step $reg_step_A
+	 * @param EE_SPCO_Reg_Step $reg_step_B
+	 * @return int
+	 */
+	public function reg_step_sorting_callback(EE_SPCO_Reg_Step $reg_step_A, EE_SPCO_Reg_Step $reg_step_B)
+	{
+		// send finalize_registration step to the end of the array
+		if ($reg_step_A->slug() === 'finalize_registration') {
+			return 1;
+		} elseif ($reg_step_B->slug() === 'finalize_registration') {
+			return -1;
+		}
+		if ($reg_step_A->order() === $reg_step_B->order()) {
+			return 0;
+		}
+		return ($reg_step_A->order() > $reg_step_B->order()) ? 1 : -1;
+	}
+
+
+	/**
+	 * set_reg_step_initiated
+	 *
+	 * @access    public
+	 * @param    EE_SPCO_Reg_Step $reg_step
+	 * @throws \EE_Error
+	 */
+	public function set_reg_step_initiated(EE_SPCO_Reg_Step $reg_step)
+	{
+		// call set_reg_step_initiated ???
+		if (
 // first time visiting SPCO ?
-            ! $this->revisit
-            && (
-                // and displaying the reg step form for the first time ?
-                $this->action === 'display_spco_reg_step'
-                // or initializing the final step
-                || $reg_step instanceof EE_SPCO_Reg_Step_Finalize_Registration
-            )
-        ) {
-            // set the start time for this reg step
-            if (! $this->transaction->set_reg_step_initiated($reg_step->slug())) {
-                if (WP_DEBUG) {
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__('The "%1$s" registration step was not initialized properly.', 'event_espresso'),
-                            $reg_step->name()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    set_reg_step_JSON_info
-     *
-     * @access public
-     * @return    void
-     */
-    public function set_reg_step_JSON_info()
-    {
-        EE_Registry::$i18n_js_strings['reg_steps'] = array();
-        // pass basic reg step data to JS
-        foreach ($this->reg_steps as $reg_step) {
-            EE_Registry::$i18n_js_strings['reg_steps'][] = $reg_step->slug();
-        }
-        // reset reg step html
-        // $this->json_response->set_reg_step_html('');
-    }
-
-
-    /**
-     *    reset_reg_steps
-     *
-     * @access public
-     * @return void
-     */
-    public function reset_reg_steps()
-    {
-        $this->sort_reg_steps();
-        $this->set_current_step(EED_Single_Page_Checkout::getRequest()->getRequestParam('step'));
-        $this->set_next_step();
-        // the text that appears on the reg step form submit button
-        $this->current_step->set_submit_button_text();
-        $this->set_reg_step_JSON_info();
-    }
-
-
-    /**
-     *    get_registration_time_limit
-     *
-     * @access    public
-     * @return        string
-     */
-    public function get_registration_time_limit(): string
-    {
-        $registration_time_limit = (float) (EE_Registry::instance()->SSN->expiration() - time());
-        $time_limit_format = $registration_time_limit > 60 * MINUTE_IN_SECONDS ? 'H:i:s' : 'i:s';
-        $registration_time_limit = date($time_limit_format, $registration_time_limit);
-        return (string) apply_filters(
-            'FHEE__EE_Checkout__get_registration_time_limit__registration_time_limit',
-            $registration_time_limit
-        );
-    }
-
-
-    /**
-     * payment_required
-     *
-     * @return boolean
-     */
-    public function payment_required()
-    {
-        // if NOT:
-        //     registration via admin
-        //      completed TXN
-        //      overpaid TXN
-        //      free TXN(total = 0.00)
-        //      then payment required is TRUE
-        return ! ($this->admin_request
-                  || $this->transaction->is_completed()
-                  || $this->transaction->is_overpaid()
-                  || $this->transaction->is_free()) ? true : false;
-    }
-
-
-    /**
-     * get_cart_for_transaction
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @return EE_Cart
-     */
-    public function get_cart_for_transaction($transaction)
-    {
-        $session = EE_Registry::instance()->load_core('Session');
-        $cart = $transaction instanceof EE_Transaction ? EE_Cart::get_cart_from_txn($transaction, $session) : null;
-        // verify cart
-        if (! $cart instanceof EE_Cart) {
-            $cart = EE_Registry::instance()->load_core('Cart');
-        }
-
-        return $cart;
-    }
-
-
-    /**
-     *    initialize_txn_reg_steps_array
-     *
-     * @access public
-     * @return    array
-     */
-    public function initialize_txn_reg_steps_array()
-    {
-        $txn_reg_steps_array = array();
-        foreach ($this->reg_steps as $reg_step) {
-            $txn_reg_steps_array[ $reg_step->slug() ] = false;
-        }
-        return $txn_reg_steps_array;
-    }
-
-
-    /**
-     *    update_txn_reg_steps_array
-     *
-     * @access public
-     * @return    bool
-     * @throws \EE_Error
-     */
-    public function update_txn_reg_steps_array()
-    {
-        $updated = false;
-        foreach ($this->reg_steps as $reg_step) {
-            if ($reg_step->completed()) {
-                $updated = $this->transaction->set_reg_step_completed($reg_step->slug())
-                    ? true
-                    : $updated;
-            }
-        }
-        if ($updated) {
-            $this->transaction->save();
-        }
-        return $updated;
-    }
-
-
-    /**
-     *    stash_transaction_and_checkout
-     *
-     * @access public
-     * @return    void
-     * @throws \EE_Error
-     */
-    public function stash_transaction_and_checkout()
-    {
-        if (! $this->revisit) {
-            $this->update_txn_reg_steps_array();
-        }
-        $this->track_transaction_and_registration_status_updates();
-        // save all data to the db, but suppress errors
-        // $this->save_all_data( FALSE );
-        // cache the checkout in the session
-        EE_Registry::instance()->SSN->set_checkout($this);
-    }
-
-
-    /**
-     *    track_transaction_and_registration_status_updates
-     *    stores whether any updates were made to the TXN or it's related registrations
-     *
-     * @access public
-     * @return void
-     * @throws \EE_Error
-     */
-    public function track_transaction_and_registration_status_updates()
-    {
-        // verify the transaction
-        if ($this->transaction instanceof EE_Transaction) {
-            // has there been a TXN status change during this checkout?
-            $this->txn_status_updated = $this->transaction->txn_status_updated();
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            // grab the saved registrations from the transaction
-            foreach ($this->transaction->registrations($this->reg_cache_where_params) as $registration) {
-                if ($registration_processor->reg_status_updated($registration->ID())) {
-                    $this->set_reg_status_updated($registration->ID(), true);
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    visit_allows_processing_of_this_registration
-     *    determines if the current SPCO visit should allow the passed EE_Registration to be used in processing.
-     *    one of the following conditions must be met:
-     *        EITHER:    A) first time thru SPCO -> process ALL registrations ( NOT a revisit )
-     *        OR :        B) primary registrant is editing info -> process ALL registrations ( primary_revisit )
-     *        OR :        C) another registrant is editing info -> ONLY process their registration ( revisit AND their
-     *        reg_url_link matches )
-     *
-     * @access public
-     * @param    EE_Registration $registration
-     * @return    bool
-     * @throws \EE_Error
-     */
-    public function visit_allows_processing_of_this_registration(EE_Registration $registration)
-    {
-        return ! $this->revisit
-               || $this->primary_revisit
-               || (
-                   $this->revisit && $this->reg_url_link === $registration->reg_url_link()
-               )
-            ? true
-            : false;
-    }
-
-
-    /**
-     *    _transaction_has_primary_registration
-     *
-     * @access        private
-     * @return        bool
-     */
-    public function transaction_has_primary_registrant()
-    {
-        return $this->primary_attendee_obj instanceof EE_Attendee ? true : false;
-    }
-
-
-    /**
-     *    save_all_data
-     *    simply loops through the current transaction and saves all data for each registration
-     *
-     * @access public
-     * @param bool $show_errors
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function save_all_data($show_errors = true)
-    {
-        // verify the transaction
-        if ($this->transaction instanceof EE_Transaction) {
-            // save to ensure that TXN has ID
-            $this->transaction->save();
-            // grab the saved registrations from the transaction
-            foreach ($this->transaction->registrations($this->reg_cache_where_params) as $registration) {
-                $this->_save_registration($registration, $show_errors);
-            }
-        } else {
-            if ($show_errors) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'A valid Transaction was not found when attempting to save your registration information.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * _save_registration_attendee
-     *
-     * @param    EE_Registration $registration
-     * @param bool               $show_errors
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _save_registration($registration, $show_errors = true)
-    {
-        // verify object
-        if ($registration instanceof EE_Registration) {
-            // should this registration be processed during this visit ?
-            if ($this->visit_allows_processing_of_this_registration($registration)) {
-                // set TXN ID
-                if (! $registration->transaction_ID()) {
-                    $registration->set_transaction_id($this->transaction->ID());
-                }
-                // verify and save the attendee
-                $this->_save_registration_attendee($registration, $show_errors);
-                // save answers to reg form questions
-                $this->_save_registration_answers($registration, $show_errors);
-                // save changes
-                $registration->save();
-                // update txn cache
-                if (! $this->transaction->update_cache_after_object_save('Registration', $registration)) {
-                    if ($show_errors) {
-                        EE_Error::add_error(
-                            esc_html__(
-                                'The newly saved Registration object could not be cached on the Transaction.',
-                                'event_espresso'
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                }
-            }
-        } else {
-            if ($show_errors) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'An invalid Registration object was discovered when attempting to save your registration information.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-    }
-
-
-    /**
-     * _save_registration_attendee
-     *
-     * @param    EE_Registration $registration
-     * @param bool               $show_errors
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _save_registration_attendee($registration, $show_errors = true)
-    {
-        if ($registration->attendee() instanceof EE_Attendee) {
-            // save so that ATT has ID
-            $registration->attendee()->save();
-            if (! $registration->update_cache_after_object_save('Attendee', $registration->attendee())) {
-                if ($show_errors) {
-                    EE_Error::add_error(
-                        esc_html__(
-                            'The newly saved Attendee object could not be cached on the registration.',
-                            'event_espresso'
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            }
-        } else {
-            if ($show_errors) {
-                EE_Error::add_error(
-                    sprintf(
-                        '%1$s||%1$s $attendee = %2$s',
-                        esc_html__(
-                            'Either no Attendee information was found, or an invalid Attendee object was discovered when attempting to save your registration information.',
-                            'event_espresso'
-                        ),
-                        var_export($registration->attendee(), true)
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-    }
-
-
-    /**
-     * _save_question_answers
-     *
-     * @param    EE_Registration $registration
-     * @param bool               $show_errors
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _save_registration_answers($registration, $show_errors = true)
-    {
-        // now save the answers
-        foreach ($registration->answers() as $cache_key => $answer) {
-            // verify object
-            if ($answer instanceof EE_Answer) {
-                $answer->set_registration($registration->ID());
-                $answer->save();
-                if (! $registration->update_cache_after_object_save('Answer', $answer, $cache_key)) {
-                    if ($show_errors) {
-                        EE_Error::add_error(
-                            esc_html__(
-                                'The newly saved Answer object could not be cached on the registration.',
-                                'event_espresso'
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                }
-            } else {
-                if ($show_errors) {
-                    EE_Error::add_error(
-                        esc_html__(
-                            'An invalid Answer object was discovered when attempting to save your registration information.',
-                            'event_espresso'
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    refresh_all_entities
-     *   will either refresh the entity map with objects form the db or from the checkout cache
-     *
-     * @access public
-     * @param bool $from_db
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function refresh_all_entities($from_db = false)
-    {
-        $this->current_step->setRequest(EED_Single_Page_Checkout::getRequest());
-        $from_db = $this->current_step->is_final_step() || $this->action === 'process_gateway_response'
-            ? true
-            : $from_db;
-        // $this->log(
-        //     __CLASS__,
-        //     __FUNCTION__,
-        //     __LINE__,
-        //     array('from_db' => $from_db)
-        // );
-        return $from_db ? $this->refresh_from_db() : $this->refresh_entity_map();
-    }
-
-
-    /**
-     *  refresh_entity_map
-     *  simply loops through the current transaction and updates each
-     *  model's entity map using EEM_Base::refresh_entity_map_from_db()
-     *
-     * @access public
-     * @return bool
-     * @throws \EE_Error
-     */
-    protected function refresh_from_db()
-    {
-        // verify the transaction
-        if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
-            // pull fresh TXN data from the db
-            $this->transaction = $this->transaction->get_model()->refresh_entity_map_from_db($this->transaction->ID());
-            // update EE_Checkout's cached primary_attendee object
-            $this->primary_attendee_obj = $this->_refresh_primary_attendee_obj_from_db($this->transaction);
-            // update EE_Checkout's cached payment object
-            $payment = $this->transaction->last_payment();
-            $this->payment = $payment instanceof EE_Payment ? $payment : $this->payment;
-            // update EE_Checkout's cached payment_method object
-            $payment_method = $this->payment instanceof EE_Payment ? $this->payment->payment_method() : null;
-            $this->payment_method = $payment_method instanceof EE_Payment_Method ? $payment_method
-                : $this->payment_method;
-            // now refresh the cart, based on the TXN
-            $this->cart = $this->get_cart_for_transaction($this->transaction);
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'A valid Transaction was not found when attempting to update the model entity mapper.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * _refresh_primary_attendee_obj_from_db
-     *
-     * @param   EE_Transaction $transaction
-     * @return  EE_Attendee | null
-     * @throws \EE_Error
-     */
-    protected function _refresh_primary_attendee_obj_from_db(EE_Transaction $transaction)
-    {
-        $primary_attendee_obj = null;
-        // grab the saved registrations from the transaction
-        foreach ($transaction->registrations($this->reg_cache_where_params, true) as $registration) {
-            // verify object
-            if ($registration instanceof EE_Registration) {
-                $attendee = $registration->attendee();
-                // verify object && maybe cache primary_attendee_obj ?
-                if ($attendee instanceof EE_Attendee && $registration->is_primary_registrant()) {
-                    $primary_attendee_obj = $attendee;
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'An invalid Registration object was discovered when attempting to update the model entity mapper.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        return $primary_attendee_obj;
-    }
-
-
-    /**
-     *  refresh_entity_map
-     *  simply loops through the current transaction and updates
-     *  each model's entity map using EEM_Base::refresh_entity_map_with()
-     *
-     * @access public
-     * @return bool
-     * @throws \EE_Error
-     */
-    protected function refresh_entity_map()
-    {
-        // verify the transaction
-        if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
-            // never cache payment info
-            $this->transaction->clear_cache('Payment');
-            // is the Payment Options Reg Step completed ?
-            if ($this->transaction->reg_step_completed('payment_options')) {
-                // then check for payments and update TXN accordingly
-                /** @type EE_Transaction_Payments $transaction_payments */
-                $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-                $transaction_payments->calculate_total_payments_and_update_status($this->transaction);
-            }
-            // grab the saved registrations from the transaction
-            foreach ($this->transaction->registrations($this->reg_cache_where_params) as $reg_cache_ID => $registration) {
-                $this->_refresh_registration($reg_cache_ID, $registration);
-            }
-            // make sure our cached TXN is added to the model entity mapper
-            $this->transaction = $this->transaction->get_model()->refresh_entity_map_with(
-                $this->transaction->ID(),
-                $this->transaction
-            );
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'A valid Transaction was not found when attempting to update the model entity mapper.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // verify and update the cart because inaccurate totals are not so much fun
-        if ($this->cart instanceof EE_Cart) {
-            $grand_total = $this->cart->get_grand_total();
-            if ($grand_total instanceof EE_Line_Item && $grand_total->ID()) {
-                $grand_total->recalculate_total_including_taxes();
-                $grand_total = $grand_total->get_model()->refresh_entity_map_with(
-                    $this->cart->get_grand_total()->ID(),
-                    $this->cart->get_grand_total()
-                );
-            }
-            if ($grand_total instanceof EE_Line_Item) {
-                $this->cart = EE_Cart::instance($grand_total);
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'A valid Cart was not found when attempting to update the model entity mapper.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * _refresh_registration
-     *
-     * @param    string | int    $reg_cache_ID
-     * @param    EE_Registration $registration
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _refresh_registration($reg_cache_ID, $registration)
-    {
-
-        // verify object
-        if ($registration instanceof EE_Registration) {
-            // update the entity mapper attendee
-            $this->_refresh_registration_attendee($registration);
-            // update the entity mapper answers for reg form questions
-            $this->_refresh_registration_answers($registration);
-            // make sure the cached registration is added to the model entity mapper
-            $registration->get_model()->refresh_entity_map_with($reg_cache_ID, $registration);
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'An invalid Registration object was discovered when attempting to update the model entity mapper.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * _save_registration_attendee
-     *
-     * @param    EE_Registration $registration
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _refresh_registration_attendee($registration)
-    {
-        $attendee = $registration->attendee();
-        // verify object
-        if ($attendee instanceof EE_Attendee && $attendee->ID()) {
-            // make sure the cached attendee is added to the model entity mapper
-            $registration->attendee()->get_model()->refresh_entity_map_with($attendee->ID(), $attendee);
-            // maybe cache primary_attendee_obj ?
-            if ($registration->is_primary_registrant()) {
-                $this->primary_attendee_obj = $attendee;
-            }
-        }
-    }
-
-
-    /**
-     * _refresh_registration_answers
-     *
-     * @param    EE_Registration $registration
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _refresh_registration_answers($registration)
-    {
-
-        // now update the answers
-        foreach ($registration->answers() as $cache_key => $answer) {
-            // verify object
-            if ($answer instanceof EE_Answer) {
-                if ($answer->ID()) {
-                    // make sure the cached answer is added to the model entity mapper
-                    $answer->get_model()->refresh_entity_map_with($answer->ID(), $answer);
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'An invalid Answer object was discovered when attempting to update the model entity mapper.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-    }
-
-
-    /**
-     *    __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
-     * @throws \EE_Error
-     */
-    public function __sleep()
-    {
-        if ($this->primary_attendee_obj instanceof EE_Attendee && $this->primary_attendee_obj->ID()) {
-            $this->primary_attendee_obj = $this->primary_attendee_obj->ID();
-        }        // remove the reg form and the checkout
-        if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
-            $this->transaction = $this->transaction->ID();
-        }        // remove the reg form and the checkout
-        return array_diff(array_keys(get_object_vars($this)), array('billing_form', 'registration_form'));
-    }
-
-
-    /**
-     *    __wakeup
-     * to conserve db space, we are removing the EE_Checkout object from EE_SPCO_Reg_Step objects upon serialization
-     * this will reinstate the EE_Checkout object on each EE_SPCO_Reg_Step object
-     */
-    public function __wakeup()
-    {
-        try {
-            if (! $this->primary_attendee_obj instanceof EE_Attendee && absint($this->primary_attendee_obj) !== 0) {
-                // $this->primary_attendee_obj is actually just an ID, so use it to get the object from the db
-                $this->primary_attendee_obj = EEM_Attendee::instance()->get_one_by_ID($this->primary_attendee_obj);
-            }
-            if (! $this->transaction instanceof EE_Transaction && absint($this->transaction) !== 0) {
-                // $this->transaction is actually just an ID, so use it to get the object from the db
-                $this->transaction = EEM_Transaction::instance()->get_one_by_ID($this->transaction);
-            }
-            foreach ($this->reg_steps as $reg_step) {
-                $reg_step->checkout = $this;
-            }
-        } catch (Throwable $e) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred while attempting to reinstate a EE_SPCO_Reg_Step object in EE_Checkout::__wakeup().',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * debug
-     *
-     * @param string $class
-     * @param string $func
-     * @param string $line
-     * @param array  $info
-     * @param bool   $display_request
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function log($class = '', $func = '', $line = '', $info = array(), $display_request = false)
-    {
-        $disabled = true;
-        if (WP_DEBUG && ! $disabled) {
-            $debug_data = get_option('EE_DEBUG_SPCO_' . EE_Session::instance()->id(), array());
-            $default_data = array(
-                $class                    => $func . '() : ' . $line,
-                'request->step'           => $this->step,
-                'request->action'         => $this->action,
-                'current_step->slug'      => $this->current_step instanceof EE_SPCO_Reg_Step ?
-                    $this->current_step->slug() : '',
-                'current_step->completed' => $this->current_step instanceof EE_SPCO_Reg_Step ?
-                    $this->current_step->completed() : '',
-                'txn_status_updated'      => $this->transaction->txn_status_updated(),
-                'reg_status_updated'      => $this->reg_status_updated,
-                'reg_url_link'            => $this->reg_url_link,
-            );
-            if ($this->transaction instanceof EE_Transaction) {
-                $default_data['TXN_status'] = $this->transaction->status_ID();
-                $default_data['TXN_reg_steps'] = $this->transaction->reg_steps();
-                foreach ($this->transaction->registrations($this->reg_cache_where_params) as $REG_ID => $registration) {
-                    $default_data['registrations'][ $REG_ID ] = $registration->status_ID();
-                }
-                if ($this->transaction->ID()) {
-                    $TXN_ID = 'EE_Transaction: ' . $this->transaction->ID();
-                    // don't serialize objects
-                    $info = $this->_strip_objects($info);
-                    if (! isset($debug_data[ $TXN_ID ])) {
-                        $debug_data[ $TXN_ID ] = array();
-                    }
-                    $debug_data[ $TXN_ID ][ microtime() ] = array_merge(
-                        $default_data,
-                        $info
-                    );
-                    update_option('EE_DEBUG_SPCO_' . EE_Session::instance()->id(), $debug_data);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * _strip_objects
-     *
-     * @param array $info
-     * @return array
-     */
-    public function _strip_objects($info = array())
-    {
-        foreach ((array) $info as $key => $value) {
-            if (is_array($value)) {
-                $info[ $key ] = $this->_strip_objects($value);
-            } elseif (is_object($value)) {
-                $object_class = get_class($value);
-                $info[ $object_class ] = array();
-                $info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : 0;
-                if (method_exists($value, 'status')) {
-                    $info[ $object_class ]['status'] = $value->status();
-                } elseif (method_exists($value, 'status_ID')) {
-                    $info[ $object_class ]['status'] = $value->status_ID();
-                }
-                unset($info[ $key ]);
-            }
-        }
-        return (array) $info;
-    }
+			! $this->revisit
+			&& (
+				// and displaying the reg step form for the first time ?
+				$this->action === 'display_spco_reg_step'
+				// or initializing the final step
+				|| $reg_step instanceof EE_SPCO_Reg_Step_Finalize_Registration
+			)
+		) {
+			// set the start time for this reg step
+			if (! $this->transaction->set_reg_step_initiated($reg_step->slug())) {
+				if (WP_DEBUG) {
+					EE_Error::add_error(
+						sprintf(
+							esc_html__('The "%1$s" registration step was not initialized properly.', 'event_espresso'),
+							$reg_step->name()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    set_reg_step_JSON_info
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function set_reg_step_JSON_info()
+	{
+		EE_Registry::$i18n_js_strings['reg_steps'] = array();
+		// pass basic reg step data to JS
+		foreach ($this->reg_steps as $reg_step) {
+			EE_Registry::$i18n_js_strings['reg_steps'][] = $reg_step->slug();
+		}
+		// reset reg step html
+		// $this->json_response->set_reg_step_html('');
+	}
+
+
+	/**
+	 *    reset_reg_steps
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function reset_reg_steps()
+	{
+		$this->sort_reg_steps();
+		$this->set_current_step(EED_Single_Page_Checkout::getRequest()->getRequestParam('step'));
+		$this->set_next_step();
+		// the text that appears on the reg step form submit button
+		$this->current_step->set_submit_button_text();
+		$this->set_reg_step_JSON_info();
+	}
+
+
+	/**
+	 *    get_registration_time_limit
+	 *
+	 * @access    public
+	 * @return        string
+	 */
+	public function get_registration_time_limit(): string
+	{
+		$registration_time_limit = (float) (EE_Registry::instance()->SSN->expiration() - time());
+		$time_limit_format = $registration_time_limit > 60 * MINUTE_IN_SECONDS ? 'H:i:s' : 'i:s';
+		$registration_time_limit = date($time_limit_format, $registration_time_limit);
+		return (string) apply_filters(
+			'FHEE__EE_Checkout__get_registration_time_limit__registration_time_limit',
+			$registration_time_limit
+		);
+	}
+
+
+	/**
+	 * payment_required
+	 *
+	 * @return boolean
+	 */
+	public function payment_required()
+	{
+		// if NOT:
+		//     registration via admin
+		//      completed TXN
+		//      overpaid TXN
+		//      free TXN(total = 0.00)
+		//      then payment required is TRUE
+		return ! ($this->admin_request
+				  || $this->transaction->is_completed()
+				  || $this->transaction->is_overpaid()
+				  || $this->transaction->is_free()) ? true : false;
+	}
+
+
+	/**
+	 * get_cart_for_transaction
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @return EE_Cart
+	 */
+	public function get_cart_for_transaction($transaction)
+	{
+		$session = EE_Registry::instance()->load_core('Session');
+		$cart = $transaction instanceof EE_Transaction ? EE_Cart::get_cart_from_txn($transaction, $session) : null;
+		// verify cart
+		if (! $cart instanceof EE_Cart) {
+			$cart = EE_Registry::instance()->load_core('Cart');
+		}
+
+		return $cart;
+	}
+
+
+	/**
+	 *    initialize_txn_reg_steps_array
+	 *
+	 * @access public
+	 * @return    array
+	 */
+	public function initialize_txn_reg_steps_array()
+	{
+		$txn_reg_steps_array = array();
+		foreach ($this->reg_steps as $reg_step) {
+			$txn_reg_steps_array[ $reg_step->slug() ] = false;
+		}
+		return $txn_reg_steps_array;
+	}
+
+
+	/**
+	 *    update_txn_reg_steps_array
+	 *
+	 * @access public
+	 * @return    bool
+	 * @throws \EE_Error
+	 */
+	public function update_txn_reg_steps_array()
+	{
+		$updated = false;
+		foreach ($this->reg_steps as $reg_step) {
+			if ($reg_step->completed()) {
+				$updated = $this->transaction->set_reg_step_completed($reg_step->slug())
+					? true
+					: $updated;
+			}
+		}
+		if ($updated) {
+			$this->transaction->save();
+		}
+		return $updated;
+	}
+
+
+	/**
+	 *    stash_transaction_and_checkout
+	 *
+	 * @access public
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	public function stash_transaction_and_checkout()
+	{
+		if (! $this->revisit) {
+			$this->update_txn_reg_steps_array();
+		}
+		$this->track_transaction_and_registration_status_updates();
+		// save all data to the db, but suppress errors
+		// $this->save_all_data( FALSE );
+		// cache the checkout in the session
+		EE_Registry::instance()->SSN->set_checkout($this);
+	}
+
+
+	/**
+	 *    track_transaction_and_registration_status_updates
+	 *    stores whether any updates were made to the TXN or it's related registrations
+	 *
+	 * @access public
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function track_transaction_and_registration_status_updates()
+	{
+		// verify the transaction
+		if ($this->transaction instanceof EE_Transaction) {
+			// has there been a TXN status change during this checkout?
+			$this->txn_status_updated = $this->transaction->txn_status_updated();
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			// grab the saved registrations from the transaction
+			foreach ($this->transaction->registrations($this->reg_cache_where_params) as $registration) {
+				if ($registration_processor->reg_status_updated($registration->ID())) {
+					$this->set_reg_status_updated($registration->ID(), true);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    visit_allows_processing_of_this_registration
+	 *    determines if the current SPCO visit should allow the passed EE_Registration to be used in processing.
+	 *    one of the following conditions must be met:
+	 *        EITHER:    A) first time thru SPCO -> process ALL registrations ( NOT a revisit )
+	 *        OR :        B) primary registrant is editing info -> process ALL registrations ( primary_revisit )
+	 *        OR :        C) another registrant is editing info -> ONLY process their registration ( revisit AND their
+	 *        reg_url_link matches )
+	 *
+	 * @access public
+	 * @param    EE_Registration $registration
+	 * @return    bool
+	 * @throws \EE_Error
+	 */
+	public function visit_allows_processing_of_this_registration(EE_Registration $registration)
+	{
+		return ! $this->revisit
+			   || $this->primary_revisit
+			   || (
+				   $this->revisit && $this->reg_url_link === $registration->reg_url_link()
+			   )
+			? true
+			: false;
+	}
+
+
+	/**
+	 *    _transaction_has_primary_registration
+	 *
+	 * @access        private
+	 * @return        bool
+	 */
+	public function transaction_has_primary_registrant()
+	{
+		return $this->primary_attendee_obj instanceof EE_Attendee ? true : false;
+	}
+
+
+	/**
+	 *    save_all_data
+	 *    simply loops through the current transaction and saves all data for each registration
+	 *
+	 * @access public
+	 * @param bool $show_errors
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function save_all_data($show_errors = true)
+	{
+		// verify the transaction
+		if ($this->transaction instanceof EE_Transaction) {
+			// save to ensure that TXN has ID
+			$this->transaction->save();
+			// grab the saved registrations from the transaction
+			foreach ($this->transaction->registrations($this->reg_cache_where_params) as $registration) {
+				$this->_save_registration($registration, $show_errors);
+			}
+		} else {
+			if ($show_errors) {
+				EE_Error::add_error(
+					esc_html__(
+						'A valid Transaction was not found when attempting to save your registration information.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * _save_registration_attendee
+	 *
+	 * @param    EE_Registration $registration
+	 * @param bool               $show_errors
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _save_registration($registration, $show_errors = true)
+	{
+		// verify object
+		if ($registration instanceof EE_Registration) {
+			// should this registration be processed during this visit ?
+			if ($this->visit_allows_processing_of_this_registration($registration)) {
+				// set TXN ID
+				if (! $registration->transaction_ID()) {
+					$registration->set_transaction_id($this->transaction->ID());
+				}
+				// verify and save the attendee
+				$this->_save_registration_attendee($registration, $show_errors);
+				// save answers to reg form questions
+				$this->_save_registration_answers($registration, $show_errors);
+				// save changes
+				$registration->save();
+				// update txn cache
+				if (! $this->transaction->update_cache_after_object_save('Registration', $registration)) {
+					if ($show_errors) {
+						EE_Error::add_error(
+							esc_html__(
+								'The newly saved Registration object could not be cached on the Transaction.',
+								'event_espresso'
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				}
+			}
+		} else {
+			if ($show_errors) {
+				EE_Error::add_error(
+					esc_html__(
+						'An invalid Registration object was discovered when attempting to save your registration information.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * _save_registration_attendee
+	 *
+	 * @param    EE_Registration $registration
+	 * @param bool               $show_errors
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _save_registration_attendee($registration, $show_errors = true)
+	{
+		if ($registration->attendee() instanceof EE_Attendee) {
+			// save so that ATT has ID
+			$registration->attendee()->save();
+			if (! $registration->update_cache_after_object_save('Attendee', $registration->attendee())) {
+				if ($show_errors) {
+					EE_Error::add_error(
+						esc_html__(
+							'The newly saved Attendee object could not be cached on the registration.',
+							'event_espresso'
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			}
+		} else {
+			if ($show_errors) {
+				EE_Error::add_error(
+					sprintf(
+						'%1$s||%1$s $attendee = %2$s',
+						esc_html__(
+							'Either no Attendee information was found, or an invalid Attendee object was discovered when attempting to save your registration information.',
+							'event_espresso'
+						),
+						var_export($registration->attendee(), true)
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * _save_question_answers
+	 *
+	 * @param    EE_Registration $registration
+	 * @param bool               $show_errors
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _save_registration_answers($registration, $show_errors = true)
+	{
+		// now save the answers
+		foreach ($registration->answers() as $cache_key => $answer) {
+			// verify object
+			if ($answer instanceof EE_Answer) {
+				$answer->set_registration($registration->ID());
+				$answer->save();
+				if (! $registration->update_cache_after_object_save('Answer', $answer, $cache_key)) {
+					if ($show_errors) {
+						EE_Error::add_error(
+							esc_html__(
+								'The newly saved Answer object could not be cached on the registration.',
+								'event_espresso'
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				}
+			} else {
+				if ($show_errors) {
+					EE_Error::add_error(
+						esc_html__(
+							'An invalid Answer object was discovered when attempting to save your registration information.',
+							'event_espresso'
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    refresh_all_entities
+	 *   will either refresh the entity map with objects form the db or from the checkout cache
+	 *
+	 * @access public
+	 * @param bool $from_db
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function refresh_all_entities($from_db = false)
+	{
+		$this->current_step->setRequest(EED_Single_Page_Checkout::getRequest());
+		$from_db = $this->current_step->is_final_step() || $this->action === 'process_gateway_response'
+			? true
+			: $from_db;
+		// $this->log(
+		//     __CLASS__,
+		//     __FUNCTION__,
+		//     __LINE__,
+		//     array('from_db' => $from_db)
+		// );
+		return $from_db ? $this->refresh_from_db() : $this->refresh_entity_map();
+	}
+
+
+	/**
+	 *  refresh_entity_map
+	 *  simply loops through the current transaction and updates each
+	 *  model's entity map using EEM_Base::refresh_entity_map_from_db()
+	 *
+	 * @access public
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	protected function refresh_from_db()
+	{
+		// verify the transaction
+		if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
+			// pull fresh TXN data from the db
+			$this->transaction = $this->transaction->get_model()->refresh_entity_map_from_db($this->transaction->ID());
+			// update EE_Checkout's cached primary_attendee object
+			$this->primary_attendee_obj = $this->_refresh_primary_attendee_obj_from_db($this->transaction);
+			// update EE_Checkout's cached payment object
+			$payment = $this->transaction->last_payment();
+			$this->payment = $payment instanceof EE_Payment ? $payment : $this->payment;
+			// update EE_Checkout's cached payment_method object
+			$payment_method = $this->payment instanceof EE_Payment ? $this->payment->payment_method() : null;
+			$this->payment_method = $payment_method instanceof EE_Payment_Method ? $payment_method
+				: $this->payment_method;
+			// now refresh the cart, based on the TXN
+			$this->cart = $this->get_cart_for_transaction($this->transaction);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'A valid Transaction was not found when attempting to update the model entity mapper.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * _refresh_primary_attendee_obj_from_db
+	 *
+	 * @param   EE_Transaction $transaction
+	 * @return  EE_Attendee | null
+	 * @throws \EE_Error
+	 */
+	protected function _refresh_primary_attendee_obj_from_db(EE_Transaction $transaction)
+	{
+		$primary_attendee_obj = null;
+		// grab the saved registrations from the transaction
+		foreach ($transaction->registrations($this->reg_cache_where_params, true) as $registration) {
+			// verify object
+			if ($registration instanceof EE_Registration) {
+				$attendee = $registration->attendee();
+				// verify object && maybe cache primary_attendee_obj ?
+				if ($attendee instanceof EE_Attendee && $registration->is_primary_registrant()) {
+					$primary_attendee_obj = $attendee;
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'An invalid Registration object was discovered when attempting to update the model entity mapper.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		return $primary_attendee_obj;
+	}
+
+
+	/**
+	 *  refresh_entity_map
+	 *  simply loops through the current transaction and updates
+	 *  each model's entity map using EEM_Base::refresh_entity_map_with()
+	 *
+	 * @access public
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	protected function refresh_entity_map()
+	{
+		// verify the transaction
+		if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
+			// never cache payment info
+			$this->transaction->clear_cache('Payment');
+			// is the Payment Options Reg Step completed ?
+			if ($this->transaction->reg_step_completed('payment_options')) {
+				// then check for payments and update TXN accordingly
+				/** @type EE_Transaction_Payments $transaction_payments */
+				$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+				$transaction_payments->calculate_total_payments_and_update_status($this->transaction);
+			}
+			// grab the saved registrations from the transaction
+			foreach ($this->transaction->registrations($this->reg_cache_where_params) as $reg_cache_ID => $registration) {
+				$this->_refresh_registration($reg_cache_ID, $registration);
+			}
+			// make sure our cached TXN is added to the model entity mapper
+			$this->transaction = $this->transaction->get_model()->refresh_entity_map_with(
+				$this->transaction->ID(),
+				$this->transaction
+			);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'A valid Transaction was not found when attempting to update the model entity mapper.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// verify and update the cart because inaccurate totals are not so much fun
+		if ($this->cart instanceof EE_Cart) {
+			$grand_total = $this->cart->get_grand_total();
+			if ($grand_total instanceof EE_Line_Item && $grand_total->ID()) {
+				$grand_total->recalculate_total_including_taxes();
+				$grand_total = $grand_total->get_model()->refresh_entity_map_with(
+					$this->cart->get_grand_total()->ID(),
+					$this->cart->get_grand_total()
+				);
+			}
+			if ($grand_total instanceof EE_Line_Item) {
+				$this->cart = EE_Cart::instance($grand_total);
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'A valid Cart was not found when attempting to update the model entity mapper.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * _refresh_registration
+	 *
+	 * @param    string | int    $reg_cache_ID
+	 * @param    EE_Registration $registration
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _refresh_registration($reg_cache_ID, $registration)
+	{
+
+		// verify object
+		if ($registration instanceof EE_Registration) {
+			// update the entity mapper attendee
+			$this->_refresh_registration_attendee($registration);
+			// update the entity mapper answers for reg form questions
+			$this->_refresh_registration_answers($registration);
+			// make sure the cached registration is added to the model entity mapper
+			$registration->get_model()->refresh_entity_map_with($reg_cache_ID, $registration);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'An invalid Registration object was discovered when attempting to update the model entity mapper.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * _save_registration_attendee
+	 *
+	 * @param    EE_Registration $registration
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _refresh_registration_attendee($registration)
+	{
+		$attendee = $registration->attendee();
+		// verify object
+		if ($attendee instanceof EE_Attendee && $attendee->ID()) {
+			// make sure the cached attendee is added to the model entity mapper
+			$registration->attendee()->get_model()->refresh_entity_map_with($attendee->ID(), $attendee);
+			// maybe cache primary_attendee_obj ?
+			if ($registration->is_primary_registrant()) {
+				$this->primary_attendee_obj = $attendee;
+			}
+		}
+	}
+
+
+	/**
+	 * _refresh_registration_answers
+	 *
+	 * @param    EE_Registration $registration
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _refresh_registration_answers($registration)
+	{
+
+		// now update the answers
+		foreach ($registration->answers() as $cache_key => $answer) {
+			// verify object
+			if ($answer instanceof EE_Answer) {
+				if ($answer->ID()) {
+					// make sure the cached answer is added to the model entity mapper
+					$answer->get_model()->refresh_entity_map_with($answer->ID(), $answer);
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'An invalid Answer object was discovered when attempting to update the model entity mapper.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+	}
+
+
+	/**
+	 *    __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
+	 * @throws \EE_Error
+	 */
+	public function __sleep()
+	{
+		if ($this->primary_attendee_obj instanceof EE_Attendee && $this->primary_attendee_obj->ID()) {
+			$this->primary_attendee_obj = $this->primary_attendee_obj->ID();
+		}        // remove the reg form and the checkout
+		if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
+			$this->transaction = $this->transaction->ID();
+		}        // remove the reg form and the checkout
+		return array_diff(array_keys(get_object_vars($this)), array('billing_form', 'registration_form'));
+	}
+
+
+	/**
+	 *    __wakeup
+	 * to conserve db space, we are removing the EE_Checkout object from EE_SPCO_Reg_Step objects upon serialization
+	 * this will reinstate the EE_Checkout object on each EE_SPCO_Reg_Step object
+	 */
+	public function __wakeup()
+	{
+		try {
+			if (! $this->primary_attendee_obj instanceof EE_Attendee && absint($this->primary_attendee_obj) !== 0) {
+				// $this->primary_attendee_obj is actually just an ID, so use it to get the object from the db
+				$this->primary_attendee_obj = EEM_Attendee::instance()->get_one_by_ID($this->primary_attendee_obj);
+			}
+			if (! $this->transaction instanceof EE_Transaction && absint($this->transaction) !== 0) {
+				// $this->transaction is actually just an ID, so use it to get the object from the db
+				$this->transaction = EEM_Transaction::instance()->get_one_by_ID($this->transaction);
+			}
+			foreach ($this->reg_steps as $reg_step) {
+				$reg_step->checkout = $this;
+			}
+		} catch (Throwable $e) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred while attempting to reinstate a EE_SPCO_Reg_Step object in EE_Checkout::__wakeup().',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * debug
+	 *
+	 * @param string $class
+	 * @param string $func
+	 * @param string $line
+	 * @param array  $info
+	 * @param bool   $display_request
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function log($class = '', $func = '', $line = '', $info = array(), $display_request = false)
+	{
+		$disabled = true;
+		if (WP_DEBUG && ! $disabled) {
+			$debug_data = get_option('EE_DEBUG_SPCO_' . EE_Session::instance()->id(), array());
+			$default_data = array(
+				$class                    => $func . '() : ' . $line,
+				'request->step'           => $this->step,
+				'request->action'         => $this->action,
+				'current_step->slug'      => $this->current_step instanceof EE_SPCO_Reg_Step ?
+					$this->current_step->slug() : '',
+				'current_step->completed' => $this->current_step instanceof EE_SPCO_Reg_Step ?
+					$this->current_step->completed() : '',
+				'txn_status_updated'      => $this->transaction->txn_status_updated(),
+				'reg_status_updated'      => $this->reg_status_updated,
+				'reg_url_link'            => $this->reg_url_link,
+			);
+			if ($this->transaction instanceof EE_Transaction) {
+				$default_data['TXN_status'] = $this->transaction->status_ID();
+				$default_data['TXN_reg_steps'] = $this->transaction->reg_steps();
+				foreach ($this->transaction->registrations($this->reg_cache_where_params) as $REG_ID => $registration) {
+					$default_data['registrations'][ $REG_ID ] = $registration->status_ID();
+				}
+				if ($this->transaction->ID()) {
+					$TXN_ID = 'EE_Transaction: ' . $this->transaction->ID();
+					// don't serialize objects
+					$info = $this->_strip_objects($info);
+					if (! isset($debug_data[ $TXN_ID ])) {
+						$debug_data[ $TXN_ID ] = array();
+					}
+					$debug_data[ $TXN_ID ][ microtime() ] = array_merge(
+						$default_data,
+						$info
+					);
+					update_option('EE_DEBUG_SPCO_' . EE_Session::instance()->id(), $debug_data);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * _strip_objects
+	 *
+	 * @param array $info
+	 * @return array
+	 */
+	public function _strip_objects($info = array())
+	{
+		foreach ((array) $info as $key => $value) {
+			if (is_array($value)) {
+				$info[ $key ] = $this->_strip_objects($value);
+			} elseif (is_object($value)) {
+				$object_class = get_class($value);
+				$info[ $object_class ] = array();
+				$info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : 0;
+				if (method_exists($value, 'status')) {
+					$info[ $object_class ]['status'] = $value->status();
+				} elseif (method_exists($value, 'status_ID')) {
+					$info[ $object_class ]['status'] = $value->status_ID();
+				}
+				unset($info[ $key ]);
+			}
+		}
+		return (array) $info;
+	}
 }

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

Indentation +2810 added lines, -2810 removed lines

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

Spacing +80 added lines, -80 removed lines

@@ -126,7 +126,7 @@ 
         $this->request              = EED_Single_Page_Checkout::getRequest();
         $this->_slug                = 'payment_options';
         $this->_name                = esc_html__('Payment Options', 'event_espresso');
-        $this->_template            = SPCO_REG_STEPS_PATH . $this->_slug . '/payment_options_main.template.php';
+        $this->_template            = SPCO_REG_STEPS_PATH.$this->_slug.'/payment_options_main.template.php';
         $this->checkout             = $checkout;
         $this->payment_method_model = EEM_Payment_Method::instance();
         $this->_reset_success_message();
@@ -168,7 +168,7 @@ 
      */
     public function translate_js_strings()
     {
-        EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
+        EE_Registry::$i18n_js_strings['no_payment_method'] = esc_html__(
             'Please select a method of payment in order to continue.',
             'event_espresso'
         );
@@ -176,7 +176,7 @@ 
             'A valid method of payment could not be determined. Please refresh the page and try again.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
+        EE_Registry::$i18n_js_strings['forwarding_to_offsite'] = esc_html__(
             'Forwarding to Secure Payment Provider.',
             'event_espresso'
         );
@@ -192,7 +192,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 (
@@ -305,18 +305,18 @@ 
                 continue;
             }
             // 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() === RegStatus::AWAITING_REVIEW) {
                 // 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(),
@@ -333,7 +333,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(),
@@ -343,7 +343,7 @@ 
             }
             // are they allowed to pay now and is there monies owing?
             if ($registration->owes_monies_and_can_pay()) {
-                $registrations_requiring_payment[ $REG_ID ] = $registration;
+                $registrations_requiring_payment[$REG_ID] = $registration;
                 do_action(
                     'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
                     $registration->event(),
@@ -354,28 +354,28 @@ 
                       && $registration->status_ID() !== RegStatus::AWAITING_REVIEW
                       && $registration->ticket()->is_free()
             ) {
-                $registrations_for_free_events[ $registration->ticket()->ID() ] = $registration;
+                $registrations_for_free_events[$registration->ticket()->ID()] = $registration;
             }
         }
         $subsections = [];
         // now decide which template to load
-        if (! empty($sold_out_events)) {
+        if ( ! empty($sold_out_events)) {
             $subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
         }
-        if (! empty($insufficient_spaces_available)) {
+        if ( ! empty($insufficient_spaces_available)) {
             $subsections['insufficient_space'] = $this->_insufficient_spaces_available(
                 $insufficient_spaces_available
             );
         }
-        if (! empty($registrations_requiring_pre_approval)) {
+        if ( ! empty($registrations_requiring_pre_approval)) {
             $subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
                 $registrations_requiring_pre_approval
             );
         }
-        if (! empty($registrations_for_free_events)) {
+        if ( ! empty($registrations_for_free_events)) {
             $subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
         }
-        if (! empty($registrations_requiring_payment)) {
+        if ( ! empty($registrations_requiring_payment)) {
             if ($this->checkout->amount_owing > 0) {
                 // check for method_of_payment before setting up line items
                 // so that surcharges can be applied to the line items based on the selected method of payment
@@ -404,7 +404,7 @@ 
                         ['registrations' => $registrations]
                     )
                 );
-                $this->checkout->amount_owing   = $filtered_line_item_tree->total();
+                $this->checkout->amount_owing = $filtered_line_item_tree->total();
                 $this->_apply_registration_payments_to_amount_owing($registrations);
             }
             $no_payment_required = false;
@@ -449,13 +449,13 @@ 
     public static function add_spco_line_item_filters(
         EE_Line_Item_Filter_Collection $line_item_filter_collection
     ): EE_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(
@@ -494,8 +494,8 @@ 
         );
         foreach ($registrations as $REG_ID => $registration) {
             // has this registration lost it's space ?
-            if (isset($ejected_registrations[ $REG_ID ])) {
-                unset($registrations[ $REG_ID ]);
+            if (isset($ejected_registrations[$REG_ID])) {
+                unset($registrations[$REG_ID]);
             }
         }
         return $registrations;
@@ -544,25 +544,25 @@ 
             }
             $EVT_ID = $registration->event_ID();
             $ticket = $registration->ticket();
-            if (! isset($tickets_remaining[ $ticket->ID() ])) {
-                $tickets_remaining[ $ticket->ID() ] = $ticket->remaining();
+            if ( ! isset($tickets_remaining[$ticket->ID()])) {
+                $tickets_remaining[$ticket->ID()] = $ticket->remaining();
             }
-            if ($tickets_remaining[ $ticket->ID() ] > 0) {
-                if (! isset($event_reg_count[ $EVT_ID ])) {
-                    $event_reg_count[ $EVT_ID ] = 0;
+            if ($tickets_remaining[$ticket->ID()] > 0) {
+                if ( ! isset($event_reg_count[$EVT_ID])) {
+                    $event_reg_count[$EVT_ID] = 0;
                 }
-                $event_reg_count[ $EVT_ID ]++;
-                if (! isset($event_spaces_remaining[ $EVT_ID ])) {
-                    $event_spaces_remaining[ $EVT_ID ] = $registration->event()->spaces_remaining_for_sale();
+                $event_reg_count[$EVT_ID]++;
+                if ( ! isset($event_spaces_remaining[$EVT_ID])) {
+                    $event_spaces_remaining[$EVT_ID] = $registration->event()->spaces_remaining_for_sale();
                 }
             }
             if (
                 $revisit
-                && ($tickets_remaining[ $ticket->ID() ] === 0
-                    || $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
+                && ($tickets_remaining[$ticket->ID()] === 0
+                    || $event_reg_count[$EVT_ID] > $event_spaces_remaining[$EVT_ID]
                 )
             ) {
-                $ejected_registrations[ $REG_ID ] = $registration->event();
+                $ejected_registrations[$REG_ID] = $registration->event();
                 if ($registration->status_ID() !== RegStatus::WAIT_LIST) {
                     /** @type EE_Registration_Processor $registration_processor */
                     $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
@@ -609,7 +609,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'
                 )
@@ -665,7 +665,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')
                 );
             }
         }
@@ -713,7 +713,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(
                         '',
                         '',
@@ -843,7 +843,7 @@ 
     {
         return new EE_Form_Section_Proper(
             [
-                'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
+                'html_id'         => 'ee-'.$this->slug().'-extra-hidden-inputs',
                 'layout_strategy' => new EE_Div_Per_Section_Layout(),
                 'subsections'     => [
                     'spco_no_payment_required' => new EE_Hidden_Input(
@@ -881,7 +881,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();
@@ -955,7 +955,7 @@ 
             );
         }
         // switch up header depending on number of available payment methods
-        $payment_method_header     = count($this->checkout->available_payment_methods) > 1
+        $payment_method_header = count($this->checkout->available_payment_methods) > 1
             ? apply_filters(
                 'FHEE__registration_page_payment_options__method_of_payment_hdr',
                 esc_html__('Please Select Your Method of Payment', 'event_espresso')
@@ -985,14 +985,14 @@ 
         ];
         // loop through payment methods
         foreach ($this->checkout->available_payment_methods as $payment_method) {
-            if (! $payment_method instanceof EE_Payment_Method) {
+            if ( ! $payment_method instanceof EE_Payment_Method) {
                 continue;
             }
 
             $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
@@ -1007,11 +1007,11 @@ 
             ) {
                 $this->checkout->selected_method_of_payment = $payment_method->slug();
                 $this->_save_selected_method_of_payment();
-                $default_payment_method_option[ $payment_method->slug() ] = $payment_method_button;
+                $default_payment_method_option[$payment_method->slug()] = $payment_method_button;
             } else {
-                $available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
+                $available_payment_method_options[$payment_method->slug()] = $payment_method_button;
             }
-            $payment_methods_billing_info[ $payment_method->slug() . '-info' ] =
+            $payment_methods_billing_info[$payment_method->slug().'-info'] =
                 $this->_payment_method_billing_info(
                     $payment_method
                 );
@@ -1023,7 +1023,7 @@ 
         $available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
             $available_payment_method_options
         );
-        $available_payment_methods                              += $payment_methods_billing_info;
+        $available_payment_methods += $payment_methods_billing_info;
         // build the available payment methods form
         return new EE_Form_Section_Proper(
             [
@@ -1042,7 +1042,7 @@ 
      */
     protected function _get_available_payment_methods(): array
     {
-        if (! empty($this->checkout->available_payment_methods)) {
+        if ( ! empty($this->checkout->available_payment_methods)) {
             return $this->checkout->available_payment_methods;
         }
         $available_payment_methods = [];
@@ -1053,7 +1053,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;
@@ -1141,7 +1141,7 @@ 
         );
         return new EE_Form_Section_Proper(
             [
-                'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
+                'html_id'         => 'spco-payment-method-info-'.$payment_method->slug(),
                 'html_class'      => 'spco-payment-method-info-dv',
                 // only display the selected or default PM
                 'html_style'      => $currently_selected ? '' : 'display:none;',
@@ -1168,7 +1168,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 (
@@ -1338,7 +1338,7 @@ 
      */
     public function switch_payment_method()
     {
-        if (! $this->_verify_payment_method_is_set()) {
+        if ( ! $this->_verify_payment_method_is_set()) {
             return false;
         }
         if (
@@ -1472,7 +1472,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();
         }
@@ -1497,7 +1497,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
@@ -1507,7 +1507,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) {
@@ -1537,7 +1537,7 @@ 
     {
         // get State ID
         $STA_ID = $this->request->getRequestParam('state');
-        if (! empty($STA_ID)) {
+        if ( ! empty($STA_ID)) {
             // can we get state object from name ?
             EE_Registry::instance()->load_model('State');
             $state  = EEM_State::instance()->get_col([['STA_name' => $STA_ID], 'limit' => 1], 'STA_ID');
@@ -1545,7 +1545,7 @@ 
         }
         // get Country ISO
         $CNT_ISO = $this->request->getRequestParam('country');
-        if (! empty($CNT_ISO)) {
+        if ( ! empty($CNT_ISO)) {
             // can we get country object from name ?
             EE_Registry::instance()->load_model('Country');
             $country = EEM_Country::instance()->get_col(
@@ -1724,7 +1724,7 @@ 
     protected function _maybe_set_completed(EE_Payment $payment)
     {
         // Do we need to redirect them? If so, there's more work to be done.
-        if (! $payment->redirect_url()) {
+        if ( ! $payment->redirect_url()) {
             $this->set_completed();
         }
     }
@@ -1780,7 +1780,7 @@ 
     private function _process_payment()
     {
         // basically confirm that the event hasn't sold out since they hit the page
-        if (! $this->_last_second_ticket_verifications()) {
+        if ( ! $this->_last_second_ticket_verifications()) {
             return null;
         }
         // ya gotta make a choice man
@@ -1791,7 +1791,7 @@ 
             return null;
         }
         // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+        if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
             return null;
         }
         // setup billing form
@@ -1800,12 +1800,12 @@ 
                 $this->checkout->payment_method
             );
             // bad billing form ?
-            if (! $this->_billing_form_is_valid()) {
+            if ( ! $this->_billing_form_is_valid()) {
                 return null;
             }
         }
         // ensure primary registrant has been fully processed
-        if (! $this->_setup_primary_registrant_prior_to_payment()) {
+        if ( ! $this->_setup_primary_registrant_prior_to_payment()) {
             return null;
         }
         // if session is close to expiring (under 10 minutes by default)
@@ -1859,7 +1859,7 @@ 
     protected function _last_second_ticket_verifications(): bool
     {
         // 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();
@@ -1907,7 +1907,7 @@ 
             $this->_get_payment_method_for_selected_method_of_payment()
         );
         $html                        = $payment_method_billing_info->get_html();
-        $html                        .= $this->checkout->redirect_form;
+        $html .= $this->checkout->redirect_form;
         /** @var ResponseInterface $response */
         $response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
         $response->addOutput($html);
@@ -1922,7 +1922,7 @@ 
      */
     private function _billing_form_is_valid(): bool
     {
-        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) {
@@ -2042,16 +2042,16 @@ 
     private function _capture_primary_registration_data_from_billing_form(): bool
     {
         $primary_registration = $this->checkout->transaction->primary_registration();
-        if (! $this->validatePrimaryRegistration($primary_registration)) {
+        if ( ! $this->validatePrimaryRegistration($primary_registration)) {
             return false;
         }
 
         $primary_attendee = $this->getPrimaryAttendee($primary_registration);
-        if (! $this->validatePrimaryAttendee($primary_attendee)) {
+        if ( ! $this->validatePrimaryAttendee($primary_attendee)) {
             return false;
         }
 
-        if (! $this->addAttendeeToPrimaryRegistration($primary_attendee, $primary_registration)) {
+        if ( ! $this->addAttendeeToPrimaryRegistration($primary_attendee, $primary_registration)) {
             return false;
         }
         // both the primary registration and primary attendee objects should be valid entities at this point
@@ -2218,10 +2218,10 @@ 
             return null;
         }
         // get EE_Payment_Method object
-        $payment_method = $this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ]
+        $payment_method = $this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment]
             ?? $this->payment_method_model->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(
@@ -2239,7 +2239,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(
@@ -2271,7 +2271,7 @@ 
         $this->checkout->transaction->save();
         /** @var PaymentProcessor $payment_processor */
         $payment_processor = LoaderFactory::getShared(PaymentProcessor::class);
-        if (! $payment_processor instanceof PaymentProcessor) {
+        if ( ! $payment_processor instanceof PaymentProcessor) {
             return null;
         }
         /** @var EE_Transaction_Processor $transaction_processor */
@@ -2365,7 +2365,7 @@ 
             return true;
         }
         // verify payment object
-        if (! $payment instanceof EE_Payment) {
+        if ( ! $payment instanceof EE_Payment) {
             // not a payment
             EE_Error::add_error(
                 sprintf(
@@ -2410,7 +2410,7 @@ 
                 // and lastly, let's bump the payment status to pending
                 $payment->set_status(EEM_Payment::status_id_pending);
                 $payment->save();
-            } elseif (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
+            } elseif ( ! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
                 // User shouldn't be redirected. So let's process it here.
                 // $this->_setup_redirect_for_next_step();
                 $this->checkout->continue_reg = false;
@@ -2486,7 +2486,7 @@ 
                     return false;
                 // bad payment
                 case EEM_Payment::status_id_failed:
-                    if (! empty($msg)) {
+                    if ( ! empty($msg)) {
                         EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
                         return false;
                     }
@@ -2545,18 +2545,18 @@ 
         // how have they chosen to pay?
         $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
         // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+        if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
             $this->checkout->continue_reg = false;
             return false;
         }
-        if (! $this->checkout->payment_method->is_off_site()) {
+        if ( ! $this->checkout->payment_method->is_off_site()) {
             return false;
         }
         $this->_validate_offsite_return();
         // verify TXN
         if ($this->checkout->transaction instanceof EE_Transaction) {
             $gateway = $this->checkout->payment_method->type_obj()->get_gateway();
-            if (! $gateway instanceof EE_Offsite_Gateway) {
+            if ( ! $gateway instanceof EE_Offsite_Gateway) {
                 $this->checkout->continue_reg = false;
                 return false;
             }
@@ -2570,7 +2570,7 @@ 
                 $this->checkout->payment = $payment;
                 // mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
                 // because we will complete this step during the IPN processing then
-                if (! $this->handle_IPN_in_this_request()) {
+                if ( ! $this->handle_IPN_in_this_request()) {
                     $this->set_completed();
                 }
                 return true;
@@ -2663,13 +2663,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__(
@@ -2735,7 +2735,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);
             }

PaymentMethods/PayPalCommerce/tools/extra_meta/PayPalExtraMetaManager.php

Indentation +388 added lines, -388 removed lines

@@ -23,392 +23,392 @@
  */
 class PayPalExtraMetaManager
 {
-    private static ?OpenSSLEncryption $encryptor = null;
-
-    private static ?PayPalExtraMeta $pay_pal_extra_meta = null;
-
-
-    /**
-     * Get PayPal extra meta helper.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return PayPalExtraMeta
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function extraMeta(EE_Payment_Method $paypal_pm): PayPalExtraMeta
-    {
-        $post_params = LoaderFactory::getLoader()->getShared(RequestInterface::class)->postParams();
-        if (
-            ! PayPalExtraMetaManager::$pay_pal_extra_meta instanceof PayPalExtraMeta
-            || PayPalExtraMetaManager::$pay_pal_extra_meta->pm->slug() !== $paypal_pm->slug()
-            || (! empty($post_params['sandbox_mode'])
-                && in_array($post_params['sandbox_mode'], ['0', '1'], true)
-                && $paypal_pm->debug_mode() !== (bool) $post_params['sandbox_mode']
-            )
-        ) {
-            PayPalExtraMetaManager::$pay_pal_extra_meta = new PayPalExtraMeta($paypal_pm);
-        }
-        return PayPalExtraMetaManager::$pay_pal_extra_meta;
-    }
-
-
-    /**
-     * Get OpenSSLEncryption instance.
-     *
-     * @return OpenSSLEncryption
-     */
-    public static function encryptor(): OpenSSLEncryption
-    {
-        if (! PayPalExtraMetaManager::$encryptor instanceof OpenSSLEncryption) {
-            PayPalExtraMetaManager::$encryptor = LoaderFactory::getLoader()->getShared(
-                OpenSSLEncryption::class,
-                [new Base64Encoder()]
-            );
-        }
-        return PayPalExtraMetaManager::$encryptor;
-    }
-
-
-    /**
-     * Get payment method option/extra meta
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $option_name
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getPmOption(EE_Payment_Method $paypal_pm, string $option_name)
-    {
-        $option_value = PayPalExtraMetaManager::extraMeta($paypal_pm)->getOption($option_name);
-        // Decrypt the encrypted options.
-        if (
-            $option_name === Domain::META_KEY_ACCESS_TOKEN
-            || $option_name === Domain::META_KEY_PARTNER_MERCHANT_ID
-            || $option_name === Domain::META_KEY_CLIENT_SECRET
-        ) {
-            $option_value = PayPalExtraMetaManager::decryptString($option_value, $paypal_pm);
-        }
-        return $option_value;
-    }
-
-
-    /**
-     * Save payment method option/extra meta
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $option_name
-     * @param                   $option_value
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function savePmOption(EE_Payment_Method $paypal_pm, string $option_name, $option_value): bool
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->saveOption($option_name, $option_value);
-    }
-
-
-    /**
-     * Save a list of payment method options/extra meta.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $options_list
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function savePmOptions(EE_Payment_Method $paypal_pm, array $options_list): bool
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->saveBatch($options_list);
-    }
-
-
-    /**
-     * Delete payment method option/extra meta
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $option_name
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function deletePmOption(EE_Payment_Method $paypal_pm, string $option_name): bool
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteOption($option_name);
-    }
-
-
-    /**
-     * Get all options for payment method.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getAllData(EE_Payment_Method $paypal_pm): array
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->getMetaData();
-    }
-
-
-    /**
-     * Delete payment method metadata.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function deleteData(EE_Payment_Method $paypal_pm): bool
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteMetaData();
-    }
-
-
-    /**
-     * Delete all payment method metadata.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function deleteAllData(EE_Payment_Method $paypal_pm): bool
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteAllMetaData();
-    }
-
-    /**
-     * Save the debug mode option if it changed.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $request_data
-     * @return bool             Updated or not.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function updateDebugMode(EE_Payment_Method $paypal_pm, array $request_data): bool
-    {
-        if (
-            isset($request_data['sandbox_mode'])
-            && in_array($request_data['sandbox_mode'], ['0', '1'], true)
-            && $paypal_pm->debug_mode() !== (bool) $request_data['sandbox_mode']
-        ) {
-            try {
-                $paypal_pm->save(['PMD_debug_mode' => (bool) $request_data['sandbox_mode']]);
-            } catch (EE_Error $e) {
-                PayPalLogger::errorLog(
-                    sprintf(
-                        esc_html__('Note, debug mode not saved ! %1$s', 'event_espresso'),
-                        $e->getMessage()
-                    ),
-                    ['request_data' => $request_data, 'trace' => $e->getTrace()],
-                    $paypal_pm
-                );
-                return false;
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Save partner access token and parameters.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $response
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function savePartnerAccessToken(EE_Payment_Method $paypal_pm, array $response): bool
-    {
-        $paypal_data         = [];
-        $expected_parameters = [
-            Domain::META_KEY_ACCESS_TOKEN,
-            Domain::META_KEY_TOKEN_EXPIRES_IN,
-            Domain::META_KEY_APP_ID,
-            Domain::META_KEY_PARTNER_CLIENT_ID,
-            Domain::META_KEY_PARTNER_MERCHANT_ID,
-            Domain::META_KEY_BN_CODE,
-        ];
-        foreach ($expected_parameters as $api_key) {
-            if (! isset($response[ $api_key ])) {
-                // Don't want to try saving data that doesn't exist.
-                continue;
-            }
-            try {
-                switch ($api_key) {
-                    case Domain::META_KEY_ACCESS_TOKEN:
-                    case Domain::META_KEY_PARTNER_MERCHANT_ID:
-                        $paypal_data[ $api_key ] = PayPalExtraMetaManager::encryptString(
-                            $response[ $api_key ],
-                            $paypal_pm
-                        );
-                        break;
-                    case Domain::META_KEY_TOKEN_EXPIRES_IN:
-                        $paypal_data[ $api_key ] = time() + (int) sanitize_key($response[ $api_key ]);
-                        break;
-                    default:
-                        $paypal_data[ $api_key ] = sanitize_text_field($response[ $api_key ]);
-                }
-            } catch (Exception $e) {
-                PayPalLogger::errorLog(
-                    $e->getMessage(),
-                    ['response' => $response, 'trace' => $e->getTrace()],
-                    $paypal_pm
-                );
-                return false;
-            }
-        }
-        return PayPalExtraMetaManager::savePmOptions($paypal_pm, $paypal_data);
-    }
-
-
-    /**
-     * Save merchant/seller API credentials.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $response
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function saveSellerApiCredentials(EE_Payment_Method $paypal_pm, array $response): bool
-    {
-        $api_credentials     = [];
-        $expected_parameters = [Domain::META_KEY_SELLER_MERCHANT_ID];
-        foreach ($expected_parameters as $api_key) {
-            if (! isset($response[ $api_key ])) {
-                // Don't want to try saving data that doesn't exist.
-                continue;
-            }
-            $api_credentials[ $api_key ] = $response[ $api_key ];
-        }
-        return PayPalExtraMetaManager::savePmOptions($paypal_pm, $api_credentials);
-    }
-
-
-    /**
-     * Save other payment method related settings from a data array.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $data
-     * @param array             $get_params
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function parseAndSaveOptions(EE_Payment_Method $paypal_pm, array $data, array $get_params): bool
-    {
-        $allowed_checkout_type = 'express_checkout';
-        // Did the merchant onboard with PPCP enabled or no.
-        if (! empty($get_params['selected_payment']) && $get_params['selected_payment'] === 'PPCP') {
-            // Make sure that merchant's account really supports advanced card fields (included in the PPCP scope).
-            // Has to include "PPCP_CUSTOM" product for ACDC support. "EXPRESS_CHECKOUT" otherwise.
-            if (! empty($data['response']['products'][0]['name'])) {
-                foreach ($data['response']['products'] as $product) {
-                    if ($product['name'] === 'PPCP_CUSTOM') {
-                        // This merchant has PPCP in the products list, so we can enable both (all supported) checkout types.
-                        $allowed_checkout_type = 'all';
-                        break;
-                    }
-                }
-            }
-        }
-        // Set the PM option Checkout type, just in case merchant doesn't save PM options manually.
-        $checkout_type_setting = $paypal_pm->get_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, true, false);
-        if (! $checkout_type_setting || $checkout_type_setting !== $allowed_checkout_type) {
-            $paypal_pm->update_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, $allowed_checkout_type);
-        }
-        // Save the scopes that were authorized.
-        if (! empty($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'])) {
-            $scopes = [];
-            foreach ($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'] as $scope) {
-                // Scope will look like: 'https://uri.paypal.com/services/payments/partnerfee'
-                $split       = explode('/', $scope);
-                $split_count = count($split);
-                // Get the scope itself.
-                $scopes[] = $split[ $split_count - 1 ];
-            }
-            if (empty($scopes)) {
-                // In case the there's a change in how scopes come in just save the list.
-                $scopes = $data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'];
-            }
-            PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_AUTHORIZED_SCOPES, $scopes);
-        }
-        return PayPalExtraMetaManager::savePmOption(
-            $paypal_pm,
-            Domain::META_KEY_ALLOWED_CHECKOUT_TYPE,
-            $allowed_checkout_type
-        );
-    }
-
-
-    /**
-     * Encrypt a text field.
-     *
-     * @param string            $text
-     * @param EE_Payment_Method $paypal_pm
-     * @return string|null
-     * @throws Exception
-     */
-    public static function encryptString(string $text, EE_Payment_Method $paypal_pm): ?string
-    {
-        // We sure we are getting something ?
-        if (! $text) {
-            return $text;
-        }
-
-        try {
-            // Do encrypt.
-            $sanitized_text = sanitize_text_field($text);
-            $key_identifier = $paypal_pm->debug_mode()
-                ? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
-                : PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
-            $encrypted      = PayPalExtraMetaManager::encryptor()->encrypt($sanitized_text, $key_identifier);
-        } catch (Exception $e) {
-            PayPalLogger::errorLog(
-                $e->getMessage(),
-                ['trace' => $e->getTrace()],
-                $paypal_pm
-            );
-        }
-        return $encrypted ?? null;
-    }
-
-
-    /**
-     * Decrypt a string.
-     *
-     * @param string            $text
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     */
-    public static function decryptString(string $text, EE_Payment_Method $paypal_pm): string
-    {
-        // Are we even getting something ?
-        if (! $text) {
-            return $text;
-        }
-        // Try decrypting.
-        try {
-            $key_identifier = $paypal_pm->debug_mode()
-                ? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
-                : PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
-            $decrypted      = PayPalExtraMetaManager::encryptor()->decrypt($text, $key_identifier);
-        } catch (Exception $e) {
-            PayPalLogger::errorLog(
-                $e->getMessage(),
-                ['trace' => $e->getTrace()],
-                $paypal_pm
-            );
-            return $text;
-        }
-        return $decrypted ?? $text;
-    }
+	private static ?OpenSSLEncryption $encryptor = null;
+
+	private static ?PayPalExtraMeta $pay_pal_extra_meta = null;
+
+
+	/**
+	 * Get PayPal extra meta helper.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return PayPalExtraMeta
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function extraMeta(EE_Payment_Method $paypal_pm): PayPalExtraMeta
+	{
+		$post_params = LoaderFactory::getLoader()->getShared(RequestInterface::class)->postParams();
+		if (
+			! PayPalExtraMetaManager::$pay_pal_extra_meta instanceof PayPalExtraMeta
+			|| PayPalExtraMetaManager::$pay_pal_extra_meta->pm->slug() !== $paypal_pm->slug()
+			|| (! empty($post_params['sandbox_mode'])
+				&& in_array($post_params['sandbox_mode'], ['0', '1'], true)
+				&& $paypal_pm->debug_mode() !== (bool) $post_params['sandbox_mode']
+			)
+		) {
+			PayPalExtraMetaManager::$pay_pal_extra_meta = new PayPalExtraMeta($paypal_pm);
+		}
+		return PayPalExtraMetaManager::$pay_pal_extra_meta;
+	}
+
+
+	/**
+	 * Get OpenSSLEncryption instance.
+	 *
+	 * @return OpenSSLEncryption
+	 */
+	public static function encryptor(): OpenSSLEncryption
+	{
+		if (! PayPalExtraMetaManager::$encryptor instanceof OpenSSLEncryption) {
+			PayPalExtraMetaManager::$encryptor = LoaderFactory::getLoader()->getShared(
+				OpenSSLEncryption::class,
+				[new Base64Encoder()]
+			);
+		}
+		return PayPalExtraMetaManager::$encryptor;
+	}
+
+
+	/**
+	 * Get payment method option/extra meta
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $option_name
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getPmOption(EE_Payment_Method $paypal_pm, string $option_name)
+	{
+		$option_value = PayPalExtraMetaManager::extraMeta($paypal_pm)->getOption($option_name);
+		// Decrypt the encrypted options.
+		if (
+			$option_name === Domain::META_KEY_ACCESS_TOKEN
+			|| $option_name === Domain::META_KEY_PARTNER_MERCHANT_ID
+			|| $option_name === Domain::META_KEY_CLIENT_SECRET
+		) {
+			$option_value = PayPalExtraMetaManager::decryptString($option_value, $paypal_pm);
+		}
+		return $option_value;
+	}
+
+
+	/**
+	 * Save payment method option/extra meta
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $option_name
+	 * @param                   $option_value
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function savePmOption(EE_Payment_Method $paypal_pm, string $option_name, $option_value): bool
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->saveOption($option_name, $option_value);
+	}
+
+
+	/**
+	 * Save a list of payment method options/extra meta.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $options_list
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function savePmOptions(EE_Payment_Method $paypal_pm, array $options_list): bool
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->saveBatch($options_list);
+	}
+
+
+	/**
+	 * Delete payment method option/extra meta
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $option_name
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function deletePmOption(EE_Payment_Method $paypal_pm, string $option_name): bool
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteOption($option_name);
+	}
+
+
+	/**
+	 * Get all options for payment method.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getAllData(EE_Payment_Method $paypal_pm): array
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->getMetaData();
+	}
+
+
+	/**
+	 * Delete payment method metadata.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function deleteData(EE_Payment_Method $paypal_pm): bool
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteMetaData();
+	}
+
+
+	/**
+	 * Delete all payment method metadata.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function deleteAllData(EE_Payment_Method $paypal_pm): bool
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteAllMetaData();
+	}
+
+	/**
+	 * Save the debug mode option if it changed.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $request_data
+	 * @return bool             Updated or not.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function updateDebugMode(EE_Payment_Method $paypal_pm, array $request_data): bool
+	{
+		if (
+			isset($request_data['sandbox_mode'])
+			&& in_array($request_data['sandbox_mode'], ['0', '1'], true)
+			&& $paypal_pm->debug_mode() !== (bool) $request_data['sandbox_mode']
+		) {
+			try {
+				$paypal_pm->save(['PMD_debug_mode' => (bool) $request_data['sandbox_mode']]);
+			} catch (EE_Error $e) {
+				PayPalLogger::errorLog(
+					sprintf(
+						esc_html__('Note, debug mode not saved ! %1$s', 'event_espresso'),
+						$e->getMessage()
+					),
+					['request_data' => $request_data, 'trace' => $e->getTrace()],
+					$paypal_pm
+				);
+				return false;
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Save partner access token and parameters.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $response
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function savePartnerAccessToken(EE_Payment_Method $paypal_pm, array $response): bool
+	{
+		$paypal_data         = [];
+		$expected_parameters = [
+			Domain::META_KEY_ACCESS_TOKEN,
+			Domain::META_KEY_TOKEN_EXPIRES_IN,
+			Domain::META_KEY_APP_ID,
+			Domain::META_KEY_PARTNER_CLIENT_ID,
+			Domain::META_KEY_PARTNER_MERCHANT_ID,
+			Domain::META_KEY_BN_CODE,
+		];
+		foreach ($expected_parameters as $api_key) {
+			if (! isset($response[ $api_key ])) {
+				// Don't want to try saving data that doesn't exist.
+				continue;
+			}
+			try {
+				switch ($api_key) {
+					case Domain::META_KEY_ACCESS_TOKEN:
+					case Domain::META_KEY_PARTNER_MERCHANT_ID:
+						$paypal_data[ $api_key ] = PayPalExtraMetaManager::encryptString(
+							$response[ $api_key ],
+							$paypal_pm
+						);
+						break;
+					case Domain::META_KEY_TOKEN_EXPIRES_IN:
+						$paypal_data[ $api_key ] = time() + (int) sanitize_key($response[ $api_key ]);
+						break;
+					default:
+						$paypal_data[ $api_key ] = sanitize_text_field($response[ $api_key ]);
+				}
+			} catch (Exception $e) {
+				PayPalLogger::errorLog(
+					$e->getMessage(),
+					['response' => $response, 'trace' => $e->getTrace()],
+					$paypal_pm
+				);
+				return false;
+			}
+		}
+		return PayPalExtraMetaManager::savePmOptions($paypal_pm, $paypal_data);
+	}
+
+
+	/**
+	 * Save merchant/seller API credentials.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $response
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function saveSellerApiCredentials(EE_Payment_Method $paypal_pm, array $response): bool
+	{
+		$api_credentials     = [];
+		$expected_parameters = [Domain::META_KEY_SELLER_MERCHANT_ID];
+		foreach ($expected_parameters as $api_key) {
+			if (! isset($response[ $api_key ])) {
+				// Don't want to try saving data that doesn't exist.
+				continue;
+			}
+			$api_credentials[ $api_key ] = $response[ $api_key ];
+		}
+		return PayPalExtraMetaManager::savePmOptions($paypal_pm, $api_credentials);
+	}
+
+
+	/**
+	 * Save other payment method related settings from a data array.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $data
+	 * @param array             $get_params
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function parseAndSaveOptions(EE_Payment_Method $paypal_pm, array $data, array $get_params): bool
+	{
+		$allowed_checkout_type = 'express_checkout';
+		// Did the merchant onboard with PPCP enabled or no.
+		if (! empty($get_params['selected_payment']) && $get_params['selected_payment'] === 'PPCP') {
+			// Make sure that merchant's account really supports advanced card fields (included in the PPCP scope).
+			// Has to include "PPCP_CUSTOM" product for ACDC support. "EXPRESS_CHECKOUT" otherwise.
+			if (! empty($data['response']['products'][0]['name'])) {
+				foreach ($data['response']['products'] as $product) {
+					if ($product['name'] === 'PPCP_CUSTOM') {
+						// This merchant has PPCP in the products list, so we can enable both (all supported) checkout types.
+						$allowed_checkout_type = 'all';
+						break;
+					}
+				}
+			}
+		}
+		// Set the PM option Checkout type, just in case merchant doesn't save PM options manually.
+		$checkout_type_setting = $paypal_pm->get_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, true, false);
+		if (! $checkout_type_setting || $checkout_type_setting !== $allowed_checkout_type) {
+			$paypal_pm->update_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, $allowed_checkout_type);
+		}
+		// Save the scopes that were authorized.
+		if (! empty($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'])) {
+			$scopes = [];
+			foreach ($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'] as $scope) {
+				// Scope will look like: 'https://uri.paypal.com/services/payments/partnerfee'
+				$split       = explode('/', $scope);
+				$split_count = count($split);
+				// Get the scope itself.
+				$scopes[] = $split[ $split_count - 1 ];
+			}
+			if (empty($scopes)) {
+				// In case the there's a change in how scopes come in just save the list.
+				$scopes = $data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'];
+			}
+			PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_AUTHORIZED_SCOPES, $scopes);
+		}
+		return PayPalExtraMetaManager::savePmOption(
+			$paypal_pm,
+			Domain::META_KEY_ALLOWED_CHECKOUT_TYPE,
+			$allowed_checkout_type
+		);
+	}
+
+
+	/**
+	 * Encrypt a text field.
+	 *
+	 * @param string            $text
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string|null
+	 * @throws Exception
+	 */
+	public static function encryptString(string $text, EE_Payment_Method $paypal_pm): ?string
+	{
+		// We sure we are getting something ?
+		if (! $text) {
+			return $text;
+		}
+
+		try {
+			// Do encrypt.
+			$sanitized_text = sanitize_text_field($text);
+			$key_identifier = $paypal_pm->debug_mode()
+				? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
+				: PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
+			$encrypted      = PayPalExtraMetaManager::encryptor()->encrypt($sanitized_text, $key_identifier);
+		} catch (Exception $e) {
+			PayPalLogger::errorLog(
+				$e->getMessage(),
+				['trace' => $e->getTrace()],
+				$paypal_pm
+			);
+		}
+		return $encrypted ?? null;
+	}
+
+
+	/**
+	 * Decrypt a string.
+	 *
+	 * @param string            $text
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 */
+	public static function decryptString(string $text, EE_Payment_Method $paypal_pm): string
+	{
+		// Are we even getting something ?
+		if (! $text) {
+			return $text;
+		}
+		// Try decrypting.
+		try {
+			$key_identifier = $paypal_pm->debug_mode()
+				? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
+				: PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
+			$decrypted      = PayPalExtraMetaManager::encryptor()->decrypt($text, $key_identifier);
+		} catch (Exception $e) {
+			PayPalLogger::errorLog(
+				$e->getMessage(),
+				['trace' => $e->getTrace()],
+				$paypal_pm
+			);
+			return $text;
+		}
+		return $decrypted ?? $text;
+	}
 }

Spacing +16 added lines, -16 removed lines

@@ -42,7 +42,7 @@ 
         if (
             ! PayPalExtraMetaManager::$pay_pal_extra_meta instanceof PayPalExtraMeta
             || PayPalExtraMetaManager::$pay_pal_extra_meta->pm->slug() !== $paypal_pm->slug()
-            || (! empty($post_params['sandbox_mode'])
+            || ( ! empty($post_params['sandbox_mode'])
                 && in_array($post_params['sandbox_mode'], ['0', '1'], true)
                 && $paypal_pm->debug_mode() !== (bool) $post_params['sandbox_mode']
             )
@@ -60,7 +60,7 @@ 
      */
     public static function encryptor(): OpenSSLEncryption
     {
-        if (! PayPalExtraMetaManager::$encryptor instanceof OpenSSLEncryption) {
+        if ( ! PayPalExtraMetaManager::$encryptor instanceof OpenSSLEncryption) {
             PayPalExtraMetaManager::$encryptor = LoaderFactory::getLoader()->getShared(
                 OpenSSLEncryption::class,
                 [new Base64Encoder()]
@@ -237,7 +237,7 @@ 
             Domain::META_KEY_BN_CODE,
         ];
         foreach ($expected_parameters as $api_key) {
-            if (! isset($response[ $api_key ])) {
+            if ( ! isset($response[$api_key])) {
                 // Don't want to try saving data that doesn't exist.
                 continue;
             }
@@ -245,16 +245,16 @@ 
                 switch ($api_key) {
                     case Domain::META_KEY_ACCESS_TOKEN:
                     case Domain::META_KEY_PARTNER_MERCHANT_ID:
-                        $paypal_data[ $api_key ] = PayPalExtraMetaManager::encryptString(
-                            $response[ $api_key ],
+                        $paypal_data[$api_key] = PayPalExtraMetaManager::encryptString(
+                            $response[$api_key],
                             $paypal_pm
                         );
                         break;
                     case Domain::META_KEY_TOKEN_EXPIRES_IN:
-                        $paypal_data[ $api_key ] = time() + (int) sanitize_key($response[ $api_key ]);
+                        $paypal_data[$api_key] = time() + (int) sanitize_key($response[$api_key]);
                         break;
                     default:
-                        $paypal_data[ $api_key ] = sanitize_text_field($response[ $api_key ]);
+                        $paypal_data[$api_key] = sanitize_text_field($response[$api_key]);
                 }
             } catch (Exception $e) {
                 PayPalLogger::errorLog(
@@ -283,11 +283,11 @@ 
         $api_credentials     = [];
         $expected_parameters = [Domain::META_KEY_SELLER_MERCHANT_ID];
         foreach ($expected_parameters as $api_key) {
-            if (! isset($response[ $api_key ])) {
+            if ( ! isset($response[$api_key])) {
                 // Don't want to try saving data that doesn't exist.
                 continue;
             }
-            $api_credentials[ $api_key ] = $response[ $api_key ];
+            $api_credentials[$api_key] = $response[$api_key];
         }
         return PayPalExtraMetaManager::savePmOptions($paypal_pm, $api_credentials);
     }
@@ -307,10 +307,10 @@ 
     {
         $allowed_checkout_type = 'express_checkout';
         // Did the merchant onboard with PPCP enabled or no.
-        if (! empty($get_params['selected_payment']) && $get_params['selected_payment'] === 'PPCP') {
+        if ( ! empty($get_params['selected_payment']) && $get_params['selected_payment'] === 'PPCP') {
             // Make sure that merchant's account really supports advanced card fields (included in the PPCP scope).
             // Has to include "PPCP_CUSTOM" product for ACDC support. "EXPRESS_CHECKOUT" otherwise.
-            if (! empty($data['response']['products'][0]['name'])) {
+            if ( ! empty($data['response']['products'][0]['name'])) {
                 foreach ($data['response']['products'] as $product) {
                     if ($product['name'] === 'PPCP_CUSTOM') {
                         // This merchant has PPCP in the products list, so we can enable both (all supported) checkout types.
@@ -322,18 +322,18 @@ 
         }
         // Set the PM option Checkout type, just in case merchant doesn't save PM options manually.
         $checkout_type_setting = $paypal_pm->get_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, true, false);
-        if (! $checkout_type_setting || $checkout_type_setting !== $allowed_checkout_type) {
+        if ( ! $checkout_type_setting || $checkout_type_setting !== $allowed_checkout_type) {
             $paypal_pm->update_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, $allowed_checkout_type);
         }
         // Save the scopes that were authorized.
-        if (! empty($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'])) {
+        if ( ! empty($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'])) {
             $scopes = [];
             foreach ($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'] as $scope) {
                 // Scope will look like: 'https://uri.paypal.com/services/payments/partnerfee'
                 $split       = explode('/', $scope);
                 $split_count = count($split);
                 // Get the scope itself.
-                $scopes[] = $split[ $split_count - 1 ];
+                $scopes[] = $split[$split_count - 1];
             }
             if (empty($scopes)) {
                 // In case the there's a change in how scopes come in just save the list.
@@ -360,7 +360,7 @@ 
     public static function encryptString(string $text, EE_Payment_Method $paypal_pm): ?string
     {
         // We sure we are getting something ?
-        if (! $text) {
+        if ( ! $text) {
             return $text;
         }
 
@@ -392,7 +392,7 @@ 
     public static function decryptString(string $text, EE_Payment_Method $paypal_pm): string
     {
         // Are we even getting something ?
-        if (! $text) {
+        if ( ! $text) {
             return $text;
         }
         // Try decrypting.

PaymentMethods/PayPalCommerce/PayPalCheckout/forms/BillingForm.php

Indentation +571 added lines, -571 removed lines

@@ -37,575 +37,575 @@
  */
 class BillingForm extends EE_Billing_Attendee_Info_Form
 {
-    protected EE_Payment_Method $paypal_pmt;
-
-    protected ?EE_Transaction $transaction = null;
-
-    protected string $checkout_type;
-
-    /**
-     * Filepath to template files
-     *
-     * @var string $template_path
-     */
-    protected string $template_path;
-
-
-    /**
-     * Class constructor.
-     *
-     * @param EE_Payment_Method    $payment_method
-     * @param array                $options
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(EE_Payment_Method $payment_method, array $options)
-    {
-        $this->paypal_pmt    = $payment_method;
-        // Can't be too careful.
-        $this->transaction   = $options['transaction'] ?? null;
-        $this->template_path = $options['template_path'] ?? '';
-        $this->checkout_type = $payment_method->get_extra_meta(
-            Domain::META_KEY_CHECKOUT_TYPE,
-            true,
-            'express_checkout'
-        );
-        $pm_slug             = $payment_method->slug();
-        $parameters          = array_replace_recursive(
-            $options,
-            [
-                'name'        => 'PayPalCommerceBillingForm',
-                'html_id'     => 'pp-' . $pm_slug . '-billing-form',
-                'html_class'  => 'pp_commerce_billing_form',
-                'subsections' => [
-                    'eea_paypal_commerce_token' => new EE_Hidden_Input(
-                        [
-                            'html_id'   => 'eea-paypal-commerce-token',
-                            'html_name' => 'EEA_paymentToken',
-                            'default'   => '',
-                        ]
-                    ),
-                    'pp_order_nonce'            => new EE_Hidden_Input(
-                        [
-                            'html_id'   => 'eea-' . $pm_slug . '-order-nonce',
-                            'html_name' => 'pp_order_nonce',
-                            'default'   => '',
-                        ]
-                    ),
-                    'pp_order_id'               => new EE_Hidden_Input(
-                        [
-                            'html_id'   => 'eea-' . $pm_slug . '-order-id',
-                            'html_name' => 'pp_order_id',
-                            'default'   => '',
-                        ]
-                    ),
-                    'pp_order_status'           => new EE_Hidden_Input(
-                        [
-                            'html_id'   => 'eea-' . $pm_slug . '-order-status',
-                            'html_name' => 'pp_order_status',
-                            'default'   => '',
-                        ]
-                    ),
-                ],
-            ]
-        );
-        // Add data tags to the PP script.
-        add_filter('script_loader_tag', [$this, 'addDataTagsToScript'], 10, 2);
-        parent::__construct($payment_method, $parameters);
-        // Add and exclude other sections.
-        $this->addPaymentSections();
-        // Additional actions and/or filters.
-        $this->loadActionsAndFilters();
-    }
-
-
-    /**
-     * Add PayPal payment sections.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function addPaymentSections(): void
-    {
-        // Exclude the default billing form fields.
-        $this->exclude(
-            [
-                'first_name',
-                'last_name',
-                'email',
-            ]
-        );
-        // Add PayPal Hosted Fields.
-        if (! empty($this->checkout_type) && $this->checkout_type !== 'express_checkout') {
-            $this->addAdvancedCardFields();
-        }
-        // Add payment types separator, if both are enabled.
-        if ($this->checkout_type === 'all') {
-            $this->addTypesSeparator();
-        }
-        // Add PayPal Buttons section.
-        if ($this->checkout_type !== 'ppcp') {
-            $this->add_subsections(
-                [
-                    'paypal_commerce_pm_form' => $this->addPayPalCheckout(),
-                ]
-            );
-        }
-        // Exclude the rest billing form fields if the payment type is express checkout.
-        if ($this->checkout_type === 'express_checkout') {
-            $this->exclude(
-                [
-                    'address',
-                    'address2',
-                    'state',
-                    'phone',
-                    'city',
-                    'country',
-                    'zip',
-                ]
-            );
-            // Remove the Info subsection.
-            add_filter('FHEE__EE_Form_Section_Proper___construct__options_array', [$this, 'excludeInfoSubsection']);
-        }
-        $this->add_subsections(
-            [
-                'debug_content' => $this->addDebugContent($this->paypal_pmt),
-            ]
-        );
-    }
-
-
-    /**
-     * Additional actions and/or filters.
-     *
-     * @return void
-     */
-    public function loadActionsAndFilters(): void
-    {
-        add_filter(
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
-            [__CLASS__, 'excludeBillingFormFields'],
-            10,
-            2
-        );
-    }
-
-
-    /**
-     * Filter out billing form fields if pay button was used.
-     *
-     * @param EE_Billing_Info_Form $billing_form
-     * @param EE_Payment_Method    $payment_method
-     * @return EE_Billing_Info_Form
-     */
-    public static function excludeBillingFormFields(
-        EE_Billing_Info_Form $billing_form,
-        EE_Payment_Method $payment_method
-    ): EE_Billing_Info_Form {
-        $request        = LoaderFactory::getShared(Request::class);
-        $request_params = $request->requestParams();
-        // Only the PPC billing form.
-        if (! $billing_form instanceof BillingForm) {
-            return $billing_form;
-        }
-        // Make sure the billing form subsections have correct names.
-        $inputs = $billing_form->inputs_in_subsections();
-        if (
-            ! empty($request_params['process_form_submission'])
-            && $request_params['process_form_submission'] === '1'
-            && ! empty($request_params['eep_ppc_skip_form_validation'])
-        ) {
-            // Hide card info fields.
-            $billing_form->exclude(
-                [
-                    'pp_name_on_card',
-                    'address',
-                    'address2',
-                    'state',
-                    'phone',
-                    'city',
-                    'country',
-                    'zip',
-                ]
-            );
-        }
-        return $billing_form;
-    }
-
-
-    /**
-     * Add advanced card & debit card fields.
-     *
-     * @return void
-     * @throws EE_Error|ReflectionException
-     */
-    public function addAdvancedCardFields(): void
-    {
-        $pm_slug = $this->paypal_pmt->slug();
-        $this->add_subsections(
-            [
-                'pp_card_number'     => new EE_Form_Section_HTML(
-                    EEH_HTML::label(
-                        esc_html__('Card Number', 'event_espresso'),
-                        "$pm_slug-card-number-lbl",
-                        "$pm_slug-card-fields",
-                        "",
-                        'for="' . $pm_slug . '-card-number"'
-                    ) .
-                    EEH_HTML::p(
-                        "",
-                        "$pm_slug-card-number",
-                        "card_field $pm_slug-card-fields"
-                    )
-                ),
-                'pp_expiration_date' => new EE_Form_Section_HTML(
-                    EEH_HTML::label(
-                        esc_html__('Expiration Date', 'event_espresso'),
-                        "$pm_slug-expiration-date-lbl",
-                        "$pm_slug-card-fields",
-                        "",
-                        'for="' . $pm_slug . '-expiration-date"'
-                    ) .
-                    EEH_HTML::p(
-                        "",
-                        "$pm_slug-expiration-date",
-                        "card_field $pm_slug-card-fields"
-                    )
-                ),
-                'pp_card_cvv'        => new EE_Form_Section_HTML(
-                    EEH_HTML::label(
-                        esc_html__('CVV', 'event_espresso'),
-                        "$pm_slug-cvv-lbl",
-                        "$pm_slug-card-fields",
-                        "",
-                        'for="' . $pm_slug . '-cvv"'
-                    ) .
-                    EEH_HTML::p(
-                        "",
-                        "$pm_slug-cvv",
-                        "card_field $pm_slug-card-fields"
-                    )
-                ),
-                'pp_name_on_card'    => new EE_Text_Input(
-                    [
-                        'html_label_text' => esc_html__('Name On Card', 'event_espresso'),
-                        'html_id'         => $pm_slug . '-card-holder-name',
-                        'html_name'       => 'card-holder-name',
-                        'html_class'      => '',
-                        'required'        => true,
-                    ]
-                ),
-            ]
-        );
-        // Add the submit button at the end.
-        $this->add_subsections(
-            [
-                'pp_cc_submit' => new EE_Submit_Input(
-                    [
-                        'html_label_text' => esc_html__('Submit', 'event_espresso'),
-                        'html_id'         => $pm_slug,
-                        'html_class'      => 'eep-ppc-btn',
-                    ]
-                ),
-            ],
-            'phone',
-            false
-        );
-    }
-
-
-    /**
-     * Add advanced card & debit card fields.
-     *
-     * @return void
-     * @throws EE_Error|ReflectionException
-     */
-    public function addTypesSeparator(): void
-    {
-        $this->add_subsections(
-            [
-                'pp_payment_types_separator' => new EE_Form_Section_HTML(
-                    EEH_HTML::div(
-                        EEH_HTML::div(
-                            ' ',
-                            'eep-' . $this->paypal_pmt->slug() . '-payments-separator',
-                            'eep-ppc-separator-line eep-left-floating'
-                        ) .
-                        EEH_HTML::div(
-                            esc_html__(' or ', 'event_espresso'),
-                            'eep-' . $this->paypal_pmt->slug() . '-separator-text',
-                            'eep-ppc-separator-text1 eep-mid-floating'
-                        ) . EEH_HTML::div(
-                            ' ',
-                            'eep-' . $this->paypal_pmt->slug() . '-payments-separator',
-                            'eep-ppc-separator-line eep-right-floating'
-                        ),
-                        'eep-ppc-separator-holder',
-                        'eep-ppc-separator-holder'
-                    )
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * Exclude the info subsection from the PPC checkout form.
-     *
-     * @param array $options_array
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function excludeInfoSubsection(array $options_array): array
-    {
-        if (
-            ! empty($options_array['html_id'])
-            && $options_array['html_id'] === 'spco-payment-method-info-' . $this->paypal_pmt->slug()
-        ) {
-            if (! empty($options_array['subsections']) && isset($options_array['subsections']['info'])) {
-                unset($options_array['subsections']['info']);
-            }
-        }
-        return $options_array;
-    }
-
-
-    /**
-     * Possibly adds debug content to PayPal commerce billing form.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return EE_Form_Section_Base
-     * @throws EE_Error|ReflectionException
-     */
-    public function addDebugContent(EE_Payment_Method $paypal_pm): EE_Form_Section_Base
-    {
-        if ($paypal_pm->debug_mode()) {
-            return new EE_Form_Section_Proper(
-                [
-                    'layout_strategy' => new EE_Template_Layout(
-                        [
-                            'layout_template_file' => $this->template_path . 'debugInfo.template.php',
-                            'template_args'        => [],
-                        ]
-                    ),
-                ]
-            );
-        }
-        return new EE_Form_Section_HTML();
-    }
-
-
-    /**
-     * Add PayPal checkout buttons.
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function addPayPalCheckout(): EE_Form_Section_Proper
-    {
-        $template_args['pm_slug']     = $this->paypal_pmt->slug();
-        return new EE_Form_Section_Proper(
-            [
-                'layout_strategy' => new EE_Template_Layout(
-                    [
-                        'layout_template_file' => $this->template_path . 'paymentButtons.template.php',
-                        'template_args'        => $template_args,
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * Load scripts and localize data needed for this form.
-     *
-     * @param $tag
-     * @param $handle
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function addDataTagsToScript($tag, $handle): string
-    {
-        if ($handle === 'eea_paypal_commerce_js_lib') {
-            $bn_code  = PayPalExtraMetaManager::getPmOption($this->_pm_instance, Domain::META_KEY_BN_CODE);
-            $response = EED_PayPalCommerce::requestClientToken($this->paypal_pmt);
-            if (empty($response['client_token'])) {
-                return $tag;
-            }
-            $client_token = $response['client_token'];
-            $attributes   = " data-partner-attribution-id=\"$bn_code\" data-client-token=\"$client_token\"";
-            $tag          = str_replace('></script>', $attributes . '></script>', $tag);
-        }
-        return $tag;
-    }
-
-
-    /**
-     * Load scripts and localize data needed for this form.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function enqueue_js(): void
-    {
-        // Setup default values
-        $client_id_key = Domain::META_KEY_CLIENT_ID;
-        $merchant_id   = false;
-        $funding_options = ['venmo', 'paylater'];
-
-        // Override the above if third party integration
-        if (EED_PayPalCommerce::isThirdParty($this->_pm_instance)) {
-            $client_id_key = Domain::META_KEY_PARTNER_CLIENT_ID;
-            $merchant_id   = PayPalExtraMetaManager::getPmOption(
-                $this->_pm_instance,
-                Domain::META_KEY_SELLER_MERCHANT_ID
-            );
-        }
-
-        // Setup query args
-        $url_params            = [
-            'client-id'        => PayPalExtraMetaManager::getPmOption($this->_pm_instance, $client_id_key),
-            'currency'         => CurrencyManager::currencyCode(),
-            'components'       => implode(',', ['buttons','hosted-fields']),
-            'intent'           => 'capture',
-            'merchant-id'      => $merchant_id,
-        ];
-
-        // Which funding methods are active?
-        $enabled_funding = $this->_pm_instance->get_extra_meta(Domain::META_KEY_FUNDING_OPTIONS, true, $funding_options);
-
-        // Any funding method not enabled should be disabled.
-        $disabled_funding = array_diff(
-            $funding_options,
-            $enabled_funding
-        );
-
-        // Any funding options enabled?
-        if (count($enabled_funding) > 0) {
-            $url_params['enable-funding'] = implode(',', $enabled_funding);
-        }
-
-        // Any funding options disabled?
-        if (count($disabled_funding) > 0) {
-            $url_params['disable-funding'] = implode(',', $disabled_funding);
-        }
-
-        // Enqueue the PayPal JS
-        wp_enqueue_script(
-            'eea_paypal_commerce_js_lib',
-            add_query_arg($url_params, 'https://www.paypal.com/sdk/js'),
-            [],
-            null
-        );
-
-        wp_enqueue_script(
-            'eea_paypal_commerce_js',
-            EEP_PAYPAL_COMMERCE_URL . 'assets/js/paypal-commerce-payments.js',
-            ['eea_paypal_commerce_js_lib'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        // Styles.
-        wp_enqueue_style(
-            'eea_paypal_checkout_form_styles',
-            EEP_PAYPAL_COMMERCE_URL . 'assets' . DS . 'css' . DS . 'eea-paypal-checkout.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        // Localize the script with our transaction data.
-        $parameters = $this->localizeParameters();
-        wp_localize_script('eea_paypal_commerce_js', 'eeaPPCommerceParameters', $parameters);
-        parent::enqueue_js();
-    }
-
-
-    /**
-     * Form and return PayPal commerce parameters for script localization.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function localizeParameters(): array
-    {
-        // Also tell the script about each instance of this PM.
-        $pm_versions            = [];
-        $active_payment_methods = EEM_Payment_Method::instance()->get_all_active(
-            EEM_Payment_Method::scope_cart,
-            [['PMD_slug' => ['LIKE', '%paypalcheckout%']]]
-        );
-        foreach ($active_payment_methods as $payment_method) {
-            $pm_versions[ $payment_method->slug() ] = [
-                'pm_slug' => $payment_method->slug(),
-            ];
-        }
-        // Convert money for a display format.
-        $decimal_places = CurrencyManager::getDecimalPlaces();
-        $org_country    = isset(EE_Registry::instance()->CFG->organization)
-        && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
-            ? EE_Registry::instance()->CFG->organization->CNT_ISO
-            : 'US';
-        $transaction_id = $this->transaction instanceof EE_Transaction ? $this->transaction->ID() : 0;
-        $currency_code  = CurrencyManager::currencyCode();
-        return [
-            'pm_versions'            => $pm_versions,
-            'payment_currency'       => $currency_code,
-            'checkout_type'          => $this->checkout_type,
-            'currency_sign'          => EE_Registry::instance()->CFG->currency->sign,
-            'pp_order_nonce'         => wp_create_nonce(Domain::CAPTURE_ORDER_NONCE_NAME),
-            // The transaction ID is only used for logging errors.
-            'txn_id'                 => $transaction_id,
-            'org_country'            => $org_country,
-            'decimal_places'         => $decimal_places,
-            'site_name'              => get_bloginfo('name'),
-            'active_states'          => EED_PayPalCommerce::getActiveStates(),
-            'no_spco_error'          => esc_html__(
-                'It appears the SDK script was not loaded properly! Please refresh the page and try again or contact support.',
-                'event_espresso'
-            ),
-            'no_pm_error'            => esc_html__(
-                'It appears that PayPal Commerce checkout JavaScript was not loaded properly! Please refresh the page and try again or contact support. PayPal Commerce payments can\'t be processed.',
-                'event_espresso'
-            ),
-            'browser_not_supported'  => esc_html__(
-                'It appears that this browser is not supported by PayPal scripts. We apologize, but PayPal payments won\'t work in this browser version.',
-                'event_espresso'
-            ),
-            'get_token_error'        => esc_html__(
-                'There was an error while trying to get the payment token. Please refresh the page and try again or contact support.',
-                'event_espresso'
-            ),
-            'form_validation_notice' => esc_html__('Billing form information not valid.', 'event_espresso'),
-            'no_verification_token'  => esc_html__('Missing the Verification token.', 'event_espresso'),
-            'error_response'         => esc_html__('Error response received', 'event_espresso'),
-            'payment_error'          => esc_html__(
-                'There was an error with this payment. See the logs for details.',
-                'event_espresso'
-            ),
-            'no_order_id'            => esc_html__('No Order ID found.', 'event_espresso'),
-            'general_pp_error'       => esc_html__('PayPal form threw an error.', 'event_espresso'),
-            'hf_render_error'        => esc_html__('Hosted fields could not be rendered!', 'event_espresso'),
-            'pm_capture_error'       => esc_html__('Payment could not be captured!', 'event_espresso'),
-            'contact_support_msg'    => sprintf(
-                /* translators: %1$s: organization email, %2$s: the transaction ID */
-                esc_html__('Please contact support (%1$s) for more details on this transaction #%2$s.', 'event_espresso'),
-                EE_Registry::instance()->CFG->organization->get_pretty('email'),
-                $transaction_id
-            ),
-            'not_acdc_eligible'      => esc_html__(
-                'This merchant is not eligible for Advanced Card Fields checkout type.',
-                'event_espresso'
-            ),
-            'processor_response'     => esc_html__('Processor response: ', 'event_espresso'),
-        ];
-    }
+	protected EE_Payment_Method $paypal_pmt;
+
+	protected ?EE_Transaction $transaction = null;
+
+	protected string $checkout_type;
+
+	/**
+	 * Filepath to template files
+	 *
+	 * @var string $template_path
+	 */
+	protected string $template_path;
+
+
+	/**
+	 * Class constructor.
+	 *
+	 * @param EE_Payment_Method    $payment_method
+	 * @param array                $options
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(EE_Payment_Method $payment_method, array $options)
+	{
+		$this->paypal_pmt    = $payment_method;
+		// Can't be too careful.
+		$this->transaction   = $options['transaction'] ?? null;
+		$this->template_path = $options['template_path'] ?? '';
+		$this->checkout_type = $payment_method->get_extra_meta(
+			Domain::META_KEY_CHECKOUT_TYPE,
+			true,
+			'express_checkout'
+		);
+		$pm_slug             = $payment_method->slug();
+		$parameters          = array_replace_recursive(
+			$options,
+			[
+				'name'        => 'PayPalCommerceBillingForm',
+				'html_id'     => 'pp-' . $pm_slug . '-billing-form',
+				'html_class'  => 'pp_commerce_billing_form',
+				'subsections' => [
+					'eea_paypal_commerce_token' => new EE_Hidden_Input(
+						[
+							'html_id'   => 'eea-paypal-commerce-token',
+							'html_name' => 'EEA_paymentToken',
+							'default'   => '',
+						]
+					),
+					'pp_order_nonce'            => new EE_Hidden_Input(
+						[
+							'html_id'   => 'eea-' . $pm_slug . '-order-nonce',
+							'html_name' => 'pp_order_nonce',
+							'default'   => '',
+						]
+					),
+					'pp_order_id'               => new EE_Hidden_Input(
+						[
+							'html_id'   => 'eea-' . $pm_slug . '-order-id',
+							'html_name' => 'pp_order_id',
+							'default'   => '',
+						]
+					),
+					'pp_order_status'           => new EE_Hidden_Input(
+						[
+							'html_id'   => 'eea-' . $pm_slug . '-order-status',
+							'html_name' => 'pp_order_status',
+							'default'   => '',
+						]
+					),
+				],
+			]
+		);
+		// Add data tags to the PP script.
+		add_filter('script_loader_tag', [$this, 'addDataTagsToScript'], 10, 2);
+		parent::__construct($payment_method, $parameters);
+		// Add and exclude other sections.
+		$this->addPaymentSections();
+		// Additional actions and/or filters.
+		$this->loadActionsAndFilters();
+	}
+
+
+	/**
+	 * Add PayPal payment sections.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function addPaymentSections(): void
+	{
+		// Exclude the default billing form fields.
+		$this->exclude(
+			[
+				'first_name',
+				'last_name',
+				'email',
+			]
+		);
+		// Add PayPal Hosted Fields.
+		if (! empty($this->checkout_type) && $this->checkout_type !== 'express_checkout') {
+			$this->addAdvancedCardFields();
+		}
+		// Add payment types separator, if both are enabled.
+		if ($this->checkout_type === 'all') {
+			$this->addTypesSeparator();
+		}
+		// Add PayPal Buttons section.
+		if ($this->checkout_type !== 'ppcp') {
+			$this->add_subsections(
+				[
+					'paypal_commerce_pm_form' => $this->addPayPalCheckout(),
+				]
+			);
+		}
+		// Exclude the rest billing form fields if the payment type is express checkout.
+		if ($this->checkout_type === 'express_checkout') {
+			$this->exclude(
+				[
+					'address',
+					'address2',
+					'state',
+					'phone',
+					'city',
+					'country',
+					'zip',
+				]
+			);
+			// Remove the Info subsection.
+			add_filter('FHEE__EE_Form_Section_Proper___construct__options_array', [$this, 'excludeInfoSubsection']);
+		}
+		$this->add_subsections(
+			[
+				'debug_content' => $this->addDebugContent($this->paypal_pmt),
+			]
+		);
+	}
+
+
+	/**
+	 * Additional actions and/or filters.
+	 *
+	 * @return void
+	 */
+	public function loadActionsAndFilters(): void
+	{
+		add_filter(
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
+			[__CLASS__, 'excludeBillingFormFields'],
+			10,
+			2
+		);
+	}
+
+
+	/**
+	 * Filter out billing form fields if pay button was used.
+	 *
+	 * @param EE_Billing_Info_Form $billing_form
+	 * @param EE_Payment_Method    $payment_method
+	 * @return EE_Billing_Info_Form
+	 */
+	public static function excludeBillingFormFields(
+		EE_Billing_Info_Form $billing_form,
+		EE_Payment_Method $payment_method
+	): EE_Billing_Info_Form {
+		$request        = LoaderFactory::getShared(Request::class);
+		$request_params = $request->requestParams();
+		// Only the PPC billing form.
+		if (! $billing_form instanceof BillingForm) {
+			return $billing_form;
+		}
+		// Make sure the billing form subsections have correct names.
+		$inputs = $billing_form->inputs_in_subsections();
+		if (
+			! empty($request_params['process_form_submission'])
+			&& $request_params['process_form_submission'] === '1'
+			&& ! empty($request_params['eep_ppc_skip_form_validation'])
+		) {
+			// Hide card info fields.
+			$billing_form->exclude(
+				[
+					'pp_name_on_card',
+					'address',
+					'address2',
+					'state',
+					'phone',
+					'city',
+					'country',
+					'zip',
+				]
+			);
+		}
+		return $billing_form;
+	}
+
+
+	/**
+	 * Add advanced card & debit card fields.
+	 *
+	 * @return void
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function addAdvancedCardFields(): void
+	{
+		$pm_slug = $this->paypal_pmt->slug();
+		$this->add_subsections(
+			[
+				'pp_card_number'     => new EE_Form_Section_HTML(
+					EEH_HTML::label(
+						esc_html__('Card Number', 'event_espresso'),
+						"$pm_slug-card-number-lbl",
+						"$pm_slug-card-fields",
+						"",
+						'for="' . $pm_slug . '-card-number"'
+					) .
+					EEH_HTML::p(
+						"",
+						"$pm_slug-card-number",
+						"card_field $pm_slug-card-fields"
+					)
+				),
+				'pp_expiration_date' => new EE_Form_Section_HTML(
+					EEH_HTML::label(
+						esc_html__('Expiration Date', 'event_espresso'),
+						"$pm_slug-expiration-date-lbl",
+						"$pm_slug-card-fields",
+						"",
+						'for="' . $pm_slug . '-expiration-date"'
+					) .
+					EEH_HTML::p(
+						"",
+						"$pm_slug-expiration-date",
+						"card_field $pm_slug-card-fields"
+					)
+				),
+				'pp_card_cvv'        => new EE_Form_Section_HTML(
+					EEH_HTML::label(
+						esc_html__('CVV', 'event_espresso'),
+						"$pm_slug-cvv-lbl",
+						"$pm_slug-card-fields",
+						"",
+						'for="' . $pm_slug . '-cvv"'
+					) .
+					EEH_HTML::p(
+						"",
+						"$pm_slug-cvv",
+						"card_field $pm_slug-card-fields"
+					)
+				),
+				'pp_name_on_card'    => new EE_Text_Input(
+					[
+						'html_label_text' => esc_html__('Name On Card', 'event_espresso'),
+						'html_id'         => $pm_slug . '-card-holder-name',
+						'html_name'       => 'card-holder-name',
+						'html_class'      => '',
+						'required'        => true,
+					]
+				),
+			]
+		);
+		// Add the submit button at the end.
+		$this->add_subsections(
+			[
+				'pp_cc_submit' => new EE_Submit_Input(
+					[
+						'html_label_text' => esc_html__('Submit', 'event_espresso'),
+						'html_id'         => $pm_slug,
+						'html_class'      => 'eep-ppc-btn',
+					]
+				),
+			],
+			'phone',
+			false
+		);
+	}
+
+
+	/**
+	 * Add advanced card & debit card fields.
+	 *
+	 * @return void
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function addTypesSeparator(): void
+	{
+		$this->add_subsections(
+			[
+				'pp_payment_types_separator' => new EE_Form_Section_HTML(
+					EEH_HTML::div(
+						EEH_HTML::div(
+							' ',
+							'eep-' . $this->paypal_pmt->slug() . '-payments-separator',
+							'eep-ppc-separator-line eep-left-floating'
+						) .
+						EEH_HTML::div(
+							esc_html__(' or ', 'event_espresso'),
+							'eep-' . $this->paypal_pmt->slug() . '-separator-text',
+							'eep-ppc-separator-text1 eep-mid-floating'
+						) . EEH_HTML::div(
+							' ',
+							'eep-' . $this->paypal_pmt->slug() . '-payments-separator',
+							'eep-ppc-separator-line eep-right-floating'
+						),
+						'eep-ppc-separator-holder',
+						'eep-ppc-separator-holder'
+					)
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * Exclude the info subsection from the PPC checkout form.
+	 *
+	 * @param array $options_array
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function excludeInfoSubsection(array $options_array): array
+	{
+		if (
+			! empty($options_array['html_id'])
+			&& $options_array['html_id'] === 'spco-payment-method-info-' . $this->paypal_pmt->slug()
+		) {
+			if (! empty($options_array['subsections']) && isset($options_array['subsections']['info'])) {
+				unset($options_array['subsections']['info']);
+			}
+		}
+		return $options_array;
+	}
+
+
+	/**
+	 * Possibly adds debug content to PayPal commerce billing form.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return EE_Form_Section_Base
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function addDebugContent(EE_Payment_Method $paypal_pm): EE_Form_Section_Base
+	{
+		if ($paypal_pm->debug_mode()) {
+			return new EE_Form_Section_Proper(
+				[
+					'layout_strategy' => new EE_Template_Layout(
+						[
+							'layout_template_file' => $this->template_path . 'debugInfo.template.php',
+							'template_args'        => [],
+						]
+					),
+				]
+			);
+		}
+		return new EE_Form_Section_HTML();
+	}
+
+
+	/**
+	 * Add PayPal checkout buttons.
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function addPayPalCheckout(): EE_Form_Section_Proper
+	{
+		$template_args['pm_slug']     = $this->paypal_pmt->slug();
+		return new EE_Form_Section_Proper(
+			[
+				'layout_strategy' => new EE_Template_Layout(
+					[
+						'layout_template_file' => $this->template_path . 'paymentButtons.template.php',
+						'template_args'        => $template_args,
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * Load scripts and localize data needed for this form.
+	 *
+	 * @param $tag
+	 * @param $handle
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function addDataTagsToScript($tag, $handle): string
+	{
+		if ($handle === 'eea_paypal_commerce_js_lib') {
+			$bn_code  = PayPalExtraMetaManager::getPmOption($this->_pm_instance, Domain::META_KEY_BN_CODE);
+			$response = EED_PayPalCommerce::requestClientToken($this->paypal_pmt);
+			if (empty($response['client_token'])) {
+				return $tag;
+			}
+			$client_token = $response['client_token'];
+			$attributes   = " data-partner-attribution-id=\"$bn_code\" data-client-token=\"$client_token\"";
+			$tag          = str_replace('></script>', $attributes . '></script>', $tag);
+		}
+		return $tag;
+	}
+
+
+	/**
+	 * Load scripts and localize data needed for this form.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function enqueue_js(): void
+	{
+		// Setup default values
+		$client_id_key = Domain::META_KEY_CLIENT_ID;
+		$merchant_id   = false;
+		$funding_options = ['venmo', 'paylater'];
+
+		// Override the above if third party integration
+		if (EED_PayPalCommerce::isThirdParty($this->_pm_instance)) {
+			$client_id_key = Domain::META_KEY_PARTNER_CLIENT_ID;
+			$merchant_id   = PayPalExtraMetaManager::getPmOption(
+				$this->_pm_instance,
+				Domain::META_KEY_SELLER_MERCHANT_ID
+			);
+		}
+
+		// Setup query args
+		$url_params            = [
+			'client-id'        => PayPalExtraMetaManager::getPmOption($this->_pm_instance, $client_id_key),
+			'currency'         => CurrencyManager::currencyCode(),
+			'components'       => implode(',', ['buttons','hosted-fields']),
+			'intent'           => 'capture',
+			'merchant-id'      => $merchant_id,
+		];
+
+		// Which funding methods are active?
+		$enabled_funding = $this->_pm_instance->get_extra_meta(Domain::META_KEY_FUNDING_OPTIONS, true, $funding_options);
+
+		// Any funding method not enabled should be disabled.
+		$disabled_funding = array_diff(
+			$funding_options,
+			$enabled_funding
+		);
+
+		// Any funding options enabled?
+		if (count($enabled_funding) > 0) {
+			$url_params['enable-funding'] = implode(',', $enabled_funding);
+		}
+
+		// Any funding options disabled?
+		if (count($disabled_funding) > 0) {
+			$url_params['disable-funding'] = implode(',', $disabled_funding);
+		}
+
+		// Enqueue the PayPal JS
+		wp_enqueue_script(
+			'eea_paypal_commerce_js_lib',
+			add_query_arg($url_params, 'https://www.paypal.com/sdk/js'),
+			[],
+			null
+		);
+
+		wp_enqueue_script(
+			'eea_paypal_commerce_js',
+			EEP_PAYPAL_COMMERCE_URL . 'assets/js/paypal-commerce-payments.js',
+			['eea_paypal_commerce_js_lib'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		// Styles.
+		wp_enqueue_style(
+			'eea_paypal_checkout_form_styles',
+			EEP_PAYPAL_COMMERCE_URL . 'assets' . DS . 'css' . DS . 'eea-paypal-checkout.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		// Localize the script with our transaction data.
+		$parameters = $this->localizeParameters();
+		wp_localize_script('eea_paypal_commerce_js', 'eeaPPCommerceParameters', $parameters);
+		parent::enqueue_js();
+	}
+
+
+	/**
+	 * Form and return PayPal commerce parameters for script localization.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function localizeParameters(): array
+	{
+		// Also tell the script about each instance of this PM.
+		$pm_versions            = [];
+		$active_payment_methods = EEM_Payment_Method::instance()->get_all_active(
+			EEM_Payment_Method::scope_cart,
+			[['PMD_slug' => ['LIKE', '%paypalcheckout%']]]
+		);
+		foreach ($active_payment_methods as $payment_method) {
+			$pm_versions[ $payment_method->slug() ] = [
+				'pm_slug' => $payment_method->slug(),
+			];
+		}
+		// Convert money for a display format.
+		$decimal_places = CurrencyManager::getDecimalPlaces();
+		$org_country    = isset(EE_Registry::instance()->CFG->organization)
+		&& EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
+			? EE_Registry::instance()->CFG->organization->CNT_ISO
+			: 'US';
+		$transaction_id = $this->transaction instanceof EE_Transaction ? $this->transaction->ID() : 0;
+		$currency_code  = CurrencyManager::currencyCode();
+		return [
+			'pm_versions'            => $pm_versions,
+			'payment_currency'       => $currency_code,
+			'checkout_type'          => $this->checkout_type,
+			'currency_sign'          => EE_Registry::instance()->CFG->currency->sign,
+			'pp_order_nonce'         => wp_create_nonce(Domain::CAPTURE_ORDER_NONCE_NAME),
+			// The transaction ID is only used for logging errors.
+			'txn_id'                 => $transaction_id,
+			'org_country'            => $org_country,
+			'decimal_places'         => $decimal_places,
+			'site_name'              => get_bloginfo('name'),
+			'active_states'          => EED_PayPalCommerce::getActiveStates(),
+			'no_spco_error'          => esc_html__(
+				'It appears the SDK script was not loaded properly! Please refresh the page and try again or contact support.',
+				'event_espresso'
+			),
+			'no_pm_error'            => esc_html__(
+				'It appears that PayPal Commerce checkout JavaScript was not loaded properly! Please refresh the page and try again or contact support. PayPal Commerce payments can\'t be processed.',
+				'event_espresso'
+			),
+			'browser_not_supported'  => esc_html__(
+				'It appears that this browser is not supported by PayPal scripts. We apologize, but PayPal payments won\'t work in this browser version.',
+				'event_espresso'
+			),
+			'get_token_error'        => esc_html__(
+				'There was an error while trying to get the payment token. Please refresh the page and try again or contact support.',
+				'event_espresso'
+			),
+			'form_validation_notice' => esc_html__('Billing form information not valid.', 'event_espresso'),
+			'no_verification_token'  => esc_html__('Missing the Verification token.', 'event_espresso'),
+			'error_response'         => esc_html__('Error response received', 'event_espresso'),
+			'payment_error'          => esc_html__(
+				'There was an error with this payment. See the logs for details.',
+				'event_espresso'
+			),
+			'no_order_id'            => esc_html__('No Order ID found.', 'event_espresso'),
+			'general_pp_error'       => esc_html__('PayPal form threw an error.', 'event_espresso'),
+			'hf_render_error'        => esc_html__('Hosted fields could not be rendered!', 'event_espresso'),
+			'pm_capture_error'       => esc_html__('Payment could not be captured!', 'event_espresso'),
+			'contact_support_msg'    => sprintf(
+				/* translators: %1$s: organization email, %2$s: the transaction ID */
+				esc_html__('Please contact support (%1$s) for more details on this transaction #%2$s.', 'event_espresso'),
+				EE_Registry::instance()->CFG->organization->get_pretty('email'),
+				$transaction_id
+			),
+			'not_acdc_eligible'      => esc_html__(
+				'This merchant is not eligible for Advanced Card Fields checkout type.',
+				'event_espresso'
+			),
+			'processor_response'     => esc_html__('Processor response: ', 'event_espresso'),
+		];
+	}
 }

PaymentMethods/PayPalCommerce/modules/EED_PayPalOnboard.module.php

Indentation +759 added lines, -759 removed lines

@@ -20,766 +20,766 @@
  */
 class EED_PayPalOnboard extends EED_Module
 {
-    /**
-     * @return EED_Module
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance(): EED_Module
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * Run - initial module setup.
-     *
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     * For hooking into EE Admin Core and other modules.
-     *
-     * @return void
-     */
-    public static function set_hooks_admin(): void
-    {
-        // check for the most basic EE capability
-        /** @var EE_Capabilities $capabilities */
-        $capabilities = LoaderFactory::getLoader()->getShared(EE_Capabilities::class);
-        if (
-            DbStatus::isOffline()
-            || ! $capabilities->current_user_can('ee_manage_gateways', 'manage-paypal-onboarding')
-        ) {
-            return;
-        }
-        // Get onboarding URL.
-        add_action('wp_ajax_eeaPpGetOnboardingUrl', [__CLASS__, 'getOnboardingUrl']);
-        // Catch the return/redirect from PayPal onboarding page.
-        add_action('admin_init', [__CLASS__, 'updateOnboardingStatus']);
-        // Return the connection/onboard status.
-        add_action('wp_ajax_eeaPpGetOnboardStatus', [__CLASS__, 'getOnboardStatus']);
-        // Revoke access.
-        add_action('wp_ajax_eeaPpOffboard', [__CLASS__, 'offboard']);
-        // Clear all metadata.
-        add_action('wp_ajax_eeaPpClearMetaData', [__CLASS__, 'clearMetaData']);
-        add_action('wp_ajax_eeaPpSaveDebugMode', [__CLASS__, 'eeaPpSaveDebugMode']);
-        // Admin notice.
-        add_action('admin_init', [__CLASS__, 'adminNotice']);
-    }
-
-
-    /**
-     * Get the onboarding URL.
-     * (AJAX)
-     *
-     * @return void
-     */
-    public static function getOnboardingUrl(): void
-    {
-        $signup_link = '';
-        try {
-            $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-            if (! $paypal_pm instanceof EE_Payment_Method) {
-                PayPalLogger::errorLogAndExit(
-                    esc_html__('No payment method.', 'event_espresso'),
-                    EED_Module::getRequest()->postParams(),
-                    $paypal_pm
-                );
-            }
-            PayPalExtraMetaManager::updateDebugMode($paypal_pm, EED_Module::getRequest()->postParams());
-            // Just get a new onboarding URL every time.
-            $signup_link = EED_PayPalOnboard::requestOnboardingUrl($paypal_pm);
-            if (! $signup_link) {
-                $err_msg = esc_html__('Error! Could not generate a sign-up link.', 'event_espresso');
-                PayPalLogger::errorLogAndExit($err_msg, ['signup_link' => $signup_link], $paypal_pm);
-            }
-        } catch (Exception $e) {
-            PayPalLogger::errorLogAndExit($e->getMessage(), ['trace' => $e->getTrace()]);
-        }
-        // Is it empty (can happen if we didn't get the URL through the API).
-        $signup_link = $signup_link ? $signup_link . '?&displayMode=minibrowser' : '#';
-        wp_send_json(
-            [
-                'signup_link' => $signup_link,
-            ]
-        );
-    }
-
-
-    /**
-     * Request the sign-up link from PayPal.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param bool              $one_time_request
-     * @return string
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public static function requestOnboardingUrl(EE_Payment_Method $paypal_pm, bool $one_time_request = false): string
-    {
-        $signup_link = '';
-        // Get the access token.
-        $access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
-        if (! $access_token) {
-            $err_msg = esc_html__('Error! No access token.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, ['access_token' => $access_token], $paypal_pm);
-            return '';
-        }
-        // Request the access token.
-        $body_params = EED_PayPalOnboard::signupLinkRequestBody($paypal_pm);
-        $bn_code     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
-        $post_params = [
-            'method'  => 'POST',
-            'headers' => [
-                'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
-                'Content-Type'                  => 'application/json',
-                'Authorization'                 => 'Bearer ' . $access_token,
-                'PayPal-Partner-Attribution-Id' => $bn_code,
-            ],
-            'body'    => $body_params,
-        ];
-        $request_url = Domain::getPayPalApiUrl($paypal_pm) . '/v2/customer/partner-referrals';
-        $response    = EED_PayPalOnboard::sendRequest($paypal_pm, $request_url, $post_params);
-        // Check the data we received.
-        if (isset($response['error']) || empty($response['links'])) {
-            // Did the original access token get replaced by any chance ?
-            if (
-                ! $one_time_request
-                && ! empty($response['message'])
-                && $response['message'] === 'Access Token not found in cache'
-            ) {
-                // Clear all PM metadata and try getting the access token One more time.
-                PayPalExtraMetaManager::deleteData($paypal_pm);
-                PayPalLogger::errorLog(
-                    esc_html__('Removing old metadata before new onboarding.', 'event_espresso'),
-                    $response,
-                    $paypal_pm
-                );
-                return EED_PayPalOnboard::requestOnboardingUrl($paypal_pm, true);
-            }
-            $err_msg = esc_html__('Incoming sign-up link parameter validation failed.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, $response, $paypal_pm);
-            return '';
-        }
-        // Now retrieve that sign-up link.
-        foreach ($response['links'] as $link) {
-            if ($link['rel'] === 'action_url') {
-                $signup_link = $link['href'] ?? '';
-            }
-        }
-        return $signup_link;
-    }
-
-
-    /**
-     * Get the return URL.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws Exception
-     */
-    public static function signupLinkRequestBody(EE_Payment_Method $paypal_pm): string
-    {
-        $identifier_string = new OneTimeString($paypal_pm->debug_mode());
-        $tracking_id       = $identifier_string->value();
-        $request           = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $selected_payment  = $request->getRequestParam('selected_payment', 'EXPRESS_CHECKOUT');
-        // Save the identifier for future use.
-        PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_TRACKING_ID, $tracking_id);
-        // Assemble the return URL.
-        $return_url = EED_PayPalOnboard::getReturnUrl($paypal_pm, $selected_payment);
-        return json_encode(
-            [
-                'tracking_id'             => $tracking_id,
-                'operations'              => [
-                    [
-                        'operation'                  => 'API_INTEGRATION',
-                        'api_integration_preference' => [
-                            'rest_api_integration' => [
-                                'integration_method'  => 'PAYPAL',
-                                'integration_type'    => 'THIRD_PARTY',
-                                'third_party_details' => [
-                                    'features' => ['PAYMENT', 'REFUND', 'PARTNER_FEE'],
-                                ],
-                            ],
-                        ],
-                    ],
-                ],
-                'products'                => [$selected_payment],
-                'legal_consents'          => [
-                    [
-                        'type'    => 'SHARE_DATA_CONSENT',
-                        'granted' => true,
-                    ],
-                ],
-                'partner_config_override' => [
-                    'return_url' => $return_url,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Get the return URL.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $selected_payment
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getReturnUrl(EE_Payment_Method $paypal_pm, string $selected_payment = ''): string
-    {
-        $wp_nonce = EED_Module::getRequest()->getRequestParam('wp_nonce');
-        $nonce    = wp_create_nonce(Domain::NONCE_NAME_ONBOARDING_RETURN);
-        return add_query_arg(
-            [
-                'page'                        => 'espresso_payment_settings',
-                'webhook_action'              => 'eepPpcMerchantOnboard',
-                'payment_method'              => $paypal_pm->slug(),
-                '_wpnonce'                    => $wp_nonce,
-                'nonce'                       => $nonce,
-                'selected_payment'            => $selected_payment,
-                Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
-            ],
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Redirect to the payment method (PP) settings home page.
-     *
-     * @return void
-     */
-    public static function redirectToPmSettingsHome(): void
-    {
-        $get_params = EED_Module::getRequest()->getParams();
-        if (empty($get_params['payment_method'])) {
-            // Simply do not redirect.
-            return;
-        }
-        $args_to_add = [
-            'page'           => 'espresso_payment_settings',
-            'payment_method' => $get_params['payment_method'],
-        ];
-        if (isset($get_params['sandbox_mode'])) {
-            $args_to_add[ Domain::META_KEY_SANDBOX_MODE ] = $get_params['sandbox_mode'];
-        }
-        $home_url = add_query_arg($args_to_add, admin_url('admin.php'));
-        wp_redirect($home_url);
-        exit;
-    }
-
-
-    /**
-     * Check user’s onboarding status.
-     * This will handle the user return from the auth page and also check the status via the API.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function updateOnboardingStatus(): void
-    {
-        // Check if this is the webhook from PayPal.
-        if (
-            ! isset($_GET['webhook_action'], $_GET['nonce'])
-            || $_GET['webhook_action'] !== 'eepPpcMerchantOnboard'
-        ) {
-            return;  // Ignore.
-        }
-        $get_params = EED_Module::getRequest()->getParams();
-        // Get the payment method.
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
-            PayPalLogger::errorLog(
-                esc_html__('Not able to validate the payment method.', 'event_espresso'),
-                $get_params,
-                $paypal_pm
-            );
-            EED_PayPalOnboard::redirectToPmSettingsHome();
-            return;
-        }
-        // Check the response (GET) parameters.
-        if (! EED_PayPalOnboard::onboardingStatusResponseValid($get_params, $paypal_pm)) {
-            // Missing parameters. Can't proceed.
-            PayPalLogger::errorLog(
-                esc_html__('Missing required onboarding parameters.', 'event_espresso'),
-                $get_params,
-                $paypal_pm
-            );
-            EED_PayPalOnboard::redirectToPmSettingsHome();
-            return;
-        }
-        // Check on the onboarding status (recommended by PP).
-        $onboarding_status = EED_PayPalOnboard::trackSellerOnboarding(
-            $paypal_pm,
-            $get_params[ Domain::META_KEY_SELLER_MERCHANT_ID ]
-        );
-        if (! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
-            PayPalLogger::errorLog(
-                $onboarding_status['message'] ?? esc_html__('Failed to track seller onboarding.', 'event_espresso'),
-                array_merge($get_params, $onboarding_status),
-                $paypal_pm
-            );
-            EED_PayPalOnboard::redirectToPmSettingsHome();
-            return;
-        }
-        // Start saving the setup and info.
-        PayPalExtraMetaManager::parseAndSaveOptions($paypal_pm, $onboarding_status, $get_params);
-        // Save the credentials.
-        PayPalExtraMetaManager::saveSellerApiCredentials($paypal_pm, $get_params);
-        // Also clen GET params by redirecting, because PP auto redirects to the return_url on closing the onboarding window.
-        EED_PayPalOnboard::redirectToPmSettingsHome();
-    }
-
-
-    /**
-     * Check if all required parameters for the onboarding status check are present.
-     *
-     * @param array $data
-     * @param mixed $paypal_pm
-     * @return bool
-     */
-    public static function onboardingStatusResponseValid(array $data, $paypal_pm): bool
-    {
-        // Check that we have all the required parameters and the nonce is ok.
-        if (
-            $paypal_pm instanceof EE_Payment_Method
-            && wp_verify_nonce($data['nonce'], Domain::NONCE_NAME_ONBOARDING_RETURN)
-            && ! empty($data[ Domain::API_PARAM_PARTNER_ID ])
-            && ! empty($data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-            && isset($data[ Domain::API_PARAM_EMAIL_CONFIRMED ])
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Get partner access token.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getPartnerAccessToken(EE_Payment_Method $paypal_pm): string
-    {
-        // See if it's already saved.
-        $access_token = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ACCESS_TOKEN);
-        // If we don't have it, request/update it.
-        if (! $access_token) {
-            return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
-        }
-        if (EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm)) {
-            return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
-        }
-        // Access token is saved as encrypted, but return decrypted.
-        return $access_token;
-    }
-
-
-    /**
-     * Get partner access token.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
-    {
-        $expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_TOKEN_EXPIRES_IN);
-        if (! $expires_at) {
-            return true;
-        }
-        // Validate the token expiration date.
-        $minutes_left = round(($expires_at - time()) / 60);
-        // Refresh if less than 2 hours till expiration left. Access tokens have a life of 15 minutes or 8 hours.
-        if ($minutes_left <= 60 * 2) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Request the partner access token from PayPal and save/update it.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function requestPartnerAccessToken(EE_Payment_Method $paypal_pm): string
-    {
-        $nonce = wp_create_nonce('eea_pp_commerce_get_access_token');
-        // Request the access token.
-        $post_args = [
-            'method' => 'POST',
-            'body'   => [
-                'nonce'                       => $nonce,
-                'api_version'                 => 'v1',
-                Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
-            ],
-        ];
-        if (defined('LOCAL_MIDDLEMAN_SERVER')) {
-            $post_args['sslverify'] = Manager::verifySSL();
-        }
-        $post_url = EED_PayPalOnboard::getMiddlemanBaseUrl($paypal_pm) . 'get_token';
-        $response = EED_PayPalOnboard::sendRequest($paypal_pm, $post_url, $post_args);
-        if (isset($response['error'])) {
-            return '';
-        }
-        // Check the data we received.
-        if (! EED_PayPalOnboard::partnerTokenResponseValid($response, $paypal_pm)) {
-            return '';
-        }
-        // If we are here all seems to be ok. Save the token and it's data.
-        $saved = PayPalExtraMetaManager::savePartnerAccessToken($paypal_pm, $response);
-        if (! $saved) {
-            return '';
-        }
-        return $response['access_token'];
-    }
-
-
-    /**
-     * Request seller onboarding status from PayPal.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $merchant_id
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function trackSellerOnboarding(EE_Payment_Method $paypal_pm, string $merchant_id): array
-    {
-        $track_onboarding = EED_PayPalOnboard::getTrackOnboardingApi($paypal_pm, $merchant_id);
-        if (! $track_onboarding instanceof TrackSellerOnboarding) {
-            return [
-                'error'   => 'TRACK_ONBOARDING_FAILED',
-                'message' => esc_html__('Failed to track seller onboarding.', 'event_espresso')
-            ];
-        }
-        return $track_onboarding->isValid();
-    }
-
-
-    /**
-     * Returns the Track Seller Onboarding API.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $merchant_id
-     * @return TrackSellerOnboarding|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getTrackOnboardingApi(
-        EE_Payment_Method $paypal_pm,
-        string $merchant_id
-    ): ?TrackSellerOnboarding {
-        $partner_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_MERCHANT_ID);
-        $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi || ! $partner_id) {
-            return null;
-        }
-        return new TrackSellerOnboarding($paypal_api, $partner_id, $merchant_id, $paypal_pm->debug_mode());
-    }
-
-
-    /**
-     * Check the onboard status and return the result.
-     * (AJAX)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getOnboardStatus(): void
-    {
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
-            $err_msg = esc_html__('Could not specify the payment method.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, EED_Module::getRequest()->postParams(), $paypal_pm);
-            wp_send_json(['on_board' => false]);
-        }
-        try {
-            $seller_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_SELLER_MERCHANT_ID) ?? '--';
-        } catch (Exception $e) {
-            $seller_id = '--';
-            PayPalLogger::errorLog($e->getMessage(), ['trace' => $e->getTrace()]);
-        }
-        wp_send_json(
-            [
-                'on_board'  => EED_PayPalOnboard::isOnboard($paypal_pm),
-                'seller_id' => $seller_id,
-            ]
-        );
-    }
-
-
-    /**
-     * De-authorize the seller. Remove all API credentials.
-     * (AJAX)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function offboard(): void
-    {
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        EED_PayPalOnboard::validatePmAjax($paypal_pm);
-        PayPalExtraMetaManager::deleteData($paypal_pm);
-        PayPalLogger::errorLog(
-            esc_html__('Offboarding. Removing metadata.', 'event_espresso'),
-            EED_Module::getRequest()->postParams(),
-            $paypal_pm
-        );
-        wp_send_json(['success' => true]);
-    }
-
-
-    /**
-     * Clear all credentials metadata.
-     * (AJAX)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function clearMetaData(): void
-    {
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        EED_PayPalOnboard::validatePmAjax($paypal_pm);
-        PayPalExtraMetaManager::deleteAllData($paypal_pm);
-        PayPalLogger::errorLog(
-            esc_html__('Doing a Reset. Removing all PM settings metadata.', 'event_espresso'),
-            EED_Module::getRequest()->postParams(),
-            $paypal_pm
-        );
-        wp_send_json(['success' => true]);
-    }
-
-
-    /**
-     * Save the sandbox mode option.
-     * (AJAX)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function eeaPpSaveDebugMode(): void
-    {
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        EED_PayPalOnboard::validatePmAjax($paypal_pm);
-        // Reset the partner access token.
-        PayPalExtraMetaManager::updateDebugMode($paypal_pm, EED_Module::getRequest()->postParams());
-        // And do the data reset.
-        PayPalExtraMetaManager::deleteAllData($paypal_pm);
-        wp_send_json(['success' => true]);
-    }
-
-
-    /**
-     * Validate the PM instance, returning an ajax response on invalid.
-     *
-     * @param $paypal_pm
-     * @return void
-     */
-    public static function validatePmAjax($paypal_pm): void
-    {
-        if (! $paypal_pm instanceof EE_Payment_Method) {
-            wp_send_json(
-                [
-                    'error'   => 'INVALID_PM',
-                    'message' => esc_html__(
-                        'Invalid payment method. Please refresh the page and try again.',
-                        'event_espresso'
-                    ),
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * Checks if already onboard.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function isOnboard(EE_Payment_Method $payment_method): bool
-    {
-        $pp_meta_data = PayPalExtraMetaManager::getAllData($payment_method);
-        return
-            (
-                // onboarded with a third party integration ?
-                ! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ])
-            ) || (
-                // or with the first party integration ?
-                ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_ID ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_SECRET ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_PAYER_ID ])
-            );
-    }
-
-
-    /**
-     * Send a request and return a decoded response body.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $request_url
-     * @param array             $request_args
-     * @return array
-     */
-    public static function sendRequest(EE_Payment_Method $paypal_pm, string $request_url, array $request_args): array
-    {
-        $error_return = ['error' => true];
-        $response     = wp_remote_request($request_url, $request_args);
-        if (is_wp_error($response)) {
-            $message = $response->get_error_message();
-            PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
-            $error_return['message'] = $message;
-            return $error_return;
-        }
-        $response_body = (isset($response['body']) && $response['body']) ? json_decode($response['body'], true) : [];
-        if (empty($response_body) || isset($response_body['error'])) {
-            $message = $response_body['error_description']
-                ?? sprintf(
-                    esc_html__('Unknown response received while sending a request to: %1$s', 'event_espresso'),
-                    $request_url
-                );
-            PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
-            $error_return['message'] = $message;
-            return $error_return;
-        }
-        return $response_body;
-    }
-
-
-    /**
-     * Check the response for a partner token request.
-     *
-     * @param array             $response
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     */
-    public static function partnerTokenResponseValid(array $response, EE_Payment_Method $paypal_pm): bool
-    {
-        // Check the data we received.
-        if (
-            empty($response['nonce'])
-            || ! wp_verify_nonce($response['nonce'], 'eea_pp_commerce_get_access_token')
-            || empty($response['access_token'])
-            || empty($response['app_id'])
-            || empty($response['expires_in'])
-            || empty($response['partner_client_id'])
-            || empty($response['partner_merchant_id'])
-        ) {
-            // This is an error.
-            PayPalLogger::errorLog(
-                esc_html__('Incoming parameter validation failed.', 'event_espresso'),
-                $response,
-                $paypal_pm
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Returns the base URL to the middleman server.
-     * If LOCAL_MIDDLEMAN_SERVER is defined, requests will be sent to connect.eventespresso.test
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getMiddlemanBaseUrl(EE_Payment_Method $payment_method): string
-    {
-        $target = defined('LOCAL_MIDDLEMAN_SERVER') ? 'test' : 'com';
-        // If this PM is used under different provider accounts, you might need an account indicator.
-        $account = defined('EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR') ? EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR : '';
-        $postfix = $payment_method->debug_mode() ? '_sandbox' : '';
-        return "https://connect.eventespresso.$target/paypal_commerce$account$postfix/";
-    }
-
-
-    /**
-     * This Payment Method admin notices.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function adminNotice()
-    {
-        // Show the notice if PayPal Commerce PM is active but merchant is not onboard.
-        $pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug(Domain::PM_SLUG);
-        if (
-            $pp_commerce instanceof EE_Payment_Method
-            && $pp_commerce->active()
-            && ! EED_PayPalOnboard::isOnboard($pp_commerce)
-        ) {
-            add_action('admin_notices', [EED_PayPalOnboard::class, 'notOnboardNotice']);
-        }
-    }
-
-
-    /**
-     * Contents of the not onboard admin notice.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function notOnboardNotice()
-    {
-        $open_anchor = $close_anchor = '';
-        $pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug(Domain::PM_SLUG);
-        if ($pp_commerce instanceof EE_Payment_Method) {
-            $pm_page      = add_query_arg(
-                [
-                    'page'           => 'espresso_payment_settings',
-                    'webhook_action' => 'eepPpcMerchantOnboard',
-                    'payment_method' => $pp_commerce->slug(),
-                ],
-                admin_url('admin.php')
-            );
-            $open_anchor  = "<a href='$pm_page'>";
-            $close_anchor = "</a>";
-        }
-        $notice = sprintf(
-            esc_html__(
-                '%1$sPayPal Commerce%2$s payment method was activated but is not connected to PayPal. Please %3$sfinish setting up%4$s this payment method.',
-                'event_espresso'
-            ),
-            '<strong>',
-            '</strong>',
-            $open_anchor,
-            $close_anchor
-        );
-        echo "
+	/**
+	 * @return EED_Module
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance(): EED_Module
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * Run - initial module setup.
+	 *
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 * For hooking into EE Admin Core and other modules.
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin(): void
+	{
+		// check for the most basic EE capability
+		/** @var EE_Capabilities $capabilities */
+		$capabilities = LoaderFactory::getLoader()->getShared(EE_Capabilities::class);
+		if (
+			DbStatus::isOffline()
+			|| ! $capabilities->current_user_can('ee_manage_gateways', 'manage-paypal-onboarding')
+		) {
+			return;
+		}
+		// Get onboarding URL.
+		add_action('wp_ajax_eeaPpGetOnboardingUrl', [__CLASS__, 'getOnboardingUrl']);
+		// Catch the return/redirect from PayPal onboarding page.
+		add_action('admin_init', [__CLASS__, 'updateOnboardingStatus']);
+		// Return the connection/onboard status.
+		add_action('wp_ajax_eeaPpGetOnboardStatus', [__CLASS__, 'getOnboardStatus']);
+		// Revoke access.
+		add_action('wp_ajax_eeaPpOffboard', [__CLASS__, 'offboard']);
+		// Clear all metadata.
+		add_action('wp_ajax_eeaPpClearMetaData', [__CLASS__, 'clearMetaData']);
+		add_action('wp_ajax_eeaPpSaveDebugMode', [__CLASS__, 'eeaPpSaveDebugMode']);
+		// Admin notice.
+		add_action('admin_init', [__CLASS__, 'adminNotice']);
+	}
+
+
+	/**
+	 * Get the onboarding URL.
+	 * (AJAX)
+	 *
+	 * @return void
+	 */
+	public static function getOnboardingUrl(): void
+	{
+		$signup_link = '';
+		try {
+			$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+			if (! $paypal_pm instanceof EE_Payment_Method) {
+				PayPalLogger::errorLogAndExit(
+					esc_html__('No payment method.', 'event_espresso'),
+					EED_Module::getRequest()->postParams(),
+					$paypal_pm
+				);
+			}
+			PayPalExtraMetaManager::updateDebugMode($paypal_pm, EED_Module::getRequest()->postParams());
+			// Just get a new onboarding URL every time.
+			$signup_link = EED_PayPalOnboard::requestOnboardingUrl($paypal_pm);
+			if (! $signup_link) {
+				$err_msg = esc_html__('Error! Could not generate a sign-up link.', 'event_espresso');
+				PayPalLogger::errorLogAndExit($err_msg, ['signup_link' => $signup_link], $paypal_pm);
+			}
+		} catch (Exception $e) {
+			PayPalLogger::errorLogAndExit($e->getMessage(), ['trace' => $e->getTrace()]);
+		}
+		// Is it empty (can happen if we didn't get the URL through the API).
+		$signup_link = $signup_link ? $signup_link . '?&displayMode=minibrowser' : '#';
+		wp_send_json(
+			[
+				'signup_link' => $signup_link,
+			]
+		);
+	}
+
+
+	/**
+	 * Request the sign-up link from PayPal.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param bool              $one_time_request
+	 * @return string
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public static function requestOnboardingUrl(EE_Payment_Method $paypal_pm, bool $one_time_request = false): string
+	{
+		$signup_link = '';
+		// Get the access token.
+		$access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
+		if (! $access_token) {
+			$err_msg = esc_html__('Error! No access token.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, ['access_token' => $access_token], $paypal_pm);
+			return '';
+		}
+		// Request the access token.
+		$body_params = EED_PayPalOnboard::signupLinkRequestBody($paypal_pm);
+		$bn_code     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
+		$post_params = [
+			'method'  => 'POST',
+			'headers' => [
+				'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
+				'Content-Type'                  => 'application/json',
+				'Authorization'                 => 'Bearer ' . $access_token,
+				'PayPal-Partner-Attribution-Id' => $bn_code,
+			],
+			'body'    => $body_params,
+		];
+		$request_url = Domain::getPayPalApiUrl($paypal_pm) . '/v2/customer/partner-referrals';
+		$response    = EED_PayPalOnboard::sendRequest($paypal_pm, $request_url, $post_params);
+		// Check the data we received.
+		if (isset($response['error']) || empty($response['links'])) {
+			// Did the original access token get replaced by any chance ?
+			if (
+				! $one_time_request
+				&& ! empty($response['message'])
+				&& $response['message'] === 'Access Token not found in cache'
+			) {
+				// Clear all PM metadata and try getting the access token One more time.
+				PayPalExtraMetaManager::deleteData($paypal_pm);
+				PayPalLogger::errorLog(
+					esc_html__('Removing old metadata before new onboarding.', 'event_espresso'),
+					$response,
+					$paypal_pm
+				);
+				return EED_PayPalOnboard::requestOnboardingUrl($paypal_pm, true);
+			}
+			$err_msg = esc_html__('Incoming sign-up link parameter validation failed.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, $response, $paypal_pm);
+			return '';
+		}
+		// Now retrieve that sign-up link.
+		foreach ($response['links'] as $link) {
+			if ($link['rel'] === 'action_url') {
+				$signup_link = $link['href'] ?? '';
+			}
+		}
+		return $signup_link;
+	}
+
+
+	/**
+	 * Get the return URL.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws Exception
+	 */
+	public static function signupLinkRequestBody(EE_Payment_Method $paypal_pm): string
+	{
+		$identifier_string = new OneTimeString($paypal_pm->debug_mode());
+		$tracking_id       = $identifier_string->value();
+		$request           = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$selected_payment  = $request->getRequestParam('selected_payment', 'EXPRESS_CHECKOUT');
+		// Save the identifier for future use.
+		PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_TRACKING_ID, $tracking_id);
+		// Assemble the return URL.
+		$return_url = EED_PayPalOnboard::getReturnUrl($paypal_pm, $selected_payment);
+		return json_encode(
+			[
+				'tracking_id'             => $tracking_id,
+				'operations'              => [
+					[
+						'operation'                  => 'API_INTEGRATION',
+						'api_integration_preference' => [
+							'rest_api_integration' => [
+								'integration_method'  => 'PAYPAL',
+								'integration_type'    => 'THIRD_PARTY',
+								'third_party_details' => [
+									'features' => ['PAYMENT', 'REFUND', 'PARTNER_FEE'],
+								],
+							],
+						],
+					],
+				],
+				'products'                => [$selected_payment],
+				'legal_consents'          => [
+					[
+						'type'    => 'SHARE_DATA_CONSENT',
+						'granted' => true,
+					],
+				],
+				'partner_config_override' => [
+					'return_url' => $return_url,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Get the return URL.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $selected_payment
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getReturnUrl(EE_Payment_Method $paypal_pm, string $selected_payment = ''): string
+	{
+		$wp_nonce = EED_Module::getRequest()->getRequestParam('wp_nonce');
+		$nonce    = wp_create_nonce(Domain::NONCE_NAME_ONBOARDING_RETURN);
+		return add_query_arg(
+			[
+				'page'                        => 'espresso_payment_settings',
+				'webhook_action'              => 'eepPpcMerchantOnboard',
+				'payment_method'              => $paypal_pm->slug(),
+				'_wpnonce'                    => $wp_nonce,
+				'nonce'                       => $nonce,
+				'selected_payment'            => $selected_payment,
+				Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
+			],
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Redirect to the payment method (PP) settings home page.
+	 *
+	 * @return void
+	 */
+	public static function redirectToPmSettingsHome(): void
+	{
+		$get_params = EED_Module::getRequest()->getParams();
+		if (empty($get_params['payment_method'])) {
+			// Simply do not redirect.
+			return;
+		}
+		$args_to_add = [
+			'page'           => 'espresso_payment_settings',
+			'payment_method' => $get_params['payment_method'],
+		];
+		if (isset($get_params['sandbox_mode'])) {
+			$args_to_add[ Domain::META_KEY_SANDBOX_MODE ] = $get_params['sandbox_mode'];
+		}
+		$home_url = add_query_arg($args_to_add, admin_url('admin.php'));
+		wp_redirect($home_url);
+		exit;
+	}
+
+
+	/**
+	 * Check user’s onboarding status.
+	 * This will handle the user return from the auth page and also check the status via the API.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function updateOnboardingStatus(): void
+	{
+		// Check if this is the webhook from PayPal.
+		if (
+			! isset($_GET['webhook_action'], $_GET['nonce'])
+			|| $_GET['webhook_action'] !== 'eepPpcMerchantOnboard'
+		) {
+			return;  // Ignore.
+		}
+		$get_params = EED_Module::getRequest()->getParams();
+		// Get the payment method.
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		if (! $paypal_pm instanceof EE_Payment_Method) {
+			PayPalLogger::errorLog(
+				esc_html__('Not able to validate the payment method.', 'event_espresso'),
+				$get_params,
+				$paypal_pm
+			);
+			EED_PayPalOnboard::redirectToPmSettingsHome();
+			return;
+		}
+		// Check the response (GET) parameters.
+		if (! EED_PayPalOnboard::onboardingStatusResponseValid($get_params, $paypal_pm)) {
+			// Missing parameters. Can't proceed.
+			PayPalLogger::errorLog(
+				esc_html__('Missing required onboarding parameters.', 'event_espresso'),
+				$get_params,
+				$paypal_pm
+			);
+			EED_PayPalOnboard::redirectToPmSettingsHome();
+			return;
+		}
+		// Check on the onboarding status (recommended by PP).
+		$onboarding_status = EED_PayPalOnboard::trackSellerOnboarding(
+			$paypal_pm,
+			$get_params[ Domain::META_KEY_SELLER_MERCHANT_ID ]
+		);
+		if (! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
+			PayPalLogger::errorLog(
+				$onboarding_status['message'] ?? esc_html__('Failed to track seller onboarding.', 'event_espresso'),
+				array_merge($get_params, $onboarding_status),
+				$paypal_pm
+			);
+			EED_PayPalOnboard::redirectToPmSettingsHome();
+			return;
+		}
+		// Start saving the setup and info.
+		PayPalExtraMetaManager::parseAndSaveOptions($paypal_pm, $onboarding_status, $get_params);
+		// Save the credentials.
+		PayPalExtraMetaManager::saveSellerApiCredentials($paypal_pm, $get_params);
+		// Also clen GET params by redirecting, because PP auto redirects to the return_url on closing the onboarding window.
+		EED_PayPalOnboard::redirectToPmSettingsHome();
+	}
+
+
+	/**
+	 * Check if all required parameters for the onboarding status check are present.
+	 *
+	 * @param array $data
+	 * @param mixed $paypal_pm
+	 * @return bool
+	 */
+	public static function onboardingStatusResponseValid(array $data, $paypal_pm): bool
+	{
+		// Check that we have all the required parameters and the nonce is ok.
+		if (
+			$paypal_pm instanceof EE_Payment_Method
+			&& wp_verify_nonce($data['nonce'], Domain::NONCE_NAME_ONBOARDING_RETURN)
+			&& ! empty($data[ Domain::API_PARAM_PARTNER_ID ])
+			&& ! empty($data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
+			&& isset($data[ Domain::API_PARAM_EMAIL_CONFIRMED ])
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Get partner access token.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getPartnerAccessToken(EE_Payment_Method $paypal_pm): string
+	{
+		// See if it's already saved.
+		$access_token = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ACCESS_TOKEN);
+		// If we don't have it, request/update it.
+		if (! $access_token) {
+			return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
+		}
+		if (EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm)) {
+			return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
+		}
+		// Access token is saved as encrypted, but return decrypted.
+		return $access_token;
+	}
+
+
+	/**
+	 * Get partner access token.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
+	{
+		$expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_TOKEN_EXPIRES_IN);
+		if (! $expires_at) {
+			return true;
+		}
+		// Validate the token expiration date.
+		$minutes_left = round(($expires_at - time()) / 60);
+		// Refresh if less than 2 hours till expiration left. Access tokens have a life of 15 minutes or 8 hours.
+		if ($minutes_left <= 60 * 2) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Request the partner access token from PayPal and save/update it.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function requestPartnerAccessToken(EE_Payment_Method $paypal_pm): string
+	{
+		$nonce = wp_create_nonce('eea_pp_commerce_get_access_token');
+		// Request the access token.
+		$post_args = [
+			'method' => 'POST',
+			'body'   => [
+				'nonce'                       => $nonce,
+				'api_version'                 => 'v1',
+				Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
+			],
+		];
+		if (defined('LOCAL_MIDDLEMAN_SERVER')) {
+			$post_args['sslverify'] = Manager::verifySSL();
+		}
+		$post_url = EED_PayPalOnboard::getMiddlemanBaseUrl($paypal_pm) . 'get_token';
+		$response = EED_PayPalOnboard::sendRequest($paypal_pm, $post_url, $post_args);
+		if (isset($response['error'])) {
+			return '';
+		}
+		// Check the data we received.
+		if (! EED_PayPalOnboard::partnerTokenResponseValid($response, $paypal_pm)) {
+			return '';
+		}
+		// If we are here all seems to be ok. Save the token and it's data.
+		$saved = PayPalExtraMetaManager::savePartnerAccessToken($paypal_pm, $response);
+		if (! $saved) {
+			return '';
+		}
+		return $response['access_token'];
+	}
+
+
+	/**
+	 * Request seller onboarding status from PayPal.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $merchant_id
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function trackSellerOnboarding(EE_Payment_Method $paypal_pm, string $merchant_id): array
+	{
+		$track_onboarding = EED_PayPalOnboard::getTrackOnboardingApi($paypal_pm, $merchant_id);
+		if (! $track_onboarding instanceof TrackSellerOnboarding) {
+			return [
+				'error'   => 'TRACK_ONBOARDING_FAILED',
+				'message' => esc_html__('Failed to track seller onboarding.', 'event_espresso')
+			];
+		}
+		return $track_onboarding->isValid();
+	}
+
+
+	/**
+	 * Returns the Track Seller Onboarding API.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $merchant_id
+	 * @return TrackSellerOnboarding|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getTrackOnboardingApi(
+		EE_Payment_Method $paypal_pm,
+		string $merchant_id
+	): ?TrackSellerOnboarding {
+		$partner_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_MERCHANT_ID);
+		$paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
+		if (! $paypal_api instanceof PayPalApi || ! $partner_id) {
+			return null;
+		}
+		return new TrackSellerOnboarding($paypal_api, $partner_id, $merchant_id, $paypal_pm->debug_mode());
+	}
+
+
+	/**
+	 * Check the onboard status and return the result.
+	 * (AJAX)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getOnboardStatus(): void
+	{
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		if (! $paypal_pm instanceof EE_Payment_Method) {
+			$err_msg = esc_html__('Could not specify the payment method.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, EED_Module::getRequest()->postParams(), $paypal_pm);
+			wp_send_json(['on_board' => false]);
+		}
+		try {
+			$seller_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_SELLER_MERCHANT_ID) ?? '--';
+		} catch (Exception $e) {
+			$seller_id = '--';
+			PayPalLogger::errorLog($e->getMessage(), ['trace' => $e->getTrace()]);
+		}
+		wp_send_json(
+			[
+				'on_board'  => EED_PayPalOnboard::isOnboard($paypal_pm),
+				'seller_id' => $seller_id,
+			]
+		);
+	}
+
+
+	/**
+	 * De-authorize the seller. Remove all API credentials.
+	 * (AJAX)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function offboard(): void
+	{
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		EED_PayPalOnboard::validatePmAjax($paypal_pm);
+		PayPalExtraMetaManager::deleteData($paypal_pm);
+		PayPalLogger::errorLog(
+			esc_html__('Offboarding. Removing metadata.', 'event_espresso'),
+			EED_Module::getRequest()->postParams(),
+			$paypal_pm
+		);
+		wp_send_json(['success' => true]);
+	}
+
+
+	/**
+	 * Clear all credentials metadata.
+	 * (AJAX)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function clearMetaData(): void
+	{
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		EED_PayPalOnboard::validatePmAjax($paypal_pm);
+		PayPalExtraMetaManager::deleteAllData($paypal_pm);
+		PayPalLogger::errorLog(
+			esc_html__('Doing a Reset. Removing all PM settings metadata.', 'event_espresso'),
+			EED_Module::getRequest()->postParams(),
+			$paypal_pm
+		);
+		wp_send_json(['success' => true]);
+	}
+
+
+	/**
+	 * Save the sandbox mode option.
+	 * (AJAX)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function eeaPpSaveDebugMode(): void
+	{
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		EED_PayPalOnboard::validatePmAjax($paypal_pm);
+		// Reset the partner access token.
+		PayPalExtraMetaManager::updateDebugMode($paypal_pm, EED_Module::getRequest()->postParams());
+		// And do the data reset.
+		PayPalExtraMetaManager::deleteAllData($paypal_pm);
+		wp_send_json(['success' => true]);
+	}
+
+
+	/**
+	 * Validate the PM instance, returning an ajax response on invalid.
+	 *
+	 * @param $paypal_pm
+	 * @return void
+	 */
+	public static function validatePmAjax($paypal_pm): void
+	{
+		if (! $paypal_pm instanceof EE_Payment_Method) {
+			wp_send_json(
+				[
+					'error'   => 'INVALID_PM',
+					'message' => esc_html__(
+						'Invalid payment method. Please refresh the page and try again.',
+						'event_espresso'
+					),
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * Checks if already onboard.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function isOnboard(EE_Payment_Method $payment_method): bool
+	{
+		$pp_meta_data = PayPalExtraMetaManager::getAllData($payment_method);
+		return
+			(
+				// onboarded with a third party integration ?
+				! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
+				&& ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ])
+			) || (
+				// or with the first party integration ?
+				! empty($pp_meta_data[ Domain::META_KEY_CLIENT_ID ])
+				&& ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_SECRET ])
+				&& ! empty($pp_meta_data[ Domain::META_KEY_PAYER_ID ])
+			);
+	}
+
+
+	/**
+	 * Send a request and return a decoded response body.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $request_url
+	 * @param array             $request_args
+	 * @return array
+	 */
+	public static function sendRequest(EE_Payment_Method $paypal_pm, string $request_url, array $request_args): array
+	{
+		$error_return = ['error' => true];
+		$response     = wp_remote_request($request_url, $request_args);
+		if (is_wp_error($response)) {
+			$message = $response->get_error_message();
+			PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
+			$error_return['message'] = $message;
+			return $error_return;
+		}
+		$response_body = (isset($response['body']) && $response['body']) ? json_decode($response['body'], true) : [];
+		if (empty($response_body) || isset($response_body['error'])) {
+			$message = $response_body['error_description']
+				?? sprintf(
+					esc_html__('Unknown response received while sending a request to: %1$s', 'event_espresso'),
+					$request_url
+				);
+			PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
+			$error_return['message'] = $message;
+			return $error_return;
+		}
+		return $response_body;
+	}
+
+
+	/**
+	 * Check the response for a partner token request.
+	 *
+	 * @param array             $response
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 */
+	public static function partnerTokenResponseValid(array $response, EE_Payment_Method $paypal_pm): bool
+	{
+		// Check the data we received.
+		if (
+			empty($response['nonce'])
+			|| ! wp_verify_nonce($response['nonce'], 'eea_pp_commerce_get_access_token')
+			|| empty($response['access_token'])
+			|| empty($response['app_id'])
+			|| empty($response['expires_in'])
+			|| empty($response['partner_client_id'])
+			|| empty($response['partner_merchant_id'])
+		) {
+			// This is an error.
+			PayPalLogger::errorLog(
+				esc_html__('Incoming parameter validation failed.', 'event_espresso'),
+				$response,
+				$paypal_pm
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Returns the base URL to the middleman server.
+	 * If LOCAL_MIDDLEMAN_SERVER is defined, requests will be sent to connect.eventespresso.test
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getMiddlemanBaseUrl(EE_Payment_Method $payment_method): string
+	{
+		$target = defined('LOCAL_MIDDLEMAN_SERVER') ? 'test' : 'com';
+		// If this PM is used under different provider accounts, you might need an account indicator.
+		$account = defined('EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR') ? EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR : '';
+		$postfix = $payment_method->debug_mode() ? '_sandbox' : '';
+		return "https://connect.eventespresso.$target/paypal_commerce$account$postfix/";
+	}
+
+
+	/**
+	 * This Payment Method admin notices.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function adminNotice()
+	{
+		// Show the notice if PayPal Commerce PM is active but merchant is not onboard.
+		$pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug(Domain::PM_SLUG);
+		if (
+			$pp_commerce instanceof EE_Payment_Method
+			&& $pp_commerce->active()
+			&& ! EED_PayPalOnboard::isOnboard($pp_commerce)
+		) {
+			add_action('admin_notices', [EED_PayPalOnboard::class, 'notOnboardNotice']);
+		}
+	}
+
+
+	/**
+	 * Contents of the not onboard admin notice.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function notOnboardNotice()
+	{
+		$open_anchor = $close_anchor = '';
+		$pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug(Domain::PM_SLUG);
+		if ($pp_commerce instanceof EE_Payment_Method) {
+			$pm_page      = add_query_arg(
+				[
+					'page'           => 'espresso_payment_settings',
+					'webhook_action' => 'eepPpcMerchantOnboard',
+					'payment_method' => $pp_commerce->slug(),
+				],
+				admin_url('admin.php')
+			);
+			$open_anchor  = "<a href='$pm_page'>";
+			$close_anchor = "</a>";
+		}
+		$notice = sprintf(
+			esc_html__(
+				'%1$sPayPal Commerce%2$s payment method was activated but is not connected to PayPal. Please %3$sfinish setting up%4$s this payment method.',
+				'event_espresso'
+			),
+			'<strong>',
+			'</strong>',
+			$open_anchor,
+			$close_anchor
+		);
+		echo "
         <div class='error'>
             <p>$notice</p>
         </div>";
-    }
+	}
 }

Spacing +30 added lines, -30 removed lines

@@ -85,7 +85,7 @@ 
         $signup_link = '';
         try {
             $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-            if (! $paypal_pm instanceof EE_Payment_Method) {
+            if ( ! $paypal_pm instanceof EE_Payment_Method) {
                 PayPalLogger::errorLogAndExit(
                     esc_html__('No payment method.', 'event_espresso'),
                     EED_Module::getRequest()->postParams(),
@@ -95,7 +95,7 @@ 
             PayPalExtraMetaManager::updateDebugMode($paypal_pm, EED_Module::getRequest()->postParams());
             // Just get a new onboarding URL every time.
             $signup_link = EED_PayPalOnboard::requestOnboardingUrl($paypal_pm);
-            if (! $signup_link) {
+            if ( ! $signup_link) {
                 $err_msg = esc_html__('Error! Could not generate a sign-up link.', 'event_espresso');
                 PayPalLogger::errorLogAndExit($err_msg, ['signup_link' => $signup_link], $paypal_pm);
             }
@@ -103,7 +103,7 @@ 
             PayPalLogger::errorLogAndExit($e->getMessage(), ['trace' => $e->getTrace()]);
         }
         // Is it empty (can happen if we didn't get the URL through the API).
-        $signup_link = $signup_link ? $signup_link . '?&displayMode=minibrowser' : '#';
+        $signup_link = $signup_link ? $signup_link.'?&displayMode=minibrowser' : '#';
         wp_send_json(
             [
                 'signup_link' => $signup_link,
@@ -126,7 +126,7 @@ 
         $signup_link = '';
         // Get the access token.
         $access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
-        if (! $access_token) {
+        if ( ! $access_token) {
             $err_msg = esc_html__('Error! No access token.', 'event_espresso');
             PayPalLogger::errorLog($err_msg, ['access_token' => $access_token], $paypal_pm);
             return '';
@@ -139,12 +139,12 @@ 
             'headers' => [
                 'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
                 'Content-Type'                  => 'application/json',
-                'Authorization'                 => 'Bearer ' . $access_token,
+                'Authorization'                 => 'Bearer '.$access_token,
                 'PayPal-Partner-Attribution-Id' => $bn_code,
             ],
             'body'    => $body_params,
         ];
-        $request_url = Domain::getPayPalApiUrl($paypal_pm) . '/v2/customer/partner-referrals';
+        $request_url = Domain::getPayPalApiUrl($paypal_pm).'/v2/customer/partner-referrals';
         $response    = EED_PayPalOnboard::sendRequest($paypal_pm, $request_url, $post_params);
         // Check the data we received.
         if (isset($response['error']) || empty($response['links'])) {
@@ -271,7 +271,7 @@ 
             'payment_method' => $get_params['payment_method'],
         ];
         if (isset($get_params['sandbox_mode'])) {
-            $args_to_add[ Domain::META_KEY_SANDBOX_MODE ] = $get_params['sandbox_mode'];
+            $args_to_add[Domain::META_KEY_SANDBOX_MODE] = $get_params['sandbox_mode'];
         }
         $home_url = add_query_arg($args_to_add, admin_url('admin.php'));
         wp_redirect($home_url);
@@ -294,12 +294,12 @@ 
             ! isset($_GET['webhook_action'], $_GET['nonce'])
             || $_GET['webhook_action'] !== 'eepPpcMerchantOnboard'
         ) {
-            return;  // Ignore.
+            return; // Ignore.
         }
         $get_params = EED_Module::getRequest()->getParams();
         // Get the payment method.
         $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
+        if ( ! $paypal_pm instanceof EE_Payment_Method) {
             PayPalLogger::errorLog(
                 esc_html__('Not able to validate the payment method.', 'event_espresso'),
                 $get_params,
@@ -309,7 +309,7 @@ 
             return;
         }
         // Check the response (GET) parameters.
-        if (! EED_PayPalOnboard::onboardingStatusResponseValid($get_params, $paypal_pm)) {
+        if ( ! EED_PayPalOnboard::onboardingStatusResponseValid($get_params, $paypal_pm)) {
             // Missing parameters. Can't proceed.
             PayPalLogger::errorLog(
                 esc_html__('Missing required onboarding parameters.', 'event_espresso'),
@@ -322,9 +322,9 @@ 
         // Check on the onboarding status (recommended by PP).
         $onboarding_status = EED_PayPalOnboard::trackSellerOnboarding(
             $paypal_pm,
-            $get_params[ Domain::META_KEY_SELLER_MERCHANT_ID ]
+            $get_params[Domain::META_KEY_SELLER_MERCHANT_ID]
         );
-        if (! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
+        if ( ! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
             PayPalLogger::errorLog(
                 $onboarding_status['message'] ?? esc_html__('Failed to track seller onboarding.', 'event_espresso'),
                 array_merge($get_params, $onboarding_status),
@@ -355,9 +355,9 @@ 
         if (
             $paypal_pm instanceof EE_Payment_Method
             && wp_verify_nonce($data['nonce'], Domain::NONCE_NAME_ONBOARDING_RETURN)
-            && ! empty($data[ Domain::API_PARAM_PARTNER_ID ])
-            && ! empty($data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-            && isset($data[ Domain::API_PARAM_EMAIL_CONFIRMED ])
+            && ! empty($data[Domain::API_PARAM_PARTNER_ID])
+            && ! empty($data[Domain::META_KEY_SELLER_MERCHANT_ID])
+            && isset($data[Domain::API_PARAM_EMAIL_CONFIRMED])
         ) {
             return true;
         }
@@ -378,7 +378,7 @@ 
         // See if it's already saved.
         $access_token = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ACCESS_TOKEN);
         // If we don't have it, request/update it.
-        if (! $access_token) {
+        if ( ! $access_token) {
             return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
         }
         if (EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm)) {
@@ -400,7 +400,7 @@ 
     public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
     {
         $expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_TOKEN_EXPIRES_IN);
-        if (! $expires_at) {
+        if ( ! $expires_at) {
             return true;
         }
         // Validate the token expiration date.
@@ -436,18 +436,18 @@ 
         if (defined('LOCAL_MIDDLEMAN_SERVER')) {
             $post_args['sslverify'] = Manager::verifySSL();
         }
-        $post_url = EED_PayPalOnboard::getMiddlemanBaseUrl($paypal_pm) . 'get_token';
+        $post_url = EED_PayPalOnboard::getMiddlemanBaseUrl($paypal_pm).'get_token';
         $response = EED_PayPalOnboard::sendRequest($paypal_pm, $post_url, $post_args);
         if (isset($response['error'])) {
             return '';
         }
         // Check the data we received.
-        if (! EED_PayPalOnboard::partnerTokenResponseValid($response, $paypal_pm)) {
+        if ( ! EED_PayPalOnboard::partnerTokenResponseValid($response, $paypal_pm)) {
             return '';
         }
         // If we are here all seems to be ok. Save the token and it's data.
         $saved = PayPalExtraMetaManager::savePartnerAccessToken($paypal_pm, $response);
-        if (! $saved) {
+        if ( ! $saved) {
             return '';
         }
         return $response['access_token'];
@@ -466,7 +466,7 @@ 
     public static function trackSellerOnboarding(EE_Payment_Method $paypal_pm, string $merchant_id): array
     {
         $track_onboarding = EED_PayPalOnboard::getTrackOnboardingApi($paypal_pm, $merchant_id);
-        if (! $track_onboarding instanceof TrackSellerOnboarding) {
+        if ( ! $track_onboarding instanceof TrackSellerOnboarding) {
             return [
                 'error'   => 'TRACK_ONBOARDING_FAILED',
                 'message' => esc_html__('Failed to track seller onboarding.', 'event_espresso')
@@ -491,7 +491,7 @@ 
     ): ?TrackSellerOnboarding {
         $partner_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_MERCHANT_ID);
         $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi || ! $partner_id) {
+        if ( ! $paypal_api instanceof PayPalApi || ! $partner_id) {
             return null;
         }
         return new TrackSellerOnboarding($paypal_api, $partner_id, $merchant_id, $paypal_pm->debug_mode());
@@ -509,7 +509,7 @@ 
     public static function getOnboardStatus(): void
     {
         $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
+        if ( ! $paypal_pm instanceof EE_Payment_Method) {
             $err_msg = esc_html__('Could not specify the payment method.', 'event_espresso');
             PayPalLogger::errorLog($err_msg, EED_Module::getRequest()->postParams(), $paypal_pm);
             wp_send_json(['on_board' => false]);
@@ -601,7 +601,7 @@ 
      */
     public static function validatePmAjax($paypal_pm): void
     {
-        if (! $paypal_pm instanceof EE_Payment_Method) {
+        if ( ! $paypal_pm instanceof EE_Payment_Method) {
             wp_send_json(
                 [
                     'error'   => 'INVALID_PM',
@@ -629,13 +629,13 @@ 
         return
             (
                 // onboarded with a third party integration ?
-                ! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ])
+                ! empty($pp_meta_data[Domain::META_KEY_SELLER_MERCHANT_ID])
+                && ! empty($pp_meta_data[Domain::META_KEY_ACCESS_TOKEN])
             ) || (
                 // or with the first party integration ?
-                ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_ID ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_SECRET ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_PAYER_ID ])
+                ! empty($pp_meta_data[Domain::META_KEY_CLIENT_ID])
+                && ! empty($pp_meta_data[Domain::META_KEY_CLIENT_SECRET])
+                && ! empty($pp_meta_data[Domain::META_KEY_PAYER_ID])
             );
     }
 
@@ -756,7 +756,7 @@ 
         $open_anchor = $close_anchor = '';
         $pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug(Domain::PM_SLUG);
         if ($pp_commerce instanceof EE_Payment_Method) {
-            $pm_page      = add_query_arg(
+            $pm_page = add_query_arg(
                 [
                     'page'           => 'espresso_payment_settings',
                     'webhook_action' => 'eepPpcMerchantOnboard',

espresso.php

Indentation +107 added lines, -107 removed lines

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