eventespresso / event-espresso-core

modules/venues_archive/EED_Venues_Archive.module.php

Indentation +174 added lines, -174 removed lines

@@ -29,178 +29,178 @@
  */
 class EED_Venues_Archive extends EED_Module
 {
-    /**
-     * @return EED_Venues_Archive
-     */
-    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()
-    {
-        /** @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();
-        EE_Config::register_route(
-            $custom_post_types[EspressoPostType::VENUES]['plural_slug'],
-            'Venues_Archive',
-            'run'
-        );
-    }
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-    }
-
-
-    /**
-     * run - initial module setup
-     *
-     * @access    public
-     * @param \WP $WP
-     */
-    public function run($WP)
-    {
-        // check what template is loaded
-        add_filter('template_include', array($this, 'template_include'), 999, 1);
-        add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
-    }
-
-
-    /**
-     * template_include
-     *
-     * @access public
-     * @param  string $template
-     * @return string
-     */
-    public function template_include($template)
-    {
-        // not a custom template?
-        if (
-            EE_Registry::instance()->load_core('Front_Controller', array(), false, true)
-                                   ->get_selected_template() != 'archive-espresso_venues.php'
-        ) {
-            EEH_Template::load_espresso_theme_functions();
-            // then add extra event data via hooks
-            add_filter('the_title', array($this, 'the_title'), 100, 1);
-            // don't know if theme uses the_excerpt
-            add_filter('the_excerpt', array($this, 'venue_details'), 100);
-            // or the_content
-            add_filter('the_content', array($this, 'venue_details'), 100);
-            // don't display entry meta because the existing theme will take care of that
-            add_filter('FHEE__content_espresso_venues_details_template__display_entry_meta', '__return_false');
-        }
-        return $template;
-    }
-
-
-    /**
-     * the_title
-     *
-     * @access public
-     * @param  string $title
-     * @return string
-     */
-    public function the_title($title = '')
-    {
-        return $title;
-    }
-
-
-    /**
-     *    venue_details
-     *
-     * @access public
-     * @param  string $content
-     * @return string
-     */
-    public function venue_details($content)
-    {
-        global $post;
-        if (
-            $post->post_type == EspressoPostType::VENUES
-            && ! post_password_required()
-        ) {
-            // since the 'content-espresso_venues-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_excerpt', array($this, 'venue_details'), 100);
-            remove_filter('the_content', array($this, 'venue_details'), 100);
-            // add filters we want
-            add_filter('the_content', array($this, 'venue_location'), 110);
-            add_filter('the_excerpt', array($this, 'venue_location'), 110);
-            // now load our template
-            $template = EEH_Template::locate_template('content-espresso_venues-details.php');
-            // now add our filter back in, plus some others
-            add_filter('the_excerpt', array($this, 'venue_details'), 100);
-            add_filter('the_content', array($this, 'venue_details'), 100);
-            // remove other filters we added so they won't get applied to the next post
-            remove_filter('the_content', array($this, 'venue_location'), 110);
-            remove_filter('the_excerpt', array($this, 'venue_location'), 110);
-            // we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
-        }
-        return ! empty($template) ? $template : $content;
-    }
-
-
-    /**
-     * venue_location
-     *
-     * @access public
-     * @param  string $content
-     * @return string
-     */
-    public function venue_location($content)
-    {
-        return $content . EEH_Template::locate_template('content-espresso_venues-location.php');
-    }
-
-
-    /**
-     *    wp_enqueue_scripts
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp_enqueue_scripts()
-    {
-        // get some style
-        if (apply_filters('FHEE_enable_default_espresso_css', true) && is_archive()) {
-            // first check theme 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')
-                );
-            } elseif (is_readable(EE_TEMPLATES . $this->theme . '/style.css')) {
-                wp_register_style(
-                    $this->theme,
-                    EE_TEMPLATES_URL . $this->theme . '/style.css',
-                    array('dashicons', 'espresso_default')
-                );
-            }
-            wp_enqueue_style($this->theme);
-        }
-    }
+	/**
+	 * @return EED_Venues_Archive
+	 */
+	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()
+	{
+		/** @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();
+		EE_Config::register_route(
+			$custom_post_types[EspressoPostType::VENUES]['plural_slug'],
+			'Venues_Archive',
+			'run'
+		);
+	}
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
+
+
+	/**
+	 * run - initial module setup
+	 *
+	 * @access    public
+	 * @param \WP $WP
+	 */
+	public function run($WP)
+	{
+		// check what template is loaded
+		add_filter('template_include', array($this, 'template_include'), 999, 1);
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
+	}
+
+
+	/**
+	 * template_include
+	 *
+	 * @access public
+	 * @param  string $template
+	 * @return string
+	 */
+	public function template_include($template)
+	{
+		// not a custom template?
+		if (
+			EE_Registry::instance()->load_core('Front_Controller', array(), false, true)
+								   ->get_selected_template() != 'archive-espresso_venues.php'
+		) {
+			EEH_Template::load_espresso_theme_functions();
+			// then add extra event data via hooks
+			add_filter('the_title', array($this, 'the_title'), 100, 1);
+			// don't know if theme uses the_excerpt
+			add_filter('the_excerpt', array($this, 'venue_details'), 100);
+			// or the_content
+			add_filter('the_content', array($this, 'venue_details'), 100);
+			// don't display entry meta because the existing theme will take care of that
+			add_filter('FHEE__content_espresso_venues_details_template__display_entry_meta', '__return_false');
+		}
+		return $template;
+	}
+
+
+	/**
+	 * the_title
+	 *
+	 * @access public
+	 * @param  string $title
+	 * @return string
+	 */
+	public function the_title($title = '')
+	{
+		return $title;
+	}
+
+
+	/**
+	 *    venue_details
+	 *
+	 * @access public
+	 * @param  string $content
+	 * @return string
+	 */
+	public function venue_details($content)
+	{
+		global $post;
+		if (
+			$post->post_type == EspressoPostType::VENUES
+			&& ! post_password_required()
+		) {
+			// since the 'content-espresso_venues-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_excerpt', array($this, 'venue_details'), 100);
+			remove_filter('the_content', array($this, 'venue_details'), 100);
+			// add filters we want
+			add_filter('the_content', array($this, 'venue_location'), 110);
+			add_filter('the_excerpt', array($this, 'venue_location'), 110);
+			// now load our template
+			$template = EEH_Template::locate_template('content-espresso_venues-details.php');
+			// now add our filter back in, plus some others
+			add_filter('the_excerpt', array($this, 'venue_details'), 100);
+			add_filter('the_content', array($this, 'venue_details'), 100);
+			// remove other filters we added so they won't get applied to the next post
+			remove_filter('the_content', array($this, 'venue_location'), 110);
+			remove_filter('the_excerpt', array($this, 'venue_location'), 110);
+			// we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
+		}
+		return ! empty($template) ? $template : $content;
+	}
+
+
+	/**
+	 * venue_location
+	 *
+	 * @access public
+	 * @param  string $content
+	 * @return string
+	 */
+	public function venue_location($content)
+	{
+		return $content . EEH_Template::locate_template('content-espresso_venues-location.php');
+	}
+
+
+	/**
+	 *    wp_enqueue_scripts
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp_enqueue_scripts()
+	{
+		// get some style
+		if (apply_filters('FHEE_enable_default_espresso_css', true) && is_archive()) {
+			// first check theme 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')
+				);
+			} elseif (is_readable(EE_TEMPLATES . $this->theme . '/style.css')) {
+				wp_register_style(
+					$this->theme,
+					EE_TEMPLATES_URL . $this->theme . '/style.css',
+					array('dashicons', 'espresso_default')
+				);
+			}
+			wp_enqueue_style($this->theme);
+		}
+	}
 }

modules/batch/EED_Batch.module.php

Indentation +452 added lines, -452 removed lines

@@ -29,456 +29,456 @@
  */
 class EED_Batch extends EED_Module
 {
-    public const PAGE_SLUG = 'espresso_batch';
-
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
-     * processes data only
-     */
-    const batch_job = 'job';
-
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
-     * produces a file for download
-     */
-    const batch_file_job = 'file';
-
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates this request is NOT
-     * for a batch job. It's the same as not providing the $_REQUEST[ 'batch' ]
-     * at all
-     */
-    const batch_not_job = 'none';
-
-    /**
-     *
-     * @var string 'file', or 'job', or false to indicate its not a batch request at all
-     */
-    protected $_batch_request_type = '';
-
-    /**
-     * Because we want to use the response in both the localized JS and in the body
-     * we need to make this response available between method calls
-     *
-     * @var JobStepResponse|null
-     */
-    protected $_job_step_response = null;
-
-    /**
-     * @var LoaderInterface|null
-     */
-    protected $loader = null;
-
-
-    /**
-     * Gets the batch instance
-     *
-     * @return  EED_Module|EED_Batch
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance(): EED_Batch
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * Sets hooks to enable batch jobs on the frontend. Disabled by default
-     * because it's an attack vector and there are currently no implementations
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function set_hooks()
-    {
-        // because this is a possible attack vector, let's have this disabled until
-        // we at least have a real use for it on the frontend
-        if (apply_filters('FHEE__EED_Batch__set_hooks__enable_frontend_batch', false)) {
-            add_action('wp_enqueue_scripts', [self::instance(), 'enqueue_scripts']);
-            add_filter('template_include', [self::instance(), 'override_template'], 99);
-        }
-    }
-
-
-    /**
-     * Initializes some hooks for the admin in order to run batch jobs
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('load-admin_page_espresso_batch', [self::instance(), 'setPageTitle']);
-        add_action('admin_menu', [self::instance(), 'register_admin_pages']);
-        add_action('admin_enqueue_scripts', [self::instance(), 'enqueue_scripts']);
-
-        // ajax
-        add_action('wp_ajax_espresso_batch_continue', [self::instance(), 'continueBatchJob']);
-        add_action('wp_ajax_espresso_batch_advance', [self::instance(), 'advanceBatchJob']);
-        add_action('wp_ajax_espresso_batch_cleanup', [self::instance(), 'cleanupBatchJob']);
-        add_action('wp_ajax_nopriv_espresso_batch_continue', [self::instance(), 'continueBatchJob']);
-        add_action('wp_ajax_nopriv_espresso_batch_advance', [self::instance(), 'advanceBatchJob']);
-        add_action('wp_ajax_nopriv_espresso_batch_cleanup', [self::instance(), 'cleanupBatchJob']);
-    }
-
-
-    /**
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.9.80.p
-     */
-    protected function getLoader(): LoaderInterface
-    {
-        if (! $this->loader instanceof LoaderInterface) {
-            $this->loader = LoaderFactory::getLoader();
-        }
-        return $this->loader;
-    }
-
-
-    /**
-     * Enqueues batch scripts on the frontend or admin, and creates a job
-     */
-    public function enqueue_scripts()
-    {
-        $request = EED_Batch::getRequest();
-        if (
-            $request->getRequestParam(EED_Batch::PAGE_SLUG)
-            || $request->getRequestParam('page') === EED_Batch::PAGE_SLUG
-        ) {
-            if (
-                ! $request->requestParamIsSet('default_nonce')
-                || ! wp_verify_nonce($request->getRequestParam('default_nonce'), 'default_nonce')
-            ) {
-                wp_die(
-                    esc_html__(
-                        'The link you clicked to start the batch job has expired. Please go back and refresh the previous page.',
-                        'event_espresso'
-                    )
-                );
-            }
-            switch ($this->batch_request_type()) {
-                case self::batch_job:
-                    $this->enqueue_scripts_styles_batch_create();
-                    break;
-                case self::batch_file_job:
-                    $this->enqueue_scripts_styles_batch_file_create();
-                    break;
-            }
-        }
-    }
-
-
-    /**
-     * Create a batch job, enqueues a script to run it, and localizes some data for it
-     */
-    public function enqueue_scripts_styles_batch_create()
-    {
-        $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
-        wp_enqueue_script(
-            'batch_runner_init',
-            BATCH_URL . 'assets/batch_runner_init.js',
-            ['batch_runner'],
-            date('Y-m-d-H:i', time()),
-            true
-        );
-        wp_localize_script('batch_runner_init', 'ee_job_response', $job_response->to_array());
-        wp_localize_script('batch_runner_init', 'eei18n', EE_Registry::$i18n_js_strings);
-
-        $return_url = EED_Batch::getRequest()->getRequestParam('return_url', '', DataType::URL);
-        if ($return_url) {
-            wp_localize_script(
-                'batch_runner_init',
-                'ee_job_i18n',
-                [
-                    'return_url'                => $return_url,
-                    'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam(
-                        'auto_redirect_on_complete'
-                    ),
-                    'user_message'              => EED_Batch::getRequest()->getRequestParam('assessment_notice')
-                        ?: EED_Batch::getRequest()->getRequestParam('job_start_notice'),
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * Creates a batch job which will download a file, enqueues a script to run the job, and localizes some data for it
-     */
-    public function enqueue_scripts_styles_batch_file_create()
-    {
-        // creates a job based on the request variable
-        $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
-        wp_enqueue_script(
-            'batch_file_runner_init',
-            BATCH_URL . 'assets/batch_file_runner_init.js',
-            ['batch_runner'],
-            date('Y-m-d-H:i', time()),
-            true
-        );
-        wp_localize_script('batch_file_runner_init', 'ee_job_response', $job_response->to_array());
-        wp_localize_script('batch_file_runner_init', 'eei18n', EE_Registry::$i18n_js_strings);
-
-        $return_url = EED_Batch::getRequest()->getRequestParam('return_url', '', DataType::URL);
-        if ($return_url) {
-            wp_localize_script(
-                'batch_file_runner_init',
-                'ee_job_i18n',
-                ['return_url' => $return_url]
-            );
-        }
-    }
-
-
-    /**
-     * Enqueues scripts and styles common to any batch job, and creates
-     * a job from the request data, and stores the response in the
-     * $this->_job_step_response property
-     *
-     * @return JobStepResponse
-     */
-    protected function _enqueue_batch_job_scripts_and_styles_and_start_job(): JobStepResponse
-    {
-        // just copy the bits of EE admin's eei18n that we need in the JS
-        EE_Registry::$i18n_js_strings['batchJobError'] = __(
-            'An error occurred and the job has been stopped. Please refresh the page to try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['is_admin']      = is_admin();
-        wp_enqueue_style(
-            EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN,
-            EE_ADMIN_URL . 'assets/ee-admin-page.css',
-            ['espresso_admin_base'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style(
-            'batch_runner',
-            BATCH_URL . 'assets/batch_runner.css',
-            [EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
-            date('Y-m-d-H:i', time())
-        );
-        wp_register_script(
-            'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js',
-            ['jquery'],
-            date('Y-m-d-H:i', time()),
-            true
-        );
-        wp_enqueue_style(
-            'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css',
-            [],
-            date('Y-m-d-H:i', time())
-        );
-        wp_enqueue_script(
-            'batch_runner',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js',
-            ['progress_bar', CoreAssetManager::JS_HANDLE_CORE],
-            date('Y-m-d-H:i', time()),
-            true
-        );
-        /** @var BatchRequestProcessor $batch_runner */
-        $batch_runner = $this->getLoader()->getShared('EventEspresso\core\libraries\batch\BatchRequestProcessor');
-        // eg 'EventEspresso\core\libraries\batch\JobHandlers\RegistrationsReport'
-        // remember the response for later. We need it to display the page body
-        $this->_job_step_response = $batch_runner->createJob();
-        return $this->_job_step_response;
-    }
-
-
-    /**
-     * If we are doing a frontend batch job, this makes it so WP shows our template's HTML
-     *
-     * @param string $template
-     * @return string
-     */
-    public function override_template(string $template): string
-    {
-        $request = EED_Batch::getRequest();
-        if ($request->requestParamIsSet('batch') && $request->requestParamIsSet(EED_Batch::PAGE_SLUG)) {
-            return EE_MODULES . 'batch/templates/batch_frontend_wrapper.template.php';
-        }
-        return $template;
-    }
-
-
-    /**
-     * Adds an admin page which doesn't appear in the admin menu
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function register_admin_pages()
-    {
-        add_submenu_page(
-            // parent slug. we don't want this to actually appear in the menu
-            '',
-            // page title
-            esc_html__('Batch Job', 'event_espresso'),
-            // menu title
-            'n/a',
-            // we want this page to actually be accessible to anyone,
-            'read',
-            // menu slug
-            EED_Batch::PAGE_SLUG,
-            // callback
-            [self::instance(), 'show_admin_page']
-        );
-    }
-
-
-    /**
-     * prevents the following notice from appearing in the error log:
-     * PHP Deprecated:  strip_tags():
-     * Passing null to parameter #1 ($string) of type string is deprecated
-     * in /wp-admin/admin-header.php on line 36
-     *
-     * @return void
-     * @since 5.0.18.p
-     */
-    public function setPageTitle()
-    {
-        global $title;
-        $title = esc_html__('Batch Job', 'event_espresso');
-    }
-
-
-    /**
-     * Renders the admin page, after most of the work was already done during enqueuing scripts
-     * of creating the job and localizing some data
-     */
-    public function show_admin_page()
-    {
-        echo EEH_Template::locate_template(
-            EE_MODULES . 'batch/templates/batch_wrapper.template.php',
-            [
-                'batch_request_type'        => $this->batch_request_type(),
-                'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam('auto_redirect_on_complete'),
-                'user_message'              => EED_Batch::getRequest()->getRequestParam('assessment_notice')
-                    ?: EED_Batch::getRequest()->getRequestParam('job_start_notice'),
-            ]
-        );
-    }
-
-
-    private function runBatchRunnerJob(string $job)
-    {
-        $job_id = EED_Batch::getRequest()->getRequestParam('job_id');
-        /** @var BatchRequestProcessor $batch_runner */
-        $batch_runner = $this->getLoader()->getShared('EventEspresso\core\libraries\batch\BatchRequestProcessor');
-        $job_response = $batch_runner->{$job}($job_id);
-        $this->_return_json($job_response->to_array());
-    }
-
-
-    /**
-     * Receives ajax calls for continuing a job
-     */
-    public function continueBatchJob()
-    {
-        $this->runBatchRunnerJob('continueJob');
-    }
-
-
-    /**
-     * Receives ajax calls for continuing a job
-     */
-    public function advanceBatchJob()
-    {
-        $this->runBatchRunnerJob('advanceJob');
-    }
-
-
-    /**
-     * Receives the ajax call to cleanup a job
-     *
-     * @return void
-     */
-    public function cleanupBatchJob()
-    {
-        $this->runBatchRunnerJob('cleanupJob');
-    }
-
-
-    /**
-     * Returns a json response
-     *
-     * @param array $data The data we want to send echo via in the JSON response's "data" element
-     *
-     * The returned json object is created from an array in the following format:
-     * array(
-     *    'notices' => '', // - contains any EE_Error formatted notices
-     *    'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
-     *    We're also going to include the template args with every package (so js can pick out any specific template
-     *    args that might be included in here)
-     *    'isEEajax' => true,//indicates this is a response from EE
-     * )
-     */
-    protected function _return_json(array $data)
-    {
-        $json = [
-            'data'     => $data,
-            'isEEajax' => true,
-            // special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
-        ];
-
-        // make sure there are no php errors or headers_sent.  Then we can set correct json header.
-        if (error_get_last() === null || ! headers_sent()) {
-            $notices = EE_Error::get_notices(false);
-            header('Content-Type: application/json; charset=UTF-8');
-            echo wp_json_encode($json + $notices);
-            exit();
-        }
-    }
-
-
-    /**
-     * Gets the job step response which was done during the enqueuing of scripts
-     *
-     * @return JobStepResponse
-     */
-    public function job_step_response(): JobStepResponse
-    {
-        return $this->_job_step_response;
-    }
-
-
-    /**
-     * Gets the batch request type indicated in the current request
-     *
-     * @return string: EED_Batch::batch_job, EED_Batch::batch_file_job, EED_Batch::batch_not_job
-     */
-    public function batch_request_type(): string
-    {
-        if (! $this->_batch_request_type) {
-            $request = EED_Batch::getRequest();
-            $batch   = $request->getRequestParam('batch');
-            switch ($batch) {
-                case self::batch_job:
-                    $this->_batch_request_type = self::batch_job;
-                    break;
-                case self::batch_file_job:
-                    $this->_batch_request_type = self::batch_file_job;
-                    break;
-                default:
-                    // if we didn't find that it was a batch request, indicate it wasn't
-                    $this->_batch_request_type = self::batch_not_job;
-            }
-        }
-        return $this->_batch_request_type;
-    }
-
-
-    /**
-     * Unnecessary
-     *
-     * @param WP $WP
-     */
-    public function run($WP)
-    {
-    }
+	public const PAGE_SLUG = 'espresso_batch';
+
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
+	 * processes data only
+	 */
+	const batch_job = 'job';
+
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
+	 * produces a file for download
+	 */
+	const batch_file_job = 'file';
+
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates this request is NOT
+	 * for a batch job. It's the same as not providing the $_REQUEST[ 'batch' ]
+	 * at all
+	 */
+	const batch_not_job = 'none';
+
+	/**
+	 *
+	 * @var string 'file', or 'job', or false to indicate its not a batch request at all
+	 */
+	protected $_batch_request_type = '';
+
+	/**
+	 * Because we want to use the response in both the localized JS and in the body
+	 * we need to make this response available between method calls
+	 *
+	 * @var JobStepResponse|null
+	 */
+	protected $_job_step_response = null;
+
+	/**
+	 * @var LoaderInterface|null
+	 */
+	protected $loader = null;
+
+
+	/**
+	 * Gets the batch instance
+	 *
+	 * @return  EED_Module|EED_Batch
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance(): EED_Batch
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * Sets hooks to enable batch jobs on the frontend. Disabled by default
+	 * because it's an attack vector and there are currently no implementations
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function set_hooks()
+	{
+		// because this is a possible attack vector, let's have this disabled until
+		// we at least have a real use for it on the frontend
+		if (apply_filters('FHEE__EED_Batch__set_hooks__enable_frontend_batch', false)) {
+			add_action('wp_enqueue_scripts', [self::instance(), 'enqueue_scripts']);
+			add_filter('template_include', [self::instance(), 'override_template'], 99);
+		}
+	}
+
+
+	/**
+	 * Initializes some hooks for the admin in order to run batch jobs
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('load-admin_page_espresso_batch', [self::instance(), 'setPageTitle']);
+		add_action('admin_menu', [self::instance(), 'register_admin_pages']);
+		add_action('admin_enqueue_scripts', [self::instance(), 'enqueue_scripts']);
+
+		// ajax
+		add_action('wp_ajax_espresso_batch_continue', [self::instance(), 'continueBatchJob']);
+		add_action('wp_ajax_espresso_batch_advance', [self::instance(), 'advanceBatchJob']);
+		add_action('wp_ajax_espresso_batch_cleanup', [self::instance(), 'cleanupBatchJob']);
+		add_action('wp_ajax_nopriv_espresso_batch_continue', [self::instance(), 'continueBatchJob']);
+		add_action('wp_ajax_nopriv_espresso_batch_advance', [self::instance(), 'advanceBatchJob']);
+		add_action('wp_ajax_nopriv_espresso_batch_cleanup', [self::instance(), 'cleanupBatchJob']);
+	}
+
+
+	/**
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.9.80.p
+	 */
+	protected function getLoader(): LoaderInterface
+	{
+		if (! $this->loader instanceof LoaderInterface) {
+			$this->loader = LoaderFactory::getLoader();
+		}
+		return $this->loader;
+	}
+
+
+	/**
+	 * Enqueues batch scripts on the frontend or admin, and creates a job
+	 */
+	public function enqueue_scripts()
+	{
+		$request = EED_Batch::getRequest();
+		if (
+			$request->getRequestParam(EED_Batch::PAGE_SLUG)
+			|| $request->getRequestParam('page') === EED_Batch::PAGE_SLUG
+		) {
+			if (
+				! $request->requestParamIsSet('default_nonce')
+				|| ! wp_verify_nonce($request->getRequestParam('default_nonce'), 'default_nonce')
+			) {
+				wp_die(
+					esc_html__(
+						'The link you clicked to start the batch job has expired. Please go back and refresh the previous page.',
+						'event_espresso'
+					)
+				);
+			}
+			switch ($this->batch_request_type()) {
+				case self::batch_job:
+					$this->enqueue_scripts_styles_batch_create();
+					break;
+				case self::batch_file_job:
+					$this->enqueue_scripts_styles_batch_file_create();
+					break;
+			}
+		}
+	}
+
+
+	/**
+	 * Create a batch job, enqueues a script to run it, and localizes some data for it
+	 */
+	public function enqueue_scripts_styles_batch_create()
+	{
+		$job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
+		wp_enqueue_script(
+			'batch_runner_init',
+			BATCH_URL . 'assets/batch_runner_init.js',
+			['batch_runner'],
+			date('Y-m-d-H:i', time()),
+			true
+		);
+		wp_localize_script('batch_runner_init', 'ee_job_response', $job_response->to_array());
+		wp_localize_script('batch_runner_init', 'eei18n', EE_Registry::$i18n_js_strings);
+
+		$return_url = EED_Batch::getRequest()->getRequestParam('return_url', '', DataType::URL);
+		if ($return_url) {
+			wp_localize_script(
+				'batch_runner_init',
+				'ee_job_i18n',
+				[
+					'return_url'                => $return_url,
+					'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam(
+						'auto_redirect_on_complete'
+					),
+					'user_message'              => EED_Batch::getRequest()->getRequestParam('assessment_notice')
+						?: EED_Batch::getRequest()->getRequestParam('job_start_notice'),
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * Creates a batch job which will download a file, enqueues a script to run the job, and localizes some data for it
+	 */
+	public function enqueue_scripts_styles_batch_file_create()
+	{
+		// creates a job based on the request variable
+		$job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
+		wp_enqueue_script(
+			'batch_file_runner_init',
+			BATCH_URL . 'assets/batch_file_runner_init.js',
+			['batch_runner'],
+			date('Y-m-d-H:i', time()),
+			true
+		);
+		wp_localize_script('batch_file_runner_init', 'ee_job_response', $job_response->to_array());
+		wp_localize_script('batch_file_runner_init', 'eei18n', EE_Registry::$i18n_js_strings);
+
+		$return_url = EED_Batch::getRequest()->getRequestParam('return_url', '', DataType::URL);
+		if ($return_url) {
+			wp_localize_script(
+				'batch_file_runner_init',
+				'ee_job_i18n',
+				['return_url' => $return_url]
+			);
+		}
+	}
+
+
+	/**
+	 * Enqueues scripts and styles common to any batch job, and creates
+	 * a job from the request data, and stores the response in the
+	 * $this->_job_step_response property
+	 *
+	 * @return JobStepResponse
+	 */
+	protected function _enqueue_batch_job_scripts_and_styles_and_start_job(): JobStepResponse
+	{
+		// just copy the bits of EE admin's eei18n that we need in the JS
+		EE_Registry::$i18n_js_strings['batchJobError'] = __(
+			'An error occurred and the job has been stopped. Please refresh the page to try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['is_admin']      = is_admin();
+		wp_enqueue_style(
+			EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN,
+			EE_ADMIN_URL . 'assets/ee-admin-page.css',
+			['espresso_admin_base'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style(
+			'batch_runner',
+			BATCH_URL . 'assets/batch_runner.css',
+			[EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
+			date('Y-m-d-H:i', time())
+		);
+		wp_register_script(
+			'progress_bar',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js',
+			['jquery'],
+			date('Y-m-d-H:i', time()),
+			true
+		);
+		wp_enqueue_style(
+			'progress_bar',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css',
+			[],
+			date('Y-m-d-H:i', time())
+		);
+		wp_enqueue_script(
+			'batch_runner',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js',
+			['progress_bar', CoreAssetManager::JS_HANDLE_CORE],
+			date('Y-m-d-H:i', time()),
+			true
+		);
+		/** @var BatchRequestProcessor $batch_runner */
+		$batch_runner = $this->getLoader()->getShared('EventEspresso\core\libraries\batch\BatchRequestProcessor');
+		// eg 'EventEspresso\core\libraries\batch\JobHandlers\RegistrationsReport'
+		// remember the response for later. We need it to display the page body
+		$this->_job_step_response = $batch_runner->createJob();
+		return $this->_job_step_response;
+	}
+
+
+	/**
+	 * If we are doing a frontend batch job, this makes it so WP shows our template's HTML
+	 *
+	 * @param string $template
+	 * @return string
+	 */
+	public function override_template(string $template): string
+	{
+		$request = EED_Batch::getRequest();
+		if ($request->requestParamIsSet('batch') && $request->requestParamIsSet(EED_Batch::PAGE_SLUG)) {
+			return EE_MODULES . 'batch/templates/batch_frontend_wrapper.template.php';
+		}
+		return $template;
+	}
+
+
+	/**
+	 * Adds an admin page which doesn't appear in the admin menu
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function register_admin_pages()
+	{
+		add_submenu_page(
+			// parent slug. we don't want this to actually appear in the menu
+			'',
+			// page title
+			esc_html__('Batch Job', 'event_espresso'),
+			// menu title
+			'n/a',
+			// we want this page to actually be accessible to anyone,
+			'read',
+			// menu slug
+			EED_Batch::PAGE_SLUG,
+			// callback
+			[self::instance(), 'show_admin_page']
+		);
+	}
+
+
+	/**
+	 * prevents the following notice from appearing in the error log:
+	 * PHP Deprecated:  strip_tags():
+	 * Passing null to parameter #1 ($string) of type string is deprecated
+	 * in /wp-admin/admin-header.php on line 36
+	 *
+	 * @return void
+	 * @since 5.0.18.p
+	 */
+	public function setPageTitle()
+	{
+		global $title;
+		$title = esc_html__('Batch Job', 'event_espresso');
+	}
+
+
+	/**
+	 * Renders the admin page, after most of the work was already done during enqueuing scripts
+	 * of creating the job and localizing some data
+	 */
+	public function show_admin_page()
+	{
+		echo EEH_Template::locate_template(
+			EE_MODULES . 'batch/templates/batch_wrapper.template.php',
+			[
+				'batch_request_type'        => $this->batch_request_type(),
+				'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam('auto_redirect_on_complete'),
+				'user_message'              => EED_Batch::getRequest()->getRequestParam('assessment_notice')
+					?: EED_Batch::getRequest()->getRequestParam('job_start_notice'),
+			]
+		);
+	}
+
+
+	private function runBatchRunnerJob(string $job)
+	{
+		$job_id = EED_Batch::getRequest()->getRequestParam('job_id');
+		/** @var BatchRequestProcessor $batch_runner */
+		$batch_runner = $this->getLoader()->getShared('EventEspresso\core\libraries\batch\BatchRequestProcessor');
+		$job_response = $batch_runner->{$job}($job_id);
+		$this->_return_json($job_response->to_array());
+	}
+
+
+	/**
+	 * Receives ajax calls for continuing a job
+	 */
+	public function continueBatchJob()
+	{
+		$this->runBatchRunnerJob('continueJob');
+	}
+
+
+	/**
+	 * Receives ajax calls for continuing a job
+	 */
+	public function advanceBatchJob()
+	{
+		$this->runBatchRunnerJob('advanceJob');
+	}
+
+
+	/**
+	 * Receives the ajax call to cleanup a job
+	 *
+	 * @return void
+	 */
+	public function cleanupBatchJob()
+	{
+		$this->runBatchRunnerJob('cleanupJob');
+	}
+
+
+	/**
+	 * Returns a json response
+	 *
+	 * @param array $data The data we want to send echo via in the JSON response's "data" element
+	 *
+	 * The returned json object is created from an array in the following format:
+	 * array(
+	 *    'notices' => '', // - contains any EE_Error formatted notices
+	 *    'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
+	 *    We're also going to include the template args with every package (so js can pick out any specific template
+	 *    args that might be included in here)
+	 *    'isEEajax' => true,//indicates this is a response from EE
+	 * )
+	 */
+	protected function _return_json(array $data)
+	{
+		$json = [
+			'data'     => $data,
+			'isEEajax' => true,
+			// special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
+		];
+
+		// make sure there are no php errors or headers_sent.  Then we can set correct json header.
+		if (error_get_last() === null || ! headers_sent()) {
+			$notices = EE_Error::get_notices(false);
+			header('Content-Type: application/json; charset=UTF-8');
+			echo wp_json_encode($json + $notices);
+			exit();
+		}
+	}
+
+
+	/**
+	 * Gets the job step response which was done during the enqueuing of scripts
+	 *
+	 * @return JobStepResponse
+	 */
+	public function job_step_response(): JobStepResponse
+	{
+		return $this->_job_step_response;
+	}
+
+
+	/**
+	 * Gets the batch request type indicated in the current request
+	 *
+	 * @return string: EED_Batch::batch_job, EED_Batch::batch_file_job, EED_Batch::batch_not_job
+	 */
+	public function batch_request_type(): string
+	{
+		if (! $this->_batch_request_type) {
+			$request = EED_Batch::getRequest();
+			$batch   = $request->getRequestParam('batch');
+			switch ($batch) {
+				case self::batch_job:
+					$this->_batch_request_type = self::batch_job;
+					break;
+				case self::batch_file_job:
+					$this->_batch_request_type = self::batch_file_job;
+					break;
+				default:
+					// if we didn't find that it was a batch request, indicate it wasn't
+					$this->_batch_request_type = self::batch_not_job;
+			}
+		}
+		return $this->_batch_request_type;
+	}
+
+
+	/**
+	 * Unnecessary
+	 *
+	 * @param WP $WP
+	 */
+	public function run($WP)
+	{
+	}
 }

modules/venue_single/EED_Venue_Single.module.php

Indentation +169 added lines, -169 removed lines

@@ -29,173 +29,173 @@
  */
 class EED_Venue_Single extends EED_Module
 {
-    /**
-     * @return EED_Venue_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()
-    {
-        /** @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();
-        EE_Config::register_route(
-            $custom_post_types[EspressoPostType::VENUES]['singular_slug'],
-            'Venue_Single',
-            'run'
-        );
-    }
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-    }
-
-
-    /**
-     * run - initial module setup
-     *
-     * @access    public
-     * @param \WP $WP
-     */
-    public function run($WP)
-    {
-        // check what template is loaded
-        add_filter('template_include', array($this, 'template_include'), 999, 1);
-        add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
-    }
-
-
-    /**
-     * template_include
-     *
-     * @access public
-     * @param  string $template
-     * @return string
-     */
-    public function template_include($template)
-    {
-        // not a custom template?
-        if (
-            EE_Registry::instance()
-                       ->load_core('Front_Controller', array(), false, true)
-                       ->get_selected_template() != 'single-espresso_venues.php'
-        ) {
-            EEH_Template::load_espresso_theme_functions();
-            // then add extra event data via hooks
-            add_filter('the_title', array($this, 'the_title'), 100, 1);
-            add_filter('the_content', array($this, 'venue_details'), 100);
-            // don't display entry meta because the existing theme will take car of that
-            add_filter('FHEE__content_espresso_venues_details_template__display_entry_meta', '__return_false');
-        }
-        return $template;
-    }
-
-
-    /**
-     * the_title
-     *
-     * @access public
-     * @param  string $title
-     * @return string
-     */
-    public function the_title($title = '')
-    {
-        return $title;
-    }
-
-
-    /**
-     *    venue_details
-     *
-     * @access public
-     * @param  string $content
-     * @return string
-     */
-    public function venue_details($content)
-    {
-        global $post;
-        if (
-            $post->post_type == EspressoPostType::VENUES
-            && ! post_password_required()
-        ) {
-            // since the 'content-espresso_venues-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($this, 'venue_details'), 100);
-            // add filters we want
-            add_filter('the_content', array($this, 'venue_location'), 110);
-            // now load our template
-            $template = EEH_Template::locate_template('content-espresso_venues-details.php');
-            // remove other filters we added so they won't get applied to the next post
-            remove_filter('the_content', array($this, 'venue_location'), 110);
-        }
-        // we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
-        return ! empty($template) ? $template : $content;
-    }
-
-
-    /**
-     * venue_location
-     *
-     * @access public
-     * @param  string $content
-     * @return string
-     */
-    public function venue_location($content)
-    {
-        return $content . EEH_Template::locate_template('content-espresso_venues-location.php');
-    }
-
-
-    /**
-     *    wp_enqueue_scripts
-     *
-     * @access public
-     * @return void
-     */
-    public function wp_enqueue_scripts()
-    {
-        // get some style
-        if (apply_filters('FHEE_enable_default_espresso_css', true) && is_single()) {
-            // first check theme 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')
-                );
-            } elseif (is_readable(EE_TEMPLATES . $this->theme . '/style.css')) {
-                wp_register_style(
-                    $this->theme,
-                    EE_TEMPLATES_URL . $this->theme . '/style.css',
-                    array('dashicons', 'espresso_default')
-                );
-            }
-            wp_enqueue_style($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);
-            }
-        }
-    }
+	/**
+	 * @return EED_Venue_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()
+	{
+		/** @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();
+		EE_Config::register_route(
+			$custom_post_types[EspressoPostType::VENUES]['singular_slug'],
+			'Venue_Single',
+			'run'
+		);
+	}
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
+
+
+	/**
+	 * run - initial module setup
+	 *
+	 * @access    public
+	 * @param \WP $WP
+	 */
+	public function run($WP)
+	{
+		// check what template is loaded
+		add_filter('template_include', array($this, 'template_include'), 999, 1);
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
+	}
+
+
+	/**
+	 * template_include
+	 *
+	 * @access public
+	 * @param  string $template
+	 * @return string
+	 */
+	public function template_include($template)
+	{
+		// not a custom template?
+		if (
+			EE_Registry::instance()
+					   ->load_core('Front_Controller', array(), false, true)
+					   ->get_selected_template() != 'single-espresso_venues.php'
+		) {
+			EEH_Template::load_espresso_theme_functions();
+			// then add extra event data via hooks
+			add_filter('the_title', array($this, 'the_title'), 100, 1);
+			add_filter('the_content', array($this, 'venue_details'), 100);
+			// don't display entry meta because the existing theme will take car of that
+			add_filter('FHEE__content_espresso_venues_details_template__display_entry_meta', '__return_false');
+		}
+		return $template;
+	}
+
+
+	/**
+	 * the_title
+	 *
+	 * @access public
+	 * @param  string $title
+	 * @return string
+	 */
+	public function the_title($title = '')
+	{
+		return $title;
+	}
+
+
+	/**
+	 *    venue_details
+	 *
+	 * @access public
+	 * @param  string $content
+	 * @return string
+	 */
+	public function venue_details($content)
+	{
+		global $post;
+		if (
+			$post->post_type == EspressoPostType::VENUES
+			&& ! post_password_required()
+		) {
+			// since the 'content-espresso_venues-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($this, 'venue_details'), 100);
+			// add filters we want
+			add_filter('the_content', array($this, 'venue_location'), 110);
+			// now load our template
+			$template = EEH_Template::locate_template('content-espresso_venues-details.php');
+			// remove other filters we added so they won't get applied to the next post
+			remove_filter('the_content', array($this, 'venue_location'), 110);
+		}
+		// we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
+		return ! empty($template) ? $template : $content;
+	}
+
+
+	/**
+	 * venue_location
+	 *
+	 * @access public
+	 * @param  string $content
+	 * @return string
+	 */
+	public function venue_location($content)
+	{
+		return $content . EEH_Template::locate_template('content-espresso_venues-location.php');
+	}
+
+
+	/**
+	 *    wp_enqueue_scripts
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function wp_enqueue_scripts()
+	{
+		// get some style
+		if (apply_filters('FHEE_enable_default_espresso_css', true) && is_single()) {
+			// first check theme 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')
+				);
+			} elseif (is_readable(EE_TEMPLATES . $this->theme . '/style.css')) {
+				wp_register_style(
+					$this->theme,
+					EE_TEMPLATES_URL . $this->theme . '/style.css',
+					array('dashicons', 'espresso_default')
+				);
+			}
+			wp_enqueue_style($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);
+			}
+		}
+	}
 }

modules/ticket_selector/DisplayTicketSelector.php

Indentation +866 added lines, -866 removed lines

@@ -41,873 +41,873 @@
  */
 class DisplayTicketSelector
 {
-    /**
-     * @var RequestInterface
-     */
-    protected $request;
-
-    /**
-     * @var EE_Ticket_Selector_Config
-     */
-    protected $config;
-
-    /**
-     * event that ticket selector is being generated for
-     *
-     * @access protected
-     * @var EE_Event $event
-     */
-    protected $event;
-
-    /**
-     * Used to flag when the ticket selector is being called from an external iframe.
-     *
-     * @var bool $iframe
-     */
-    protected $iframe = false;
-
-    /**
-     * max attendees that can register for event at one time
-     *
-     * @var int $max_attendees
-     */
-    private $max_attendees = EE_INF;
-
-    /**
-     * @var string $date_format
-     */
-    private $date_format;
-
-    /**
-     * @var string $time_format
-     */
-    private $time_format;
-
-    /**
-     * @var boolean $display_full_ui
-     */
-    private $display_full_ui;
-
-    /**
-     * @var CurrentUser
-     */
-    private $current_user;
-
-
-    /**
-     * DisplayTicketSelector constructor.
-     *
-     * @param CurrentUser $current_user
-     * @param RequestInterface          $request
-     * @param EE_Ticket_Selector_Config $config
-     * @param bool                      $iframe
-     */
-    public function __construct(
-        CurrentUser $current_user,
-        RequestInterface $request,
-        EE_Ticket_Selector_Config $config,
-        bool $iframe = false
-    ) {
-        $this->current_user = $current_user;
-        $this->request     = $request;
-        $this->config      = $config;
-        $this->setIframe($iframe);
-        $this->date_format = apply_filters(
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
-            get_option('date_format')
-        );
-        $this->time_format  = apply_filters(
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
-            get_option('time_format')
-        );
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isIframe(): bool
-    {
-        return $this->iframe;
-    }
-
-
-    /**
-     * @param boolean $iframe
-     */
-    public function setIframe(bool $iframe = true)
-    {
-        $this->iframe = filter_var($iframe, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * finds and sets the \EE_Event object for use throughout class
-     *
-     * @param mixed $event
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function setEvent($event = null): bool
-    {
-        if ($event === null) {
-            global $post;
-            $event = $post;
-        }
-        if ($event instanceof EE_Event) {
-            $this->event = $event;
-        } elseif ($event instanceof WP_Post) {
-            if (isset($event->EE_Event) && $event->EE_Event instanceof EE_Event) {
-                $this->event = $event->EE_Event;
-            } elseif (isset($event->post_type) && $event->post_type === EspressoPostType::EVENTS) {
-                $event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object($event);
-                $this->event     = $event->EE_Event;
-            }
-        } else {
-            $user_msg = esc_html__('No Event object or an invalid Event object was supplied.', 'event_espresso');
-            $dev_msg  = $user_msg . esc_html__(
-                'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
-                'event_espresso'
-            );
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function getMaxAttendees(): int
-    {
-        return $this->max_attendees;
-    }
-
-
-    /**
-     * @param int $max_attendees
-     */
-    public function setMaxAttendees(int $max_attendees)
-    {
-        $this->max_attendees = absint(
-            apply_filters(
-                'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
-                $max_attendees
-            )
-        );
-    }
-
-
-    /**
-     * Returns whether or not the full ticket selector should be shown or not.
-     * Currently, it displays on the frontend (including ajax requests) but not the backend
-     *
-     * @return bool
-     */
-    private function display_full_ui(): bool
-    {
-        if ($this->display_full_ui === null) {
-            $this->display_full_ui = ! is_admin() || (defined('DOING_AJAX') && DOING_AJAX);
-        }
-        return $this->display_full_ui;
-    }
-
-
-    /**
-     * creates buttons for selecting number of attendees for an event
-     *
-     * @param WP_Post|int $event
-     * @param bool        $view_details
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function display($event = null, bool $view_details = false)
-    {
-        // reset filter for displaying submit button
-        remove_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        // poke and prod incoming event till it tells us what it is
-        if (! $this->setEvent($event)) {
-            return $this->handleMissingEvent();
-        }
-        // is the event expired ?
-        $template_args['event_is_expired'] = ! is_admin() && $this->event->is_expired();
-        if ($template_args['event_is_expired']) {
-            return is_single()
-                ? $this->expiredEventMessage()
-                : $this->expiredEventMessage() . $this->displayViewDetailsButton();
-        }
-        // begin gathering template arguments by getting event status
-        $template_args = ['event_status' => $this->event->get_active_status()];
-        if (
-            $this->activeEventAndShowTicketSelector(
-                $event,
-                $template_args['event_status'],
-                $view_details
-            )
-        ) {
-            return ! is_single() ? $this->displayViewDetailsButton() : '';
-        }
-        // filter the maximum qty that can appear in the Ticket Selector qty dropdowns
-        $this->setMaxAttendees($this->event->additional_limit());
-        if ($this->getMaxAttendees() < 1) {
-            return $this->ticketSalesClosedMessage();
-        }
-        // get all tickets for this event ordered by the datetime
-        $tickets = $this->getTickets();
-        if (count($tickets) < 1) {
-            return $this->noTicketAvailableMessage();
-        }
-        // redirecting to another site for registration ??
-        $external_url = (string) $this->event->external_url()
-                        && $this->event->external_url() !== get_the_permalink()
-            ? $this->event->external_url()
-            : '';
-        // if redirecting to another site for registration, then we don't load the TS
-        $ticket_selector = $external_url
-            ? $this->externalEventRegistration()
-            : $this->loadTicketSelector($tickets, $template_args);
-        // now set up the form (but not for the admin)
-        $ticket_selector = $this->display_full_ui()
-            ? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
-            : $ticket_selector;
-        // submit button and form close tag
-        $ticket_selector .= $this->display_full_ui() ? $this->displaySubmitButton($external_url) : '';
-        return $ticket_selector;
-    }
-
-
-    /**
-     * displayTicketSelector
-     * examines the event properties and determines whether a Ticket Selector should be displayed
-     *
-     * @param WP_Post|int $event
-     * @param string      $_event_active_status
-     * @param bool        $view_details
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function activeEventAndShowTicketSelector($event, string $_event_active_status, bool $view_details): bool
-    {
-        $event_post = $this->event instanceof EE_Event ? $this->event->ID() : $event;
-        return $this->display_full_ui()
-               && (
-                   ! $this->event->display_ticket_selector()
-                   || $view_details
-                   || post_password_required($event_post)
-                   || (
-                       $_event_active_status !== EE_Datetime::active
-                       && $_event_active_status !== EE_Datetime::upcoming
-                       && $_event_active_status !== EE_Datetime::sold_out
-                       && ! (
-                           $_event_active_status === EE_Datetime::inactive
-                           && is_user_logged_in()
-                       )
-                   )
-               );
-    }
-
-
-    /**
-     * noTicketAvailableMessage
-     * notice displayed if event is expired
-     *
-     * @return string
-     */
-    protected function expiredEventMessage(): string
-    {
-        return '<div class="ee-event-expired-notice"><span class="important-notice">'
-           . esc_html__(
-               'We\'re sorry, but all tickets sales have ended because the event is expired.',
-               'event_espresso'
-           )
-           . '</span></div><!-- .ee-event-expired-notice -->';
-    }
-
-
-    /**
-     * noTicketAvailableMessage
-     * notice displayed if event has no more tickets available
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function noTicketAvailableMessage(): string
-    {
-        $no_ticket_available_msg = esc_html__('We\'re sorry, but all ticket sales have ended.', 'event_espresso');
-        if (current_user_can('edit_post', $this->event->ID())) {
-            $no_ticket_available_msg .= sprintf(
-                esc_html__(
-                    '%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
-                    'event_espresso'
-                ),
-                '<div class="ee-attention" style="text-align: left;"><b>',
-                '</b><br />',
-                '<span class="edit-link"><a class="post-edit-link" href="'
-                . get_edit_post_link($this->event->ID())
-                . '">',
-                '</a></span></div><!-- .ee-attention noTicketAvailableMessage -->'
-            );
-        }
-        return '
+	/**
+	 * @var RequestInterface
+	 */
+	protected $request;
+
+	/**
+	 * @var EE_Ticket_Selector_Config
+	 */
+	protected $config;
+
+	/**
+	 * event that ticket selector is being generated for
+	 *
+	 * @access protected
+	 * @var EE_Event $event
+	 */
+	protected $event;
+
+	/**
+	 * Used to flag when the ticket selector is being called from an external iframe.
+	 *
+	 * @var bool $iframe
+	 */
+	protected $iframe = false;
+
+	/**
+	 * max attendees that can register for event at one time
+	 *
+	 * @var int $max_attendees
+	 */
+	private $max_attendees = EE_INF;
+
+	/**
+	 * @var string $date_format
+	 */
+	private $date_format;
+
+	/**
+	 * @var string $time_format
+	 */
+	private $time_format;
+
+	/**
+	 * @var boolean $display_full_ui
+	 */
+	private $display_full_ui;
+
+	/**
+	 * @var CurrentUser
+	 */
+	private $current_user;
+
+
+	/**
+	 * DisplayTicketSelector constructor.
+	 *
+	 * @param CurrentUser $current_user
+	 * @param RequestInterface          $request
+	 * @param EE_Ticket_Selector_Config $config
+	 * @param bool                      $iframe
+	 */
+	public function __construct(
+		CurrentUser $current_user,
+		RequestInterface $request,
+		EE_Ticket_Selector_Config $config,
+		bool $iframe = false
+	) {
+		$this->current_user = $current_user;
+		$this->request     = $request;
+		$this->config      = $config;
+		$this->setIframe($iframe);
+		$this->date_format = apply_filters(
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
+			get_option('date_format')
+		);
+		$this->time_format  = apply_filters(
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
+			get_option('time_format')
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isIframe(): bool
+	{
+		return $this->iframe;
+	}
+
+
+	/**
+	 * @param boolean $iframe
+	 */
+	public function setIframe(bool $iframe = true)
+	{
+		$this->iframe = filter_var($iframe, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * finds and sets the \EE_Event object for use throughout class
+	 *
+	 * @param mixed $event
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function setEvent($event = null): bool
+	{
+		if ($event === null) {
+			global $post;
+			$event = $post;
+		}
+		if ($event instanceof EE_Event) {
+			$this->event = $event;
+		} elseif ($event instanceof WP_Post) {
+			if (isset($event->EE_Event) && $event->EE_Event instanceof EE_Event) {
+				$this->event = $event->EE_Event;
+			} elseif (isset($event->post_type) && $event->post_type === EspressoPostType::EVENTS) {
+				$event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object($event);
+				$this->event     = $event->EE_Event;
+			}
+		} else {
+			$user_msg = esc_html__('No Event object or an invalid Event object was supplied.', 'event_espresso');
+			$dev_msg  = $user_msg . esc_html__(
+				'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
+				'event_espresso'
+			);
+			EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function getMaxAttendees(): int
+	{
+		return $this->max_attendees;
+	}
+
+
+	/**
+	 * @param int $max_attendees
+	 */
+	public function setMaxAttendees(int $max_attendees)
+	{
+		$this->max_attendees = absint(
+			apply_filters(
+				'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
+				$max_attendees
+			)
+		);
+	}
+
+
+	/**
+	 * Returns whether or not the full ticket selector should be shown or not.
+	 * Currently, it displays on the frontend (including ajax requests) but not the backend
+	 *
+	 * @return bool
+	 */
+	private function display_full_ui(): bool
+	{
+		if ($this->display_full_ui === null) {
+			$this->display_full_ui = ! is_admin() || (defined('DOING_AJAX') && DOING_AJAX);
+		}
+		return $this->display_full_ui;
+	}
+
+
+	/**
+	 * creates buttons for selecting number of attendees for an event
+	 *
+	 * @param WP_Post|int $event
+	 * @param bool        $view_details
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function display($event = null, bool $view_details = false)
+	{
+		// reset filter for displaying submit button
+		remove_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		// poke and prod incoming event till it tells us what it is
+		if (! $this->setEvent($event)) {
+			return $this->handleMissingEvent();
+		}
+		// is the event expired ?
+		$template_args['event_is_expired'] = ! is_admin() && $this->event->is_expired();
+		if ($template_args['event_is_expired']) {
+			return is_single()
+				? $this->expiredEventMessage()
+				: $this->expiredEventMessage() . $this->displayViewDetailsButton();
+		}
+		// begin gathering template arguments by getting event status
+		$template_args = ['event_status' => $this->event->get_active_status()];
+		if (
+			$this->activeEventAndShowTicketSelector(
+				$event,
+				$template_args['event_status'],
+				$view_details
+			)
+		) {
+			return ! is_single() ? $this->displayViewDetailsButton() : '';
+		}
+		// filter the maximum qty that can appear in the Ticket Selector qty dropdowns
+		$this->setMaxAttendees($this->event->additional_limit());
+		if ($this->getMaxAttendees() < 1) {
+			return $this->ticketSalesClosedMessage();
+		}
+		// get all tickets for this event ordered by the datetime
+		$tickets = $this->getTickets();
+		if (count($tickets) < 1) {
+			return $this->noTicketAvailableMessage();
+		}
+		// redirecting to another site for registration ??
+		$external_url = (string) $this->event->external_url()
+						&& $this->event->external_url() !== get_the_permalink()
+			? $this->event->external_url()
+			: '';
+		// if redirecting to another site for registration, then we don't load the TS
+		$ticket_selector = $external_url
+			? $this->externalEventRegistration()
+			: $this->loadTicketSelector($tickets, $template_args);
+		// now set up the form (but not for the admin)
+		$ticket_selector = $this->display_full_ui()
+			? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
+			: $ticket_selector;
+		// submit button and form close tag
+		$ticket_selector .= $this->display_full_ui() ? $this->displaySubmitButton($external_url) : '';
+		return $ticket_selector;
+	}
+
+
+	/**
+	 * displayTicketSelector
+	 * examines the event properties and determines whether a Ticket Selector should be displayed
+	 *
+	 * @param WP_Post|int $event
+	 * @param string      $_event_active_status
+	 * @param bool        $view_details
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function activeEventAndShowTicketSelector($event, string $_event_active_status, bool $view_details): bool
+	{
+		$event_post = $this->event instanceof EE_Event ? $this->event->ID() : $event;
+		return $this->display_full_ui()
+			   && (
+				   ! $this->event->display_ticket_selector()
+				   || $view_details
+				   || post_password_required($event_post)
+				   || (
+					   $_event_active_status !== EE_Datetime::active
+					   && $_event_active_status !== EE_Datetime::upcoming
+					   && $_event_active_status !== EE_Datetime::sold_out
+					   && ! (
+						   $_event_active_status === EE_Datetime::inactive
+						   && is_user_logged_in()
+					   )
+				   )
+			   );
+	}
+
+
+	/**
+	 * noTicketAvailableMessage
+	 * notice displayed if event is expired
+	 *
+	 * @return string
+	 */
+	protected function expiredEventMessage(): string
+	{
+		return '<div class="ee-event-expired-notice"><span class="important-notice">'
+		   . esc_html__(
+			   'We\'re sorry, but all tickets sales have ended because the event is expired.',
+			   'event_espresso'
+		   )
+		   . '</span></div><!-- .ee-event-expired-notice -->';
+	}
+
+
+	/**
+	 * noTicketAvailableMessage
+	 * notice displayed if event has no more tickets available
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function noTicketAvailableMessage(): string
+	{
+		$no_ticket_available_msg = esc_html__('We\'re sorry, but all ticket sales have ended.', 'event_espresso');
+		if (current_user_can('edit_post', $this->event->ID())) {
+			$no_ticket_available_msg .= sprintf(
+				esc_html__(
+					'%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
+					'event_espresso'
+				),
+				'<div class="ee-attention" style="text-align: left;"><b>',
+				'</b><br />',
+				'<span class="edit-link"><a class="post-edit-link" href="'
+				. get_edit_post_link($this->event->ID())
+				. '">',
+				'</a></span></div><!-- .ee-attention noTicketAvailableMessage -->'
+			);
+		}
+		return '
             <div class="ee-event-expired-notice">
                 <span class="important-notice">' . $no_ticket_available_msg . '</span>
             </div><!-- .ee-event-expired-notice -->';
-    }
-
-
-    /**
-     * ticketSalesClosed
-     * notice displayed if event ticket sales are turned off
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function ticketSalesClosedMessage(): string
-    {
-        $sales_closed_msg = esc_html__(
-            'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
-            'event_espresso'
-        );
-        if (current_user_can('edit_post', $this->event->ID())) {
-            $sales_closed_msg .= sprintf(
-                esc_html__(
-                    '%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
-                    'event_espresso'
-                ),
-                '<div class="ee-attention" style="text-align: left;"><b>',
-                '</b><br />',
-                '<span class="edit-link"><a class="post-edit-link" href="'
-                . get_edit_post_link($this->event->ID())
-                . '">',
-                '</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
-            );
-        }
-        return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
-    }
-
-
-    /**
-     * getTickets
-     *
-     * @return EE_Base_Class[]|EE_Ticket[]
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function getTickets()
-    {
-        $show_expired_tickets = is_admin() || $this->config->show_expired_tickets;
-
-        $ticket_query_args = [
-            [
-                'Datetime.EVT_ID' => $this->event->ID(),
-                'TKT_visibility'  => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
-            ],
-            'order_by' => [
-                'TKT_required'           => 'DESC',
-                'TKT_order'              => 'ASC',
-                'TKT_start_date'         => 'ASC',
-                'TKT_end_date'           => 'ASC',
-                'Datetime.DTT_EVT_start' => 'DESC',
-            ],
-        ];
-
-        $datetime_id = $this->request->getRequestParam('datetime', 0, 'int');
-        if ($datetime_id) {
-            $ticket_query_args[0]['Datetime.DTT_ID'] = $datetime_id;
-        }
-
-        if (! $show_expired_tickets) {
-            // use the correct applicable time query depending on what version of core is being run.
-            $current_time                         = method_exists('EEM_Datetime', 'current_time_for_query')
-                ? time()
-                : current_time('timestamp');
-            $ticket_query_args[0]['TKT_end_date'] = ['>', $current_time];
-        }
-        /** @var EE_Ticket[] $tickets */
-        $tickets = EEM_Ticket::instance()->get_all($ticket_query_args);
-        // remove tickets based on their visibility and the current user's allowed access (crudely based on roles)
-        // and filter the returned results
-         $tickets = array_filter($tickets, [$this, 'ticketVisibilityFilter']);
-        return (array) apply_filters(
-            'FHEE__EventEspresso_modules_ticketSelector_DisplayTicketSelector__getTickets',
-            $tickets,
-            $ticket_query_args,
-            $this
-        );
-    }
-
-
-    /**
-     * returns true if any of the following is true:
-     *  - ticket visibility is PUBLIC
-     *  - ticket visibility is MEMBERS_ONLY and user is logged in
-     *  - ticket visibility is ADMINS_ONLY when user IS logged in as an admin
-     *  - ticket visibility is ADMIN_UI_ONLY when ticket selector is being viewed via an admin page UI
-     *
-     * @param EE_Ticket $ticket
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   5.0.0.p
-     */
-    public function ticketVisibilityFilter(EE_Ticket $ticket): bool
-    {
-        return $ticket->isPublicOnly()
-               || ($ticket->isMembersOnly() && $this->current_user->isLoggedIn())
-               || (
-                   $ticket->isAdminsOnly()
-                   && ($this->current_user->isEventManager() || $this->current_user->isSuperAdmin())
-               )
-               || ($ticket->isAdminUiOnly() && is_admin());
-    }
-
-
-    /**
-     * loadTicketSelector
-     * begins to assemble template arguments
-     * and decides whether to load a "simple" ticket selector, or the standard
-     *
-     * @param EE_Ticket[] $tickets
-     * @param array       $template_args
-     * @return TicketSelectorSimple|TicketSelectorStandard
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function loadTicketSelector(array $tickets, array $template_args)
-    {
-        $template_args['event']            = $this->event;
-        $template_args['EVT_ID']           = $this->event->ID();
-        $template_args['event_is_expired'] = $this->event->is_expired();
-        $template_args['max_atndz']        = $this->getMaxAttendees();
-        $template_args['date_format']      = $this->date_format;
-        $template_args['time_format']      = $this->time_format;
-        /**
-         * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
-         *
-         * @param string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
-         * @param int $EVT_ID The Event ID
-         * @since 4.9.13
-         */
-        $template_args['anchor_id']    = apply_filters(
-            'FHEE__EE_Ticket_Selector__redirect_anchor_id',
-            '#tkt-slctr-tbl-' . $this->event->ID(),
-            $this->event->ID()
-        );
-        $template_args['tickets']      = $tickets;
-        $template_args['ticket_count'] = count($tickets);
-        $ticket_selector               = $this->simpleTicketSelector($tickets, $template_args);
-        if ($ticket_selector instanceof TicketSelectorSimple) {
-            return $ticket_selector;
-        }
-        return new TicketSelectorStandard(
-            $this->config,
-            $this->getTaxConfig(),
-            $this->event,
-            $tickets,
-            $this->getMaxAttendees(),
-            $template_args,
-            $this->date_format,
-            $this->time_format
-        );
-    }
-
-
-    /**
-     * simpleTicketSelector
-     * there's one ticket, and max attendees is set to one,
-     * so if the event is free, then this is a "simple" ticket selector
-     * a.k.a. "Dude Where's my Ticket Selector?"
-     *
-     * @param EE_Ticket[] $tickets
-     * @param array       $template_args
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function simpleTicketSelector(array $tickets, array $template_args)
-    {
-        // if there is only ONE ticket with a max qty of ONE
-        if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
-            return '';
-        }
-        /** @var EE_Ticket $ticket */
-        $ticket = reset($tickets);
-        // if the ticket is free... then not much need for the ticket selector
-        if (
-            apply_filters(
-                'FHEE__ticket_selector_chart_template__hide_ticket_selector',
-                $ticket->is_free(),
-                $this->event->ID()
-            )
-        ) {
-            return new TicketSelectorSimple(
-                $this->event,
-                $ticket,
-                $this->getMaxAttendees(),
-                $template_args
-            );
-        }
-        return '';
-    }
-
-
-    /**
-     * externalEventRegistration
-     *
-     * @return string
-     */
-    public function externalEventRegistration(): string
-    {
-        // if not we still need to trigger the display of the submit button
-        add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        // display notice to admin that registration is external
-        return $this->display_full_ui()
-            ? esc_html__(
-                'Registration is at an external URL for this event.',
-                'event_espresso'
-            )
-            : '';
-    }
-
-
-    /**
-     * formOpen
-     *
-     * @param int    $ID
-     * @param string $external_url
-     * @return        string
-     */
-    public function formOpen(int $ID = 0, string $external_url = ''): string
-    {
-        // if redirecting, we don't need any anything else
-        if ($external_url) {
-            $html = '<form method="GET" ';
-            $html .= 'action="' . EEH_URL::refactor_url($external_url) . '" ';
-            $html .= 'name="ticket-selector-form-' . $ID . '"';
-            // open link in new window ?
-            $html       .= apply_filters(
-                'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
-                $this->isIframe(),
-                $this
-            )
-                ? ' target="_blank"'
-                : '';
-            $html       .= '>';
-            $query_args = EEH_URL::get_query_string($external_url);
-            foreach ((array) $query_args as $query_arg => $value) {
-                $html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
-            }
-            return $html;
-        }
-        // if there is no submit button, then don't start building a form
-        // because the "View Details" button will build its own form
-        if (! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
-            return '';
-        }
-        $checkout_url = EEH_Event_View::event_link_url($ID);
-        if (! $checkout_url) {
-            EE_Error::add_error(
-                esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // set no cache headers and constants
-        EE_System::do_not_cache();
-        $html = '<form method="POST" ';
-        $html .= 'action="' . $checkout_url . '" ';
-        $html .= 'name="ticket-selector-form-' . $ID . '"';
-        $html .= $this->iframe ? ' target="_blank"' : '';
-        $html .= '>';
-        $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
-        return apply_filters('FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event);
-    }
-
-
-    /**
-     * displaySubmitButton
-     *
-     * @param string $external_url
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function displaySubmitButton(string $external_url = ''): string
-    {
-        $html = '';
-        if ($this->display_full_ui()) {
-            // standard TS displayed with submit button, ie: "Register Now"
-            if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
-                $html .= $this->displayRegisterNowButton();
-                $html .= empty($external_url)
-                    ? $this->ticketSelectorEndDiv()
-                    : $this->clearTicketSelector();
-                $html .= '<br/>' . $this->formClose();
-            } elseif ($this->getMaxAttendees() === 1) {
-                // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
-                if ($this->event->is_sold_out()) {
-                    // then instead of a View Details or Submit button, just display a "Sold Out" message
-                    $html .= apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
-                        sprintf(
-                            esc_html__(
-                                '%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
-                                'event_espresso'
-                            ),
-                            '<p class="no-ticket-selector-msg clear-float">',
-                            $this->event->name(),
-                            '</p>',
-                            '<br />'
-                        ),
-                        $this->event
-                    );
-                    if (
-                        apply_filters(
-                            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                            false,
-                            $this->event
-                        )
-                    ) {
-                        $html .= $this->displayRegisterNowButton();
-                    }
-                    // sold out DWMTS event, no TS, no submit or view details button, but has additional content
-                    $html .= $this->ticketSelectorEndDiv();
-                } elseif (
-                    apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
-                    && ! is_single()
-                ) {
-                    // this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
-                    // but no tickets are available, so display event's "View Details" button.
-                    // it is being viewed via somewhere other than a single post
-                    $html .= $this->displayViewDetailsButton(true);
-                } else {
-                    $html .= $this->ticketSelectorEndDiv();
-                }
-            } elseif (is_archive()) {
-                // event list, no tickets available so display event's "View Details" button
-                $html .= $this->ticketSelectorEndDiv();
-                $html .= $this->displayViewDetailsButton();
-            } else {
-                if (
-                    apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                        false,
-                        $this->event
-                    )
-                ) {
-                    $html .= $this->displayRegisterNowButton();
-                }
-                // no submit or view details button, and no additional content
-                $html .= $this->ticketSelectorEndDiv();
-            }
-            if (! $this->iframe && ! is_archive()) {
-                $html .= EEH_Template::powered_by_event_espresso('', '', ['utm_content' => 'ticket_selector']);
-            }
-        }
-        return apply_filters(
-            'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displaySubmitButton__html',
-            $html,
-            $this->event,
-            $this
-        );
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function displayRegisterNowButton(): string
-    {
-        $btn_text     = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
-            esc_html__('Register Now', 'event_espresso'),
-            $this->event
-        );
-        $external_url = (string) $this->event->external_url()
-                        && $this->event->external_url() !== get_the_permalink()
-            ? $this->event->external_url()
-            : '';
-        $html         = EEH_HTML::div(
-            '',
-            'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap',
-            'ticket-selector-submit-btn-wrap'
-        );
-        $html         .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
-        $html         .= ' class="ticket-selector-submit-btn ';
-        $html         .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
-        $html         .= ' type="submit" value="' . $btn_text . '" data-ee-disable-after-recaptcha="true" />';
-        $html         .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
-        $html         .= apply_filters(
-            'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
-            '',
-            $this->event,
-            $this->iframe
-        );
-        return $html;
-    }
-
-
-    /**
-     * displayViewDetailsButton
-     *
-     * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
-     *                    (ie: $_max_atndz === 1) where there are no available tickets,
-     *                    either because they are sold out, expired, or not yet on sale.
-     *                    In this case, we need to close the form BEFORE adding any closing divs
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function displayViewDetailsButton(bool $DWMTS = false): string
-    {
-        if (! $this->event->get_permalink()) {
-            EE_Error::add_error(
-                esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $view_details_btn = '<form method="GET" action="';
-        $view_details_btn .= apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
-            $this->event->get_permalink(),
-            $this->event
-        );
-        $view_details_btn .= '"';
-        // open link in new window ?
-        $view_details_btn .= apply_filters(
-            'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
-            $this->isIframe(),
-            $this
-        )
-            ? ' target="_blank"'
-            : '';
-        $view_details_btn .= '>';
-        $btn_text         = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
-            esc_html__('View Details', 'event_espresso'),
-            $this->event
-        );
-        $view_details_btn .= '<input id="ticket-selector-submit-'
-                             . $this->event->ID()
-                             . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
-                             . $btn_text
-                             . '" />';
-        $view_details_btn .= apply_filters('FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event);
-        if ($DWMTS) {
-            $view_details_btn .= $this->formClose();
-            $view_details_btn .= $this->ticketSelectorEndDiv();
-            $view_details_btn .= '<br/>';
-        } else {
-            $view_details_btn .= $this->clearTicketSelector();
-            $view_details_btn .= '<br/>';
-            $view_details_btn .= $this->formClose();
-        }
-        return $view_details_btn;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function ticketSelectorEndDiv(): string
-    {
-        return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function clearTicketSelector(): string
-    {
-        // standard TS displayed, appears after a "Register Now" or "view Details" button
-        return '<div class="clear"></div><!-- clearTicketSelector -->';
-    }
-
-
-    /**
-     * @access        public
-     * @return        string
-     */
-    public function formClose(): string
-    {
-        return '</form>';
-    }
-
-
-    /**
-     * handleMissingEvent
-     * Returns either false or an error to display when no valid event is passed.
-     *
-     * @return string
-     * @throws ExceptionStackTraceDisplay
-     * @throws InvalidInterfaceException
-     * @throws Exception
-     */
-    protected function handleMissingEvent()
-    {
-        // If this is not an iFrame request, simply return false.
-        if (! $this->isIframe()) {
-            return '';
-        }
-        // This is an iFrame so return an error.
-        // Display stack trace if WP_DEBUG is enabled.
-        if (WP_DEBUG === true && current_user_can('edit_pages')) {
-            $event_id = $this->request->getRequestParam('event', 0, 'int');
-            new ExceptionStackTraceDisplay(
-                new InvalidArgumentException(
-                    sprintf(
-                        esc_html__(
-                            'A valid Event ID is required to display the ticket selector.%3$sAn Event with an ID of "%1$s" could not be found.%3$sPlease verify that the embed code added to this post\'s content includes an "%2$s" argument and that its value corresponds to a valid Event ID.',
-                            'event_espresso'
-                        ),
-                        $event_id,
-                        'event',
-                        '<br />'
-                    )
-                )
-            );
-            return '';
-        }
-        // If WP_DEBUG is not enabled, display a message stating the event could not be found.
-        return EEH_HTML::p(
-            esc_html__(
-                'A valid Event could not be found. Please contact the event administrator for assistance.',
-                'event_espresso'
-            )
-        );
-    }
-
-
-    /**
-     * @return EE_Tax_Config
-     * @since   4.10.14.p
-     */
-    protected function getTaxConfig()
-    {
-        return isset(EE_Registry::instance()->CFG->tax_settings)
-               && EE_Registry::instance()->CFG->tax_settings instanceof EE_Tax_Config
-            ? EE_Registry::instance()->CFG->tax_settings
-            : new EE_Tax_Config();
-    }
+	}
+
+
+	/**
+	 * ticketSalesClosed
+	 * notice displayed if event ticket sales are turned off
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function ticketSalesClosedMessage(): string
+	{
+		$sales_closed_msg = esc_html__(
+			'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
+			'event_espresso'
+		);
+		if (current_user_can('edit_post', $this->event->ID())) {
+			$sales_closed_msg .= sprintf(
+				esc_html__(
+					'%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
+					'event_espresso'
+				),
+				'<div class="ee-attention" style="text-align: left;"><b>',
+				'</b><br />',
+				'<span class="edit-link"><a class="post-edit-link" href="'
+				. get_edit_post_link($this->event->ID())
+				. '">',
+				'</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
+			);
+		}
+		return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
+	}
+
+
+	/**
+	 * getTickets
+	 *
+	 * @return EE_Base_Class[]|EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function getTickets()
+	{
+		$show_expired_tickets = is_admin() || $this->config->show_expired_tickets;
+
+		$ticket_query_args = [
+			[
+				'Datetime.EVT_ID' => $this->event->ID(),
+				'TKT_visibility'  => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
+			],
+			'order_by' => [
+				'TKT_required'           => 'DESC',
+				'TKT_order'              => 'ASC',
+				'TKT_start_date'         => 'ASC',
+				'TKT_end_date'           => 'ASC',
+				'Datetime.DTT_EVT_start' => 'DESC',
+			],
+		];
+
+		$datetime_id = $this->request->getRequestParam('datetime', 0, 'int');
+		if ($datetime_id) {
+			$ticket_query_args[0]['Datetime.DTT_ID'] = $datetime_id;
+		}
+
+		if (! $show_expired_tickets) {
+			// use the correct applicable time query depending on what version of core is being run.
+			$current_time                         = method_exists('EEM_Datetime', 'current_time_for_query')
+				? time()
+				: current_time('timestamp');
+			$ticket_query_args[0]['TKT_end_date'] = ['>', $current_time];
+		}
+		/** @var EE_Ticket[] $tickets */
+		$tickets = EEM_Ticket::instance()->get_all($ticket_query_args);
+		// remove tickets based on their visibility and the current user's allowed access (crudely based on roles)
+		// and filter the returned results
+		 $tickets = array_filter($tickets, [$this, 'ticketVisibilityFilter']);
+		return (array) apply_filters(
+			'FHEE__EventEspresso_modules_ticketSelector_DisplayTicketSelector__getTickets',
+			$tickets,
+			$ticket_query_args,
+			$this
+		);
+	}
+
+
+	/**
+	 * returns true if any of the following is true:
+	 *  - ticket visibility is PUBLIC
+	 *  - ticket visibility is MEMBERS_ONLY and user is logged in
+	 *  - ticket visibility is ADMINS_ONLY when user IS logged in as an admin
+	 *  - ticket visibility is ADMIN_UI_ONLY when ticket selector is being viewed via an admin page UI
+	 *
+	 * @param EE_Ticket $ticket
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   5.0.0.p
+	 */
+	public function ticketVisibilityFilter(EE_Ticket $ticket): bool
+	{
+		return $ticket->isPublicOnly()
+			   || ($ticket->isMembersOnly() && $this->current_user->isLoggedIn())
+			   || (
+				   $ticket->isAdminsOnly()
+				   && ($this->current_user->isEventManager() || $this->current_user->isSuperAdmin())
+			   )
+			   || ($ticket->isAdminUiOnly() && is_admin());
+	}
+
+
+	/**
+	 * loadTicketSelector
+	 * begins to assemble template arguments
+	 * and decides whether to load a "simple" ticket selector, or the standard
+	 *
+	 * @param EE_Ticket[] $tickets
+	 * @param array       $template_args
+	 * @return TicketSelectorSimple|TicketSelectorStandard
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function loadTicketSelector(array $tickets, array $template_args)
+	{
+		$template_args['event']            = $this->event;
+		$template_args['EVT_ID']           = $this->event->ID();
+		$template_args['event_is_expired'] = $this->event->is_expired();
+		$template_args['max_atndz']        = $this->getMaxAttendees();
+		$template_args['date_format']      = $this->date_format;
+		$template_args['time_format']      = $this->time_format;
+		/**
+		 * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
+		 *
+		 * @param string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
+		 * @param int $EVT_ID The Event ID
+		 * @since 4.9.13
+		 */
+		$template_args['anchor_id']    = apply_filters(
+			'FHEE__EE_Ticket_Selector__redirect_anchor_id',
+			'#tkt-slctr-tbl-' . $this->event->ID(),
+			$this->event->ID()
+		);
+		$template_args['tickets']      = $tickets;
+		$template_args['ticket_count'] = count($tickets);
+		$ticket_selector               = $this->simpleTicketSelector($tickets, $template_args);
+		if ($ticket_selector instanceof TicketSelectorSimple) {
+			return $ticket_selector;
+		}
+		return new TicketSelectorStandard(
+			$this->config,
+			$this->getTaxConfig(),
+			$this->event,
+			$tickets,
+			$this->getMaxAttendees(),
+			$template_args,
+			$this->date_format,
+			$this->time_format
+		);
+	}
+
+
+	/**
+	 * simpleTicketSelector
+	 * there's one ticket, and max attendees is set to one,
+	 * so if the event is free, then this is a "simple" ticket selector
+	 * a.k.a. "Dude Where's my Ticket Selector?"
+	 *
+	 * @param EE_Ticket[] $tickets
+	 * @param array       $template_args
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function simpleTicketSelector(array $tickets, array $template_args)
+	{
+		// if there is only ONE ticket with a max qty of ONE
+		if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
+			return '';
+		}
+		/** @var EE_Ticket $ticket */
+		$ticket = reset($tickets);
+		// if the ticket is free... then not much need for the ticket selector
+		if (
+			apply_filters(
+				'FHEE__ticket_selector_chart_template__hide_ticket_selector',
+				$ticket->is_free(),
+				$this->event->ID()
+			)
+		) {
+			return new TicketSelectorSimple(
+				$this->event,
+				$ticket,
+				$this->getMaxAttendees(),
+				$template_args
+			);
+		}
+		return '';
+	}
+
+
+	/**
+	 * externalEventRegistration
+	 *
+	 * @return string
+	 */
+	public function externalEventRegistration(): string
+	{
+		// if not we still need to trigger the display of the submit button
+		add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		// display notice to admin that registration is external
+		return $this->display_full_ui()
+			? esc_html__(
+				'Registration is at an external URL for this event.',
+				'event_espresso'
+			)
+			: '';
+	}
+
+
+	/**
+	 * formOpen
+	 *
+	 * @param int    $ID
+	 * @param string $external_url
+	 * @return        string
+	 */
+	public function formOpen(int $ID = 0, string $external_url = ''): string
+	{
+		// if redirecting, we don't need any anything else
+		if ($external_url) {
+			$html = '<form method="GET" ';
+			$html .= 'action="' . EEH_URL::refactor_url($external_url) . '" ';
+			$html .= 'name="ticket-selector-form-' . $ID . '"';
+			// open link in new window ?
+			$html       .= apply_filters(
+				'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
+				$this->isIframe(),
+				$this
+			)
+				? ' target="_blank"'
+				: '';
+			$html       .= '>';
+			$query_args = EEH_URL::get_query_string($external_url);
+			foreach ((array) $query_args as $query_arg => $value) {
+				$html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
+			}
+			return $html;
+		}
+		// if there is no submit button, then don't start building a form
+		// because the "View Details" button will build its own form
+		if (! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
+			return '';
+		}
+		$checkout_url = EEH_Event_View::event_link_url($ID);
+		if (! $checkout_url) {
+			EE_Error::add_error(
+				esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// set no cache headers and constants
+		EE_System::do_not_cache();
+		$html = '<form method="POST" ';
+		$html .= 'action="' . $checkout_url . '" ';
+		$html .= 'name="ticket-selector-form-' . $ID . '"';
+		$html .= $this->iframe ? ' target="_blank"' : '';
+		$html .= '>';
+		$html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
+		return apply_filters('FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event);
+	}
+
+
+	/**
+	 * displaySubmitButton
+	 *
+	 * @param string $external_url
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function displaySubmitButton(string $external_url = ''): string
+	{
+		$html = '';
+		if ($this->display_full_ui()) {
+			// standard TS displayed with submit button, ie: "Register Now"
+			if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
+				$html .= $this->displayRegisterNowButton();
+				$html .= empty($external_url)
+					? $this->ticketSelectorEndDiv()
+					: $this->clearTicketSelector();
+				$html .= '<br/>' . $this->formClose();
+			} elseif ($this->getMaxAttendees() === 1) {
+				// its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
+				if ($this->event->is_sold_out()) {
+					// then instead of a View Details or Submit button, just display a "Sold Out" message
+					$html .= apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
+						sprintf(
+							esc_html__(
+								'%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
+								'event_espresso'
+							),
+							'<p class="no-ticket-selector-msg clear-float">',
+							$this->event->name(),
+							'</p>',
+							'<br />'
+						),
+						$this->event
+					);
+					if (
+						apply_filters(
+							'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+							false,
+							$this->event
+						)
+					) {
+						$html .= $this->displayRegisterNowButton();
+					}
+					// sold out DWMTS event, no TS, no submit or view details button, but has additional content
+					$html .= $this->ticketSelectorEndDiv();
+				} elseif (
+					apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
+					&& ! is_single()
+				) {
+					// this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
+					// but no tickets are available, so display event's "View Details" button.
+					// it is being viewed via somewhere other than a single post
+					$html .= $this->displayViewDetailsButton(true);
+				} else {
+					$html .= $this->ticketSelectorEndDiv();
+				}
+			} elseif (is_archive()) {
+				// event list, no tickets available so display event's "View Details" button
+				$html .= $this->ticketSelectorEndDiv();
+				$html .= $this->displayViewDetailsButton();
+			} else {
+				if (
+					apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+						false,
+						$this->event
+					)
+				) {
+					$html .= $this->displayRegisterNowButton();
+				}
+				// no submit or view details button, and no additional content
+				$html .= $this->ticketSelectorEndDiv();
+			}
+			if (! $this->iframe && ! is_archive()) {
+				$html .= EEH_Template::powered_by_event_espresso('', '', ['utm_content' => 'ticket_selector']);
+			}
+		}
+		return apply_filters(
+			'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displaySubmitButton__html',
+			$html,
+			$this->event,
+			$this
+		);
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function displayRegisterNowButton(): string
+	{
+		$btn_text     = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
+			esc_html__('Register Now', 'event_espresso'),
+			$this->event
+		);
+		$external_url = (string) $this->event->external_url()
+						&& $this->event->external_url() !== get_the_permalink()
+			? $this->event->external_url()
+			: '';
+		$html         = EEH_HTML::div(
+			'',
+			'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap',
+			'ticket-selector-submit-btn-wrap'
+		);
+		$html         .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
+		$html         .= ' class="ticket-selector-submit-btn ';
+		$html         .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
+		$html         .= ' type="submit" value="' . $btn_text . '" data-ee-disable-after-recaptcha="true" />';
+		$html         .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
+		$html         .= apply_filters(
+			'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
+			'',
+			$this->event,
+			$this->iframe
+		);
+		return $html;
+	}
+
+
+	/**
+	 * displayViewDetailsButton
+	 *
+	 * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
+	 *                    (ie: $_max_atndz === 1) where there are no available tickets,
+	 *                    either because they are sold out, expired, or not yet on sale.
+	 *                    In this case, we need to close the form BEFORE adding any closing divs
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function displayViewDetailsButton(bool $DWMTS = false): string
+	{
+		if (! $this->event->get_permalink()) {
+			EE_Error::add_error(
+				esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$view_details_btn = '<form method="GET" action="';
+		$view_details_btn .= apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
+			$this->event->get_permalink(),
+			$this->event
+		);
+		$view_details_btn .= '"';
+		// open link in new window ?
+		$view_details_btn .= apply_filters(
+			'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
+			$this->isIframe(),
+			$this
+		)
+			? ' target="_blank"'
+			: '';
+		$view_details_btn .= '>';
+		$btn_text         = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
+			esc_html__('View Details', 'event_espresso'),
+			$this->event
+		);
+		$view_details_btn .= '<input id="ticket-selector-submit-'
+							 . $this->event->ID()
+							 . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
+							 . $btn_text
+							 . '" />';
+		$view_details_btn .= apply_filters('FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event);
+		if ($DWMTS) {
+			$view_details_btn .= $this->formClose();
+			$view_details_btn .= $this->ticketSelectorEndDiv();
+			$view_details_btn .= '<br/>';
+		} else {
+			$view_details_btn .= $this->clearTicketSelector();
+			$view_details_btn .= '<br/>';
+			$view_details_btn .= $this->formClose();
+		}
+		return $view_details_btn;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function ticketSelectorEndDiv(): string
+	{
+		return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function clearTicketSelector(): string
+	{
+		// standard TS displayed, appears after a "Register Now" or "view Details" button
+		return '<div class="clear"></div><!-- clearTicketSelector -->';
+	}
+
+
+	/**
+	 * @access        public
+	 * @return        string
+	 */
+	public function formClose(): string
+	{
+		return '</form>';
+	}
+
+
+	/**
+	 * handleMissingEvent
+	 * Returns either false or an error to display when no valid event is passed.
+	 *
+	 * @return string
+	 * @throws ExceptionStackTraceDisplay
+	 * @throws InvalidInterfaceException
+	 * @throws Exception
+	 */
+	protected function handleMissingEvent()
+	{
+		// If this is not an iFrame request, simply return false.
+		if (! $this->isIframe()) {
+			return '';
+		}
+		// This is an iFrame so return an error.
+		// Display stack trace if WP_DEBUG is enabled.
+		if (WP_DEBUG === true && current_user_can('edit_pages')) {
+			$event_id = $this->request->getRequestParam('event', 0, 'int');
+			new ExceptionStackTraceDisplay(
+				new InvalidArgumentException(
+					sprintf(
+						esc_html__(
+							'A valid Event ID is required to display the ticket selector.%3$sAn Event with an ID of "%1$s" could not be found.%3$sPlease verify that the embed code added to this post\'s content includes an "%2$s" argument and that its value corresponds to a valid Event ID.',
+							'event_espresso'
+						),
+						$event_id,
+						'event',
+						'<br />'
+					)
+				)
+			);
+			return '';
+		}
+		// If WP_DEBUG is not enabled, display a message stating the event could not be found.
+		return EEH_HTML::p(
+			esc_html__(
+				'A valid Event could not be found. Please contact the event administrator for assistance.',
+				'event_espresso'
+			)
+		);
+	}
+
+
+	/**
+	 * @return EE_Tax_Config
+	 * @since   4.10.14.p
+	 */
+	protected function getTaxConfig()
+	{
+		return isset(EE_Registry::instance()->CFG->tax_settings)
+			   && EE_Registry::instance()->CFG->tax_settings instanceof EE_Tax_Config
+			? EE_Registry::instance()->CFG->tax_settings
+			: new EE_Tax_Config();
+	}
 }

modules/event_single/EED_Event_Single.module.php

Indentation +470 added lines, -470 removed lines

@@ -14,475 +14,475 @@ 
  */
 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();
-        EE_Config::register_route(
-            $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;
-    }
-
-
-    /**
-     * loop_start
-     *
-     * @param    array $wp_query_array an array containing the WP_Query object
-     * @return    void
-     */
-    public static function loop_start($wp_query_array)
-    {
-        global $post;
-        do_action('AHEE_event_details_before_post', $post, $wp_query_array);
-    }
-
-
-    /**
-     * 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();
+		EE_Config::register_route(
+			$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;
+	}
+
+
+	/**
+	 * loop_start
+	 *
+	 * @param    array $wp_query_array an array containing the WP_Query object
+	 * @return    void
+	 */
+	public static function loop_start($wp_query_array)
+	{
+		global $post;
+		do_action('AHEE_event_details_before_post', $post, $wp_query_array);
+	}
+
+
+	/**
+	 * 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);
+	}
 }
 
 
@@ -494,5 +494,5 @@ 
  */
 function espresso_display_venue_in_event_details()
 {
-    return EED_Event_Single::display_venue();
+	return EED_Event_Single::display_venue();
 }

modules/feeds/EED_Feeds.module.php

Indentation +207 added lines, -207 removed lines

@@ -11,211 +11,211 @@
  */
 class EED_Feeds extends EED_Module
 {
-    /**
-     * @return EED_Feeds
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        add_action('parse_request', ['EED_Feeds', 'parse_request']);
-        add_filter('default_feed', ['EED_Feeds', 'default_feed']);
-        add_filter('comment_feed_join', ['EED_Feeds', 'comment_feed_join'], 10, 2);
-        add_filter('comment_feed_where', ['EED_Feeds', 'comment_feed_where'], 10, 2);
-    }
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-    }
-
-
-    /**
-     *    run - initial module setup
-     *
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     *    default_feed
-     *
-     * @param type    rss2, atom, rss, rdf, rssjs
-     * @return    string
-     */
-    public static function default_feed($type = 'rss2')
-    {
-        // rss2, atom, rss, rdf, rssjs
-        $type = 'rss2';
-        return $type;
-    }
-
-
-    /**
-     *    parse_request
-     *
-     * @return    void
-     */
-    public static function parse_request()
-    {
-        $request = self::getRequest();
-        if (! $request->requestParamIsSet('post_type')) {
-            return;
-        }
-        // define path to templates
-        define('RSS_FEEDS_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
-        // what kinda post_type are we dealing with ?
-        switch ($request->getRequestParam('post_type')) {
-            case EspressoPostType::EVENTS:
-                // for rss2, atom, rss, rdf
-                add_filter('the_excerpt_rss', ['EED_Feeds', 'the_event_feed']);
-                add_filter('the_content_feed', ['EED_Feeds', 'the_event_feed']);
-                // for json ( also uses the above filter )
-                add_filter('rssjs_feed_item', ['EED_Feeds', 'the_event_rssjs_feed']);
-                break;
-            case EspressoPostType::VENUES:
-                // for rss2, atom, rss, rdf
-                add_filter('the_excerpt_rss', ['EED_Feeds', 'the_venue_feed']);
-                add_filter('the_content_feed', ['EED_Feeds', 'the_venue_feed']);
-                // for json ( also uses the above filter )
-                add_filter('rssjs_feed_item', ['EED_Feeds', 'the_venue_rssjs_feed']);
-                break;
-        }
-    }
-
-
-    /**
-     *    comment_feed_join - EVEN THOUGH... our espresso_attendees custom post type is set to NOT PUBLIC
-     *    WordPress thought it would be a good idea to display the comments for them in the RSS feeds... we think NOT
-     *    so this little snippet of SQL taps into the comment feed query and removes comments for the
-     *    espresso_attendees post_type
-     *
-     * @param string $SQL the JOIN clause for the comment feed query
-     * @return string
-     */
-    public static function comment_feed_join($SQL)
-    {
-        global $wpdb;
-        // check for wp_posts table in JOIN clause
-        if (strpos($SQL, $wpdb->posts) !== false) {
-            add_filter('EED_Feeds__comment_feed_where__espresso_attendees', '__return_true');
-        }
-        return $SQL;
-    }
-
-
-    /**
-     *    comment_feed_where - EVEN THOUGH... our espresso_attendees custom post type is set to NOT PUBLIC
-     *    WordPress thought it would be a good idea to display the comments for them in the RSS feeds... we think NOT
-     *    so this little snippet of SQL taps into the comment feed query and removes comments for the
-     *    espresso_attendees post_type
-     *
-     * @param string $SQL the WHERE clause for the comment feed query
-     * @return string
-     */
-    public static function comment_feed_where($SQL)
-    {
-        global $wp_query, $wpdb;
-        if ($wp_query->is_comment_feed && apply_filters('EED_Feeds__comment_feed_where__espresso_attendees', false)) {
-            $SQL .= " AND $wpdb->posts.post_type != " . EspressoPostType::ATTENDEES;
-        }
-        return $SQL;
-    }
-
-
-    /**
-     *    the_event_feed
-     *
-     * @param string $content
-     * @return string
-     */
-    public static function the_event_feed($content)
-    {
-        if (is_feed() && is_readable(RSS_FEEDS_TEMPLATES_PATH . 'espresso_events_feed.template.php')) {
-            global $post;
-            $template_args = [
-                'EVT_ID'            => $post->ID,
-                'event_description' => get_option('rss_use_excerpt') ? $post->post_excerpt : $post->post_content,
-            ];
-            $content       = EEH_Template::display_template(
-                RSS_FEEDS_TEMPLATES_PATH . 'espresso_events_feed.template.php',
-                $template_args,
-                true
-            );
-        }
-        return $content;
-    }
-
-
-    /**
-     *    the_event_rssjs_feed
-     *
-     * @param object $item
-     * @return object
-     */
-    public static function the_event_rssjs_feed($item)
-    {
-        if (is_feed() && isset($item->description)) {
-            $item->description = EED_Feeds::the_event_feed($item->description);
-        }
-        return $item;
-    }
-
-
-    /**
-     *    the_venue_feed
-     *
-     * @param string $content
-     * @return string
-     */
-    public static function the_venue_feed($content)
-    {
-        if (is_feed() && is_readable(RSS_FEEDS_TEMPLATES_PATH . 'espresso_venues_feed.template.php')) {
-            global $post;
-            $template_args = [
-                'VNU_ID'            => $post->ID,
-                'venue_description' => get_option('rss_use_excerpt') ? $post->post_excerpt : $post->post_content,
-            ];
-            $content       = EEH_Template::display_template(
-                RSS_FEEDS_TEMPLATES_PATH . 'espresso_venues_feed.template.php',
-                $template_args,
-                true
-            );
-        }
-        return $content;
-    }
-
-
-    /**
-     *    the_venue_rssjs_feed
-     *
-     * @param object $item
-     * @return object
-     */
-    public static function the_venue_rssjs_feed($item)
-    {
-        if (is_feed() && isset($item->description)) {
-            $item->description = EED_Feeds::the_venue_feed($item->description);
-        }
-        return $item;
-    }
+	/**
+	 * @return EED_Feeds
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		add_action('parse_request', ['EED_Feeds', 'parse_request']);
+		add_filter('default_feed', ['EED_Feeds', 'default_feed']);
+		add_filter('comment_feed_join', ['EED_Feeds', 'comment_feed_join'], 10, 2);
+		add_filter('comment_feed_where', ['EED_Feeds', 'comment_feed_where'], 10, 2);
+	}
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
+
+
+	/**
+	 *    run - initial module setup
+	 *
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 *    default_feed
+	 *
+	 * @param type    rss2, atom, rss, rdf, rssjs
+	 * @return    string
+	 */
+	public static function default_feed($type = 'rss2')
+	{
+		// rss2, atom, rss, rdf, rssjs
+		$type = 'rss2';
+		return $type;
+	}
+
+
+	/**
+	 *    parse_request
+	 *
+	 * @return    void
+	 */
+	public static function parse_request()
+	{
+		$request = self::getRequest();
+		if (! $request->requestParamIsSet('post_type')) {
+			return;
+		}
+		// define path to templates
+		define('RSS_FEEDS_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
+		// what kinda post_type are we dealing with ?
+		switch ($request->getRequestParam('post_type')) {
+			case EspressoPostType::EVENTS:
+				// for rss2, atom, rss, rdf
+				add_filter('the_excerpt_rss', ['EED_Feeds', 'the_event_feed']);
+				add_filter('the_content_feed', ['EED_Feeds', 'the_event_feed']);
+				// for json ( also uses the above filter )
+				add_filter('rssjs_feed_item', ['EED_Feeds', 'the_event_rssjs_feed']);
+				break;
+			case EspressoPostType::VENUES:
+				// for rss2, atom, rss, rdf
+				add_filter('the_excerpt_rss', ['EED_Feeds', 'the_venue_feed']);
+				add_filter('the_content_feed', ['EED_Feeds', 'the_venue_feed']);
+				// for json ( also uses the above filter )
+				add_filter('rssjs_feed_item', ['EED_Feeds', 'the_venue_rssjs_feed']);
+				break;
+		}
+	}
+
+
+	/**
+	 *    comment_feed_join - EVEN THOUGH... our espresso_attendees custom post type is set to NOT PUBLIC
+	 *    WordPress thought it would be a good idea to display the comments for them in the RSS feeds... we think NOT
+	 *    so this little snippet of SQL taps into the comment feed query and removes comments for the
+	 *    espresso_attendees post_type
+	 *
+	 * @param string $SQL the JOIN clause for the comment feed query
+	 * @return string
+	 */
+	public static function comment_feed_join($SQL)
+	{
+		global $wpdb;
+		// check for wp_posts table in JOIN clause
+		if (strpos($SQL, $wpdb->posts) !== false) {
+			add_filter('EED_Feeds__comment_feed_where__espresso_attendees', '__return_true');
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 *    comment_feed_where - EVEN THOUGH... our espresso_attendees custom post type is set to NOT PUBLIC
+	 *    WordPress thought it would be a good idea to display the comments for them in the RSS feeds... we think NOT
+	 *    so this little snippet of SQL taps into the comment feed query and removes comments for the
+	 *    espresso_attendees post_type
+	 *
+	 * @param string $SQL the WHERE clause for the comment feed query
+	 * @return string
+	 */
+	public static function comment_feed_where($SQL)
+	{
+		global $wp_query, $wpdb;
+		if ($wp_query->is_comment_feed && apply_filters('EED_Feeds__comment_feed_where__espresso_attendees', false)) {
+			$SQL .= " AND $wpdb->posts.post_type != " . EspressoPostType::ATTENDEES;
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 *    the_event_feed
+	 *
+	 * @param string $content
+	 * @return string
+	 */
+	public static function the_event_feed($content)
+	{
+		if (is_feed() && is_readable(RSS_FEEDS_TEMPLATES_PATH . 'espresso_events_feed.template.php')) {
+			global $post;
+			$template_args = [
+				'EVT_ID'            => $post->ID,
+				'event_description' => get_option('rss_use_excerpt') ? $post->post_excerpt : $post->post_content,
+			];
+			$content       = EEH_Template::display_template(
+				RSS_FEEDS_TEMPLATES_PATH . 'espresso_events_feed.template.php',
+				$template_args,
+				true
+			);
+		}
+		return $content;
+	}
+
+
+	/**
+	 *    the_event_rssjs_feed
+	 *
+	 * @param object $item
+	 * @return object
+	 */
+	public static function the_event_rssjs_feed($item)
+	{
+		if (is_feed() && isset($item->description)) {
+			$item->description = EED_Feeds::the_event_feed($item->description);
+		}
+		return $item;
+	}
+
+
+	/**
+	 *    the_venue_feed
+	 *
+	 * @param string $content
+	 * @return string
+	 */
+	public static function the_venue_feed($content)
+	{
+		if (is_feed() && is_readable(RSS_FEEDS_TEMPLATES_PATH . 'espresso_venues_feed.template.php')) {
+			global $post;
+			$template_args = [
+				'VNU_ID'            => $post->ID,
+				'venue_description' => get_option('rss_use_excerpt') ? $post->post_excerpt : $post->post_content,
+			];
+			$content       = EEH_Template::display_template(
+				RSS_FEEDS_TEMPLATES_PATH . 'espresso_venues_feed.template.php',
+				$template_args,
+				true
+			);
+		}
+		return $content;
+	}
+
+
+	/**
+	 *    the_venue_rssjs_feed
+	 *
+	 * @param object $item
+	 * @return object
+	 */
+	public static function the_venue_rssjs_feed($item)
+	{
+		if (is_feed() && isset($item->description)) {
+			$item->description = EED_Feeds::the_venue_feed($item->description);
+		}
+		return $item;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -78,11 +78,11 @@ 
     public static function parse_request()
     {
         $request = self::getRequest();
-        if (! $request->requestParamIsSet('post_type')) {
+        if ( ! $request->requestParamIsSet('post_type')) {
             return;
         }
         // define path to templates
-        define('RSS_FEEDS_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
+        define('RSS_FEEDS_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)).'templates/');
         // what kinda post_type are we dealing with ?
         switch ($request->getRequestParam('post_type')) {
             case EspressoPostType::EVENTS:
@@ -136,7 +136,7 @@ 
     {
         global $wp_query, $wpdb;
         if ($wp_query->is_comment_feed && apply_filters('EED_Feeds__comment_feed_where__espresso_attendees', false)) {
-            $SQL .= " AND $wpdb->posts.post_type != " . EspressoPostType::ATTENDEES;
+            $SQL .= " AND $wpdb->posts.post_type != ".EspressoPostType::ATTENDEES;
         }
         return $SQL;
     }
@@ -150,14 +150,14 @@ 
      */
     public static function the_event_feed($content)
     {
-        if (is_feed() && is_readable(RSS_FEEDS_TEMPLATES_PATH . 'espresso_events_feed.template.php')) {
+        if (is_feed() && is_readable(RSS_FEEDS_TEMPLATES_PATH.'espresso_events_feed.template.php')) {
             global $post;
             $template_args = [
                 'EVT_ID'            => $post->ID,
                 'event_description' => get_option('rss_use_excerpt') ? $post->post_excerpt : $post->post_content,
             ];
-            $content       = EEH_Template::display_template(
-                RSS_FEEDS_TEMPLATES_PATH . 'espresso_events_feed.template.php',
+            $content = EEH_Template::display_template(
+                RSS_FEEDS_TEMPLATES_PATH.'espresso_events_feed.template.php',
                 $template_args,
                 true
             );
@@ -189,14 +189,14 @@ 
      */
     public static function the_venue_feed($content)
     {
-        if (is_feed() && is_readable(RSS_FEEDS_TEMPLATES_PATH . 'espresso_venues_feed.template.php')) {
+        if (is_feed() && is_readable(RSS_FEEDS_TEMPLATES_PATH.'espresso_venues_feed.template.php')) {
             global $post;
             $template_args = [
                 'VNU_ID'            => $post->ID,
                 'venue_description' => get_option('rss_use_excerpt') ? $post->post_excerpt : $post->post_content,
             ];
-            $content       = EEH_Template::display_template(
-                RSS_FEEDS_TEMPLATES_PATH . 'espresso_venues_feed.template.php',
+            $content = EEH_Template::display_template(
+                RSS_FEEDS_TEMPLATES_PATH.'espresso_venues_feed.template.php',
                 $template_args,
                 true
             );

modules/single_page_checkout/EED_Single_Page_Checkout.module.php

Indentation +1714 added lines, -1714 removed lines

@@ -20,1718 +20,1718 @@
  */
 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;
-
-    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
-                EE_Config::register_route(
-                    $reg_step['slug'],
-                    'EED_Single_Page_Checkout',
-                    'run',
-                    'step'
-                );
-                // add AJAX or other hooks
-                if (isset($reg_step['has_hooks']) && $reg_step['has_hooks']) {
-                    // setup autoloaders if necessary
-                    if (! class_exists($reg_step['class_name'])) {
-                        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(
-                            $reg_step['file_path'],
-                            true
-                        );
-                    }
-                    if (is_callable($reg_step['class_name'], 'set_hooks')) {
-                        call_user_func([$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);
-            // lock the transaction
-            $this->checkout->transaction->lock();
-            // make sure all of our cached objects are added to their respective model entity mappers
-            $this->checkout->refresh_all_entities();
-            // set amount owing
-            $this->checkout->amount_owing = $this->checkout->transaction->remaining();
-            // initialize each reg step, which gives them the chance to potentially alter the process
-            $this->_initialize_reg_steps();
-            // DEBUG LOG
-            // $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
-            // get reg form
-            if (! $this->_check_form_submission()) {
-                EED_Single_Page_Checkout::$_initialized = true;
-                return;
-            }
-            // checkout the action!!!
-            $this->_process_form_action();
-            // add some style and make it dance
-            $this->add_styles_and_scripts($this);
-            // kk... SPCO has successfully run
-            EED_Single_Page_Checkout::$_initialized = true;
-            // set no cache headers and constants
-            EE_System::do_not_cache();
-            // add anchor
-            add_action('loop_start', [$this, 'set_checkout_anchor'], 1);
-            // remove transaction lock
-            add_action('shutdown', [$this, 'unlock_transaction'], 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 (! EE_Registry::instance()->SSN instanceof EE_Session) {
-            throw new EE_Error(esc_html__('The EE_Session class could not be loaded.', 'event_espresso'));
-        }
-        $clear_session_requested = $this->request->getRequestParam('clear_session', false, 'bool');
-        // is session still valid ?
-        if (
-            $clear_session_requested
-            || (
-                EE_Registry::instance()->SSN->expired()
-                && $this->request->getRequestParam('e_reg_url_link') === ''
-            )
-        ) {
-            $this->checkout = new EE_Checkout();
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-            // EE_Registry::instance()->SSN->reset_cart();
-            // EE_Registry::instance()->SSN->reset_checkout();
-            // EE_Registry::instance()->SSN->reset_transaction();
-            if (! $clear_session_requested) {
-                EE_Error::add_attention(
-                    EE_Registry::$i18n_js_strings['registration_expiration_notice'],
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            // EE_Registry::instance()->SSN->reset_expired();
-        }
-    }
-
-
-    /**
-     * 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 = EE_Registry::instance()->SSN->checkout();
-        // verify
-        if (! $checkout instanceof EE_Checkout) {
-            // instantiate EE_Checkout object for handling the properties of the current checkout process
-            $checkout = EE_Registry::instance()->load_file(
-                SPCO_INC_PATH,
-                'EE_Checkout',
-                'class',
-                [],
-                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(
-                EE_Registry::instance()->SSN->expiration() + 1,
-                $transaction->ID()
-            );
-            return $transaction;
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return null;
-    }
-
-
-    /**
-     * _get_registrations
-     *
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_registrations(EE_Transaction $transaction)
-    {
-        // first step: grab the registrants  { : o
-        $registrations                      = $transaction->registrations($this->checkout->reg_cache_where_params);
-        $this->checkout->total_ticket_count = count($registrations);
-        // verify registrations have been set
-        if (empty($registrations)) {
-            // if no cached registrations, then check the db
-            $registrations = $transaction->registrations($this->checkout->reg_cache_where_params);
-            // still nothing ? well as long as this isn't a revisit
-            if (empty($registrations) && ! $this->checkout->revisit) {
-                // generate new registrations from scratch
-                $registrations = $this->_initialize_registrations($transaction);
-            }
-        }
-        // sort by their original registration order
-        usort($registrations, ['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
-                    EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-                    EED_Single_Page_Checkout::$_initialized       = false;
-                    EED_Single_Page_Checkout::$_checkout_verified = false;
-                    $this->_initialize();
-                    EE_Error::reset_notices();
-                    return false;
-                }
-                EE_Error::add_error(
-                    esc_html__(
-                        'We\'re sorry but there appears to be an error with the "reg_url_link" or the transaction itself. Please refresh the page and try again or contact support.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        // now that things have been kinda sufficiently verified,
-        // let's add the checkout to the session so that it's available to other systems
-        EE_Registry::instance()->SSN->set_checkout($this->checkout);
-        return true;
-    }
-
-
-    /**
-     * 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
-     */
-    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
-        );
-    }
-
-
-    /**
-     * @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()
-    {
-        // 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])
-                ) {
-                    // dynamically creates hook point like:
-                    //   AHEE__Single_Page_Checkout__before_attendee_information__process_reg_step
-                    do_action(
-                        "AHEE__Single_Page_Checkout__before_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
-                        $this->checkout->current_step
-                    );
-                    $process_reg_step = apply_filters(
-                        "AHEE__Single_Page_Checkout__process_reg_step__{$this->checkout->current_step->slug()}__{$this->checkout->action}",
-                        true,
-                        $this->checkout->current_step,
-                        $this
-                    );
-                    // call action on current step
-                    if ($process_reg_step && call_user_func([$this->checkout->current_step, $this->checkout->action])) {
-                        // good registrant, you get to proceed
-                        if (
-                            $this->checkout->current_step->success_message() !== ''
-                            && apply_filters(
-                                'FHEE__Single_Page_Checkout___process_form_action__display_success',
-                                false
-                            )
-                        ) {
-                            EE_Error::add_success(
-                                $this->checkout->current_step->success_message()
-                                . '<br />' . $this->checkout->next_step->_instructions()
-                            );
-                        }
-                        // pack it up, pack it in...
-                        $this->_setup_redirect();
-                    }
-                    // dynamically creates hook point like:
-                    //  AHEE__Single_Page_Checkout__after_payment_options__process_reg_step
-                    do_action(
-                        "AHEE__Single_Page_Checkout__after_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
-                        $this->checkout->current_step
-                    );
-                } else {
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                'The requested form action "%s" does not exist for the current "%s" registration step.',
-                                'event_espresso'
-                            ),
-                            $this->checkout->action,
-                            $this->checkout->current_step->name()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            // end default
-        }
-        // store our progress so far
-        $this->checkout->stash_transaction_and_checkout();
-        // advance to the next step! If you pass GO, collect $200
-        $this->go_to_next_step();
-    }
-
-
-    /**
-     * @param EED_Single_Page_Checkout|EE_SPCO_Reg_Step $target an object with the method `translate_js_strings` and
-     *                                                          `enqueue_styles_and_scripts`.
-     * @return void
-     */
-    public function add_styles_and_scripts($target)
-    {
-        // i18n
-        $target->translate_js_strings();
-        if ($this->checkout->admin_request) {
-            add_action('admin_enqueue_scripts', [$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']                          = EE_Registry::instance()->SSN->id();
-        EE_Registry::$i18n_js_strings['currency']                       = EE_Registry::instance()->CFG->currency;
-        EE_Registry::$i18n_js_strings['datepicker_yearRange']           = '-150:+20';
-        EE_Registry::$i18n_js_strings['timer_years']                    = esc_html__('years', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_months']                   = esc_html__('months', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_weeks']                    = esc_html__('weeks', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_days']                     = esc_html__('days', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_hours']                    = esc_html__('hours', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_minutes']                  = esc_html__('minutes', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_seconds']                  = esc_html__('seconds', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_year']                     = esc_html__('year', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_month']                    = esc_html__('month', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_week']                     = esc_html__('week', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_day']                      = esc_html__('day', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_hour']                     = esc_html__('hour', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_minute']                   = esc_html__('minute', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_second']                   = esc_html__('second', 'event_espresso');
-        EE_Registry::$i18n_js_strings['registration_expiration_notice'] =
-            EED_Single_Page_Checkout::getRegistrationExpirationNotice();
-        EE_Registry::$i18n_js_strings['ajax_submit']                    = apply_filters(
-            'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
-            true
-        );
-        EE_Registry::$i18n_js_strings['session_extension']              = absint(
-            apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS)
-        );
-        EE_Registry::$i18n_js_strings['session_expiration']             = gmdate(
-            'M d, Y H:i:s',
-            EE_Registry::instance()->SSN->expiration() + (get_option('gmt_offset') * HOUR_IN_SECONDS)
-        );
-    }
-
-
-    /**
-     * @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(
-            'jquery_plugin',
-            EE_THIRD_PARTY_URL . 'jquery	.plugin.min.js',
-            ['jquery'],
-            '1.0.1',
-            true
-        );
-        wp_register_script(
-            'jquery_countdown',
-            EE_THIRD_PARTY_URL . 'jquery	.countdown.min.js',
-            ['jquery_plugin'],
-            '2.1.0',
-            true
-        );
-        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');
-        if (apply_filters('FHEE__registration_page_wrapper_template__display_time_limit', false)) {
-            wp_enqueue_script('jquery_countdown');
-        }
-        /**
-         * global action hook for enqueueing styles and scripts with
-         * spco calls.
-         */
-        do_action('AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts', $this);
-        /**
-         * dynamic action hook for enqueueing styles and scripts with spco calls.
-         * The hook will end up being something like:
-         *      AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information
-         */
-        do_action(
-            'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__' . $this->checkout->current_step->slug(),
-            $this
-        );
-    }
-
-
-    /**
-     * display the Registration Single Page Checkout Form
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _display_spco_reg_form()
-    {
-        // if registering via the admin, just display the reg form for the current step
-        if ($this->checkout->admin_request) {
-            EED_Single_Page_Checkout::getResponse()->addOutput($this->checkout->current_step->display_reg_form());
-        } else {
-            // add powered by EE msg
-            add_action('AHEE__SPCO__reg_form_footer', ['EED_Single_Page_Checkout', 'display_registration_footer']);
-            $empty_cart                                 = count(
-                    $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params)
-                ) < 1;
-            EE_Registry::$i18n_js_strings['empty_cart'] = $empty_cart;
-            $cookies_not_set_msg                        = '';
-            if ($empty_cart) {
-                $cookies_not_set_msg = apply_filters(
-                    'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg',
-                    sprintf(
-                        esc_html__(
-                            '%1$s%3$sIt appears your browser is not currently set to accept Cookies%4$s%5$sIn order to register for events, you need to enable cookies.%7$sIf you require assistance, then click the following link to learn how to %8$senable cookies%9$s%6$s%2$s',
-                            'event_espresso'
-                        ),
-                        '<div class="ee-attention hidden" id="ee-cookies-not-set-msg">',
-                        '</div>',
-                        '<h6 class="important-notice">',
-                        '</h6>',
-                        '<p>',
-                        '</p>',
-                        '<br />',
-                        '<a href="https://www.whatismybrowser.com/guides/how-to-enable-cookies/" target="_blank" rel="noopener noreferrer">',
-                        '</a>'
-                    )
-                );
-            }
-            $this->checkout->registration_form = new EE_Form_Section_Proper(
-                [
-                    'name'            => 'single-page-checkout',
-                    'html_id'         => 'ee-single-page-checkout-dv',
-                    'layout_strategy' =>
-                        new EE_Template_Layout(
-                            [
-                                'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php',
-                                'template_args'        => [
-                                    'empty_cart'              => $empty_cart,
-                                    'revisit'                 => $this->checkout->revisit,
-                                    'reg_steps'               => $this->checkout->reg_steps,
-                                    'next_step'               => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                        ? $this->checkout->next_step->slug()
-                                        : '',
-                                    'empty_msg'               => apply_filters(
-                                        'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg',
-                                        sprintf(
-                                            esc_html__(
-                                                'You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.',
-                                                'event_espresso'
-                                            ),
-                                            '<a href="'
-                                            . get_post_type_archive_link(EspressoPostType::EVENTS)
-                                            . '" title="',
-                                            '">',
-                                            '</a>'
-                                        )
-                                    ),
-                                    'cookies_not_set_msg'     => $cookies_not_set_msg,
-                                    'registration_time_limit' => $this->checkout->get_registration_time_limit(),
-                                    'session_expiration'      => gmdate(
-                                        'M d, Y H:i:s',
-                                        EE_Registry::instance()->SSN->expiration()
-                                        + (get_option('gmt_offset') * HOUR_IN_SECONDS)
-                                    ),
-                                ],
-                            ]
-                        ),
-                ]
-            );
-            // load template and add to output sent that gets filtered into the_content()
-            EED_Single_Page_Checkout::getResponse()->addOutput($this->checkout->registration_form->get_html());
-        }
-    }
-
-
-    /**
-     * @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
-     */
-    public function unlock_transaction()
-    {
-        if ($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
-     * @throws EE_Error
-     */
-    protected function _handle_json_response()
-    {
-        // if this is an ajax request
-        if ($this->request->isAjax()) {
-            $this->checkout->json_response->set_registration_time_limit(
-                $this->checkout->get_registration_time_limit()
-            );
-            $this->checkout->json_response->set_payment_amount($this->checkout->amount_owing);
-            // just send the ajax (
-            $json_response = apply_filters(
-                'FHEE__EE_Single_Page_Checkout__JSON_response',
-                $this->checkout->json_response
-            );
-            exit($json_response);
-        }
-    }
-
-
-    /**
-     * @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();
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    public function set_checkout_anchor()
-    {
-        echo '<a id="checkout" style="float: left; margin-left: -999em;"></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;
+
+	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
+				EE_Config::register_route(
+					$reg_step['slug'],
+					'EED_Single_Page_Checkout',
+					'run',
+					'step'
+				);
+				// add AJAX or other hooks
+				if (isset($reg_step['has_hooks']) && $reg_step['has_hooks']) {
+					// setup autoloaders if necessary
+					if (! class_exists($reg_step['class_name'])) {
+						EEH_Autoloader::register_autoloaders_for_each_file_in_folder(
+							$reg_step['file_path'],
+							true
+						);
+					}
+					if (is_callable($reg_step['class_name'], 'set_hooks')) {
+						call_user_func([$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);
+			// lock the transaction
+			$this->checkout->transaction->lock();
+			// make sure all of our cached objects are added to their respective model entity mappers
+			$this->checkout->refresh_all_entities();
+			// set amount owing
+			$this->checkout->amount_owing = $this->checkout->transaction->remaining();
+			// initialize each reg step, which gives them the chance to potentially alter the process
+			$this->_initialize_reg_steps();
+			// DEBUG LOG
+			// $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
+			// get reg form
+			if (! $this->_check_form_submission()) {
+				EED_Single_Page_Checkout::$_initialized = true;
+				return;
+			}
+			// checkout the action!!!
+			$this->_process_form_action();
+			// add some style and make it dance
+			$this->add_styles_and_scripts($this);
+			// kk... SPCO has successfully run
+			EED_Single_Page_Checkout::$_initialized = true;
+			// set no cache headers and constants
+			EE_System::do_not_cache();
+			// add anchor
+			add_action('loop_start', [$this, 'set_checkout_anchor'], 1);
+			// remove transaction lock
+			add_action('shutdown', [$this, 'unlock_transaction'], 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 (! EE_Registry::instance()->SSN instanceof EE_Session) {
+			throw new EE_Error(esc_html__('The EE_Session class could not be loaded.', 'event_espresso'));
+		}
+		$clear_session_requested = $this->request->getRequestParam('clear_session', false, 'bool');
+		// is session still valid ?
+		if (
+			$clear_session_requested
+			|| (
+				EE_Registry::instance()->SSN->expired()
+				&& $this->request->getRequestParam('e_reg_url_link') === ''
+			)
+		) {
+			$this->checkout = new EE_Checkout();
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+			// EE_Registry::instance()->SSN->reset_cart();
+			// EE_Registry::instance()->SSN->reset_checkout();
+			// EE_Registry::instance()->SSN->reset_transaction();
+			if (! $clear_session_requested) {
+				EE_Error::add_attention(
+					EE_Registry::$i18n_js_strings['registration_expiration_notice'],
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			// EE_Registry::instance()->SSN->reset_expired();
+		}
+	}
+
+
+	/**
+	 * 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 = EE_Registry::instance()->SSN->checkout();
+		// verify
+		if (! $checkout instanceof EE_Checkout) {
+			// instantiate EE_Checkout object for handling the properties of the current checkout process
+			$checkout = EE_Registry::instance()->load_file(
+				SPCO_INC_PATH,
+				'EE_Checkout',
+				'class',
+				[],
+				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(
+				EE_Registry::instance()->SSN->expiration() + 1,
+				$transaction->ID()
+			);
+			return $transaction;
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return null;
+	}
+
+
+	/**
+	 * _get_registrations
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_registrations(EE_Transaction $transaction)
+	{
+		// first step: grab the registrants  { : o
+		$registrations                      = $transaction->registrations($this->checkout->reg_cache_where_params);
+		$this->checkout->total_ticket_count = count($registrations);
+		// verify registrations have been set
+		if (empty($registrations)) {
+			// if no cached registrations, then check the db
+			$registrations = $transaction->registrations($this->checkout->reg_cache_where_params);
+			// still nothing ? well as long as this isn't a revisit
+			if (empty($registrations) && ! $this->checkout->revisit) {
+				// generate new registrations from scratch
+				$registrations = $this->_initialize_registrations($transaction);
+			}
+		}
+		// sort by their original registration order
+		usort($registrations, ['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
+					EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+					EED_Single_Page_Checkout::$_initialized       = false;
+					EED_Single_Page_Checkout::$_checkout_verified = false;
+					$this->_initialize();
+					EE_Error::reset_notices();
+					return false;
+				}
+				EE_Error::add_error(
+					esc_html__(
+						'We\'re sorry but there appears to be an error with the "reg_url_link" or the transaction itself. Please refresh the page and try again or contact support.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		// now that things have been kinda sufficiently verified,
+		// let's add the checkout to the session so that it's available to other systems
+		EE_Registry::instance()->SSN->set_checkout($this->checkout);
+		return true;
+	}
+
+
+	/**
+	 * 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
+	 */
+	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
+		);
+	}
+
+
+	/**
+	 * @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()
+	{
+		// 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])
+				) {
+					// dynamically creates hook point like:
+					//   AHEE__Single_Page_Checkout__before_attendee_information__process_reg_step
+					do_action(
+						"AHEE__Single_Page_Checkout__before_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
+						$this->checkout->current_step
+					);
+					$process_reg_step = apply_filters(
+						"AHEE__Single_Page_Checkout__process_reg_step__{$this->checkout->current_step->slug()}__{$this->checkout->action}",
+						true,
+						$this->checkout->current_step,
+						$this
+					);
+					// call action on current step
+					if ($process_reg_step && call_user_func([$this->checkout->current_step, $this->checkout->action])) {
+						// good registrant, you get to proceed
+						if (
+							$this->checkout->current_step->success_message() !== ''
+							&& apply_filters(
+								'FHEE__Single_Page_Checkout___process_form_action__display_success',
+								false
+							)
+						) {
+							EE_Error::add_success(
+								$this->checkout->current_step->success_message()
+								. '<br />' . $this->checkout->next_step->_instructions()
+							);
+						}
+						// pack it up, pack it in...
+						$this->_setup_redirect();
+					}
+					// dynamically creates hook point like:
+					//  AHEE__Single_Page_Checkout__after_payment_options__process_reg_step
+					do_action(
+						"AHEE__Single_Page_Checkout__after_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
+						$this->checkout->current_step
+					);
+				} else {
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								'The requested form action "%s" does not exist for the current "%s" registration step.',
+								'event_espresso'
+							),
+							$this->checkout->action,
+							$this->checkout->current_step->name()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			// end default
+		}
+		// store our progress so far
+		$this->checkout->stash_transaction_and_checkout();
+		// advance to the next step! If you pass GO, collect $200
+		$this->go_to_next_step();
+	}
+
+
+	/**
+	 * @param EED_Single_Page_Checkout|EE_SPCO_Reg_Step $target an object with the method `translate_js_strings` and
+	 *                                                          `enqueue_styles_and_scripts`.
+	 * @return void
+	 */
+	public function add_styles_and_scripts($target)
+	{
+		// i18n
+		$target->translate_js_strings();
+		if ($this->checkout->admin_request) {
+			add_action('admin_enqueue_scripts', [$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']                          = EE_Registry::instance()->SSN->id();
+		EE_Registry::$i18n_js_strings['currency']                       = EE_Registry::instance()->CFG->currency;
+		EE_Registry::$i18n_js_strings['datepicker_yearRange']           = '-150:+20';
+		EE_Registry::$i18n_js_strings['timer_years']                    = esc_html__('years', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_months']                   = esc_html__('months', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_weeks']                    = esc_html__('weeks', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_days']                     = esc_html__('days', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_hours']                    = esc_html__('hours', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_minutes']                  = esc_html__('minutes', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_seconds']                  = esc_html__('seconds', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_year']                     = esc_html__('year', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_month']                    = esc_html__('month', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_week']                     = esc_html__('week', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_day']                      = esc_html__('day', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_hour']                     = esc_html__('hour', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_minute']                   = esc_html__('minute', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_second']                   = esc_html__('second', 'event_espresso');
+		EE_Registry::$i18n_js_strings['registration_expiration_notice'] =
+			EED_Single_Page_Checkout::getRegistrationExpirationNotice();
+		EE_Registry::$i18n_js_strings['ajax_submit']                    = apply_filters(
+			'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
+			true
+		);
+		EE_Registry::$i18n_js_strings['session_extension']              = absint(
+			apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS)
+		);
+		EE_Registry::$i18n_js_strings['session_expiration']             = gmdate(
+			'M d, Y H:i:s',
+			EE_Registry::instance()->SSN->expiration() + (get_option('gmt_offset') * HOUR_IN_SECONDS)
+		);
+	}
+
+
+	/**
+	 * @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(
+			'jquery_plugin',
+			EE_THIRD_PARTY_URL . 'jquery	.plugin.min.js',
+			['jquery'],
+			'1.0.1',
+			true
+		);
+		wp_register_script(
+			'jquery_countdown',
+			EE_THIRD_PARTY_URL . 'jquery	.countdown.min.js',
+			['jquery_plugin'],
+			'2.1.0',
+			true
+		);
+		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');
+		if (apply_filters('FHEE__registration_page_wrapper_template__display_time_limit', false)) {
+			wp_enqueue_script('jquery_countdown');
+		}
+		/**
+		 * global action hook for enqueueing styles and scripts with
+		 * spco calls.
+		 */
+		do_action('AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts', $this);
+		/**
+		 * dynamic action hook for enqueueing styles and scripts with spco calls.
+		 * The hook will end up being something like:
+		 *      AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information
+		 */
+		do_action(
+			'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__' . $this->checkout->current_step->slug(),
+			$this
+		);
+	}
+
+
+	/**
+	 * display the Registration Single Page Checkout Form
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _display_spco_reg_form()
+	{
+		// if registering via the admin, just display the reg form for the current step
+		if ($this->checkout->admin_request) {
+			EED_Single_Page_Checkout::getResponse()->addOutput($this->checkout->current_step->display_reg_form());
+		} else {
+			// add powered by EE msg
+			add_action('AHEE__SPCO__reg_form_footer', ['EED_Single_Page_Checkout', 'display_registration_footer']);
+			$empty_cart                                 = count(
+					$this->checkout->transaction->registrations($this->checkout->reg_cache_where_params)
+				) < 1;
+			EE_Registry::$i18n_js_strings['empty_cart'] = $empty_cart;
+			$cookies_not_set_msg                        = '';
+			if ($empty_cart) {
+				$cookies_not_set_msg = apply_filters(
+					'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg',
+					sprintf(
+						esc_html__(
+							'%1$s%3$sIt appears your browser is not currently set to accept Cookies%4$s%5$sIn order to register for events, you need to enable cookies.%7$sIf you require assistance, then click the following link to learn how to %8$senable cookies%9$s%6$s%2$s',
+							'event_espresso'
+						),
+						'<div class="ee-attention hidden" id="ee-cookies-not-set-msg">',
+						'</div>',
+						'<h6 class="important-notice">',
+						'</h6>',
+						'<p>',
+						'</p>',
+						'<br />',
+						'<a href="https://www.whatismybrowser.com/guides/how-to-enable-cookies/" target="_blank" rel="noopener noreferrer">',
+						'</a>'
+					)
+				);
+			}
+			$this->checkout->registration_form = new EE_Form_Section_Proper(
+				[
+					'name'            => 'single-page-checkout',
+					'html_id'         => 'ee-single-page-checkout-dv',
+					'layout_strategy' =>
+						new EE_Template_Layout(
+							[
+								'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php',
+								'template_args'        => [
+									'empty_cart'              => $empty_cart,
+									'revisit'                 => $this->checkout->revisit,
+									'reg_steps'               => $this->checkout->reg_steps,
+									'next_step'               => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+										? $this->checkout->next_step->slug()
+										: '',
+									'empty_msg'               => apply_filters(
+										'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg',
+										sprintf(
+											esc_html__(
+												'You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.',
+												'event_espresso'
+											),
+											'<a href="'
+											. get_post_type_archive_link(EspressoPostType::EVENTS)
+											. '" title="',
+											'">',
+											'</a>'
+										)
+									),
+									'cookies_not_set_msg'     => $cookies_not_set_msg,
+									'registration_time_limit' => $this->checkout->get_registration_time_limit(),
+									'session_expiration'      => gmdate(
+										'M d, Y H:i:s',
+										EE_Registry::instance()->SSN->expiration()
+										+ (get_option('gmt_offset') * HOUR_IN_SECONDS)
+									),
+								],
+							]
+						),
+				]
+			);
+			// load template and add to output sent that gets filtered into the_content()
+			EED_Single_Page_Checkout::getResponse()->addOutput($this->checkout->registration_form->get_html());
+		}
+	}
+
+
+	/**
+	 * @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
+	 */
+	public function unlock_transaction()
+	{
+		if ($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
+	 * @throws EE_Error
+	 */
+	protected function _handle_json_response()
+	{
+		// if this is an ajax request
+		if ($this->request->isAjax()) {
+			$this->checkout->json_response->set_registration_time_limit(
+				$this->checkout->get_registration_time_limit()
+			);
+			$this->checkout->json_response->set_payment_amount($this->checkout->amount_owing);
+			// just send the ajax (
+			$json_response = apply_filters(
+				'FHEE__EE_Single_Page_Checkout__JSON_response',
+				$this->checkout->json_response
+			);
+			exit($json_response);
+		}
+	}
+
+
+	/**
+	 * @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();
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function set_checkout_anchor()
+	{
+		echo '<a id="checkout" style="float: left; margin-left: -999em;"></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 +49 added lines, -49 removed lines

@@ -45,7 +45,7 @@ 
 
     protected ?RequestInterface $request = null;
 
-    private bool $debug = false;    //  true    false
+    private bool $debug = false; //  true    false
 
 
     /**
@@ -109,7 +109,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
@@ -203,14 +203,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();
@@ -241,7 +241,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
                 EE_Config::register_route(
@@ -253,7 +253,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
@@ -280,19 +280,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,
@@ -438,7 +438,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;
             }
@@ -447,7 +447,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;
             }
@@ -463,7 +463,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;
             }
@@ -493,7 +493,7 @@ 
      */
     private function _verify_session()
     {
-        if (! EE_Registry::instance()->SSN instanceof EE_Session) {
+        if ( ! EE_Registry::instance()->SSN instanceof EE_Session) {
             throw new EE_Error(esc_html__('The EE_Session class could not be loaded.', 'event_espresso'));
         }
         $clear_session_requested = $this->request->getRequestParam('clear_session', false, 'bool');
@@ -510,7 +510,7 @@ 
             // EE_Registry::instance()->SSN->reset_cart();
             // EE_Registry::instance()->SSN->reset_checkout();
             // EE_Registry::instance()->SSN->reset_transaction();
-            if (! $clear_session_requested) {
+            if ( ! $clear_session_requested) {
                 EE_Error::add_attention(
                     EE_Registry::$i18n_js_strings['registration_expiration_notice'],
                     __FILE__,
@@ -536,7 +536,7 @@ 
         /** @type EE_Checkout $checkout */
         $checkout = EE_Registry::instance()->SSN->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,
@@ -554,7 +554,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
@@ -611,7 +611,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__);
@@ -683,7 +683,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;
                 }
             }
@@ -805,12 +805,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.',
@@ -1035,10 +1035,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);
@@ -1078,7 +1078,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.',
@@ -1091,9 +1091,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.',
@@ -1118,7 +1118,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
@@ -1160,9 +1160,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;
@@ -1213,7 +1213,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?
@@ -1287,7 +1287,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...
@@ -1351,27 +1351,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'
@@ -1422,7 +1422,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
         );
@@ -1430,21 +1430,21 @@ 
         // load JS
         wp_register_script(
             'jquery_plugin',
-            EE_THIRD_PARTY_URL . 'jquery	.plugin.min.js',
+            EE_THIRD_PARTY_URL.'jquery	.plugin.min.js',
             ['jquery'],
             '1.0.1',
             true
         );
         wp_register_script(
             'jquery_countdown',
-            EE_THIRD_PARTY_URL . 'jquery	.countdown.min.js',
+            EE_THIRD_PARTY_URL.'jquery	.countdown.min.js',
             ['jquery_plugin'],
             '2.1.0',
             true
         );
         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
@@ -1470,7 +1470,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
         );
     }
@@ -1523,7 +1523,7 @@ 
                     'layout_strategy' =>
                         new EE_Template_Layout(
                             [
-                                'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php',
+                                'layout_template_file' => SPCO_TEMPLATES_PATH.'registration_page_wrapper.template.php',
                                 'template_args'        => [
                                     'empty_cart'              => $empty_cart,
                                     'revisit'                 => $this->checkout->revisit,
@@ -1588,7 +1588,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);
                 }
             );
@@ -1728,7 +1728,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/reg_steps/attendee_information/EE_SPCO_Reg_Step_Attendee_Information.class.php

Indentation +858 added lines, -858 removed lines

@@ -23,862 +23,862 @@
  */
 class EE_SPCO_Reg_Step_Attendee_Information extends EE_SPCO_Reg_Step
 {
-    /**
-     * @var RegForm
-     */
-    public $reg_form;
-
-    /**
-     * @var int
-     */
-    protected $reg_form_count = 0;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param EE_Checkout $checkout
-     */
-    public function __construct(EE_Checkout $checkout)
-    {
-        $this->_slug    = 'attendee_information';
-        $this->_name    = esc_html__('Attendee Information', 'event_espresso');
-        $this->checkout = $checkout;
-        $this->_reset_success_message();
-        $this->set_instructions(
-            esc_html__('Please answer the following registration questions before proceeding.', 'event_espresso')
-        );
-    }
-
-
-    public function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['required_field']            = esc_html__(
-            ' is a required question.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['required_multi_field']      = esc_html__(
-            ' is a required question. Please enter a value for at least one of the options.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['answer_required_questions'] = esc_html__(
-            'Please answer all required questions correctly before proceeding.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['attendee_info_copied']      = sprintf(
-            esc_html_x(
-                'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
-                'The attendee information was successfully copied.(line break)Please ensure the rest of the registration form is completed before proceeding.',
-                'event_espresso'
-            ),
-            '<br/>'
-        );
-        EE_Registry::$i18n_js_strings['attendee_info_copy_error']  = esc_html__(
-            'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['enter_valid_email']         = esc_html__(
-            'You must enter a valid email address.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['valid_email_and_questions'] = esc_html__(
-            'You must enter a valid email address and answer all other required questions before you can proceed.',
-            'event_espresso'
-        );
-    }
-
-
-    public function enqueue_styles_and_scripts()
-    {
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function initialize_reg_step(): bool
-    {
-        return true;
-    }
-
-
-    /**
-     * @return RegForm
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function generate_reg_form(): RegForm
-    {
-        $this->setLegacyFiltersForRegFormGeneration();
-        /** @var RegFormDependencyHandler $dependency_handler */
-        $dependency_handler = LoaderFactory::getShared(RegFormDependencyHandler::class);
-        $dependency_handler->registerDependencies();
-        // TODO detect if event has a reg form UUID and swap this out for form generated by new reg form builder
-        return LoaderFactory::getShared(RegForm::class, [$this]);
-    }
-
-
-    /**
-     * @since   5.0.0.p
-     */
-    private function setLegacyFiltersForRegFormGeneration()
-    {
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_groups_query_parameters',
-            [$this, 'registrationQuestionGroupsQueryParameters'],
-            1,
-            2
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_group_reg_form',
-            [$this, 'registrationQuestionGroupsRegForm'],
-            1,
-            3
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__printCopyInfo',
-            [$this, 'registrationRegFormPrintCopyInfo'],
-            1,
-            2
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__related_questions_query_params',
-            [$this, 'registrationRegFormRelatedQuestionsQueryParams'],
-            1,
-            3
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__before_question_group_questions',
-            [$this, 'registrationRegFormBeforeQuestionGroupQuestions'],
-            1,
-            3
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__subsections_array',
-            [$this, 'registrationRegFormSubsections'],
-            1,
-            3
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__after_question_group_questions',
-            [$this, 'registrationRegFormAfterQuestionGroupQuestions'],
-            1,
-            3
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_AutoCopyAttendeeInfoForm__construct__template_args',
-            [$this, 'autoCopyAttendeeInfoTemplateArgs'],
-            1
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_CountryOptions__generateLegacyCountryOptions__country_options',
-            [$this, 'generateQuestionInputCountryOptions'],
-            1,
-            4
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_StateOptions__generateLegacyStateOptions__state_options',
-            [$this, 'generateQuestionInputStateOptions'],
-            1,
-            4
-        );
-    }
-
-
-    /**
-     * @param array           $query_params
-     * @param EE_Registration $registration
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function registrationQuestionGroupsQueryParameters(
-        array $query_params,
-        EE_Registration $registration
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
-            $query_params,
-            $registration,
-            $this
-        );
-    }
-
-
-    /**
-     * @param RegFormQuestionGroup $question_group_reg_form
-     * @param EE_Registration      $registration
-     * @param EE_Question_Group    $question_group
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function registrationQuestionGroupsRegForm(
-        RegFormQuestionGroup $question_group_reg_form,
-        EE_Registration $registration,
-        EE_Question_Group $question_group
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
-            $question_group_reg_form,
-            $registration,
-            $question_group,
-            $this
-        );
-    }
-
-
-    /**
-     * @param int $print_copy_info
-     * @param int $attendee_nmbr
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function registrationRegFormPrintCopyInfo(
-        int $print_copy_info,
-        int $attendee_nmbr
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form___printCopyInfo',
-            $print_copy_info,
-            $attendee_nmbr
-        );
-    }
-
-
-    /**
-     * @param array             $query_params
-     * @param EE_Question_Group $question_group
-     * @param EE_Registration   $registration
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function registrationRegFormRelatedQuestionsQueryParams(
-        array $query_params,
-        EE_Question_Group $question_group,
-        EE_Registration $registration
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__related_questions_query_params',
-            $query_params,
-            $question_group,
-            $registration,
-            $this
-        );
-    }
-
-
-    /**
-     * @param                   $html
-     * @param EE_Registration   $registration
-     * @param EE_Question_Group $question_group
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function registrationRegFormBeforeQuestionGroupQuestions(
-        $html,
-        EE_Registration $registration,
-        EE_Question_Group $question_group
-    ) {
-        return apply_filters(
-            'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
-            $html,
-            $registration,
-            $question_group,
-            $this
-        );
-    }
-
-
-    /**
-     * @param array             $form_subsections
-     * @param EE_Registration   $registration
-     * @param EE_Question_Group $question_group
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function registrationRegFormSubsections(
-        array $form_subsections,
-        EE_Registration $registration,
-        EE_Question_Group $question_group
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__question_group_reg_form__subsections_array',
-            $form_subsections,
-            $registration,
-            $question_group,
-            $this
-        );
-    }
-
-
-    /**
-     * @param                   $html
-     * @param EE_Registration   $registration
-     * @param EE_Question_Group $question_group
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function registrationRegFormAfterQuestionGroupQuestions(
-        $html,
-        EE_Registration $registration,
-        EE_Question_Group $question_group
-    ) {
-        return apply_filters(
-            'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
-            $html,
-            $registration,
-            $question_group,
-            $this
-        );
-    }
-
-
-    /**
-     * @param array $template_args
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function autoCopyAttendeeInfoTemplateArgs(array $template_args = [])
-    {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
-            $template_args
-        );
-    }
-
-
-    /**
-     * @param array           $country_options
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @param EE_Answer|null  $answer
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function generateQuestionInputCountryOptions(
-        array $country_options,
-        EE_Registration $registration,
-        EE_Question $question,
-        ?EE_Answer $answer
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            $country_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-    }
-
-
-    /**
-     * @param array           $state_options
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @param EE_Answer|null  $answer
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function generateQuestionInputStateOptions(
-        array $state_options,
-        EE_Registration $registration,
-        EE_Question $question,
-        ?EE_Answer $answer
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            $state_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::getRegForm()
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _registrations_reg_form()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::additionalAttendeeRegInfoInput()
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _additional_attendee_reg_info_input()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::questionGroupRegForm()
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _question_group_reg_form()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::questionGroupHeader()
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _question_group_header()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\CopyAttendeeInfoForm
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _copy_attendee_info_form()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\AutoCopyAttendeeInfoForm
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _auto_copy_attendee_info()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\CopyAttendeeInfoForm
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _copy_attendee_info_inputs()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::additionalPrimaryRegistrantInputs()
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _additional_primary_registrant_inputs()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionFactory::create()
-     *
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated   5.0.0.p
-     */
-    public function reg_form_question(EE_Registration $registration, EE_Question $question): EE_Form_Input_Base
-    {
-        /** @var RegFormQuestionFactory $reg_form_question_factory */
-        $reg_form_question_factory = LoaderFactory::getShared(RegFormQuestionFactory::class);
-        return $reg_form_question_factory->create($registration, $question);
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::generateQuestionInput()
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _generate_question_input()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\CountryOptions::forLegacyFormInput()
-     *
-     * @param array|null           $countries_list
-     * @param EE_Question|null     $question
-     * @param EE_Registration|null $registration
-     * @param EE_Answer|null       $answer
-     * @return array 2d keys are country IDs, values are their names
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated   5.0.0.p
-     */
-    public function use_cached_countries_for_form_input(
-        array $countries_list = null,
-        EE_Question $question = null,
-        EE_Registration $registration = null,
-        EE_Answer $answer = null
-    ): array {
-        /** @var CountryOptions $country_options */
-        $country_options = LoaderFactory::getShared(CountryOptions::class, [$this->checkout->action]);
-        return $country_options->forLegacyFormInput($countries_list, $question, $registration, $answer);
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\StateOptions::forLegacyFormInput()
-     *
-     * @param array|null           $states_list
-     * @param EE_Question|null     $question
-     * @param EE_Registration|null $registration
-     * @param EE_Answer|null       $answer
-     * @return array 2d keys are state IDs, values are their names
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated   5.0.0.p
-     */
-    public function use_cached_states_for_form_input(
-        array $states_list = null,
-        EE_Question $question = null,
-        EE_Registration $registration = null,
-        EE_Answer $answer = null
-    ): array {
-        /** @var StateOptions $state_options */
-        $state_options = LoaderFactory::getShared(StateOptions::class, [$this->checkout->action]);
-        return $state_options->forLegacyFormInput($states_list, $question, $registration, $answer);
-    }
-
-
-    /********************************************************************************************************/
-    /****************************************  PROCESS REG STEP  ****************************************/
-    /********************************************************************************************************/
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_reg_step(): bool
-    {
-        $this->setLegacyFiltersForRegFormProcessing();
-        // grab validated data from form
-        $valid_data = $this->checkout->current_step->valid_data();
-        // if we don't have any $valid_data then something went TERRIBLY WRONG !!!
-        if (empty($valid_data)) {
-            return $this->inValidDataError();
-        }
-        if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
-            return $this->inValidTransactionError();
-        }
-        // get cached registrations
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        // verify we got the goods
-        if (empty($registrations)) {
-            return $this->noRegistrationsError();
-        }
-        /** @var RegFormHandler $reg_form_handler */
-        $reg_form_handler = LoaderFactory::getNew(RegFormHandler::class, [$this->checkout]);
-        // extract attendee info from form data and save to model objects
-        if (! $reg_form_handler->processRegistrations($registrations, $valid_data)) {
-            // return immediately if the previous step exited early due to errors
-            return false;
-        }
-        // if first pass thru SPCO,
-        // then let's check processed registrations against the total number of tickets in the cart
-        $registrations_processed = $reg_form_handler->attendeeCount();
-        if (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
-            return $this->registrationProcessingError($registrations_processed);
-        }
-        // mark this reg step as completed
-        $this->set_completed();
-        $this->_set_success_message(
-            esc_html__('The Attendee Information Step has been successfully completed.', 'event_espresso')
-        );
-        // do action in case a plugin wants to do something with the data submitted in step 1.
-        // passes EE_Single_Page_Checkout, and it's posted data
-        do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
-        return true;
-    }
-
-
-    /**
-     * @since   5.0.0.p
-     */
-    private function setLegacyFiltersForRegFormProcessing()
-    {
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegistrations__bypass',
-            [$this, 'preRegistrationProcess'],
-            1,
-            5
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegFormData__registrant_form_data',
-            [$this, 'validDataLineItem'],
-            1,
-            2
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormInputHandler__saveRegistrationFormInput',
-            [$this, 'saveRegistrationFormInput'],
-            1,
-            4
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantData__ensureCriticalRegistrantDataIsSet',
-            [$this, 'mergeAddressDetailsWithCriticalAttendeeDetails'],
-            1
-        );
-    }
-
-
-    /**
-     * @param bool            $bypass
-     * @param int             $attendee_count
-     * @param EE_Registration $registration
-     * @param array           $registrations
-     * @param array           $reg_form_data
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function preRegistrationProcess(
-        bool $bypass,
-        int $attendee_count,
-        EE_Registration $registration,
-        array $registrations,
-        array $reg_form_data
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
-            $bypass,
-            $attendee_count,
-            $registration,
-            $registrations,
-            $reg_form_data,
-            $this
-        );
-    }
-
-
-    /**
-     * @param array           $reg_form_data
-     * @param EE_Registration $registration
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function validDataLineItem(array $reg_form_data, EE_Registration $registration)
-    {
-        return apply_filters(
-            'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-            $reg_form_data,
-            $registration
-        );
-    }
-
-
-    /**
-     * @param bool            $save
-     * @param EE_Registration $registration
-     * @param                 $form_input
-     * @param                 $input_value
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function saveRegistrationFormInput(bool $save, EE_Registration $registration, $form_input, $input_value)
-    {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
-            $save,
-            $registration,
-            $form_input,
-            $input_value,
-            $this
-        );
-    }
-
-
-    /**
-     * @param bool $merge_data
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function mergeAddressDetailsWithCriticalAttendeeDetails(bool $merge_data)
-    {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
-            $merge_data
-        );
-    }
-
-
-    /**
-     * @return bool
-     * @since   5.0.0.p
-     */
-    private function inValidDataError(): bool
-    {
-        EE_Error::add_error(
-            esc_html__('No valid question responses were received.', 'event_espresso'),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
-
-
-    /**
-     * @return bool
-     * @since   5.0.0.p
-     */
-    private function inValidTransactionError(): bool
-    {
-        EE_Error::add_error(
-            esc_html__(
-                'A valid transaction could not be initiated for processing your registrations.',
-                'event_espresso'
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
-
-
-    /**
-     * @return bool
-     * @since   5.0.0.p
-     */
-    private function noRegistrationsError(): bool
-    {
-        // combine the old translated string with a new one, in order to not break translations
-        $error_message = esc_html__(
-            'Your form data could not be applied to any valid registrations.',
-            'event_espresso'
-        );
-        $error_message .= sprintf(
-            esc_html_x(
-                '%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.',
-                '(line break)This can sometimes happen if too much time has been taken to complete the registration process.(line break)Please return to the (link)Event List(end link) and reselect your tickets. If the problem continues, please contact the site administrator.',
-                'event_espresso'
-            ),
-            '<a href="' . get_post_type_archive_link(EspressoPostType::EVENTS) . '" >',
-            '</a>',
-            '<br />'
-        );
-        EE_Error::add_error($error_message, __FILE__, __FUNCTION__, __LINE__);
-        return false;
-    }
-
-
-    /**
-     * @param int $registrations_processed
-     * @return bool
-     * @since   5.0.0.p
-     */
-    private function registrationProcessingError(int $registrations_processed): bool
-    {
-        // generate a correctly translated string for all possible singular/plural combinations
-        if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
-            $error_msg = sprintf(
-                esc_html_x(
-                    'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
-                    'There was 1 ticket in the Event Queue, but 2 registrations were processed',
-                    'event_espresso'
-                ),
-                $this->checkout->total_ticket_count,
-                $registrations_processed
-            );
-        } elseif ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
-            $error_msg = sprintf(
-                esc_html_x(
-                    'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
-                    'There was a total of 2 tickets in the Event Queue, but only 1 registration was processed',
-                    'event_espresso'
-                ),
-                $this->checkout->total_ticket_count,
-                $registrations_processed
-            );
-        } else {
-            $error_msg = sprintf(
-                esc_html__(
-                    'There was a total of 2 tickets in the Event Queue, but 2 registrations were processed',
-                    'event_espresso'
-                ),
-                $this->checkout->total_ticket_count,
-                $registrations_processed
-            );
-        }
-        EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-        return false;
-    }
-
-
-    /**
-     *    update_reg_step
-     *    this is the final step after a user  revisits the site to edit their attendee information
-     *    this gets called AFTER the process_reg_step() method above
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update_reg_step(): bool
-    {
-        // save everything
-        if ($this->process_reg_step()) {
-            $this->checkout->redirect     = true;
-            $this->checkout->redirect_url = add_query_arg(
-                [
-                    'e_reg_url_link' => $this->checkout->reg_url_link,
-                    'revisit'        => true,
-                ],
-                $this->checkout->thank_you_page_url
-            );
-            $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * @var RegForm
+	 */
+	public $reg_form;
+
+	/**
+	 * @var int
+	 */
+	protected $reg_form_count = 0;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param EE_Checkout $checkout
+	 */
+	public function __construct(EE_Checkout $checkout)
+	{
+		$this->_slug    = 'attendee_information';
+		$this->_name    = esc_html__('Attendee Information', 'event_espresso');
+		$this->checkout = $checkout;
+		$this->_reset_success_message();
+		$this->set_instructions(
+			esc_html__('Please answer the following registration questions before proceeding.', 'event_espresso')
+		);
+	}
+
+
+	public function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['required_field']            = esc_html__(
+			' is a required question.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['required_multi_field']      = esc_html__(
+			' is a required question. Please enter a value for at least one of the options.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['answer_required_questions'] = esc_html__(
+			'Please answer all required questions correctly before proceeding.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['attendee_info_copied']      = sprintf(
+			esc_html_x(
+				'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
+				'The attendee information was successfully copied.(line break)Please ensure the rest of the registration form is completed before proceeding.',
+				'event_espresso'
+			),
+			'<br/>'
+		);
+		EE_Registry::$i18n_js_strings['attendee_info_copy_error']  = esc_html__(
+			'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['enter_valid_email']         = esc_html__(
+			'You must enter a valid email address.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['valid_email_and_questions'] = esc_html__(
+			'You must enter a valid email address and answer all other required questions before you can proceed.',
+			'event_espresso'
+		);
+	}
+
+
+	public function enqueue_styles_and_scripts()
+	{
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function initialize_reg_step(): bool
+	{
+		return true;
+	}
+
+
+	/**
+	 * @return RegForm
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function generate_reg_form(): RegForm
+	{
+		$this->setLegacyFiltersForRegFormGeneration();
+		/** @var RegFormDependencyHandler $dependency_handler */
+		$dependency_handler = LoaderFactory::getShared(RegFormDependencyHandler::class);
+		$dependency_handler->registerDependencies();
+		// TODO detect if event has a reg form UUID and swap this out for form generated by new reg form builder
+		return LoaderFactory::getShared(RegForm::class, [$this]);
+	}
+
+
+	/**
+	 * @since   5.0.0.p
+	 */
+	private function setLegacyFiltersForRegFormGeneration()
+	{
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_groups_query_parameters',
+			[$this, 'registrationQuestionGroupsQueryParameters'],
+			1,
+			2
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_group_reg_form',
+			[$this, 'registrationQuestionGroupsRegForm'],
+			1,
+			3
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__printCopyInfo',
+			[$this, 'registrationRegFormPrintCopyInfo'],
+			1,
+			2
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__related_questions_query_params',
+			[$this, 'registrationRegFormRelatedQuestionsQueryParams'],
+			1,
+			3
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__before_question_group_questions',
+			[$this, 'registrationRegFormBeforeQuestionGroupQuestions'],
+			1,
+			3
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__subsections_array',
+			[$this, 'registrationRegFormSubsections'],
+			1,
+			3
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__after_question_group_questions',
+			[$this, 'registrationRegFormAfterQuestionGroupQuestions'],
+			1,
+			3
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_AutoCopyAttendeeInfoForm__construct__template_args',
+			[$this, 'autoCopyAttendeeInfoTemplateArgs'],
+			1
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_CountryOptions__generateLegacyCountryOptions__country_options',
+			[$this, 'generateQuestionInputCountryOptions'],
+			1,
+			4
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_StateOptions__generateLegacyStateOptions__state_options',
+			[$this, 'generateQuestionInputStateOptions'],
+			1,
+			4
+		);
+	}
+
+
+	/**
+	 * @param array           $query_params
+	 * @param EE_Registration $registration
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function registrationQuestionGroupsQueryParameters(
+		array $query_params,
+		EE_Registration $registration
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
+			$query_params,
+			$registration,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param RegFormQuestionGroup $question_group_reg_form
+	 * @param EE_Registration      $registration
+	 * @param EE_Question_Group    $question_group
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function registrationQuestionGroupsRegForm(
+		RegFormQuestionGroup $question_group_reg_form,
+		EE_Registration $registration,
+		EE_Question_Group $question_group
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
+			$question_group_reg_form,
+			$registration,
+			$question_group,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param int $print_copy_info
+	 * @param int $attendee_nmbr
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function registrationRegFormPrintCopyInfo(
+		int $print_copy_info,
+		int $attendee_nmbr
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form___printCopyInfo',
+			$print_copy_info,
+			$attendee_nmbr
+		);
+	}
+
+
+	/**
+	 * @param array             $query_params
+	 * @param EE_Question_Group $question_group
+	 * @param EE_Registration   $registration
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function registrationRegFormRelatedQuestionsQueryParams(
+		array $query_params,
+		EE_Question_Group $question_group,
+		EE_Registration $registration
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__related_questions_query_params',
+			$query_params,
+			$question_group,
+			$registration,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param                   $html
+	 * @param EE_Registration   $registration
+	 * @param EE_Question_Group $question_group
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function registrationRegFormBeforeQuestionGroupQuestions(
+		$html,
+		EE_Registration $registration,
+		EE_Question_Group $question_group
+	) {
+		return apply_filters(
+			'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
+			$html,
+			$registration,
+			$question_group,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param array             $form_subsections
+	 * @param EE_Registration   $registration
+	 * @param EE_Question_Group $question_group
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function registrationRegFormSubsections(
+		array $form_subsections,
+		EE_Registration $registration,
+		EE_Question_Group $question_group
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__question_group_reg_form__subsections_array',
+			$form_subsections,
+			$registration,
+			$question_group,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param                   $html
+	 * @param EE_Registration   $registration
+	 * @param EE_Question_Group $question_group
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function registrationRegFormAfterQuestionGroupQuestions(
+		$html,
+		EE_Registration $registration,
+		EE_Question_Group $question_group
+	) {
+		return apply_filters(
+			'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
+			$html,
+			$registration,
+			$question_group,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param array $template_args
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function autoCopyAttendeeInfoTemplateArgs(array $template_args = [])
+	{
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
+			$template_args
+		);
+	}
+
+
+	/**
+	 * @param array           $country_options
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @param EE_Answer|null  $answer
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function generateQuestionInputCountryOptions(
+		array $country_options,
+		EE_Registration $registration,
+		EE_Question $question,
+		?EE_Answer $answer
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			$country_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+	}
+
+
+	/**
+	 * @param array           $state_options
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @param EE_Answer|null  $answer
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function generateQuestionInputStateOptions(
+		array $state_options,
+		EE_Registration $registration,
+		EE_Question $question,
+		?EE_Answer $answer
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			$state_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::getRegForm()
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _registrations_reg_form()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::additionalAttendeeRegInfoInput()
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _additional_attendee_reg_info_input()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::questionGroupRegForm()
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _question_group_reg_form()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::questionGroupHeader()
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _question_group_header()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\CopyAttendeeInfoForm
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _copy_attendee_info_form()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\AutoCopyAttendeeInfoForm
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _auto_copy_attendee_info()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\CopyAttendeeInfoForm
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _copy_attendee_info_inputs()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::additionalPrimaryRegistrantInputs()
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _additional_primary_registrant_inputs()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionFactory::create()
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated   5.0.0.p
+	 */
+	public function reg_form_question(EE_Registration $registration, EE_Question $question): EE_Form_Input_Base
+	{
+		/** @var RegFormQuestionFactory $reg_form_question_factory */
+		$reg_form_question_factory = LoaderFactory::getShared(RegFormQuestionFactory::class);
+		return $reg_form_question_factory->create($registration, $question);
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::generateQuestionInput()
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _generate_question_input()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\CountryOptions::forLegacyFormInput()
+	 *
+	 * @param array|null           $countries_list
+	 * @param EE_Question|null     $question
+	 * @param EE_Registration|null $registration
+	 * @param EE_Answer|null       $answer
+	 * @return array 2d keys are country IDs, values are their names
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated   5.0.0.p
+	 */
+	public function use_cached_countries_for_form_input(
+		array $countries_list = null,
+		EE_Question $question = null,
+		EE_Registration $registration = null,
+		EE_Answer $answer = null
+	): array {
+		/** @var CountryOptions $country_options */
+		$country_options = LoaderFactory::getShared(CountryOptions::class, [$this->checkout->action]);
+		return $country_options->forLegacyFormInput($countries_list, $question, $registration, $answer);
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\StateOptions::forLegacyFormInput()
+	 *
+	 * @param array|null           $states_list
+	 * @param EE_Question|null     $question
+	 * @param EE_Registration|null $registration
+	 * @param EE_Answer|null       $answer
+	 * @return array 2d keys are state IDs, values are their names
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated   5.0.0.p
+	 */
+	public function use_cached_states_for_form_input(
+		array $states_list = null,
+		EE_Question $question = null,
+		EE_Registration $registration = null,
+		EE_Answer $answer = null
+	): array {
+		/** @var StateOptions $state_options */
+		$state_options = LoaderFactory::getShared(StateOptions::class, [$this->checkout->action]);
+		return $state_options->forLegacyFormInput($states_list, $question, $registration, $answer);
+	}
+
+
+	/********************************************************************************************************/
+	/****************************************  PROCESS REG STEP  ****************************************/
+	/********************************************************************************************************/
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_reg_step(): bool
+	{
+		$this->setLegacyFiltersForRegFormProcessing();
+		// grab validated data from form
+		$valid_data = $this->checkout->current_step->valid_data();
+		// if we don't have any $valid_data then something went TERRIBLY WRONG !!!
+		if (empty($valid_data)) {
+			return $this->inValidDataError();
+		}
+		if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
+			return $this->inValidTransactionError();
+		}
+		// get cached registrations
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		// verify we got the goods
+		if (empty($registrations)) {
+			return $this->noRegistrationsError();
+		}
+		/** @var RegFormHandler $reg_form_handler */
+		$reg_form_handler = LoaderFactory::getNew(RegFormHandler::class, [$this->checkout]);
+		// extract attendee info from form data and save to model objects
+		if (! $reg_form_handler->processRegistrations($registrations, $valid_data)) {
+			// return immediately if the previous step exited early due to errors
+			return false;
+		}
+		// if first pass thru SPCO,
+		// then let's check processed registrations against the total number of tickets in the cart
+		$registrations_processed = $reg_form_handler->attendeeCount();
+		if (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
+			return $this->registrationProcessingError($registrations_processed);
+		}
+		// mark this reg step as completed
+		$this->set_completed();
+		$this->_set_success_message(
+			esc_html__('The Attendee Information Step has been successfully completed.', 'event_espresso')
+		);
+		// do action in case a plugin wants to do something with the data submitted in step 1.
+		// passes EE_Single_Page_Checkout, and it's posted data
+		do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
+		return true;
+	}
+
+
+	/**
+	 * @since   5.0.0.p
+	 */
+	private function setLegacyFiltersForRegFormProcessing()
+	{
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegistrations__bypass',
+			[$this, 'preRegistrationProcess'],
+			1,
+			5
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegFormData__registrant_form_data',
+			[$this, 'validDataLineItem'],
+			1,
+			2
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormInputHandler__saveRegistrationFormInput',
+			[$this, 'saveRegistrationFormInput'],
+			1,
+			4
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantData__ensureCriticalRegistrantDataIsSet',
+			[$this, 'mergeAddressDetailsWithCriticalAttendeeDetails'],
+			1
+		);
+	}
+
+
+	/**
+	 * @param bool            $bypass
+	 * @param int             $attendee_count
+	 * @param EE_Registration $registration
+	 * @param array           $registrations
+	 * @param array           $reg_form_data
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function preRegistrationProcess(
+		bool $bypass,
+		int $attendee_count,
+		EE_Registration $registration,
+		array $registrations,
+		array $reg_form_data
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
+			$bypass,
+			$attendee_count,
+			$registration,
+			$registrations,
+			$reg_form_data,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param array           $reg_form_data
+	 * @param EE_Registration $registration
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function validDataLineItem(array $reg_form_data, EE_Registration $registration)
+	{
+		return apply_filters(
+			'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
+			$reg_form_data,
+			$registration
+		);
+	}
+
+
+	/**
+	 * @param bool            $save
+	 * @param EE_Registration $registration
+	 * @param                 $form_input
+	 * @param                 $input_value
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function saveRegistrationFormInput(bool $save, EE_Registration $registration, $form_input, $input_value)
+	{
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
+			$save,
+			$registration,
+			$form_input,
+			$input_value,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param bool $merge_data
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function mergeAddressDetailsWithCriticalAttendeeDetails(bool $merge_data)
+	{
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
+			$merge_data
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	private function inValidDataError(): bool
+	{
+		EE_Error::add_error(
+			esc_html__('No valid question responses were received.', 'event_espresso'),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
+
+
+	/**
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	private function inValidTransactionError(): bool
+	{
+		EE_Error::add_error(
+			esc_html__(
+				'A valid transaction could not be initiated for processing your registrations.',
+				'event_espresso'
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
+
+
+	/**
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	private function noRegistrationsError(): bool
+	{
+		// combine the old translated string with a new one, in order to not break translations
+		$error_message = esc_html__(
+			'Your form data could not be applied to any valid registrations.',
+			'event_espresso'
+		);
+		$error_message .= sprintf(
+			esc_html_x(
+				'%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.',
+				'(line break)This can sometimes happen if too much time has been taken to complete the registration process.(line break)Please return to the (link)Event List(end link) and reselect your tickets. If the problem continues, please contact the site administrator.',
+				'event_espresso'
+			),
+			'<a href="' . get_post_type_archive_link(EspressoPostType::EVENTS) . '" >',
+			'</a>',
+			'<br />'
+		);
+		EE_Error::add_error($error_message, __FILE__, __FUNCTION__, __LINE__);
+		return false;
+	}
+
+
+	/**
+	 * @param int $registrations_processed
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	private function registrationProcessingError(int $registrations_processed): bool
+	{
+		// generate a correctly translated string for all possible singular/plural combinations
+		if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
+			$error_msg = sprintf(
+				esc_html_x(
+					'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
+					'There was 1 ticket in the Event Queue, but 2 registrations were processed',
+					'event_espresso'
+				),
+				$this->checkout->total_ticket_count,
+				$registrations_processed
+			);
+		} elseif ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
+			$error_msg = sprintf(
+				esc_html_x(
+					'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
+					'There was a total of 2 tickets in the Event Queue, but only 1 registration was processed',
+					'event_espresso'
+				),
+				$this->checkout->total_ticket_count,
+				$registrations_processed
+			);
+		} else {
+			$error_msg = sprintf(
+				esc_html__(
+					'There was a total of 2 tickets in the Event Queue, but 2 registrations were processed',
+					'event_espresso'
+				),
+				$this->checkout->total_ticket_count,
+				$registrations_processed
+			);
+		}
+		EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+		return false;
+	}
+
+
+	/**
+	 *    update_reg_step
+	 *    this is the final step after a user  revisits the site to edit their attendee information
+	 *    this gets called AFTER the process_reg_step() method above
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update_reg_step(): bool
+	{
+		// save everything
+		if ($this->process_reg_step()) {
+			$this->checkout->redirect     = true;
+			$this->checkout->redirect_url = add_query_arg(
+				[
+					'e_reg_url_link' => $this->checkout->reg_url_link,
+					'revisit'        => true,
+				],
+				$this->checkout->thank_you_page_url
+			);
+			$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+			return true;
+		}
+		return false;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -54,11 +54,11 @@ 
 
     public function translate_js_strings()
     {
-        EE_Registry::$i18n_js_strings['required_field']            = esc_html__(
+        EE_Registry::$i18n_js_strings['required_field'] = esc_html__(
             ' is a required question.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['required_multi_field']      = esc_html__(
+        EE_Registry::$i18n_js_strings['required_multi_field'] = esc_html__(
             ' is a required question. Please enter a value for at least one of the options.',
             'event_espresso'
         );
@@ -66,7 +66,7 @@ 
             'Please answer all required questions correctly before proceeding.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['attendee_info_copied']      = sprintf(
+        EE_Registry::$i18n_js_strings['attendee_info_copied'] = sprintf(
             esc_html_x(
                 'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
                 'The attendee information was successfully copied.(line break)Please ensure the rest of the registration form is completed before proceeding.',
@@ -74,11 +74,11 @@ 
             ),
             '<br/>'
         );
-        EE_Registry::$i18n_js_strings['attendee_info_copy_error']  = esc_html__(
+        EE_Registry::$i18n_js_strings['attendee_info_copy_error'] = esc_html__(
             'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['enter_valid_email']         = esc_html__(
+        EE_Registry::$i18n_js_strings['enter_valid_email'] = esc_html__(
             'You must enter a valid email address.',
             'event_espresso'
         );
@@ -603,7 +603,7 @@ 
         if (empty($valid_data)) {
             return $this->inValidDataError();
         }
-        if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
+        if ( ! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
             return $this->inValidTransactionError();
         }
         // get cached registrations
@@ -615,14 +615,14 @@ 
         /** @var RegFormHandler $reg_form_handler */
         $reg_form_handler = LoaderFactory::getNew(RegFormHandler::class, [$this->checkout]);
         // extract attendee info from form data and save to model objects
-        if (! $reg_form_handler->processRegistrations($registrations, $valid_data)) {
+        if ( ! $reg_form_handler->processRegistrations($registrations, $valid_data)) {
             // return immediately if the previous step exited early due to errors
             return false;
         }
         // if first pass thru SPCO,
         // then let's check processed registrations against the total number of tickets in the cart
         $registrations_processed = $reg_form_handler->attendeeCount();
-        if (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
+        if ( ! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
             return $this->registrationProcessingError($registrations_processed);
         }
         // mark this reg step as completed
@@ -799,7 +799,7 @@ 
                 '(line break)This can sometimes happen if too much time has been taken to complete the registration process.(line break)Please return to the (link)Event List(end link) and reselect your tickets. If the problem continues, please contact the site administrator.',
                 'event_espresso'
             ),
-            '<a href="' . get_post_type_archive_link(EspressoPostType::EVENTS) . '" >',
+            '<a href="'.get_post_type_archive_link(EspressoPostType::EVENTS).'" >',
             '</a>',
             '<br />'
         );

admin_pages/venues/Venues_Admin_Page.core.php

Indentation +1547 added lines, -1547 removed lines

@@ -14,1557 +14,1557 @@
  */
 class Venues_Admin_Page extends EE_Admin_Page_CPT
 {
-    /**
-     * primary key for the venue model
-     */
-    private int $VNU_ID = 0;
-
-    /**
-     * This will hold the venue object for venue_details screen.
-     *
-     * @var EE_Venue|EE_CPT_Base|null $_cpt_model_obj
-     */
-    protected $_cpt_model_obj;
-
-
-    /**
-     * This will hold the category object for category_details screen.
-     *
-     * @var stdClass|null $_category
-     */
-    protected ?stdClass $_category = null;
-
-
-    /**
-     * This property will hold the venue model instance
-     *
-     * @var EEM_Venue|null $_venue_model
-     */
-    protected ?EEM_Venue $_venue_model = null;
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _init_page_props()
-    {
-        // is there a vnu_id in the request?
-        $this->VNU_ID = $this->request->getRequestParam('VNU_ID', 0, DataType::INT);
-        $this->VNU_ID = $this->request->getRequestParam('post', $this->VNU_ID, DataType::INT);
-        $this->VNU_ID = $this->request->getRequestParam('post_ID', $this->VNU_ID, DataType::INT);
-
-        $this->page_slug        = EE_VENUES_PG_SLUG;
-        $this->_admin_base_url  = EE_VENUES_ADMIN_URL;
-        $this->_admin_base_path = EE_ADMIN_PAGES . 'venues';
-        $this->page_label       = esc_html__('Event Venues', 'event_espresso');
-        $this->_cpt_model_names = [
-            'create_new' => 'EEM_Venue',
-            'edit'       => 'EEM_Venue',
-        ];
-        $this->_cpt_edit_routes = [
-            'espresso_venues' => 'edit',
-        ];
-        $this->_venue_model     = EEM_Venue::instance();
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        // todo: all hooks for ee_venues ajax goes in here.
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = [
-            'buttons'      => [
-                'add'             => esc_html__('Add New Venue', 'event_espresso'),
-                'edit'            => esc_html__('Edit Venue', 'event_espresso'),
-                'delete'          => esc_html__('Delete Venue', 'event_espresso'),
-                'add_category'    => esc_html__('Add New Category', 'event_espresso'),
-                'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
-                'delete_category' => esc_html__('Delete Category', 'event_espresso'),
-            ],
-            'editor_title' => [
-                'espresso_venues' => esc_html__('Edit Venue', 'event_espresso'),
-            ],
-            'publishbox'   => [
-                'create_new'          => esc_html__('Save New Venue', 'event_espresso'),
-                'edit'                => esc_html__('Update Venue', 'event_espresso'),
-                'add_category'        => esc_html__('Save New Category', 'event_espresso'),
-                'edit_category'       => esc_html__('Update Category', 'event_espresso'),
-                'google_map_settings' => esc_html__('Update Settings', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    protected function _set_page_routes()
-    {
-        // load formatter helper
-        // load field generator helper
-
-
-        $this->_page_routes = [
-            'default'                    => [
-                'func'       => [$this, '_overview_list_table'],
-                'capability' => 'ee_read_venues',
-            ],
-            'create_new'                 => [
-                'func'       => [$this, '_create_new_cpt_item'],
-                'capability' => 'ee_edit_venues',
-            ],
-            'edit'                       => [
-                'func'       => [$this, '_edit_cpt_item'],
-                'capability' => 'ee_edit_venue',
-                'obj_id'     => $this->VNU_ID,
-            ],
-            'trash_venue'                => [
-                'func'       => [$this, '_trash_or_restore_venue'],
-                'args'       => ['venue_status' => 'trash'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue',
-                'obj_id'     => $this->VNU_ID,
-            ],
-            'trash_venues'               => [
-                'func'       => [$this, '_trash_or_restore_venues'],
-                'args'       => ['venue_status' => 'trash'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venues',
-            ],
-            'restore_venue'              => [
-                'func'       => [$this, '_trash_or_restore_venue'],
-                'args'       => ['venue_status' => 'draft'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue',
-                'obj_id'     => $this->VNU_ID,
-            ],
-            'restore_venues'             => [
-                'func'       => [$this, '_trash_or_restore_venues'],
-                'args'       => ['venue_status' => 'draft'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venues',
-            ],
-            'delete_venues'              => [
-                'func'       => [$this, '_delete_venues'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venues',
-            ],
-            'delete_venue'               => [
-                'func'       => [$this, '_delete_venue'],
-                'args'       => ['redirect_after' => true],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue',
-                'obj_id'     => $this->VNU_ID,
-            ],
-            // settings related
-            'google_map_settings'        => [
-                'func'       => [$this, '_google_map_settings'],
-                'capability' => 'manage_options',
-            ],
-            'update_google_map_settings' => [
-                'func'       => [$this, '_update_google_map_settings'],
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            // venue category tab related
-            'add_category'               => [
-                'func'       => [$this, '_category_details'],
-                'args'       => ['add'],
-                'capability' => 'ee_edit_venue_category',
-            ],
-            'edit_category'              => [
-                'func'       => [$this, '_category_details'],
-                'args'       => ['edit'],
-                'capability' => 'ee_edit_venue_category',
-            ],
-            'delete_categories'          => [
-                'func'       => [$this, '_delete_categories'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue_category',
-            ],
-
-            'delete_category' => [
-                'func'       => [$this, '_delete_categories'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue_category',
-            ],
-
-            'insert_category' => [
-                'func'       => [$this, '_insert_or_update_category'],
-                'args'       => ['new_category' => true],
-                'noheader'   => true,
-                'capability' => 'ee_edit_venue_category',
-            ],
-
-            'update_category'   => [
-                'func'       => [$this, '_insert_or_update_category'],
-                'args'       => ['new_category' => false],
-                'noheader'   => true,
-                'capability' => 'ee_edit_venue_category',
-            ],
-            'export_categories' => [
-                'func'       => [$this, '_categories_export'],
-                'noheader'   => true,
-                'capability' => 'export',
-            ],
-            'import_categories' => [
-                'func'       => [$this, '_import_categories'],
-                'capability' => 'import',
-            ],
-            'category_list'     => [
-                'func'       => [$this, '_category_list_table'],
-                'capability' => 'ee_manage_venue_categories',
-            ],
-        ];
-    }
-
-
-    protected function _set_page_config()
-    {
-        $EVT_CAT_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
-        $help_tabs  = [
-            'venues_editor_help_tab'                                               => [
-                'title'    => esc_html__('Venue Editor', 'event_espresso'),
-                'filename' => 'venues_editor',
-            ],
-            'venues_editor_title_richtexteditor_help_tab'                          => [
-                'title'    => esc_html__('Venue Title & Rich Text Editor', 'event_espresso'),
-                'filename' => 'venues_editor_title_richtexteditor',
-            ],
-            'venues_editor_tags_categories_help_tab'                               => [
-                'title'    => esc_html__('Venue Tags & Categories', 'event_espresso'),
-                'filename' => 'venues_editor_tags_categories',
-            ],
-            'venues_editor_physical_location_google_map_virtual_location_help_tab' => [
-                'title'    => esc_html__(
-                    'Venue Editor Physical Location & Google Map & Virtual Location',
-                    'event_espresso'
-                ),
-                'filename' => 'venues_editor_physical_location_google_map_virtual_location',
-            ],
-            'venues_editor_save_new_venue_help_tab'                                => [
-                'title'    => esc_html__('Save New Venue', 'event_espresso'),
-                'filename' => 'venues_editor_save_new_venue',
-            ],
-            'venues_editor_other_help_tab'                                         => [
-                'title'    => esc_html__('Venue Editor Other', 'event_espresso'),
-                'filename' => 'venues_editor_other',
-            ],
-        ];
-
-        $this->_page_config = [
-            'default'             => [
-                'nav'           => [
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'icon'  => 'dashicons-list-view',
-                    'order' => 10,
-                ],
-                'list_table'    => 'Venues_Admin_List_Table',
-                'help_tabs'     => [
-                    'venues_overview_help_tab'                           => [
-                        'title'    => esc_html__('Venues Overview', 'event_espresso'),
-                        'filename' => 'venues_overview',
-                    ],
-                    'venues_overview_table_column_headings_help_tab'     => [
-                        'title'    => esc_html__('Venues Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'venues_overview_table_column_headings',
-                    ],
-                    'venues_overview_views_bulk_actions_search_help_tab' => [
-                        'title'    => esc_html__('Venues Overview Views & Bulk Actions & Search', 'event_espresso'),
-                        'filename' => 'venues_overview_views_bulk_actions_search',
-                    ],
-                ],
-                'metaboxes'     => ['_espresso_news_post_box', '_espresso_links_post_box'],
-                'require_nonce' => false,
-            ],
-            'create_new'          => [
-                'nav'           => [
-                    'label'      => esc_html__('Add Venue', 'event_espresso'),
-                    'icon'       => 'dashicons-plus-alt',
-                    'order'      => 15,
-                    'persistent' => false,
-                ],
-                'help_tabs'     => $help_tabs,
-                'metaboxes'     => ['_venue_editor_metaboxes'],
-                'require_nonce' => false,
-            ],
-            'edit'                => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Venue', 'event_espresso'),
-                    'icon'       => 'dashicons-edit-large',
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => $this->VNU_ID
-                        ? add_query_arg(['post' => $this->VNU_ID], $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                ],
-                'help_tabs'     => $help_tabs,
-                'metaboxes'     => ['_venue_editor_metaboxes'],
-                'require_nonce' => false,
-            ],
-            'google_map_settings' => [
-                'nav'           => [
-                    'label' => esc_html__('Google Maps', 'event_espresso'),
-                    'icon'  => 'dashicons-location-alt',
-                    'order' => 40,
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'help_tabs'     => [
-                    'general_settings_google_maps_help_tab' => [
-                        'title'    => esc_html__('Google Maps', 'event_espresso'),
-                        'filename' => 'general_settings_google_maps',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            // venue category stuff
-            'add_category'        => [
-                'nav'           => [
-                    'label'      => esc_html__('Add Category', 'event_espresso'),
-                    'icon'       => 'dashicons-plus-alt',
-                    'order'      => 25,
-                    'persistent' => false,
-                ],
-                'metaboxes'     => ['_publish_post_box'],
-                'help_tabs'     => [
-                    'venues_add_category_help_tab' => [
-                        'title'    => esc_html__('Add New Venue Category', 'event_espresso'),
-                        'filename' => 'venues_add_category',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'edit_category'       => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Category', 'event_espresso'),
-                    'icon'       => 'dashicons-edit-large',
-                    'order'      => 25,
-                    'persistent' => false,
-                    'url'        => $EVT_CAT_ID
-                        ? add_query_arg(['EVT_CAT_ID' => $EVT_CAT_ID], $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                ],
-                'metaboxes'     => ['_publish_post_box'],
-                'help_tabs'     => [
-                    'venues_edit_category_help_tab' => [
-                        'title'    => esc_html__('Edit Venue Category', 'event_espresso'),
-                        'filename' => 'venues_edit_category',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'category_list'       => [
-                'nav'           => [
-                    'label' => esc_html__('Categories', 'event_espresso'),
-                    'icon'  => 'dashicons-networking',
-                    'order' => 20,
-                ],
-                'list_table'    => 'Venue_Categories_Admin_List_Table',
-                'help_tabs'     => [
-                    'venues_categories_help_tab'                       => [
-                        'title'    => esc_html__('Venue Categories', 'event_espresso'),
-                        'filename' => 'venues_categories',
-                    ],
-                    'venues_categories_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Venue Categories Table Column Headings', 'event_espresso'),
-                        'filename' => 'venues_categories_table_column_headings',
-                    ],
-                    'venues_categories_views_help_tab'                 => [
-                        'title'    => esc_html__('Venue Categories Views', 'event_espresso'),
-                        'filename' => 'venues_categories_views',
-                    ],
-                    'venues_categories_other_help_tab'                 => [
-                        'title'    => esc_html__('Venue Categories Other', 'event_espresso'),
-                        'filename' => 'venues_categories_other',
-                    ],
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    protected function _add_screen_options()
-    {
-        // todo
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    protected function _add_screen_options_category_list()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Venue Categories', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    // none of the below group are currently used for Event Venues
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles_create_new()
-    {
-        $this->load_scripts_styles_edit();
-    }
-
-
-    public function load_scripts_styles()
-    {
-        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', [], EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('ee-cat-admin');
-    }
-
-
-    public function load_scripts_styles_add_category()
-    {
-        $this->load_scripts_styles_edit_category();
-    }
-
-
-    public function load_scripts_styles_edit_category()
-    {
-    }
-
-
-    public function load_scripts_styles_edit()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_register_style(
-            'espresso_venues',
-            EE_VENUES_ASSETS_URL . 'ee-venues-admin.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_venues');
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Venues', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [],
-            ],
-        ];
-
-        if ($this->capabilities->current_user_can('ee_delete_venues', 'espresso_venues_trash_venues')) {
-            $this->_views['all']['bulk_action'] = [
-                'trash_venues' => esc_html__('Move to Trash', 'event_espresso'),
-            ];
-            $this->_views['trash']              = [
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'restore_venues' => esc_html__('Restore from Trash', 'event_espresso'),
-                    'delete_venues'  => esc_html__('Delete', 'event_espresso'),
-                ],
-            ];
-        }
-    }
-
-
-    protected function _set_list_table_views_category_list()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ],
-        ];
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _overview_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_template_args['after_list_table'] = EEH_Template::get_button_or_link(
-            get_post_type_archive_link(EspressoPostType::VENUES),
-            esc_html__("View Venue Archive Page", "event_espresso"),
-            'button'
-        );
-
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-                'create_new',
-                'add',
-                [],
-                'add-new-h2'
-            );
-
-        $this->_search_btn_label = esc_html__('Venues', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function extra_misc_actions_publish_box()
-    {
-        $extra_rows = [
-            'vnu_capacity' => $this->_cpt_model_obj->get_f('VNU_capacity'),
-            'vnu_url'      => $this->_cpt_model_obj->get_f('VNU_url'),
-            'vnu_phone'    => $this->_cpt_model_obj->get_f('VNU_phone'),
-        ];
-        $template   = EE_VENUES_TEMPLATE_PATH . 'venue_publish_box_extras.template.php';
-        EEH_Template::display_template($template, $extra_rows);
-    }
-
-
-    /*************        Google Maps        *************
+	/**
+	 * primary key for the venue model
+	 */
+	private int $VNU_ID = 0;
+
+	/**
+	 * This will hold the venue object for venue_details screen.
+	 *
+	 * @var EE_Venue|EE_CPT_Base|null $_cpt_model_obj
+	 */
+	protected $_cpt_model_obj;
+
+
+	/**
+	 * This will hold the category object for category_details screen.
+	 *
+	 * @var stdClass|null $_category
+	 */
+	protected ?stdClass $_category = null;
+
+
+	/**
+	 * This property will hold the venue model instance
+	 *
+	 * @var EEM_Venue|null $_venue_model
+	 */
+	protected ?EEM_Venue $_venue_model = null;
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _init_page_props()
+	{
+		// is there a vnu_id in the request?
+		$this->VNU_ID = $this->request->getRequestParam('VNU_ID', 0, DataType::INT);
+		$this->VNU_ID = $this->request->getRequestParam('post', $this->VNU_ID, DataType::INT);
+		$this->VNU_ID = $this->request->getRequestParam('post_ID', $this->VNU_ID, DataType::INT);
+
+		$this->page_slug        = EE_VENUES_PG_SLUG;
+		$this->_admin_base_url  = EE_VENUES_ADMIN_URL;
+		$this->_admin_base_path = EE_ADMIN_PAGES . 'venues';
+		$this->page_label       = esc_html__('Event Venues', 'event_espresso');
+		$this->_cpt_model_names = [
+			'create_new' => 'EEM_Venue',
+			'edit'       => 'EEM_Venue',
+		];
+		$this->_cpt_edit_routes = [
+			'espresso_venues' => 'edit',
+		];
+		$this->_venue_model     = EEM_Venue::instance();
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		// todo: all hooks for ee_venues ajax goes in here.
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = [
+			'buttons'      => [
+				'add'             => esc_html__('Add New Venue', 'event_espresso'),
+				'edit'            => esc_html__('Edit Venue', 'event_espresso'),
+				'delete'          => esc_html__('Delete Venue', 'event_espresso'),
+				'add_category'    => esc_html__('Add New Category', 'event_espresso'),
+				'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
+				'delete_category' => esc_html__('Delete Category', 'event_espresso'),
+			],
+			'editor_title' => [
+				'espresso_venues' => esc_html__('Edit Venue', 'event_espresso'),
+			],
+			'publishbox'   => [
+				'create_new'          => esc_html__('Save New Venue', 'event_espresso'),
+				'edit'                => esc_html__('Update Venue', 'event_espresso'),
+				'add_category'        => esc_html__('Save New Category', 'event_espresso'),
+				'edit_category'       => esc_html__('Update Category', 'event_espresso'),
+				'google_map_settings' => esc_html__('Update Settings', 'event_espresso'),
+			],
+		];
+	}
+
+
+	protected function _set_page_routes()
+	{
+		// load formatter helper
+		// load field generator helper
+
+
+		$this->_page_routes = [
+			'default'                    => [
+				'func'       => [$this, '_overview_list_table'],
+				'capability' => 'ee_read_venues',
+			],
+			'create_new'                 => [
+				'func'       => [$this, '_create_new_cpt_item'],
+				'capability' => 'ee_edit_venues',
+			],
+			'edit'                       => [
+				'func'       => [$this, '_edit_cpt_item'],
+				'capability' => 'ee_edit_venue',
+				'obj_id'     => $this->VNU_ID,
+			],
+			'trash_venue'                => [
+				'func'       => [$this, '_trash_or_restore_venue'],
+				'args'       => ['venue_status' => 'trash'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue',
+				'obj_id'     => $this->VNU_ID,
+			],
+			'trash_venues'               => [
+				'func'       => [$this, '_trash_or_restore_venues'],
+				'args'       => ['venue_status' => 'trash'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venues',
+			],
+			'restore_venue'              => [
+				'func'       => [$this, '_trash_or_restore_venue'],
+				'args'       => ['venue_status' => 'draft'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue',
+				'obj_id'     => $this->VNU_ID,
+			],
+			'restore_venues'             => [
+				'func'       => [$this, '_trash_or_restore_venues'],
+				'args'       => ['venue_status' => 'draft'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venues',
+			],
+			'delete_venues'              => [
+				'func'       => [$this, '_delete_venues'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venues',
+			],
+			'delete_venue'               => [
+				'func'       => [$this, '_delete_venue'],
+				'args'       => ['redirect_after' => true],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue',
+				'obj_id'     => $this->VNU_ID,
+			],
+			// settings related
+			'google_map_settings'        => [
+				'func'       => [$this, '_google_map_settings'],
+				'capability' => 'manage_options',
+			],
+			'update_google_map_settings' => [
+				'func'       => [$this, '_update_google_map_settings'],
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			// venue category tab related
+			'add_category'               => [
+				'func'       => [$this, '_category_details'],
+				'args'       => ['add'],
+				'capability' => 'ee_edit_venue_category',
+			],
+			'edit_category'              => [
+				'func'       => [$this, '_category_details'],
+				'args'       => ['edit'],
+				'capability' => 'ee_edit_venue_category',
+			],
+			'delete_categories'          => [
+				'func'       => [$this, '_delete_categories'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue_category',
+			],
+
+			'delete_category' => [
+				'func'       => [$this, '_delete_categories'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue_category',
+			],
+
+			'insert_category' => [
+				'func'       => [$this, '_insert_or_update_category'],
+				'args'       => ['new_category' => true],
+				'noheader'   => true,
+				'capability' => 'ee_edit_venue_category',
+			],
+
+			'update_category'   => [
+				'func'       => [$this, '_insert_or_update_category'],
+				'args'       => ['new_category' => false],
+				'noheader'   => true,
+				'capability' => 'ee_edit_venue_category',
+			],
+			'export_categories' => [
+				'func'       => [$this, '_categories_export'],
+				'noheader'   => true,
+				'capability' => 'export',
+			],
+			'import_categories' => [
+				'func'       => [$this, '_import_categories'],
+				'capability' => 'import',
+			],
+			'category_list'     => [
+				'func'       => [$this, '_category_list_table'],
+				'capability' => 'ee_manage_venue_categories',
+			],
+		];
+	}
+
+
+	protected function _set_page_config()
+	{
+		$EVT_CAT_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
+		$help_tabs  = [
+			'venues_editor_help_tab'                                               => [
+				'title'    => esc_html__('Venue Editor', 'event_espresso'),
+				'filename' => 'venues_editor',
+			],
+			'venues_editor_title_richtexteditor_help_tab'                          => [
+				'title'    => esc_html__('Venue Title & Rich Text Editor', 'event_espresso'),
+				'filename' => 'venues_editor_title_richtexteditor',
+			],
+			'venues_editor_tags_categories_help_tab'                               => [
+				'title'    => esc_html__('Venue Tags & Categories', 'event_espresso'),
+				'filename' => 'venues_editor_tags_categories',
+			],
+			'venues_editor_physical_location_google_map_virtual_location_help_tab' => [
+				'title'    => esc_html__(
+					'Venue Editor Physical Location & Google Map & Virtual Location',
+					'event_espresso'
+				),
+				'filename' => 'venues_editor_physical_location_google_map_virtual_location',
+			],
+			'venues_editor_save_new_venue_help_tab'                                => [
+				'title'    => esc_html__('Save New Venue', 'event_espresso'),
+				'filename' => 'venues_editor_save_new_venue',
+			],
+			'venues_editor_other_help_tab'                                         => [
+				'title'    => esc_html__('Venue Editor Other', 'event_espresso'),
+				'filename' => 'venues_editor_other',
+			],
+		];
+
+		$this->_page_config = [
+			'default'             => [
+				'nav'           => [
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'icon'  => 'dashicons-list-view',
+					'order' => 10,
+				],
+				'list_table'    => 'Venues_Admin_List_Table',
+				'help_tabs'     => [
+					'venues_overview_help_tab'                           => [
+						'title'    => esc_html__('Venues Overview', 'event_espresso'),
+						'filename' => 'venues_overview',
+					],
+					'venues_overview_table_column_headings_help_tab'     => [
+						'title'    => esc_html__('Venues Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'venues_overview_table_column_headings',
+					],
+					'venues_overview_views_bulk_actions_search_help_tab' => [
+						'title'    => esc_html__('Venues Overview Views & Bulk Actions & Search', 'event_espresso'),
+						'filename' => 'venues_overview_views_bulk_actions_search',
+					],
+				],
+				'metaboxes'     => ['_espresso_news_post_box', '_espresso_links_post_box'],
+				'require_nonce' => false,
+			],
+			'create_new'          => [
+				'nav'           => [
+					'label'      => esc_html__('Add Venue', 'event_espresso'),
+					'icon'       => 'dashicons-plus-alt',
+					'order'      => 15,
+					'persistent' => false,
+				],
+				'help_tabs'     => $help_tabs,
+				'metaboxes'     => ['_venue_editor_metaboxes'],
+				'require_nonce' => false,
+			],
+			'edit'                => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Venue', 'event_espresso'),
+					'icon'       => 'dashicons-edit-large',
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => $this->VNU_ID
+						? add_query_arg(['post' => $this->VNU_ID], $this->_current_page_view_url)
+						: $this->_admin_base_url,
+				],
+				'help_tabs'     => $help_tabs,
+				'metaboxes'     => ['_venue_editor_metaboxes'],
+				'require_nonce' => false,
+			],
+			'google_map_settings' => [
+				'nav'           => [
+					'label' => esc_html__('Google Maps', 'event_espresso'),
+					'icon'  => 'dashicons-location-alt',
+					'order' => 40,
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'help_tabs'     => [
+					'general_settings_google_maps_help_tab' => [
+						'title'    => esc_html__('Google Maps', 'event_espresso'),
+						'filename' => 'general_settings_google_maps',
+					],
+				],
+				'require_nonce' => false,
+			],
+			// venue category stuff
+			'add_category'        => [
+				'nav'           => [
+					'label'      => esc_html__('Add Category', 'event_espresso'),
+					'icon'       => 'dashicons-plus-alt',
+					'order'      => 25,
+					'persistent' => false,
+				],
+				'metaboxes'     => ['_publish_post_box'],
+				'help_tabs'     => [
+					'venues_add_category_help_tab' => [
+						'title'    => esc_html__('Add New Venue Category', 'event_espresso'),
+						'filename' => 'venues_add_category',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'edit_category'       => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Category', 'event_espresso'),
+					'icon'       => 'dashicons-edit-large',
+					'order'      => 25,
+					'persistent' => false,
+					'url'        => $EVT_CAT_ID
+						? add_query_arg(['EVT_CAT_ID' => $EVT_CAT_ID], $this->_current_page_view_url)
+						: $this->_admin_base_url,
+				],
+				'metaboxes'     => ['_publish_post_box'],
+				'help_tabs'     => [
+					'venues_edit_category_help_tab' => [
+						'title'    => esc_html__('Edit Venue Category', 'event_espresso'),
+						'filename' => 'venues_edit_category',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'category_list'       => [
+				'nav'           => [
+					'label' => esc_html__('Categories', 'event_espresso'),
+					'icon'  => 'dashicons-networking',
+					'order' => 20,
+				],
+				'list_table'    => 'Venue_Categories_Admin_List_Table',
+				'help_tabs'     => [
+					'venues_categories_help_tab'                       => [
+						'title'    => esc_html__('Venue Categories', 'event_espresso'),
+						'filename' => 'venues_categories',
+					],
+					'venues_categories_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Venue Categories Table Column Headings', 'event_espresso'),
+						'filename' => 'venues_categories_table_column_headings',
+					],
+					'venues_categories_views_help_tab'                 => [
+						'title'    => esc_html__('Venue Categories Views', 'event_espresso'),
+						'filename' => 'venues_categories_views',
+					],
+					'venues_categories_other_help_tab'                 => [
+						'title'    => esc_html__('Venue Categories Other', 'event_espresso'),
+						'filename' => 'venues_categories_other',
+					],
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	protected function _add_screen_options()
+	{
+		// todo
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	protected function _add_screen_options_category_list()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Venue Categories', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	// none of the below group are currently used for Event Venues
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles_create_new()
+	{
+		$this->load_scripts_styles_edit();
+	}
+
+
+	public function load_scripts_styles()
+	{
+		wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', [], EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('ee-cat-admin');
+	}
+
+
+	public function load_scripts_styles_add_category()
+	{
+		$this->load_scripts_styles_edit_category();
+	}
+
+
+	public function load_scripts_styles_edit_category()
+	{
+	}
+
+
+	public function load_scripts_styles_edit()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_register_style(
+			'espresso_venues',
+			EE_VENUES_ASSETS_URL . 'ee-venues-admin.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_venues');
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Venues', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [],
+			],
+		];
+
+		if ($this->capabilities->current_user_can('ee_delete_venues', 'espresso_venues_trash_venues')) {
+			$this->_views['all']['bulk_action'] = [
+				'trash_venues' => esc_html__('Move to Trash', 'event_espresso'),
+			];
+			$this->_views['trash']              = [
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'restore_venues' => esc_html__('Restore from Trash', 'event_espresso'),
+					'delete_venues'  => esc_html__('Delete', 'event_espresso'),
+				],
+			];
+		}
+	}
+
+
+	protected function _set_list_table_views_category_list()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			],
+		];
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _overview_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_template_args['after_list_table'] = EEH_Template::get_button_or_link(
+			get_post_type_archive_link(EspressoPostType::VENUES),
+			esc_html__("View Venue Archive Page", "event_espresso"),
+			'button'
+		);
+
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+				'create_new',
+				'add',
+				[],
+				'add-new-h2'
+			);
+
+		$this->_search_btn_label = esc_html__('Venues', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function extra_misc_actions_publish_box()
+	{
+		$extra_rows = [
+			'vnu_capacity' => $this->_cpt_model_obj->get_f('VNU_capacity'),
+			'vnu_url'      => $this->_cpt_model_obj->get_f('VNU_url'),
+			'vnu_phone'    => $this->_cpt_model_obj->get_f('VNU_phone'),
+		];
+		$template   = EE_VENUES_TEMPLATE_PATH . 'venue_publish_box_extras.template.php';
+		EEH_Template::display_template($template, $extra_rows);
+	}
+
+
+	/*************        Google Maps        *************
      *
      * @throws EE_Error
      * @throws EE_Error
      */
 
 
-    protected function _google_map_settings()
-    {
-        $this->_template_args['values']           = $this->_yes_no_values;
-        $default_map_settings                     = new stdClass();
-        $default_map_settings->use_google_maps    = true;
-        $default_map_settings->google_map_api_key = '';
-        // for event details pages (reg page)
-        $default_map_settings->event_details_map_width = 585;
-        // ee_map_width_single
-        $default_map_settings->event_details_map_height = 362;
-        // ee_map_height_single
-        $default_map_settings->event_details_map_zoom = 14;
-        // ee_map_zoom_single
-        $default_map_settings->event_details_display_nav = true;
-        // ee_map_nav_display_single
-        $default_map_settings->event_details_nav_size = false;
-        // ee_map_nav_size_single
-        $default_map_settings->event_details_control_type = 'default';
-        // ee_map_type_control_single
-        $default_map_settings->event_details_map_align = 'center';
-        // ee_map_align_single
-
-        // for event list pages
-        $default_map_settings->event_list_map_width = 300;
-        // ee_map_width
-        $default_map_settings->event_list_map_height = 185;
-        // ee_map_height
-        $default_map_settings->event_list_map_zoom = 12;
-        // ee_map_zoom
-        $default_map_settings->event_list_display_nav = false;
-        // ee_map_nav_display
-        $default_map_settings->event_list_nav_size = true;
-        // ee_map_nav_size
-        $default_map_settings->event_list_control_type = 'dropdown';
-        // ee_map_type_control
-        $default_map_settings->event_list_map_align = 'center';
-        // ee_map_align
-
-        $this->_template_args['map_settings'] =
-            isset(EE_Registry::instance()->CFG->map_settings)
-            && ! empty(EE_Registry::instance()->CFG->map_settings)
-                ? (object) array_merge(
-                (array) $default_map_settings,
-                (array) EE_Registry::instance()->CFG->map_settings
-            )
-                : $default_map_settings;
-
-        $this->_set_add_edit_form_tags('update_google_map_settings');
-        $this->_set_publish_post_box_vars();
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_VENUES_TEMPLATE_PATH . 'google_map.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _update_google_map_settings()
-    {
-        $map_settings = EE_Registry::instance()->CFG->map_settings;
-
-        $settings = [
-            'use_google_maps'            => 'int',
-            'google_map_api_key'         => 'string',
-            'event_details_map_width'    => 'int',
-            'event_details_map_zoom'     => 'int',
-            'event_details_display_nav'  => 'int',
-            'event_details_nav_size'     => 'int',
-            'event_details_control_type' => 'string',
-            'event_details_map_align'    => 'string',
-            'event_list_map_width'       => 'int',
-            'event_list_map_height'      => 'int',
-            'event_list_map_zoom'        => 'int',
-            'event_list_display_nav'     => 'int',
-            'event_list_nav_size'        => 'int',
-            'event_list_control_type'    => 'string',
-            'event_list_map_align'       => 'string',
-        ];
-
-        foreach ($settings as $setting => $type) {
-            $map_settings->{$setting} = $this->request->getRequestParam($setting, $map_settings->{$setting}, $type);
-        }
-
-        EE_Registry::instance()->CFG->map_settings = apply_filters(
-            'FHEE__Extend_General_Settings_Admin_Page___update_google_map_settings__CFG_map_settings',
-            $map_settings
-        );
-
-        $what    = 'Google Map Settings';
-        $success = $this->_update_espresso_configuration(
-            $what,
-            EE_Registry::instance()->CFG->map_settings,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        $this->_redirect_after_action($success, $what, 'updated', ['action' => 'google_map_settings']);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _venue_editor_metaboxes()
-    {
-        $this->verify_cpt_object();
-
-        $this->addMetaBox(
-            'espresso_venue_address_options',
-            esc_html__('Physical Location', 'event_espresso'),
-            [$this, 'venue_address_metabox'],
-            $this->page_slug,
-            'side',
-            'core'
-        );
-        $this->addMetaBox(
-            'espresso_venue_gmap_options',
-            esc_html__('Google Map', 'event_espresso'),
-            [$this, 'venue_gmap_metabox'],
-            $this->page_slug,
-            'side'
-        );
-        $this->addMetaBox(
-            'espresso_venue_virtual_loc_options',
-            esc_html__('Virtual Location', 'event_espresso'),
-            [$this, 'venue_virtual_loc_metabox'],
-            $this->page_slug,
-            'side'
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function venue_gmap_metabox()
-    {
-        $template_args = [
-            'vnu_enable_for_gmap' => EEH_Form_Fields::select_input(
-                'vnu_enable_for_gmap',
-                $this->get_yes_no_values(),
-                $this->_cpt_model_obj instanceof EE_Venue && $this->_cpt_model_obj->enable_for_gmap()
-            ),
-            'vnu_google_map_link' => $this->_cpt_model_obj->google_map_link(),
-        ];
-        $template      = EE_VENUES_TEMPLATE_PATH . 'venue_gmap_metabox_content.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function venue_address_metabox()
-    {
-        $template_args['_venue'] = $this->_cpt_model_obj;
-
-        $template_args['states_dropdown']    = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    ['QST_display_text' => esc_html__('State', 'event_espresso'), 'QST_system' => 'state']
-                ),
-                EE_Answer::new_instance(
-                    [
-                        'ANS_value' => $this->_cpt_model_obj instanceof EE_Venue
-                            ? $this->_cpt_model_obj->state_ID()
-                            : 0,
-                    ]
-                ),
-                [
-                    'input_name'     => 'sta_id',
-                    'input_id'       => 'sta_id',
-                    'input_class'    => '',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                ]
-            )
-        );
-        $template_args['countries_dropdown'] = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    ['QST_display_text' => esc_html__('Country', 'event_espresso'), 'QST_system' => 'country']
-                ),
-                EE_Answer::new_instance(
-                    [
-                        'ANS_value' => $this->_cpt_model_obj instanceof EE_Venue
-                            ? $this->_cpt_model_obj->country_ID()
-                            : 0,
-                    ]
-                ),
-                [
-                    'input_name'     => 'cnt_iso',
-                    'input_id'       => 'cnt_iso',
-                    'input_class'    => '',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                ]
-            )
-        );
-
-        $template = EE_VENUES_TEMPLATE_PATH . 'venue_address_metabox_content.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    public function venue_virtual_loc_metabox()
-    {
-        $template_args = [
-            '_venue' => $this->_cpt_model_obj,
-        ];
-        $template      = EE_VENUES_TEMPLATE_PATH . 'venue_virtual_location_metabox_content.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _restore_cpt_item($post_id, $revision_id)
-    {
-        $this->_cpt_model_obj = $this->_venue_model->get_one_by_ID($post_id);
-        // meta revision restore
-        $this->_cpt_model_obj->restore_revision($revision_id);
-    }
-
-
-    /**
-     * Handles updates for venue cpts
-     *
-     * @param int     $post_id ID of Venue CPT
-     * @param WP_Post $post    Post object (with "blessed" WP properties)
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-        if ($post instanceof WP_Post && $post->post_type !== 'espresso_venues') {
-            return;// get out we're not processing the saving of venues.
-        }
-
-        $wheres = [$this->_venue_model->primary_key_name() => $post_id];
-
-        $venue_values = [
-            'VNU_address'         => $this->request->getRequestParam('vnu_address'),
-            'VNU_address2'        => $this->request->getRequestParam('vnu_address2'),
-            'VNU_city'            => $this->request->getRequestParam('vnu_city'),
-            'STA_ID'              => $this->request->getRequestParam('sta_id'),
-            'CNT_ISO'             => $this->request->getRequestParam('cnt_iso'),
-            'VNU_zip'             => $this->request->getRequestParam('vnu_zip'),
-            'VNU_phone'           => $this->request->getRequestParam('vnu_phone'),
-            'VNU_capacity'        => $this->request->requestParamIsSet('vnu_capacity')
-                ? str_replace(',', '', $this->request->getRequestParam('vnu_capacity'))
-                : EE_INF,
-            'VNU_url'             => $this->request->getRequestParam('vnu_url'),
-            'VNU_virtual_phone'   => $this->request->getRequestParam('vnu_virtual_phone'),
-            'VNU_virtual_url'     => $this->request->getRequestParam('vnu_virtual_url'),
-            'VNU_enable_for_gmap' => $this->request->getRequestParam('vnu_enable_for_gmap', false, 'bool'),
-            'VNU_google_map_link' => $this->request->getRequestParam('vnu_google_map_link'),
-        ];
-
-        // update venue
-        $success = $this->_venue_model->update($venue_values, [$wheres]);
-
-        // get venue_object for other metaboxes that might be added via the filter... though it would seem to make sense to just use $this->_venue_model->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
-        $get_one_where = [$this->_venue_model->primary_key_name() => $post_id, 'status' => $post->post_status];
-        $venue         = $this->_venue_model->get_one([$get_one_where]);
-
-        // notice we've applied a filter for venue metabox callbacks but we don't actually have any default venue metaboxes in use.  So this is just here for addons to more easily hook into venue saves.
-        $venue_update_callbacks = apply_filters(
-            'FHEE__Venues_Admin_Page___insert_update_cpt_item__venue_update_callbacks',
-            []
-        );
-        $att_success            = true;
-        foreach ($venue_update_callbacks as $v_callback) {
-            // if ANY of these updates fail then we want the appropriate global error message
-            $att_success = call_user_func_array($v_callback, [$venue, $this->request->requestParams()])
-                ? $att_success
-                : false;
-        }
-
-        // any errors?
-        if ($success && ! $att_success) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Venue Details saved successfully but something went wrong with saving attachments.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } elseif ($success === false) {
-            EE_Error::add_error(
-                esc_html__('Venue Details did not save successfully.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * @param int $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function trash_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('VNU_ID', $post_id);
-        $this->_trash_or_restore_venue('trash', false);
-    }
-
-
-    /**
-     * @param int $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function restore_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('VNU_ID', $post_id);
-        $this->_trash_or_restore_venue('draft', false);
-    }
-
-
-    /**
-     * @param int $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('VNU_ID', $post_id);
-        $this->_delete_venue(false);
-    }
-
-
-    public function get_venue_object()
-    {
-        return $this->_cpt_model_obj;
-    }
-
-
-    /**
-     * @param string    $venue_status
-     * @param bool|null $redirect_after
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_venue(string $venue_status = 'trash', ?bool $redirect_after = true)
-    {
-        // loop thru venues
-        if ($this->VNU_ID) {
-            // clean status
-            $venue_status = sanitize_key($venue_status);
-            // grab status
-            if (! empty($venue_status)) {
-                $success = $this->_change_venue_status($this->VNU_ID, $venue_status);
-            } else {
-                $success = false;
-                $msg     = esc_html__(
-                    'An error occurred. The venue could not be moved to the trash because a valid venue status was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. The venue could not be moved to the trash because a valid venue ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        $action = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Venue', $action, ['action' => 'default']);
-        }
-    }
-
-
-    /**
-     * @param string $venue_status
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_venues(string $venue_status = 'trash')
-    {
-        // clean status
-        $venue_status = sanitize_key($venue_status);
-        // grab status
-        if (! empty($venue_status)) {
-            $success = true;
-            // determine the event id and set to array.
-            $VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
-            // loop thru events
-            foreach ($VNU_IDs as $VNU_ID) {
-                if ($VNU_ID = absint($VNU_ID)) {
-                    $results = $this->_change_venue_status($VNU_ID, $venue_status);
-                    $success = $results !== false ? $success : false;
-                } else {
-                    $msg = sprintf(
-                        esc_html__(
-                            'An error occurred. Venue #%d could not be moved to the trash because a valid venue ID was not not supplied.',
-                            'event_espresso'
-                        ),
-                        $VNU_ID
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                    $success = false;
-                }
-            }
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. The venue could not be moved to the trash because a valid venue status was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $action  = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-        $this->_redirect_after_action($success, 'Venues', $action, ['action' => 'default']);
-    }
-
-
-    /**
-     * _trash_or_restore_venues
-     * //todo this is pretty much the same as the corresponding change_event_status method in Events_Admin_Page.  We
-     * should probably abstract this up to the EE_Admin_Page_CPT (or even EE_Admin_Page) and make this a common method
-     * accepting a certain number of params.
-     *
-     * @param int|null $VNU_ID
-     * @param string   $venue_status
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _change_venue_status(?int $VNU_ID = 0, string $venue_status = ''): bool
-    {
-        // grab venue id
-        if (! $VNU_ID) {
-            $msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-        $this->_cpt_model_obj = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
-
-        // clean status
-        $venue_status = sanitize_key($venue_status);
-        // grab status
-        if (! $venue_status) {
-            $msg = esc_html__(
-                'An error occurred. No Venue Status or an invalid Venue Status was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-        // was event trashed or restored ?
-        switch ($venue_status) {
-            case 'draft':
-                $action = 'restored from the trash';
-                $hook   = 'AHEE_venue_restored_from_trash';
-                break;
-            case 'trash':
-                $action = 'moved to the trash';
-                $hook   = 'AHEE_venue_moved_to_trash';
-                break;
-            default:
-                $action = 'updated';
-                $hook   = false;
-        }
-        // use class to change status
-        $this->_cpt_model_obj->set_status($venue_status);
-        $success = $this->_cpt_model_obj->save();
-
-        if ($success === false) {
-            $msg = sprintf(esc_html__('An error occurred. The venue could not be %s.', 'event_espresso'), $action);
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if ($hook) {
-            do_action($hook);
-        }
-        return true;
-    }
-
-
-    /**
-     * @param bool $redirect_after
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_venue(bool $redirect_after = true)
-    {
-        // loop thru venues
-        if ($this->VNU_ID) {
-            $success = $this->_delete_or_trash_venue($this->VNU_ID);
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Venue', 'deleted', ['action' => 'default']);
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_venues()
-    {
-        $success = true;
-        // determine the event id and set to array.
-        $VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
-        // loop thru events
-        foreach ($VNU_IDs as $VNU_ID) {
-            if ($VNU_ID = absint($VNU_ID)) {
-                $results = $this->_delete_or_trash_venue($VNU_ID);
-                $success = $results !== false ? $success : false;
-            } else {
-                $success = false;
-                $msg     = esc_html__(
-                    'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $this->_redirect_after_action(
-            $success,
-            esc_html__('Venues', 'event_espresso'),
-            esc_html__('deleted', 'event_espresso'),
-            ['action' => 'default']
-        );
-    }
-
-
-    // todo: put in parent
-
-
-    /**
-     * @param int|null $VNU_ID
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _delete_or_trash_venue(?int $VNU_ID = 0): bool
-    {
-        // grab event id
-        if (! $VNU_ID = absint($VNU_ID)) {
-            $msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-
-        $venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
-        // first need to remove all term relationships
-        $venue->_remove_relations('Term_Taxonomy');
-        $success = $venue->delete_permanently();
-        // did it all go as planned ?
-        if (! $success) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('An error occurred. Venue ID # %d could not be deleted.', 'event_espresso'),
-                    $VNU_ID
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        EE_Error::add_success(
-            sprintf(esc_html__('Venue ID # %d has been deleted.', 'event_espresso'), $VNU_ID)
-        );
-        do_action('AHEE__Venues_Admin_Page___delete_or_trash_venue__after_venue_deleted');
-        return true;
-    }
-
-
-
-
-    /***********/
-    /* QUERIES */
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_venues($per_page = 10, $count = false)
-    {
-        $orderby = $this->request->getRequestParam('orderby', '');
-
-        switch ($orderby) {
-            case 'id':
-                $orderby = 'VNU_ID';
-                break;
-
-            case 'capacity':
-                $orderby = 'VNU_capacity';
-                break;
-
-            case 'city':
-                $orderby = 'VNU_city';
-                break;
-
-            default:
-                $orderby = 'VNU_name';
-        }
-
-        $sort         = $this->request->getRequestParam('order', 'ASC');
-        $current_page = $this->request->getRequestParam('paged', 1, 'int');
-        $per_page     = ! empty($per_page) ? $per_page : 10;
-        $per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = [$offset, $per_page];
-
-        $category = $this->request->getRequestParam('category');
-        $category = $category > 0 ? $category : null;
-
-        $where = [];
-
-        // only set initial status if it is in the incoming request.  Otherwise the "all" view display's all statuses.
-        $status = $this->request->getRequestParam('status');
-        if ($status && $status !== 'all') {
-            $where['status'] = $status;
-        }
-
-        $venue_status = $this->request->getRequestParam('venue_status');
-        if ($venue_status) {
-            $where['status'] = $venue_status;
-        }
-
-
-        if ($category) {
-            $where['Term_Taxonomy.taxonomy'] = 'espresso_venue_categories';
-            $where['Term_Taxonomy.term_id']  = $category;
-        }
-
-
-        if (! $this->capabilities->current_user_can('ee_read_others_venues', 'get_venues')) {
-            $where['VNU_wp_user'] = get_current_user_id();
-        } else {
-            if (! $this->capabilities->current_user_can('ee_read_private_venues', 'get_venues')) {
-                $where['OR'] = [
-                    'status*restrict_private' => ['!=', 'private'],
-                    'AND'                     => [
-                        'status*inclusive' => ['=', 'private'],
-                        'VNU_wp_user'      => get_current_user_id(),
-                    ],
-                ];
-            }
-        }
-
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $where['OR'] = [
-                'VNU_name'               => ['LIKE', $search_term],
-                'VNU_desc'               => ['LIKE', $search_term],
-                'VNU_short_desc'         => ['LIKE', $search_term],
-                'VNU_address'            => ['LIKE', $search_term],
-                'VNU_address2'           => ['LIKE', $search_term],
-                'VNU_city'               => ['LIKE', $search_term],
-                'VNU_zip'                => ['LIKE', $search_term],
-                'VNU_phone'              => ['LIKE', $search_term],
-                'VNU_url'                => ['LIKE', $search_term],
-                'VNU_virtual_phone'      => ['LIKE', $search_term],
-                'VNU_virtual_url'        => ['LIKE', $search_term],
-                'VNU_google_map_link'    => ['LIKE', $search_term],
-                'Event.EVT_name'         => ['LIKE', $search_term],
-                'Event.EVT_desc'         => ['LIKE', $search_term],
-                'Event.EVT_phone'        => ['LIKE', $search_term],
-                'Event.EVT_external_URL' => ['LIKE', $search_term],
-            ];
-        }
-
-
-        return $count
-            ? $this->_venue_model->count([$where], 'VNU_ID')
-            : $this->_venue_model->get_all(
-                [$where, 'limit' => $limit, 'order_by' => $orderby, 'order' => $sort]
-            );
-    }
-
-
-
-
-    /** Venue Category Stuff **/
-
-    /**
-     * set the _category property with the category object for the loaded page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_category_object()
-    {
-        if (isset($this->_category->id) && ! empty($this->_category->id)) {
-            return;
-        } // already have the category object so get out.
-
-        // set default category object
-        $this->_set_empty_category_object();
-
-        // only set if we've got an id
-        $category_ID = $this->request->getRequestParam('VEN_CAT_ID', 0, 'int');
-        if (! $category_ID) {
-            return;
-        }
-
-        $term = get_term($category_ID, 'espresso_venue_categories');
-
-
-        if (! empty($term)) {
-            $this->_category->category_name       = $term->name;
-            $this->_category->category_identifier = $term->slug;
-            $this->_category->category_desc       = $term->description;
-            $this->_category->id                  = $term->term_id;
-            $this->_category->parent              = $term->parent;
-        }
-    }
-
-
-    private function _set_empty_category_object()
-    {
-        $this->_category                = new stdClass();
-        $this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
-        $this->_category->id            = $this->_category->parent = 0;
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _category_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-                'add_category',
-                'add_category',
-                [],
-                'add-new-h2'
-            );
-        $this->_search_btn_label = esc_html__('Venue Categories', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _category_details($view)
-    {
-        // load formatter helper
-        // load field generator helper
-
-        $route = $view == 'edit' ? 'update_category' : 'insert_category';
-        $this->_set_add_edit_form_tags($route);
-
-        $this->_set_category_object();
-        $id = ! empty($this->_category->id) ? $this->_category->id : '';
-
-        $delete_action = 'delete_category';
-
-        $redirect = EE_Admin_Page::add_query_args_and_nonce(['action' => 'category_list'], $this->_admin_base_url);
-
-        $this->_set_publish_post_box_vars('VEN_CAT_ID', $id, $delete_action, $redirect);
-
-        // take care of contents
-        $this->_template_args['admin_page_content'] = $this->_category_details_content();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    protected function _category_details_content(): string
-    {
-        $editor_args['category_desc'] = [
-            'type'          => 'wp_editor',
-            'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
-            'class'         => 'my_editor_custom',
-            'wpeditor_args' => ['media_buttons' => false],
-        ];
-        $_wp_editor                   = $this->_generate_admin_form_fields($editor_args, 'array');
-
-        $all_terms = get_terms(
-            ['espresso_venue_categories'],
-            ['hide_empty' => 0, 'exclude' => [$this->_category->id]]
-        );
-
-        // setup category select for term parents.
-        $category_select_values[] = [
-            'text' => esc_html__('No Parent', 'event_espresso'),
-            'id'   => 0,
-        ];
-        foreach ($all_terms as $term) {
-            $category_select_values[] = [
-                'text' => $term->name,
-                'id'   => $term->term_id,
-            ];
-        }
-
-        $category_select = EEH_Form_Fields::select_input(
-            'category_parent',
-            $category_select_values,
-            $this->_category->parent
-        );
-        $template_args   = [
-            'category'                 => $this->_category,
-            'category_select'          => $category_select,
-            'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
-            'category_desc_editor'     => $_wp_editor['category_desc']['field'],
-            'disable'                  => '',
-            'disabled_message'         => false,
-        ];
-        $template        = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _delete_categories()
-    {
-        $category_ID  = $this->request->getRequestParam('category_id', 0, 'int');
-        $category_IDs = $this->request->getRequestParam('VEN_CAT_ID', [$category_ID], 'int', true);
-
-        foreach ($category_IDs as $cat_id) {
-            $this->_delete_category($cat_id);
-        }
-
-        // doesn't matter what page we're coming from... we're going to the same place after delete.
-        $query_args = [
-            'action' => 'category_list',
-        ];
-        $this->_redirect_after_action(0, '', '', $query_args);
-    }
-
-
-    protected function _delete_category($cat_id)
-    {
-        $cat_id = absint($cat_id);
-        wp_delete_term($cat_id, 'espresso_venue_categories');
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _insert_or_update_category($new_category)
-    {
-        $cat_id  = $new_category ? $this->_insert_category() : $this->_insert_category(true);
-        $success = 0; // we already have a success message so lets not send another.
-        if ($cat_id) {
-            $query_args = [
-                'action'     => 'edit_category',
-                'VEN_CAT_ID' => $cat_id,
-            ];
-        } else {
-            $query_args = ['action' => 'add_category'];
-        }
-        $this->_redirect_after_action($success, '', '', $query_args, true);
-    }
-
-
-    private function _insert_category($update = false)
-    {
-        $category_ID     = $update ? $this->request->getRequestParam('VEN_CAT_ID', '', 'int') : '';
-        $category_name   = $this->request->getRequestParam('category_name', '');
-        $category_desc   = $this->request->getRequestParam('category_desc', '', 'html');
-        $category_parent = $this->request->getRequestParam('category_parent', 0, 'int');
-
-        if (empty($category_name)) {
-            $msg = esc_html__('You must add a name for the category.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-
-        $term_args = [
-            'name'        => $category_name,
-            'description' => $category_desc,
-            'parent'      => $category_parent,
-        ];
-
-        $insert_ids = $update
-            ? wp_update_term($category_ID, 'espresso_venue_categories', $term_args)
-            : wp_insert_term(
-                $category_name,
-                'espresso_venue_categories',
-                $term_args
-            );
-
-        if (! is_array($insert_ids)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred and the category has not been saved to the database.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            $category_ID = $insert_ids['term_id'];
-            EE_Error::add_success(
-                sprintf(
-                    esc_html__('The category %s was successfully created', 'event_espresso'),
-                    $category_name
-                )
-            );
-        }
-
-        return $category_ID;
-    }
-
-
-    /**
-     * TODO handle category exports()
-     *
-     * @return void
-     */
-    protected function _categories_export()
-    {
-        // todo: I don't like doing this but it'll do until we modify EE_Export Class.
-        $this->request->mergeRequestParams(
-            [
-                'export'       => 'report',
-                'action'       => 'categories',
-                'category_ids' => $this->request->getRequestParam('VEN_CAT_ID', 0, 'int'),
-            ]
-        );
-
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
-            $EE_Export = EE_Export::instance($this->request->requestParams());
-            $EE_Export->export();
-        }
-    }
-
-
-    protected function _import_categories()
-    {
-        require_once(EE_CLASSES . 'EE_Import.class.php');
-        EE_Import::instance()->import();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_categories($per_page = 10, $current_page = 1, $count = false)
-    {
-        // testing term stuff
-        $orderby     = $this->request->getRequestParam('orderby', 'Term.term_id');
-        $order       = $this->request->getRequestParam('order', 'DESC');
-        $limit       = ($current_page - 1) * $per_page;
-        $where       = ['taxonomy' => 'espresso_venue_categories'];
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $where['OR'] = [
-                'Term.name'   => ['LIKE', $search_term],
-                'description' => ['LIKE', $search_term],
-            ];
-        }
-
-        $query_params = [
-            $where,
-            'order_by'   => [$orderby => $order],
-            'limit'      => $limit . ',' . $per_page,
-            'force_join' => ['Term'],
-        ];
-
-        return $count
-            ? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
-            : EEM_Term_Taxonomy::instance()->get_all($query_params);
-    }
-
-
-    /* end category stuff */
-    /**************/
+	protected function _google_map_settings()
+	{
+		$this->_template_args['values']           = $this->_yes_no_values;
+		$default_map_settings                     = new stdClass();
+		$default_map_settings->use_google_maps    = true;
+		$default_map_settings->google_map_api_key = '';
+		// for event details pages (reg page)
+		$default_map_settings->event_details_map_width = 585;
+		// ee_map_width_single
+		$default_map_settings->event_details_map_height = 362;
+		// ee_map_height_single
+		$default_map_settings->event_details_map_zoom = 14;
+		// ee_map_zoom_single
+		$default_map_settings->event_details_display_nav = true;
+		// ee_map_nav_display_single
+		$default_map_settings->event_details_nav_size = false;
+		// ee_map_nav_size_single
+		$default_map_settings->event_details_control_type = 'default';
+		// ee_map_type_control_single
+		$default_map_settings->event_details_map_align = 'center';
+		// ee_map_align_single
+
+		// for event list pages
+		$default_map_settings->event_list_map_width = 300;
+		// ee_map_width
+		$default_map_settings->event_list_map_height = 185;
+		// ee_map_height
+		$default_map_settings->event_list_map_zoom = 12;
+		// ee_map_zoom
+		$default_map_settings->event_list_display_nav = false;
+		// ee_map_nav_display
+		$default_map_settings->event_list_nav_size = true;
+		// ee_map_nav_size
+		$default_map_settings->event_list_control_type = 'dropdown';
+		// ee_map_type_control
+		$default_map_settings->event_list_map_align = 'center';
+		// ee_map_align
+
+		$this->_template_args['map_settings'] =
+			isset(EE_Registry::instance()->CFG->map_settings)
+			&& ! empty(EE_Registry::instance()->CFG->map_settings)
+				? (object) array_merge(
+				(array) $default_map_settings,
+				(array) EE_Registry::instance()->CFG->map_settings
+			)
+				: $default_map_settings;
+
+		$this->_set_add_edit_form_tags('update_google_map_settings');
+		$this->_set_publish_post_box_vars();
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EE_VENUES_TEMPLATE_PATH . 'google_map.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _update_google_map_settings()
+	{
+		$map_settings = EE_Registry::instance()->CFG->map_settings;
+
+		$settings = [
+			'use_google_maps'            => 'int',
+			'google_map_api_key'         => 'string',
+			'event_details_map_width'    => 'int',
+			'event_details_map_zoom'     => 'int',
+			'event_details_display_nav'  => 'int',
+			'event_details_nav_size'     => 'int',
+			'event_details_control_type' => 'string',
+			'event_details_map_align'    => 'string',
+			'event_list_map_width'       => 'int',
+			'event_list_map_height'      => 'int',
+			'event_list_map_zoom'        => 'int',
+			'event_list_display_nav'     => 'int',
+			'event_list_nav_size'        => 'int',
+			'event_list_control_type'    => 'string',
+			'event_list_map_align'       => 'string',
+		];
+
+		foreach ($settings as $setting => $type) {
+			$map_settings->{$setting} = $this->request->getRequestParam($setting, $map_settings->{$setting}, $type);
+		}
+
+		EE_Registry::instance()->CFG->map_settings = apply_filters(
+			'FHEE__Extend_General_Settings_Admin_Page___update_google_map_settings__CFG_map_settings',
+			$map_settings
+		);
+
+		$what    = 'Google Map Settings';
+		$success = $this->_update_espresso_configuration(
+			$what,
+			EE_Registry::instance()->CFG->map_settings,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		$this->_redirect_after_action($success, $what, 'updated', ['action' => 'google_map_settings']);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _venue_editor_metaboxes()
+	{
+		$this->verify_cpt_object();
+
+		$this->addMetaBox(
+			'espresso_venue_address_options',
+			esc_html__('Physical Location', 'event_espresso'),
+			[$this, 'venue_address_metabox'],
+			$this->page_slug,
+			'side',
+			'core'
+		);
+		$this->addMetaBox(
+			'espresso_venue_gmap_options',
+			esc_html__('Google Map', 'event_espresso'),
+			[$this, 'venue_gmap_metabox'],
+			$this->page_slug,
+			'side'
+		);
+		$this->addMetaBox(
+			'espresso_venue_virtual_loc_options',
+			esc_html__('Virtual Location', 'event_espresso'),
+			[$this, 'venue_virtual_loc_metabox'],
+			$this->page_slug,
+			'side'
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function venue_gmap_metabox()
+	{
+		$template_args = [
+			'vnu_enable_for_gmap' => EEH_Form_Fields::select_input(
+				'vnu_enable_for_gmap',
+				$this->get_yes_no_values(),
+				$this->_cpt_model_obj instanceof EE_Venue && $this->_cpt_model_obj->enable_for_gmap()
+			),
+			'vnu_google_map_link' => $this->_cpt_model_obj->google_map_link(),
+		];
+		$template      = EE_VENUES_TEMPLATE_PATH . 'venue_gmap_metabox_content.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function venue_address_metabox()
+	{
+		$template_args['_venue'] = $this->_cpt_model_obj;
+
+		$template_args['states_dropdown']    = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					['QST_display_text' => esc_html__('State', 'event_espresso'), 'QST_system' => 'state']
+				),
+				EE_Answer::new_instance(
+					[
+						'ANS_value' => $this->_cpt_model_obj instanceof EE_Venue
+							? $this->_cpt_model_obj->state_ID()
+							: 0,
+					]
+				),
+				[
+					'input_name'     => 'sta_id',
+					'input_id'       => 'sta_id',
+					'input_class'    => '',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				]
+			)
+		);
+		$template_args['countries_dropdown'] = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					['QST_display_text' => esc_html__('Country', 'event_espresso'), 'QST_system' => 'country']
+				),
+				EE_Answer::new_instance(
+					[
+						'ANS_value' => $this->_cpt_model_obj instanceof EE_Venue
+							? $this->_cpt_model_obj->country_ID()
+							: 0,
+					]
+				),
+				[
+					'input_name'     => 'cnt_iso',
+					'input_id'       => 'cnt_iso',
+					'input_class'    => '',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				]
+			)
+		);
+
+		$template = EE_VENUES_TEMPLATE_PATH . 'venue_address_metabox_content.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	public function venue_virtual_loc_metabox()
+	{
+		$template_args = [
+			'_venue' => $this->_cpt_model_obj,
+		];
+		$template      = EE_VENUES_TEMPLATE_PATH . 'venue_virtual_location_metabox_content.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _restore_cpt_item($post_id, $revision_id)
+	{
+		$this->_cpt_model_obj = $this->_venue_model->get_one_by_ID($post_id);
+		// meta revision restore
+		$this->_cpt_model_obj->restore_revision($revision_id);
+	}
+
+
+	/**
+	 * Handles updates for venue cpts
+	 *
+	 * @param int     $post_id ID of Venue CPT
+	 * @param WP_Post $post    Post object (with "blessed" WP properties)
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+		if ($post instanceof WP_Post && $post->post_type !== 'espresso_venues') {
+			return;// get out we're not processing the saving of venues.
+		}
+
+		$wheres = [$this->_venue_model->primary_key_name() => $post_id];
+
+		$venue_values = [
+			'VNU_address'         => $this->request->getRequestParam('vnu_address'),
+			'VNU_address2'        => $this->request->getRequestParam('vnu_address2'),
+			'VNU_city'            => $this->request->getRequestParam('vnu_city'),
+			'STA_ID'              => $this->request->getRequestParam('sta_id'),
+			'CNT_ISO'             => $this->request->getRequestParam('cnt_iso'),
+			'VNU_zip'             => $this->request->getRequestParam('vnu_zip'),
+			'VNU_phone'           => $this->request->getRequestParam('vnu_phone'),
+			'VNU_capacity'        => $this->request->requestParamIsSet('vnu_capacity')
+				? str_replace(',', '', $this->request->getRequestParam('vnu_capacity'))
+				: EE_INF,
+			'VNU_url'             => $this->request->getRequestParam('vnu_url'),
+			'VNU_virtual_phone'   => $this->request->getRequestParam('vnu_virtual_phone'),
+			'VNU_virtual_url'     => $this->request->getRequestParam('vnu_virtual_url'),
+			'VNU_enable_for_gmap' => $this->request->getRequestParam('vnu_enable_for_gmap', false, 'bool'),
+			'VNU_google_map_link' => $this->request->getRequestParam('vnu_google_map_link'),
+		];
+
+		// update venue
+		$success = $this->_venue_model->update($venue_values, [$wheres]);
+
+		// get venue_object for other metaboxes that might be added via the filter... though it would seem to make sense to just use $this->_venue_model->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
+		$get_one_where = [$this->_venue_model->primary_key_name() => $post_id, 'status' => $post->post_status];
+		$venue         = $this->_venue_model->get_one([$get_one_where]);
+
+		// notice we've applied a filter for venue metabox callbacks but we don't actually have any default venue metaboxes in use.  So this is just here for addons to more easily hook into venue saves.
+		$venue_update_callbacks = apply_filters(
+			'FHEE__Venues_Admin_Page___insert_update_cpt_item__venue_update_callbacks',
+			[]
+		);
+		$att_success            = true;
+		foreach ($venue_update_callbacks as $v_callback) {
+			// if ANY of these updates fail then we want the appropriate global error message
+			$att_success = call_user_func_array($v_callback, [$venue, $this->request->requestParams()])
+				? $att_success
+				: false;
+		}
+
+		// any errors?
+		if ($success && ! $att_success) {
+			EE_Error::add_error(
+				esc_html__(
+					'Venue Details saved successfully but something went wrong with saving attachments.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} elseif ($success === false) {
+			EE_Error::add_error(
+				esc_html__('Venue Details did not save successfully.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * @param int $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function trash_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('VNU_ID', $post_id);
+		$this->_trash_or_restore_venue('trash', false);
+	}
+
+
+	/**
+	 * @param int $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function restore_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('VNU_ID', $post_id);
+		$this->_trash_or_restore_venue('draft', false);
+	}
+
+
+	/**
+	 * @param int $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('VNU_ID', $post_id);
+		$this->_delete_venue(false);
+	}
+
+
+	public function get_venue_object()
+	{
+		return $this->_cpt_model_obj;
+	}
+
+
+	/**
+	 * @param string    $venue_status
+	 * @param bool|null $redirect_after
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_venue(string $venue_status = 'trash', ?bool $redirect_after = true)
+	{
+		// loop thru venues
+		if ($this->VNU_ID) {
+			// clean status
+			$venue_status = sanitize_key($venue_status);
+			// grab status
+			if (! empty($venue_status)) {
+				$success = $this->_change_venue_status($this->VNU_ID, $venue_status);
+			} else {
+				$success = false;
+				$msg     = esc_html__(
+					'An error occurred. The venue could not be moved to the trash because a valid venue status was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. The venue could not be moved to the trash because a valid venue ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		$action = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Venue', $action, ['action' => 'default']);
+		}
+	}
+
+
+	/**
+	 * @param string $venue_status
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_venues(string $venue_status = 'trash')
+	{
+		// clean status
+		$venue_status = sanitize_key($venue_status);
+		// grab status
+		if (! empty($venue_status)) {
+			$success = true;
+			// determine the event id and set to array.
+			$VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
+			// loop thru events
+			foreach ($VNU_IDs as $VNU_ID) {
+				if ($VNU_ID = absint($VNU_ID)) {
+					$results = $this->_change_venue_status($VNU_ID, $venue_status);
+					$success = $results !== false ? $success : false;
+				} else {
+					$msg = sprintf(
+						esc_html__(
+							'An error occurred. Venue #%d could not be moved to the trash because a valid venue ID was not not supplied.',
+							'event_espresso'
+						),
+						$VNU_ID
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+					$success = false;
+				}
+			}
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. The venue could not be moved to the trash because a valid venue status was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$action  = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+		$this->_redirect_after_action($success, 'Venues', $action, ['action' => 'default']);
+	}
+
+
+	/**
+	 * _trash_or_restore_venues
+	 * //todo this is pretty much the same as the corresponding change_event_status method in Events_Admin_Page.  We
+	 * should probably abstract this up to the EE_Admin_Page_CPT (or even EE_Admin_Page) and make this a common method
+	 * accepting a certain number of params.
+	 *
+	 * @param int|null $VNU_ID
+	 * @param string   $venue_status
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _change_venue_status(?int $VNU_ID = 0, string $venue_status = ''): bool
+	{
+		// grab venue id
+		if (! $VNU_ID) {
+			$msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+		$this->_cpt_model_obj = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
+
+		// clean status
+		$venue_status = sanitize_key($venue_status);
+		// grab status
+		if (! $venue_status) {
+			$msg = esc_html__(
+				'An error occurred. No Venue Status or an invalid Venue Status was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+		// was event trashed or restored ?
+		switch ($venue_status) {
+			case 'draft':
+				$action = 'restored from the trash';
+				$hook   = 'AHEE_venue_restored_from_trash';
+				break;
+			case 'trash':
+				$action = 'moved to the trash';
+				$hook   = 'AHEE_venue_moved_to_trash';
+				break;
+			default:
+				$action = 'updated';
+				$hook   = false;
+		}
+		// use class to change status
+		$this->_cpt_model_obj->set_status($venue_status);
+		$success = $this->_cpt_model_obj->save();
+
+		if ($success === false) {
+			$msg = sprintf(esc_html__('An error occurred. The venue could not be %s.', 'event_espresso'), $action);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if ($hook) {
+			do_action($hook);
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param bool $redirect_after
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_venue(bool $redirect_after = true)
+	{
+		// loop thru venues
+		if ($this->VNU_ID) {
+			$success = $this->_delete_or_trash_venue($this->VNU_ID);
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Venue', 'deleted', ['action' => 'default']);
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_venues()
+	{
+		$success = true;
+		// determine the event id and set to array.
+		$VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
+		// loop thru events
+		foreach ($VNU_IDs as $VNU_ID) {
+			if ($VNU_ID = absint($VNU_ID)) {
+				$results = $this->_delete_or_trash_venue($VNU_ID);
+				$success = $results !== false ? $success : false;
+			} else {
+				$success = false;
+				$msg     = esc_html__(
+					'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$this->_redirect_after_action(
+			$success,
+			esc_html__('Venues', 'event_espresso'),
+			esc_html__('deleted', 'event_espresso'),
+			['action' => 'default']
+		);
+	}
+
+
+	// todo: put in parent
+
+
+	/**
+	 * @param int|null $VNU_ID
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _delete_or_trash_venue(?int $VNU_ID = 0): bool
+	{
+		// grab event id
+		if (! $VNU_ID = absint($VNU_ID)) {
+			$msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+
+		$venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
+		// first need to remove all term relationships
+		$venue->_remove_relations('Term_Taxonomy');
+		$success = $venue->delete_permanently();
+		// did it all go as planned ?
+		if (! $success) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('An error occurred. Venue ID # %d could not be deleted.', 'event_espresso'),
+					$VNU_ID
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		EE_Error::add_success(
+			sprintf(esc_html__('Venue ID # %d has been deleted.', 'event_espresso'), $VNU_ID)
+		);
+		do_action('AHEE__Venues_Admin_Page___delete_or_trash_venue__after_venue_deleted');
+		return true;
+	}
+
+
+
+
+	/***********/
+	/* QUERIES */
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_venues($per_page = 10, $count = false)
+	{
+		$orderby = $this->request->getRequestParam('orderby', '');
+
+		switch ($orderby) {
+			case 'id':
+				$orderby = 'VNU_ID';
+				break;
+
+			case 'capacity':
+				$orderby = 'VNU_capacity';
+				break;
+
+			case 'city':
+				$orderby = 'VNU_city';
+				break;
+
+			default:
+				$orderby = 'VNU_name';
+		}
+
+		$sort         = $this->request->getRequestParam('order', 'ASC');
+		$current_page = $this->request->getRequestParam('paged', 1, 'int');
+		$per_page     = ! empty($per_page) ? $per_page : 10;
+		$per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = [$offset, $per_page];
+
+		$category = $this->request->getRequestParam('category');
+		$category = $category > 0 ? $category : null;
+
+		$where = [];
+
+		// only set initial status if it is in the incoming request.  Otherwise the "all" view display's all statuses.
+		$status = $this->request->getRequestParam('status');
+		if ($status && $status !== 'all') {
+			$where['status'] = $status;
+		}
+
+		$venue_status = $this->request->getRequestParam('venue_status');
+		if ($venue_status) {
+			$where['status'] = $venue_status;
+		}
+
+
+		if ($category) {
+			$where['Term_Taxonomy.taxonomy'] = 'espresso_venue_categories';
+			$where['Term_Taxonomy.term_id']  = $category;
+		}
+
+
+		if (! $this->capabilities->current_user_can('ee_read_others_venues', 'get_venues')) {
+			$where['VNU_wp_user'] = get_current_user_id();
+		} else {
+			if (! $this->capabilities->current_user_can('ee_read_private_venues', 'get_venues')) {
+				$where['OR'] = [
+					'status*restrict_private' => ['!=', 'private'],
+					'AND'                     => [
+						'status*inclusive' => ['=', 'private'],
+						'VNU_wp_user'      => get_current_user_id(),
+					],
+				];
+			}
+		}
+
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$where['OR'] = [
+				'VNU_name'               => ['LIKE', $search_term],
+				'VNU_desc'               => ['LIKE', $search_term],
+				'VNU_short_desc'         => ['LIKE', $search_term],
+				'VNU_address'            => ['LIKE', $search_term],
+				'VNU_address2'           => ['LIKE', $search_term],
+				'VNU_city'               => ['LIKE', $search_term],
+				'VNU_zip'                => ['LIKE', $search_term],
+				'VNU_phone'              => ['LIKE', $search_term],
+				'VNU_url'                => ['LIKE', $search_term],
+				'VNU_virtual_phone'      => ['LIKE', $search_term],
+				'VNU_virtual_url'        => ['LIKE', $search_term],
+				'VNU_google_map_link'    => ['LIKE', $search_term],
+				'Event.EVT_name'         => ['LIKE', $search_term],
+				'Event.EVT_desc'         => ['LIKE', $search_term],
+				'Event.EVT_phone'        => ['LIKE', $search_term],
+				'Event.EVT_external_URL' => ['LIKE', $search_term],
+			];
+		}
+
+
+		return $count
+			? $this->_venue_model->count([$where], 'VNU_ID')
+			: $this->_venue_model->get_all(
+				[$where, 'limit' => $limit, 'order_by' => $orderby, 'order' => $sort]
+			);
+	}
+
+
+
+
+	/** Venue Category Stuff **/
+
+	/**
+	 * set the _category property with the category object for the loaded page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_category_object()
+	{
+		if (isset($this->_category->id) && ! empty($this->_category->id)) {
+			return;
+		} // already have the category object so get out.
+
+		// set default category object
+		$this->_set_empty_category_object();
+
+		// only set if we've got an id
+		$category_ID = $this->request->getRequestParam('VEN_CAT_ID', 0, 'int');
+		if (! $category_ID) {
+			return;
+		}
+
+		$term = get_term($category_ID, 'espresso_venue_categories');
+
+
+		if (! empty($term)) {
+			$this->_category->category_name       = $term->name;
+			$this->_category->category_identifier = $term->slug;
+			$this->_category->category_desc       = $term->description;
+			$this->_category->id                  = $term->term_id;
+			$this->_category->parent              = $term->parent;
+		}
+	}
+
+
+	private function _set_empty_category_object()
+	{
+		$this->_category                = new stdClass();
+		$this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
+		$this->_category->id            = $this->_category->parent = 0;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _category_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+				'add_category',
+				'add_category',
+				[],
+				'add-new-h2'
+			);
+		$this->_search_btn_label = esc_html__('Venue Categories', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _category_details($view)
+	{
+		// load formatter helper
+		// load field generator helper
+
+		$route = $view == 'edit' ? 'update_category' : 'insert_category';
+		$this->_set_add_edit_form_tags($route);
+
+		$this->_set_category_object();
+		$id = ! empty($this->_category->id) ? $this->_category->id : '';
+
+		$delete_action = 'delete_category';
+
+		$redirect = EE_Admin_Page::add_query_args_and_nonce(['action' => 'category_list'], $this->_admin_base_url);
+
+		$this->_set_publish_post_box_vars('VEN_CAT_ID', $id, $delete_action, $redirect);
+
+		// take care of contents
+		$this->_template_args['admin_page_content'] = $this->_category_details_content();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	protected function _category_details_content(): string
+	{
+		$editor_args['category_desc'] = [
+			'type'          => 'wp_editor',
+			'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
+			'class'         => 'my_editor_custom',
+			'wpeditor_args' => ['media_buttons' => false],
+		];
+		$_wp_editor                   = $this->_generate_admin_form_fields($editor_args, 'array');
+
+		$all_terms = get_terms(
+			['espresso_venue_categories'],
+			['hide_empty' => 0, 'exclude' => [$this->_category->id]]
+		);
+
+		// setup category select for term parents.
+		$category_select_values[] = [
+			'text' => esc_html__('No Parent', 'event_espresso'),
+			'id'   => 0,
+		];
+		foreach ($all_terms as $term) {
+			$category_select_values[] = [
+				'text' => $term->name,
+				'id'   => $term->term_id,
+			];
+		}
+
+		$category_select = EEH_Form_Fields::select_input(
+			'category_parent',
+			$category_select_values,
+			$this->_category->parent
+		);
+		$template_args   = [
+			'category'                 => $this->_category,
+			'category_select'          => $category_select,
+			'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
+			'category_desc_editor'     => $_wp_editor['category_desc']['field'],
+			'disable'                  => '',
+			'disabled_message'         => false,
+		];
+		$template        = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _delete_categories()
+	{
+		$category_ID  = $this->request->getRequestParam('category_id', 0, 'int');
+		$category_IDs = $this->request->getRequestParam('VEN_CAT_ID', [$category_ID], 'int', true);
+
+		foreach ($category_IDs as $cat_id) {
+			$this->_delete_category($cat_id);
+		}
+
+		// doesn't matter what page we're coming from... we're going to the same place after delete.
+		$query_args = [
+			'action' => 'category_list',
+		];
+		$this->_redirect_after_action(0, '', '', $query_args);
+	}
+
+
+	protected function _delete_category($cat_id)
+	{
+		$cat_id = absint($cat_id);
+		wp_delete_term($cat_id, 'espresso_venue_categories');
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _insert_or_update_category($new_category)
+	{
+		$cat_id  = $new_category ? $this->_insert_category() : $this->_insert_category(true);
+		$success = 0; // we already have a success message so lets not send another.
+		if ($cat_id) {
+			$query_args = [
+				'action'     => 'edit_category',
+				'VEN_CAT_ID' => $cat_id,
+			];
+		} else {
+			$query_args = ['action' => 'add_category'];
+		}
+		$this->_redirect_after_action($success, '', '', $query_args, true);
+	}
+
+
+	private function _insert_category($update = false)
+	{
+		$category_ID     = $update ? $this->request->getRequestParam('VEN_CAT_ID', '', 'int') : '';
+		$category_name   = $this->request->getRequestParam('category_name', '');
+		$category_desc   = $this->request->getRequestParam('category_desc', '', 'html');
+		$category_parent = $this->request->getRequestParam('category_parent', 0, 'int');
+
+		if (empty($category_name)) {
+			$msg = esc_html__('You must add a name for the category.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+
+		$term_args = [
+			'name'        => $category_name,
+			'description' => $category_desc,
+			'parent'      => $category_parent,
+		];
+
+		$insert_ids = $update
+			? wp_update_term($category_ID, 'espresso_venue_categories', $term_args)
+			: wp_insert_term(
+				$category_name,
+				'espresso_venue_categories',
+				$term_args
+			);
+
+		if (! is_array($insert_ids)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred and the category has not been saved to the database.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			$category_ID = $insert_ids['term_id'];
+			EE_Error::add_success(
+				sprintf(
+					esc_html__('The category %s was successfully created', 'event_espresso'),
+					$category_name
+				)
+			);
+		}
+
+		return $category_ID;
+	}
+
+
+	/**
+	 * TODO handle category exports()
+	 *
+	 * @return void
+	 */
+	protected function _categories_export()
+	{
+		// todo: I don't like doing this but it'll do until we modify EE_Export Class.
+		$this->request->mergeRequestParams(
+			[
+				'export'       => 'report',
+				'action'       => 'categories',
+				'category_ids' => $this->request->getRequestParam('VEN_CAT_ID', 0, 'int'),
+			]
+		);
+
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+			require_once(EE_CLASSES . 'EE_Export.class.php');
+			$EE_Export = EE_Export::instance($this->request->requestParams());
+			$EE_Export->export();
+		}
+	}
+
+
+	protected function _import_categories()
+	{
+		require_once(EE_CLASSES . 'EE_Import.class.php');
+		EE_Import::instance()->import();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_categories($per_page = 10, $current_page = 1, $count = false)
+	{
+		// testing term stuff
+		$orderby     = $this->request->getRequestParam('orderby', 'Term.term_id');
+		$order       = $this->request->getRequestParam('order', 'DESC');
+		$limit       = ($current_page - 1) * $per_page;
+		$where       = ['taxonomy' => 'espresso_venue_categories'];
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$where['OR'] = [
+				'Term.name'   => ['LIKE', $search_term],
+				'description' => ['LIKE', $search_term],
+			];
+		}
+
+		$query_params = [
+			$where,
+			'order_by'   => [$orderby => $order],
+			'limit'      => $limit . ',' . $per_page,
+			'force_join' => ['Term'],
+		];
+
+		return $count
+			? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
+			: EEM_Term_Taxonomy::instance()->get_all($query_params);
+	}
+
+
+	/* end category stuff */
+	/**************/
 }