eventespresso / event-espresso-core

core/EE_Front_Controller.core.php

Indentation +467 added lines, -467 removed lines

@@ -3,7 +3,7 @@ 
 use EventEspresso\widgets\EspressoWidget;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -26,379 +26,379 @@ 
 final class EE_Front_Controller
 {
 
-    /**
-     * @var string $_template_path
-     */
-    private $_template_path;
-
-    /**
-     * @var string $_template
-     */
-    private $_template;
-
-    /**
-     * @type EE_Registry $Registry
-     */
-    protected $Registry;
-
-    /**
-     * @type EE_Request_Handler $Request_Handler
-     */
-    protected $Request_Handler;
-
-    /**
-     * @type EE_Module_Request_Router $Module_Request_Router
-     */
-    protected $Module_Request_Router;
-
-
-    /**
-     *    class constructor
-     *    should fire after shortcode, module, addon, or other plugin's default priority init phases have run
-     *
-     * @access    public
-     * @param \EE_Registry              $Registry
-     * @param \EE_Request_Handler       $Request_Handler
-     * @param \EE_Module_Request_Router $Module_Request_Router
-     */
-    public function __construct(
-        EE_Registry $Registry,
-        EE_Request_Handler $Request_Handler,
-        EE_Module_Request_Router $Module_Request_Router
-    ) {
-        $this->Registry              = $Registry;
-        $this->Request_Handler       = $Request_Handler;
-        $this->Module_Request_Router = $Module_Request_Router;
-        // determine how to integrate WP_Query with the EE models
-        add_action('AHEE__EE_System__initialize', array($this, 'employ_CPT_Strategy'));
-        // load other resources and begin to actually run shortcodes and modules
-        add_action('wp_loaded', array($this, 'wp_loaded'), 5);
-        // analyse the incoming WP request
-        add_action('parse_request', array($this, 'get_request'), 1, 1);
-        // process request with module factory
-        add_action('pre_get_posts', array($this, 'pre_get_posts'), 10, 1);
-        // before headers sent
-        add_action('wp', array($this, 'wp'), 5);
-        // after headers sent but before any markup is output,
-        // primarily used to process any content shortcodes
-        add_action('get_header', array($this, 'get_header'));
-        // header
-        add_action('wp_head', array($this, 'header_meta_tag'), 5);
-        add_action('wp_print_scripts', array($this, 'wp_print_scripts'), 10);
-        add_filter('template_include', array($this, 'template_include'), 1);
-        // display errors
-        add_action('loop_start', array($this, 'display_errors'), 2);
-        // the content
-        // add_filter( 'the_content', array( $this, 'the_content' ), 5, 1 );
-        //exclude our private cpt comments
-        add_filter('comments_clauses', array($this, 'filter_wp_comments'), 10, 1);
-        //make sure any ajax requests will respect the url schema when requests are made against admin-ajax.php (http:// or https://)
-        add_filter('admin_url', array($this, 'maybe_force_admin_ajax_ssl'), 200, 1);
-        // action hook EE
-        do_action('AHEE__EE_Front_Controller__construct__done', $this);
-        // for checking that browser cookies are enabled
-        if (apply_filters('FHEE__EE_Front_Controller____construct__set_test_cookie', true)) {
-            setcookie('ee_cookie_test', uniqid('ect',true), time() + DAY_IN_SECONDS, '/');
-        }
-    }
-
-
-    /**
-     * @return EE_Request_Handler
-     */
-    public function Request_Handler()
-    {
-        return $this->Request_Handler;
-    }
-
-
-    /**
-     * @return EE_Module_Request_Router
-     */
-    public function Module_Request_Router()
-    {
-        return $this->Module_Request_Router;
-    }
-
-
-
-    /**
-     * @return LegacyShortcodesManager
-     */
-    public function getLegacyShortcodesManager()
-    {
-        return EE_Config::getLegacyShortcodesManager();
-    }
-
-
-
-
-
-    /***********************************************        INIT ACTION HOOK         ***********************************************/
-
-
-
-    /**
-     * filter_wp_comments
-     * This simply makes sure that any "private" EE CPTs do not have their comments show up in any wp comment
-     * widgets/queries done on frontend
-     *
-     * @param  array $clauses array of comment clauses setup by WP_Comment_Query
-     * @return array array of comment clauses with modifications.
-     */
-    public function filter_wp_comments($clauses)
-    {
-        global $wpdb;
-        if (strpos($clauses['join'], $wpdb->posts) !== false) {
-            $cpts = EE_Register_CPTs::get_private_CPTs();
-            foreach ($cpts as $cpt => $details) {
-                $clauses['where'] .= $wpdb->prepare(" AND $wpdb->posts.post_type != %s", $cpt);
-            }
-        }
-        return $clauses;
-    }
-
-
-    /**
-     *    employ_CPT_Strategy
-     *
-     * @access    public
-     * @return    void
-     */
-    public function employ_CPT_Strategy()
-    {
-        if (apply_filters('FHEE__EE_Front_Controller__employ_CPT_Strategy', true)) {
-            $this->Registry->load_core('CPT_Strategy');
-        }
-    }
-
-
-    /**
-     * this just makes sure that if the site is using ssl that we force that for any admin ajax calls from frontend
-     *
-     * @param  string $url incoming url
-     * @return string         final assembled url
-     */
-    public function maybe_force_admin_ajax_ssl($url)
-    {
-        if (is_ssl() && preg_match('/admin-ajax.php/', $url)) {
-            $url = str_replace('http://', 'https://', $url);
-        }
-        return $url;
-    }
-
-
-
-
-
-
-    /***********************************************        WP_LOADED ACTION HOOK         ***********************************************/
-
-
-    /**
-     *    wp_loaded - should fire after shortcode, module, addon, or other plugin's have been registered and their
-     *    default priority init phases have run
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-
-
-
-    /***********************************************        PARSE_REQUEST HOOK         ***********************************************/
-    /**
-     *    _get_request
-     *
-     * @access public
-     * @param WP $WP
-     * @return void
-     */
-    public function get_request(WP $WP)
-    {
-        do_action('AHEE__EE_Front_Controller__get_request__start');
-        $this->Request_Handler->parse_request($WP);
-        do_action('AHEE__EE_Front_Controller__get_request__complete');
-    }
-
-
-
-    /**
-     *    pre_get_posts - basically a module factory for instantiating modules and selecting the final view template
-     *
-     * @access    public
-     * @param   WP_Query $WP_Query
-     * @return    void
-     */
-    public function pre_get_posts($WP_Query)
-    {
-        // only load Module_Request_Router if this is the main query
-        if (
-            $this->Module_Request_Router instanceof EE_Module_Request_Router
-            && $WP_Query->is_main_query()
-        ) {
-            // cycle thru module routes
-            while ($route = $this->Module_Request_Router->get_route($WP_Query)) {
-                // determine module and method for route
-                $module = $this->Module_Request_Router->resolve_route($route[0], $route[1]);
-                if ($module instanceof EED_Module) {
-                    // get registered view for route
-                    $this->_template_path = $this->Module_Request_Router->get_view($route);
-                    // grab module name
-                    $module_name = $module->module_name();
-                    // map the module to the module objects
-                    $this->Registry->modules->{$module_name} = $module;
-                }
-            }
-        }
-    }
-
-
-
-
-
-    /***********************************************        WP HOOK         ***********************************************/
-
-
-    /**
-     *    wp - basically last chance to do stuff before headers sent
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp()
-    {
-    }
-
-
-
-    /***********************     GET_HEADER && WP_HEAD HOOK     ***********************/
-
-
-
-    /**
-     * callback for the WP "get_header" hook point
-     * checks sidebars for EE widgets
-     * loads resources and assets accordingly
-     *
-     * @return void
-     */
-    public function get_header()
-    {
-        global $wp_query;
-        if (empty($wp_query->posts)){
-            return;
-        }
-        // if we already know this is an espresso page, then load assets
-        $load_assets = $this->Request_Handler->is_espresso_page();
-        // if we are already loading assets then just move along, otherwise check for widgets
-        $load_assets = $load_assets ? $load_assets : $this->espresso_widgets_in_active_sidebars();
-        if ( $load_assets){
-            wp_enqueue_style('espresso_default');
-            wp_enqueue_style('espresso_custom_css');
-            wp_enqueue_script('espresso_core');
-        }
-    }
-
-
-
-    /**
-     * builds list of active widgets then scans active sidebars looking for them
-     * returns true is an EE widget is found in an active sidebar
-     * Please Note: this does NOT mean that the sidebar or widget
-     * is actually in use in a given template, as that is unfortunately not known
-     * until a sidebar and it's widgets are actually loaded
-     *
-     * @return boolean
-     */
-    private function espresso_widgets_in_active_sidebars()
-    {
-        $espresso_widgets = array();
-        foreach ($this->Registry->widgets as $widget_class => $widget) {
-            $id_base = EspressoWidget::getIdBase($widget_class);
-            if (is_active_widget(false, false, $id_base)) {
-                $espresso_widgets[] = $id_base;
-            }
-        }
-        $all_sidebar_widgets = wp_get_sidebars_widgets();
-        foreach ($all_sidebar_widgets as $sidebar_name => $sidebar_widgets) {
-            if (is_array($sidebar_widgets) && ! empty($sidebar_widgets)) {
-                foreach ($sidebar_widgets as $sidebar_widget) {
-                    foreach ($espresso_widgets as $espresso_widget) {
-                        if (strpos($sidebar_widget, $espresso_widget) !== false) {
-                            return true;
-                        }
-                    }
-                }
-            }
-        }
-        return false;
-    }
-
-
-
-
-    /**
-     *    header_meta_tag
-     *
-     * @access    public
-     * @return    void
-     */
-    public function header_meta_tag()
-    {
-        print(
-            apply_filters(
-                'FHEE__EE_Front_Controller__header_meta_tag',
-                '<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n")
-        );
-
-        //let's exclude all event type taxonomy term archive pages from search engine indexing
-        //@see https://events.codebasehq.com/projects/event-espresso/tickets/10249
-        //also exclude all critical pages from indexing
-        if (
-            (
-                is_tax('espresso_event_type')
-                && get_option( 'blog_public' ) !== '0'
-            )
-            || is_page(EE_Registry::instance()->CFG->core->get_critical_pages_array())
-        ) {
-            print(
-                apply_filters(
-                    'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
-                    '<meta name="robots" content="noindex,follow" />' . "\n"
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * wp_print_scripts
-     *
-     * @return void
-     */
-    public function wp_print_scripts()
-    {
-        global $post;
-        if (
-            isset($post->EE_Event)
-            && $post->EE_Event instanceof EE_Event
-            && get_post_type() === 'espresso_events'
-            && is_singular()
-        ) {
-            \EEH_Schema::add_json_linked_data_for_event($post->EE_Event);
-        }
-    }
-
-
-
-
-    /***********************************************        THE_CONTENT FILTER HOOK         **********************************************
+	/**
+	 * @var string $_template_path
+	 */
+	private $_template_path;
+
+	/**
+	 * @var string $_template
+	 */
+	private $_template;
+
+	/**
+	 * @type EE_Registry $Registry
+	 */
+	protected $Registry;
+
+	/**
+	 * @type EE_Request_Handler $Request_Handler
+	 */
+	protected $Request_Handler;
+
+	/**
+	 * @type EE_Module_Request_Router $Module_Request_Router
+	 */
+	protected $Module_Request_Router;
+
+
+	/**
+	 *    class constructor
+	 *    should fire after shortcode, module, addon, or other plugin's default priority init phases have run
+	 *
+	 * @access    public
+	 * @param \EE_Registry              $Registry
+	 * @param \EE_Request_Handler       $Request_Handler
+	 * @param \EE_Module_Request_Router $Module_Request_Router
+	 */
+	public function __construct(
+		EE_Registry $Registry,
+		EE_Request_Handler $Request_Handler,
+		EE_Module_Request_Router $Module_Request_Router
+	) {
+		$this->Registry              = $Registry;
+		$this->Request_Handler       = $Request_Handler;
+		$this->Module_Request_Router = $Module_Request_Router;
+		// determine how to integrate WP_Query with the EE models
+		add_action('AHEE__EE_System__initialize', array($this, 'employ_CPT_Strategy'));
+		// load other resources and begin to actually run shortcodes and modules
+		add_action('wp_loaded', array($this, 'wp_loaded'), 5);
+		// analyse the incoming WP request
+		add_action('parse_request', array($this, 'get_request'), 1, 1);
+		// process request with module factory
+		add_action('pre_get_posts', array($this, 'pre_get_posts'), 10, 1);
+		// before headers sent
+		add_action('wp', array($this, 'wp'), 5);
+		// after headers sent but before any markup is output,
+		// primarily used to process any content shortcodes
+		add_action('get_header', array($this, 'get_header'));
+		// header
+		add_action('wp_head', array($this, 'header_meta_tag'), 5);
+		add_action('wp_print_scripts', array($this, 'wp_print_scripts'), 10);
+		add_filter('template_include', array($this, 'template_include'), 1);
+		// display errors
+		add_action('loop_start', array($this, 'display_errors'), 2);
+		// the content
+		// add_filter( 'the_content', array( $this, 'the_content' ), 5, 1 );
+		//exclude our private cpt comments
+		add_filter('comments_clauses', array($this, 'filter_wp_comments'), 10, 1);
+		//make sure any ajax requests will respect the url schema when requests are made against admin-ajax.php (http:// or https://)
+		add_filter('admin_url', array($this, 'maybe_force_admin_ajax_ssl'), 200, 1);
+		// action hook EE
+		do_action('AHEE__EE_Front_Controller__construct__done', $this);
+		// for checking that browser cookies are enabled
+		if (apply_filters('FHEE__EE_Front_Controller____construct__set_test_cookie', true)) {
+			setcookie('ee_cookie_test', uniqid('ect',true), time() + DAY_IN_SECONDS, '/');
+		}
+	}
+
+
+	/**
+	 * @return EE_Request_Handler
+	 */
+	public function Request_Handler()
+	{
+		return $this->Request_Handler;
+	}
+
+
+	/**
+	 * @return EE_Module_Request_Router
+	 */
+	public function Module_Request_Router()
+	{
+		return $this->Module_Request_Router;
+	}
+
+
+
+	/**
+	 * @return LegacyShortcodesManager
+	 */
+	public function getLegacyShortcodesManager()
+	{
+		return EE_Config::getLegacyShortcodesManager();
+	}
+
+
+
+
+
+	/***********************************************        INIT ACTION HOOK         ***********************************************/
+
+
+
+	/**
+	 * filter_wp_comments
+	 * This simply makes sure that any "private" EE CPTs do not have their comments show up in any wp comment
+	 * widgets/queries done on frontend
+	 *
+	 * @param  array $clauses array of comment clauses setup by WP_Comment_Query
+	 * @return array array of comment clauses with modifications.
+	 */
+	public function filter_wp_comments($clauses)
+	{
+		global $wpdb;
+		if (strpos($clauses['join'], $wpdb->posts) !== false) {
+			$cpts = EE_Register_CPTs::get_private_CPTs();
+			foreach ($cpts as $cpt => $details) {
+				$clauses['where'] .= $wpdb->prepare(" AND $wpdb->posts.post_type != %s", $cpt);
+			}
+		}
+		return $clauses;
+	}
+
+
+	/**
+	 *    employ_CPT_Strategy
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function employ_CPT_Strategy()
+	{
+		if (apply_filters('FHEE__EE_Front_Controller__employ_CPT_Strategy', true)) {
+			$this->Registry->load_core('CPT_Strategy');
+		}
+	}
+
+
+	/**
+	 * this just makes sure that if the site is using ssl that we force that for any admin ajax calls from frontend
+	 *
+	 * @param  string $url incoming url
+	 * @return string         final assembled url
+	 */
+	public function maybe_force_admin_ajax_ssl($url)
+	{
+		if (is_ssl() && preg_match('/admin-ajax.php/', $url)) {
+			$url = str_replace('http://', 'https://', $url);
+		}
+		return $url;
+	}
+
+
+
+
+
+
+	/***********************************************        WP_LOADED ACTION HOOK         ***********************************************/
+
+
+	/**
+	 *    wp_loaded - should fire after shortcode, module, addon, or other plugin's have been registered and their
+	 *    default priority init phases have run
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+
+
+
+	/***********************************************        PARSE_REQUEST HOOK         ***********************************************/
+	/**
+	 *    _get_request
+	 *
+	 * @access public
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function get_request(WP $WP)
+	{
+		do_action('AHEE__EE_Front_Controller__get_request__start');
+		$this->Request_Handler->parse_request($WP);
+		do_action('AHEE__EE_Front_Controller__get_request__complete');
+	}
+
+
+
+	/**
+	 *    pre_get_posts - basically a module factory for instantiating modules and selecting the final view template
+	 *
+	 * @access    public
+	 * @param   WP_Query $WP_Query
+	 * @return    void
+	 */
+	public function pre_get_posts($WP_Query)
+	{
+		// only load Module_Request_Router if this is the main query
+		if (
+			$this->Module_Request_Router instanceof EE_Module_Request_Router
+			&& $WP_Query->is_main_query()
+		) {
+			// cycle thru module routes
+			while ($route = $this->Module_Request_Router->get_route($WP_Query)) {
+				// determine module and method for route
+				$module = $this->Module_Request_Router->resolve_route($route[0], $route[1]);
+				if ($module instanceof EED_Module) {
+					// get registered view for route
+					$this->_template_path = $this->Module_Request_Router->get_view($route);
+					// grab module name
+					$module_name = $module->module_name();
+					// map the module to the module objects
+					$this->Registry->modules->{$module_name} = $module;
+				}
+			}
+		}
+	}
+
+
+
+
+
+	/***********************************************        WP HOOK         ***********************************************/
+
+
+	/**
+	 *    wp - basically last chance to do stuff before headers sent
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp()
+	{
+	}
+
+
+
+	/***********************     GET_HEADER && WP_HEAD HOOK     ***********************/
+
+
+
+	/**
+	 * callback for the WP "get_header" hook point
+	 * checks sidebars for EE widgets
+	 * loads resources and assets accordingly
+	 *
+	 * @return void
+	 */
+	public function get_header()
+	{
+		global $wp_query;
+		if (empty($wp_query->posts)){
+			return;
+		}
+		// if we already know this is an espresso page, then load assets
+		$load_assets = $this->Request_Handler->is_espresso_page();
+		// if we are already loading assets then just move along, otherwise check for widgets
+		$load_assets = $load_assets ? $load_assets : $this->espresso_widgets_in_active_sidebars();
+		if ( $load_assets){
+			wp_enqueue_style('espresso_default');
+			wp_enqueue_style('espresso_custom_css');
+			wp_enqueue_script('espresso_core');
+		}
+	}
+
+
+
+	/**
+	 * builds list of active widgets then scans active sidebars looking for them
+	 * returns true is an EE widget is found in an active sidebar
+	 * Please Note: this does NOT mean that the sidebar or widget
+	 * is actually in use in a given template, as that is unfortunately not known
+	 * until a sidebar and it's widgets are actually loaded
+	 *
+	 * @return boolean
+	 */
+	private function espresso_widgets_in_active_sidebars()
+	{
+		$espresso_widgets = array();
+		foreach ($this->Registry->widgets as $widget_class => $widget) {
+			$id_base = EspressoWidget::getIdBase($widget_class);
+			if (is_active_widget(false, false, $id_base)) {
+				$espresso_widgets[] = $id_base;
+			}
+		}
+		$all_sidebar_widgets = wp_get_sidebars_widgets();
+		foreach ($all_sidebar_widgets as $sidebar_name => $sidebar_widgets) {
+			if (is_array($sidebar_widgets) && ! empty($sidebar_widgets)) {
+				foreach ($sidebar_widgets as $sidebar_widget) {
+					foreach ($espresso_widgets as $espresso_widget) {
+						if (strpos($sidebar_widget, $espresso_widget) !== false) {
+							return true;
+						}
+					}
+				}
+			}
+		}
+		return false;
+	}
+
+
+
+
+	/**
+	 *    header_meta_tag
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function header_meta_tag()
+	{
+		print(
+			apply_filters(
+				'FHEE__EE_Front_Controller__header_meta_tag',
+				'<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n")
+		);
+
+		//let's exclude all event type taxonomy term archive pages from search engine indexing
+		//@see https://events.codebasehq.com/projects/event-espresso/tickets/10249
+		//also exclude all critical pages from indexing
+		if (
+			(
+				is_tax('espresso_event_type')
+				&& get_option( 'blog_public' ) !== '0'
+			)
+			|| is_page(EE_Registry::instance()->CFG->core->get_critical_pages_array())
+		) {
+			print(
+				apply_filters(
+					'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
+					'<meta name="robots" content="noindex,follow" />' . "\n"
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * wp_print_scripts
+	 *
+	 * @return void
+	 */
+	public function wp_print_scripts()
+	{
+		global $post;
+		if (
+			isset($post->EE_Event)
+			&& $post->EE_Event instanceof EE_Event
+			&& get_post_type() === 'espresso_events'
+			&& is_singular()
+		) {
+			\EEH_Schema::add_json_linked_data_for_event($post->EE_Event);
+		}
+	}
+
+
+
+
+	/***********************************************        THE_CONTENT FILTER HOOK         **********************************************
 
 
 
@@ -409,99 +409,99 @@ 
     //  * @param   $the_content
     //  * @return    string
     //  */
-    // public function the_content( $the_content ) {
-    // 	// nothing gets loaded at this point unless other systems turn this hookpoint on by using:  add_filter( 'FHEE_run_EE_the_content', '__return_true' );
-    // 	if ( apply_filters( 'FHEE_run_EE_the_content', FALSE ) ) {
-    // 	}
-    // 	return $the_content;
-    // }
-
-
-
-    /***********************************************        WP_FOOTER         ***********************************************/
-
-
-    /**
-     * display_errors
-     *
-     * @access public
-     * @return void
-     */
-    public function display_errors()
-    {
-        static $shown_already = false;
-        do_action('AHEE__EE_Front_Controller__display_errors__begin');
-        if (
-            ! $shown_already
-            && apply_filters('FHEE__EE_Front_Controller__display_errors', true)
-            && is_main_query()
-            && ! is_feed()
-            && in_the_loop()
-            && $this->Request_Handler->is_espresso_page()
-        ) {
-            echo EE_Error::get_notices();
-            $shown_already = true;
-            EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
-        }
-        do_action('AHEE__EE_Front_Controller__display_errors__end');
-    }
-
-
-
-
-
-    /***********************************************        UTILITIES         ***********************************************/
-    /**
-     *    template_include
-     *
-     * @access    public
-     * @param   string $template_include_path
-     * @return    string
-     */
-    public function template_include($template_include_path = null)
-    {
-        if ($this->Request_Handler->is_espresso_page()) {
-            $this->_template_path = ! empty($this->_template_path) ? basename($this->_template_path) : basename($template_include_path);
-            $template_path        = EEH_Template::locate_template($this->_template_path, array(), false);
-            $this->_template_path = ! empty($template_path) ? $template_path : $template_include_path;
-            $this->_template      = basename($this->_template_path);
-            return $this->_template_path;
-        }
-        return $template_include_path;
-    }
-
-
-    /**
-     *    get_selected_template
-     *
-     * @access    public
-     * @param bool $with_path
-     * @return    string
-     */
-    public function get_selected_template($with_path = false)
-    {
-        return $with_path ? $this->_template_path : $this->_template;
-    }
-
-
-
-    /**
-     * @deprecated 4.9.26
-     * @param string $shortcode_class
-     * @param \WP    $wp
-     */
-    public function initialize_shortcode($shortcode_class = '', WP $wp = null)
-    {
-        \EE_Error::doing_it_wrong(
-            __METHOD__,
-            __(
-                'Usage is deprecated. Please use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::initializeShortcode() instead.',
-                'event_espresso'
-            ),
-            '4.9.26'
-        );
-        $this->getLegacyShortcodesManager()->initializeShortcode($shortcode_class, $wp);
-    }
+	// public function the_content( $the_content ) {
+	// 	// nothing gets loaded at this point unless other systems turn this hookpoint on by using:  add_filter( 'FHEE_run_EE_the_content', '__return_true' );
+	// 	if ( apply_filters( 'FHEE_run_EE_the_content', FALSE ) ) {
+	// 	}
+	// 	return $the_content;
+	// }
+
+
+
+	/***********************************************        WP_FOOTER         ***********************************************/
+
+
+	/**
+	 * display_errors
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function display_errors()
+	{
+		static $shown_already = false;
+		do_action('AHEE__EE_Front_Controller__display_errors__begin');
+		if (
+			! $shown_already
+			&& apply_filters('FHEE__EE_Front_Controller__display_errors', true)
+			&& is_main_query()
+			&& ! is_feed()
+			&& in_the_loop()
+			&& $this->Request_Handler->is_espresso_page()
+		) {
+			echo EE_Error::get_notices();
+			$shown_already = true;
+			EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
+		}
+		do_action('AHEE__EE_Front_Controller__display_errors__end');
+	}
+
+
+
+
+
+	/***********************************************        UTILITIES         ***********************************************/
+	/**
+	 *    template_include
+	 *
+	 * @access    public
+	 * @param   string $template_include_path
+	 * @return    string
+	 */
+	public function template_include($template_include_path = null)
+	{
+		if ($this->Request_Handler->is_espresso_page()) {
+			$this->_template_path = ! empty($this->_template_path) ? basename($this->_template_path) : basename($template_include_path);
+			$template_path        = EEH_Template::locate_template($this->_template_path, array(), false);
+			$this->_template_path = ! empty($template_path) ? $template_path : $template_include_path;
+			$this->_template      = basename($this->_template_path);
+			return $this->_template_path;
+		}
+		return $template_include_path;
+	}
+
+
+	/**
+	 *    get_selected_template
+	 *
+	 * @access    public
+	 * @param bool $with_path
+	 * @return    string
+	 */
+	public function get_selected_template($with_path = false)
+	{
+		return $with_path ? $this->_template_path : $this->_template;
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.26
+	 * @param string $shortcode_class
+	 * @param \WP    $wp
+	 */
+	public function initialize_shortcode($shortcode_class = '', WP $wp = null)
+	{
+		\EE_Error::doing_it_wrong(
+			__METHOD__,
+			__(
+				'Usage is deprecated. Please use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::initializeShortcode() instead.',
+				'event_espresso'
+			),
+			'4.9.26'
+		);
+		$this->getLegacyShortcodesManager()->initializeShortcode($shortcode_class, $wp);
+	}
 
 }
 // End of file EE_Front_Controller.core.php

Spacing +7 added lines, -7 removed lines

@@ -98,7 +98,7 @@ 
         do_action('AHEE__EE_Front_Controller__construct__done', $this);
         // for checking that browser cookies are enabled
         if (apply_filters('FHEE__EE_Front_Controller____construct__set_test_cookie', true)) {
-            setcookie('ee_cookie_test', uniqid('ect',true), time() + DAY_IN_SECONDS, '/');
+            setcookie('ee_cookie_test', uniqid('ect', true), time() + DAY_IN_SECONDS, '/');
         }
     }
 
@@ -290,14 +290,14 @@ 
     public function get_header()
     {
         global $wp_query;
-        if (empty($wp_query->posts)){
+        if (empty($wp_query->posts)) {
             return;
         }
         // if we already know this is an espresso page, then load assets
         $load_assets = $this->Request_Handler->is_espresso_page();
         // if we are already loading assets then just move along, otherwise check for widgets
         $load_assets = $load_assets ? $load_assets : $this->espresso_widgets_in_active_sidebars();
-        if ( $load_assets){
+        if ($load_assets) {
             wp_enqueue_style('espresso_default');
             wp_enqueue_style('espresso_custom_css');
             wp_enqueue_script('espresso_core');
@@ -353,7 +353,7 @@ 
         print(
             apply_filters(
                 'FHEE__EE_Front_Controller__header_meta_tag',
-                '<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n")
+                '<meta name="generator" content="Event Espresso Version '.EVENT_ESPRESSO_VERSION."\" />\n")
         );
 
         //let's exclude all event type taxonomy term archive pages from search engine indexing
@@ -362,14 +362,14 @@ 
         if (
             (
                 is_tax('espresso_event_type')
-                && get_option( 'blog_public' ) !== '0'
+                && get_option('blog_public') !== '0'
             )
             || is_page(EE_Registry::instance()->CFG->core->get_critical_pages_array())
         ) {
             print(
                 apply_filters(
                     'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
-                    '<meta name="robots" content="noindex,follow" />' . "\n"
+                    '<meta name="robots" content="noindex,follow" />'."\n"
                 )
             );
         }
@@ -441,7 +441,7 @@ 
         ) {
             echo EE_Error::get_notices();
             $shown_already = true;
-            EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
+            EEH_Template::display_template(EE_TEMPLATES.'espresso-ajax-notices.template.php');
         }
         do_action('AHEE__EE_Front_Controller__display_errors__end');
     }

core/EE_Registry.core.php

Indentation +1340 added lines, -1340 removed lines

@@ -16,1376 +16,1376 @@
 class EE_Registry
 {
 
-    /**
-     *    EE_Registry Object
-     *
-     * @var EE_Registry $_instance
-     * @access    private
-     */
-    private static $_instance = null;
-
-    /**
-     * @var EE_Dependency_Map $_dependency_map
-     * @access    protected
-     */
-    protected $_dependency_map = null;
-
-    /**
-     * @var array $_class_abbreviations
-     * @access    protected
-     */
-    protected $_class_abbreviations = array();
-
-    /**
-     * @access public
-     * @var \EventEspresso\core\services\commands\CommandBusInterface $BUS
-     */
-    public $BUS;
-
-    /**
-     *    EE_Cart Object
-     *
-     * @access    public
-     * @var    EE_Cart $CART
-     */
-    public $CART = null;
-
-    /**
-     *    EE_Config Object
-     *
-     * @access    public
-     * @var    EE_Config $CFG
-     */
-    public $CFG = null;
-
-    /**
-     * EE_Network_Config Object
-     *
-     * @access public
-     * @var EE_Network_Config $NET_CFG
-     */
-    public $NET_CFG = null;
-
-    /**
-     *    StdClass object for storing library classes in
-     *
-     * @public LIB
-     * @var StdClass $LIB
-     */
-    public $LIB = null;
-
-    /**
-     *    EE_Request_Handler Object
-     *
-     * @access    public
-     * @var    EE_Request_Handler $REQ
-     */
-    public $REQ = null;
-
-    /**
-     *    EE_Session Object
-     *
-     * @access    public
-     * @var    EE_Session $SSN
-     */
-    public $SSN = null;
-
-    /**
-     * holds the ee capabilities object.
-     *
-     * @since 4.5.0
-     * @var EE_Capabilities
-     */
-    public $CAP = null;
-
-    /**
-     * holds the EE_Message_Resource_Manager object.
-     *
-     * @since 4.9.0
-     * @var EE_Message_Resource_Manager
-     */
-    public $MRM = null;
-
-
-    /**
-     * Holds the Assets Registry instance
-     * @var Registry
-     */
-    public $AssetsRegistry = null;
-
-    /**
-     *    $addons - StdClass object for holding addons which have registered themselves to work with EE core
-     *
-     * @access    public
-     * @var    EE_Addon[]
-     */
-    public $addons = null;
-
-    /**
-     *    $models
-     * @access    public
-     * @var    EEM_Base[] $models keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
-     */
-    public $models = array();
-
-    /**
-     *    $modules
-     * @access    public
-     * @var    EED_Module[] $modules
-     */
-    public $modules = null;
-
-    /**
-     *    $shortcodes
-     * @access    public
-     * @var    EES_Shortcode[] $shortcodes
-     */
-    public $shortcodes = null;
-
-    /**
-     *    $widgets
-     * @access    public
-     * @var    WP_Widget[] $widgets
-     */
-    public $widgets = null;
-
-    /**
-     * $non_abstract_db_models
-     * @access public
-     * @var array this is an array of all implemented model names (i.e. not the parent abstract models, or models
-     * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
-     * Keys are model "short names" (eg "Event") as used in model relations, and values are
-     * classnames (eg "EEM_Event")
-     */
-    public $non_abstract_db_models = array();
-
-
-    /**
-     *    $i18n_js_strings - internationalization for JS strings
-     *    usage:   EE_Registry::i18n_js_strings['string_key'] = __( 'string to translate.', 'event_espresso' );
-     *    in js file:  var translatedString = eei18n.string_key;
-     *
-     * @access    public
-     * @var    array
-     */
-    public static $i18n_js_strings = array();
-
-
-    /**
-     *    $main_file - path to espresso.php
-     *
-     * @access    public
-     * @var    array
-     */
-    public $main_file;
-
-    /**
-     * array of ReflectionClass objects where the key is the class name
-     *
-     * @access    public
-     * @var ReflectionClass[]
-     */
-    public $_reflectors;
-
-    /**
-     * boolean flag to indicate whether or not to load/save dependencies from/to the cache
-     *
-     * @access    protected
-     * @var boolean $_cache_on
-     */
-    protected $_cache_on = true;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param  \EE_Dependency_Map $dependency_map
-     * @return \EE_Registry instance
-     */
-    public static function instance(\EE_Dependency_Map $dependency_map = null)
-    {
-        // check if class object is instantiated
-        if ( ! self::$_instance instanceof EE_Registry) {
-            self::$_instance = new EE_Registry($dependency_map);
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     *protected constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access protected
-     * @param  \EE_Dependency_Map $dependency_map
-     * @return \EE_Registry
-     */
-    protected function __construct(\EE_Dependency_Map $dependency_map)
-    {
-        $this->_dependency_map = $dependency_map;
-        add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
-    }
-
-
-
-    /**
-     * initialize
-     */
-    public function initialize()
-    {
-        $this->_class_abbreviations = apply_filters(
-            'FHEE__EE_Registry____construct___class_abbreviations',
-            array(
-                'EE_Config'                                       => 'CFG',
-                'EE_Session'                                      => 'SSN',
-                'EE_Capabilities'                                 => 'CAP',
-                'EE_Cart'                                         => 'CART',
-                'EE_Network_Config'                               => 'NET_CFG',
-                'EE_Request_Handler'                              => 'REQ',
-                'EE_Message_Resource_Manager'                     => 'MRM',
-                'EventEspresso\core\services\commands\CommandBus' => 'BUS',
-                'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
-            )
-        );
-        // class library
-        $this->LIB = new stdClass();
-        $this->addons = new stdClass();
-        $this->modules = new stdClass();
-        $this->shortcodes = new stdClass();
-        $this->widgets = new stdClass();
-        $this->load_core('Base', array(), true);
-        // add our request and response objects to the cache
-        $request_loader = $this->_dependency_map->class_loader('EE_Request');
-        $this->_set_cached_class(
-            $request_loader(),
-            'EE_Request'
-        );
-        $response_loader = $this->_dependency_map->class_loader('EE_Response');
-        $this->_set_cached_class(
-            $response_loader(),
-            'EE_Response'
-        );
-        add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
-    }
-
-
-
-    /**
-     *    init
-     *
-     * @access    public
-     * @return    void
-     */
-    public function init()
-    {
-        // Get current page protocol
-        $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
-        // Output admin-ajax.php URL with same protocol as current page
-        self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
-        self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false;
-    }
-
-
-
-    /**
-     * localize_i18n_js_strings
-     *
-     * @return string
-     */
-    public static function localize_i18n_js_strings()
-    {
-        $i18n_js_strings = (array)EE_Registry::$i18n_js_strings;
-        foreach ($i18n_js_strings as $key => $value) {
-            if (is_scalar($value)) {
-                $i18n_js_strings[$key] = html_entity_decode((string)$value, ENT_QUOTES, 'UTF-8');
-            }
-        }
-        return "/* <![CDATA[ */ var eei18n = " . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
-    }
-
-
-
-    /**
-     * @param mixed string | EED_Module $module
-     */
-    public function add_module($module)
-    {
-        if ($module instanceof EED_Module) {
-            $module_class = get_class($module);
-            $this->modules->{$module_class} = $module;
-        } else {
-            if ( ! class_exists('EE_Module_Request_Router')) {
-                $this->load_core('Module_Request_Router');
-            }
-            $this->modules->{$module} = EE_Module_Request_Router::module_factory($module);
-        }
-    }
-
-
-
-    /**
-     * @param string $module_name
-     * @return mixed EED_Module | NULL
-     */
-    public function get_module($module_name = '')
-    {
-        return isset($this->modules->{$module_name}) ? $this->modules->{$module_name} : null;
-    }
-
-
-
-    /**
-     *    loads core classes - must be singletons
-     *
-     * @access    public
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     */
-    public function load_core($class_name, $arguments = array(), $load_only = false)
-    {
-        $core_paths = apply_filters(
-            'FHEE__EE_Registry__load_core__core_paths',
-            array(
-                EE_CORE,
-                EE_ADMIN,
-                EE_CPTS,
-                EE_CORE . 'data_migration_scripts' . DS,
-                EE_CORE . 'request_stack' . DS,
-                EE_CORE . 'middleware' . DS,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load($core_paths, 'EE_', $class_name, 'core', $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     *    loads service classes
-     *
-     * @access    public
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     */
-    public function load_service($class_name, $arguments = array(), $load_only = false)
-    {
-        $service_paths = apply_filters(
-            'FHEE__EE_Registry__load_service__service_paths',
-            array(
-                EE_CORE . 'services' . DS,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load($service_paths, 'EE_', $class_name, 'class', $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     *    loads data_migration_scripts
-     *
-     * @access    public
-     * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
-     * @param mixed  $arguments
-     * @return EE_Data_Migration_Script_Base|mixed
-     */
-    public function load_dms($class_name, $arguments = array())
-    {
-        // retrieve instantiated class
-        return $this->_load(EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(), 'EE_DMS_', $class_name, 'dms', $arguments, false, false, false);
-    }
-
-
-
-    /**
-     *    loads object creating classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: attendee
-     * @param mixed  $arguments  - an array of arguments to pass to the class
-     * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to instantiate
-     * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then set this to FALSE (ie. when instantiating model objects from client in a loop)
-     * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate (default)
-     * @return EE_Base_Class | bool
-     */
-    public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
-    {
-        $paths = apply_filters('FHEE__EE_Registry__load_class__paths', array(
-            EE_CORE,
-            EE_CLASSES,
-            EE_BUSINESS,
-        ));
-        // retrieve instantiated class
-        return $this->_load($paths, 'EE_', $class_name, 'class', $arguments, $from_db, $cache, $load_only);
-    }
-
-
-
-    /**
-     *    loads helper classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EEH_Base | bool
-     */
-    public function load_helper($class_name, $arguments = array(), $load_only = true)
-    {
-        // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
-        $helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
-        // retrieve instantiated class
-        return $this->_load($helper_paths, 'EEH_', $class_name, 'helper', $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     *    loads core classes - must be singletons
-     *
-     * @access    public
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @param bool   $cache      whether to cache the object or not.
-     * @return mixed
-     */
-    public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
-    {
-        $paths = array(
-            EE_LIBRARIES,
-            EE_LIBRARIES . 'messages' . DS,
-            EE_LIBRARIES . 'shortcodes' . DS,
-            EE_LIBRARIES . 'qtips' . DS,
-            EE_LIBRARIES . 'payment_methods' . DS,
-        );
-        // retrieve instantiated class
-        return $this->_load($paths, 'EE_', $class_name, 'lib', $arguments, false, $cache, $load_only);
-    }
-
-
-
-    /**
-     *    loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EEM_Base | bool
-     */
-    public function load_model($class_name, $arguments = array(), $load_only = false)
-    {
-        $paths = apply_filters('FHEE__EE_Registry__load_model__paths', array(
-            EE_MODELS,
-            EE_CORE,
-        ));
-        // retrieve instantiated class
-        return $this->_load($paths, 'EEM_', $class_name, 'model', $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     *    loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed | bool
-     */
-    public function load_model_class($class_name, $arguments = array(), $load_only = true)
-    {
-        $paths = array(
-            EE_MODELS . 'fields' . DS,
-            EE_MODELS . 'helpers' . DS,
-            EE_MODELS . 'relations' . DS,
-            EE_MODELS . 'strategies' . DS,
-        );
-        // retrieve instantiated class
-        return $this->_load($paths, 'EE_', $class_name, '', $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     * Determines if $model_name is the name of an actual EE model.
-     *
-     * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
-     * @return boolean
-     */
-    public function is_model_name($model_name)
-    {
-        return isset($this->models[$model_name]) ? true : false;
-    }
-
-
-
-    /**
-     *    generic class loader
-     *
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $file_name    - file name  ie:  my_file.php, including extension
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     */
-    public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
-    {
-        // retrieve instantiated class
-        return $this->_load($path_to_file, '', $file_name, $type, $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     *    load_addon
-     *
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $class_name   - full class name  ie:  My_Class
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EE_Addon
-     */
-    public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
-    {
-        // retrieve instantiated class
-        return $this->_load($path_to_file, 'addon', $class_name, $type, $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     * instantiates, caches, and automatically resolves dependencies
-     * for classes that use a Fully Qualified Class Name.
-     * if the class is not capable of being loaded using PSR-4 autoloading,
-     * then you need to use one of the existing load_*() methods
-     * which can resolve the classname and filepath from the passed arguments
-     *
-     * @param bool|string $class_name   Fully Qualified Class Name
-     * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
-     * @param bool        $cache        whether to cache the instantiated object for reuse
-     * @param bool        $from_db      some classes are instantiated from the db
-     *                                  and thus call a different method to instantiate
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
-     * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
-     * @return mixed                    null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     */
-    public function create(
-        $class_name = false,
-        $arguments = array(),
-        $cache = false,
-        $from_db = false,
-        $load_only = false,
-        $addon = false
-    ) {
-        $class_name = ltrim($class_name, '\\');
-        $class_name = $this->_dependency_map->get_alias($class_name);
-        if ( ! class_exists($class_name)) {
-            // maybe the class is registered with a preceding \
-            $class_name = strpos($class_name, '\\') !== 0 ? '\\' . $class_name : $class_name;
-            // still doesn't exist ?
-            if ( ! class_exists($class_name)) {
-                return null;
-            }
-        }
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only) {
-            return true;
-        }
-        $addon = $addon ? 'addon' : '';
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $addon);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }
-        // instantiate the requested object
-        $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
-        if ($this->_cache_on && $cache) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class($class_obj, $class_name, $addon, $from_db);
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-
-    /**
-     * instantiates, caches, and injects dependencies for classes
-     *
-     * @param array       $file_paths   an array of paths to folders to look in
-     * @param string      $class_prefix EE  or EEM or... ???
-     * @param bool|string $class_name   $class name
-     * @param string      $type         file type - core? class? helper? model?
-     * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
-     * @param bool        $from_db      some classes are instantiated from the db
-     *                                  and thus call a different method to instantiate
-     * @param bool        $cache        whether to cache the instantiated object for reuse
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
-     * @return null|object|bool         null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     */
-    protected function _load(
-        $file_paths = array(),
-        $class_prefix = 'EE_',
-        $class_name = false,
-        $type = 'class',
-        $arguments = array(),
-        $from_db = false,
-        $cache = true,
-        $load_only = false
-    ) {
-        $class_name = ltrim($class_name, '\\');
-        // strip php file extension
-        $class_name = str_replace('.php', '', trim($class_name));
-        // does the class have a prefix ?
-        if ( ! empty($class_prefix) && $class_prefix != 'addon') {
-            // make sure $class_prefix is uppercase
-            $class_prefix = strtoupper(trim($class_prefix));
-            // add class prefix ONCE!!!
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
-        }
-        $class_name = $this->_dependency_map->get_alias($class_name);
-        $class_exists = class_exists($class_name);
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only && $class_exists) {
-            return true;
-        }
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $class_prefix);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }
-        // if the class doesn't already exist.. then we need to try and find the file and load it
-        if ( ! $class_exists) {
-            // get full path to file
-            $path = $this->_resolve_path($class_name, $type, $file_paths);
-            // load the file
-            $loaded = $this->_require_file($path, $class_name, $type, $file_paths);
-            // if loading failed, or we are only loading a file but NOT instantiating an object
-            if ( ! $loaded || $load_only) {
-                // return boolean if only loading, or null if an object was expected
-                return $load_only ? $loaded : null;
-            }
-        }
-        // instantiate the requested object
-        $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
-        if ($this->_cache_on && $cache) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class($class_obj, $class_name, $class_prefix, $from_db);
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-
-    /**
-     * _get_cached_class
-     * attempts to find a cached version of the requested class
-     * by looking in the following places:
-     *        $this->{$class_abbreviation}            ie:    $this->CART
-     *        $this->{$class_name}                        ie:    $this->Some_Class
-     *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
-     *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
-     *
-     * @access protected
-     * @param string $class_name
-     * @param string $class_prefix
-     * @return mixed
-     */
-    protected function _get_cached_class($class_name, $class_prefix = '')
-    {
-        if (isset($this->_class_abbreviations[$class_name])) {
-            $class_abbreviation = $this->_class_abbreviations[$class_name];
-        } else {
-            // have to specify something, but not anything that will conflict
-            $class_abbreviation = 'FANCY_BATMAN_PANTS';
-        }
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation}) && ! is_null($this->{$class_abbreviation})) {
-            return $this->{$class_abbreviation};
-        } else if (isset ($this->{$class_name})) {
-            return $this->{$class_name};
-        } else if (isset ($this->LIB->{$class_name})) {
-            return $this->LIB->{$class_name};
-        } else if ($class_prefix == 'addon' && isset ($this->addons->{$class_name})) {
-            return $this->addons->{$class_name};
-        }
-        return null;
-    }
-
-
-
-    /**
-     * _resolve_path
-     * attempts to find a full valid filepath for the requested class.
-     * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
-     * then returns that path if the target file has been found and is readable
-     *
-     * @access protected
-     * @param string $class_name
-     * @param string $type
-     * @param array  $file_paths
-     * @return string | bool
-     */
-    protected function _resolve_path($class_name, $type = '', $file_paths = array())
-    {
-        // make sure $file_paths is an array
-        $file_paths = is_array($file_paths) ? $file_paths : array($file_paths);
-        // cycle thru paths
-        foreach ($file_paths as $key => $file_path) {
-            // convert all separators to proper DS, if no filepath, then use EE_CLASSES
-            $file_path = $file_path ? str_replace(array('/', '\\'), DS, $file_path) : EE_CLASSES;
-            // prep file type
-            $type = ! empty($type) ? trim($type, '.') . '.' : '';
-            // build full file path
-            $file_paths[$key] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php';
-            //does the file exist and can be read ?
-            if (is_readable($file_paths[$key])) {
-                return $file_paths[$key];
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * _require_file
-     * basically just performs a require_once()
-     * but with some error handling
-     *
-     * @access protected
-     * @param  string $path
-     * @param  string $class_name
-     * @param  string $type
-     * @param  array  $file_paths
-     * @return boolean
-     * @throws \EE_Error
-     */
-    protected function _require_file($path, $class_name, $type = '', $file_paths = array())
-    {
-        // don't give up! you gotta...
-        try {
-            //does the file exist and can it be read ?
-            if ( ! $path) {
-                // so sorry, can't find the file
-                throw new EE_Error (
-                    sprintf(
-                        __('The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s', 'event_espresso'),
-                        trim($type, '.'),
-                        $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
-                    )
-                );
-            }
-            // get the file
-            require_once($path);
-            // if the class isn't already declared somewhere
-            if (class_exists($class_name, false) === false) {
-                // so sorry, not a class
-                throw new EE_Error(
-                    sprintf(
-                        __('The %s file %s does not appear to contain the %s Class.', 'event_espresso'),
-                        $type,
-                        $path,
-                        $class_name
-                    )
-                );
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * _create_object
-     * Attempts to instantiate the requested class via any of the
-     * commonly used instantiation methods employed throughout EE.
-     * The priority for instantiation is as follows:
-     *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
-     *        - model objects via their 'new_instance_from_db' method
-     *        - model objects via their 'new_instance' method
-     *        - "singleton" classes" via their 'instance' method
-     *    - standard instantiable classes via their __constructor
-     * Prior to instantiation, if the classname exists in the dependency_map,
-     * then the constructor for the requested class will be examined to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     *
-     * @access protected
-     * @param string $class_name
-     * @param array  $arguments
-     * @param string $type
-     * @param bool   $from_db
-     * @return null | object
-     * @throws \EE_Error
-     */
-    protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
-    {
-        $class_obj = null;
-        $instantiation_mode = '0) none';
-        // don't give up! you gotta...
-        try {
-            // create reflection
-            $reflector = $this->get_ReflectionClass($class_name);
-            // make sure arguments are an array
-            $arguments = is_array($arguments) ? $arguments : array($arguments);
-            // and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
-            // else wrap it in an additional array so that it doesn't get split into multiple parameters
-            $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
-                ? $arguments
-                : array($arguments);
-            // attempt to inject dependencies ?
-            if ($this->_dependency_map->has($class_name)) {
-                $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
-            }
-            // instantiate the class if possible
-            if ($reflector->isAbstract()) {
-                // nothing to instantiate, loading file was enough
-                // does not throw an exception so $instantiation_mode is unused
-                // $instantiation_mode = "1) no constructor abstract class";
-                $class_obj = true;
-            } else if ($reflector->getConstructor() === null && $reflector->isInstantiable() && empty($arguments)) {
-                // no constructor = static methods only... nothing to instantiate, loading file was enough
-                $instantiation_mode = "2) no constructor but instantiable";
-                $class_obj = $reflector->newInstance();
-            } else if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
-                $instantiation_mode = "3) new_instance_from_db()";
-                $class_obj = call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
-            } else if (method_exists($class_name, 'new_instance')) {
-                $instantiation_mode = "4) new_instance()";
-                $class_obj = call_user_func_array(array($class_name, 'new_instance'), $arguments);
-            } else if (method_exists($class_name, 'instance')) {
-                $instantiation_mode = "5) instance()";
-                $class_obj = call_user_func_array(array($class_name, 'instance'), $arguments);
-            } else if ($reflector->isInstantiable()) {
-                $instantiation_mode = "6) constructor";
-                $class_obj = $reflector->newInstanceArgs($arguments);
-            } else {
-                // heh ? something's not right !
-                throw new EE_Error(
-                    sprintf(
-                        __('The %s file %s could not be instantiated.', 'event_espresso'),
-                        $type,
-                        $class_name
-                    )
-                );
-            }
-        } catch (Exception $e) {
-            if ( ! $e instanceof EE_Error) {
-                $e = new EE_Error(
-                    sprintf(
-                        __('The following error occurred while attempting to instantiate "%1$s": %2$s %3$s %2$s instantiation mode : %4$s', 'event_espresso'),
-                        $class_name,
-                        '<br />',
-                        $e->getMessage(),
-                        $instantiation_mode
-                    )
-                );
-            }
-            $e->get_error();
-        }
-        return $class_obj;
-    }
-
-
-
-    /**
-     * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
-     * @param array $array
-     * @return bool
-     */
-    protected function _array_is_numerically_and_sequentially_indexed(array $array)
-    {
-        return ! empty($array) ? array_keys($array) === range(0, count($array) - 1) : true;
-    }
-
-
-
-    /**
-     * getReflectionClass
-     * checks if a ReflectionClass object has already been generated for a class
-     * and returns that instead of creating a new one
-     *
-     * @access public
-     * @param string $class_name
-     * @return ReflectionClass
-     */
-    public function get_ReflectionClass($class_name)
-    {
-        if (
-            ! isset($this->_reflectors[$class_name])
-            || ! $this->_reflectors[$class_name] instanceof ReflectionClass
-        ) {
-            $this->_reflectors[$class_name] = new ReflectionClass($class_name);
-        }
-        return $this->_reflectors[$class_name];
-    }
-
-
-
-    /**
-     * _resolve_dependencies
-     * examines the constructor for the requested class to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     * PLZ NOTE: this is achieved by type hinting the constructor params
-     * For example:
-     *        if attempting to load a class "Foo" with the following constructor:
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
-     *        but only IF they are NOT already present in the incoming arguments array,
-     *        and the correct classes can be loaded
-     *
-     * @access protected
-     * @param ReflectionClass $reflector
-     * @param string          $class_name
-     * @param array           $arguments
-     * @return array
-     * @throws \ReflectionException
-     */
-    protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, $arguments = array())
-    {
-        // let's examine the constructor
-        $constructor = $reflector->getConstructor();
-        // whu? huh? nothing?
-        if ( ! $constructor) {
-            return $arguments;
-        }
-        // get constructor parameters
-        $params = $constructor->getParameters();
-        // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
-        $argument_keys = array_keys($arguments);
-        // now loop thru all of the constructors expected parameters
-        foreach ($params as $index => $param) {
-            // is this a dependency for a specific class ?
-            $param_class = $param->getClass() ? $param->getClass()->name : null;
-            if (
-                // param is not even a class
-                empty($param_class)
-                // and something already exists in the incoming arguments for this param
-                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
-            ) {
-                // so let's skip this argument and move on to the next
-                continue;
-            } else if (
-                // parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
-                ! empty($param_class)
-                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
-                && $arguments[$argument_keys[$index]] instanceof $param_class
-            ) {
-                // skip this argument and move on to the next
-                continue;
-            } else if (
-                // parameter is type hinted as a class, and should be injected
-                ! empty($param_class)
-                && $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
-            ) {
-                $arguments = $this->_resolve_dependency($class_name, $param_class, $arguments, $index);
-            } else {
-                try {
-                    $arguments[$index] = $param->getDefaultValue();
-                } catch (ReflectionException $e) {
-                    throw new ReflectionException(
-                        sprintf(
-                            __('%1$s for parameter "$%2$s"', 'event_espresso'),
-                            $e->getMessage(),
-                            $param->getName()
-                        )
-                    );
-                }
-            }
-        }
-        return $arguments;
-    }
-
-
-
-    /**
-     * @access protected
-     * @param string $class_name
-     * @param string $param_class
-     * @param array  $arguments
-     * @param mixed  $index
-     * @return array
-     */
-    protected function _resolve_dependency($class_name, $param_class, $arguments, $index)
-    {
-        $dependency = null;
-        // should dependency be loaded from cache ?
-        $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency($class_name, $param_class)
-                    !== EE_Dependency_Map::load_new_object
-            ? true
-            : false;
-        // we might have a dependency...
-        // let's MAYBE try and find it in our cache if that's what's been requested
-        $cached_class = $cache_on ? $this->_get_cached_class($param_class) : null;
-        // and grab it if it exists
-        if ($cached_class instanceof $param_class) {
-            $dependency = $cached_class;
-        } else if ($param_class != $class_name) {
-            // obtain the loader method from the dependency map
-            $loader = $this->_dependency_map->class_loader($param_class);
-            // is loader a custom closure ?
-            if ($loader instanceof Closure) {
-                $dependency = $loader();
-            } else {
-                // set the cache on property for the recursive loading call
-                $this->_cache_on = $cache_on;
-                // if not, then let's try and load it via the registry
-                if (method_exists($this, $loader)) {
-                    $dependency = $this->{$loader}($param_class);
-                } else {
-                    $dependency = $this->create($param_class, array(), $cache_on);
-                }
-            }
-        }
-        // did we successfully find the correct dependency ?
-        if ($dependency instanceof $param_class) {
-            // then let's inject it into the incoming array of arguments at the correct location
-            if (isset($argument_keys[$index])) {
-                $arguments[$argument_keys[$index]] = $dependency;
-            } else {
-                $arguments[$index] = $dependency;
-            }
-        }
-        return $arguments;
-    }
-
-
-
-    /**
-     * _set_cached_class
-     * attempts to cache the instantiated class locally
-     * in one of the following places, in the following order:
-     *        $this->{class_abbreviation}   ie:    $this->CART
-     *        $this->{$class_name}          ie:    $this->Some_Class
-     *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
-     *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
-     *
-     * @access protected
-     * @param object $class_obj
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param bool   $from_db
-     * @return void
-     */
-    protected function _set_cached_class($class_obj, $class_name, $class_prefix = '', $from_db = false)
-    {
-        if (empty($class_obj)) {
-            return;
-        }
-        // return newly instantiated class
-        if (isset($this->_class_abbreviations[$class_name])) {
-            $class_abbreviation = $this->_class_abbreviations[$class_name];
-            $this->{$class_abbreviation} = $class_obj;
-        } else if (property_exists($this, $class_name)) {
-            $this->{$class_name} = $class_obj;
-        } else if ($class_prefix == 'addon') {
-            $this->addons->{$class_name} = $class_obj;
-        } else if ( ! $from_db) {
-            $this->LIB->{$class_name} = $class_obj;
-        }
-    }
-
-
-
-    /**
-     * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
-     *
-     * @param string $classname PLEASE NOTE: the class name needs to match what's registered
-     *                          in the EE_Dependency_Map::$_class_loaders array,
-     *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
-     * @param array  $arguments
-     * @return object
-     */
-    public static function factory($classname, $arguments = array())
-    {
-        $loader = self::instance()->_dependency_map->class_loader($classname);
-        if ($loader instanceof Closure) {
-            return $loader($arguments);
-        } else if (method_exists(EE_Registry::instance(), $loader)) {
-            return EE_Registry::instance()->{$loader}($classname, $arguments);
-        }
-        return null;
-    }
-
-
-
-    /**
-     * Gets the addon by its name/slug (not classname. For that, just
-     * use the classname as the property name on EE_Config::instance()->addons)
-     *
-     * @param string $name
-     * @return EE_Addon
-     */
-    public function get_addon_by_name($name)
-    {
-        foreach ($this->addons as $addon) {
-            if ($addon->name() == $name) {
-                return $addon;
-            }
-        }
-        return null;
-    }
-
-
-
-    /**
-     * Gets an array of all the registered addons, where the keys are their names. (ie, what each returns for their name() function) They're already available on EE_Config::instance()->addons as properties, where each property's name is
-     * the addon's classname. So if you just want to get the addon by classname, use EE_Config::instance()->addons->{classname}
-     *
-     * @return EE_Addon[] where the KEYS are the addon's name()
-     */
-    public function get_addons_by_name()
-    {
-        $addons = array();
-        foreach ($this->addons as $addon) {
-            $addons[$addon->name()] = $addon;
-        }
-        return $addons;
-    }
-
-
-
-    /**
-     * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
-     * a stale copy of it around
-     *
-     * @param string $model_name
-     * @return \EEM_Base
-     * @throws \EE_Error
-     */
-    public function reset_model($model_name)
-    {
-        $model_class_name = strpos($model_name, 'EEM_') !== 0 ? "EEM_{$model_name}" : $model_name;
-        if ( ! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
-            return null;
-        }
-        //get that model reset it and make sure we nuke the old reference to it
-        if ($this->LIB->{$model_class_name} instanceof $model_class_name && is_callable(array($model_class_name, 'reset'))) {
-            $this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset();
-        } else {
-            throw new EE_Error(sprintf(__('Model %s does not have a method "reset"', 'event_espresso'), $model_name));
-        }
-        return $this->LIB->{$model_class_name};
-    }
-
-
-
-    /**
-     * Resets the registry.
-     * The criteria for what gets reset is based on what can be shared between sites on the same request when switch_to_blog
-     * is used in a multisite install.  Here is a list of things that are NOT reset.
-     * - $_dependency_map
-     * - $_class_abbreviations
-     * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
-     * - $REQ:  Still on the same request so no need to change.
-     * - $CAP: There is no site specific state in the EE_Capability class.
-     * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only one Session
-     *         can be active in a single request.  Resetting could resolve in "headers already sent" errors.
-     * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
-     *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
-     *             switch or on the restore.
-     * - $modules
-     * - $shortcodes
-     * - $widgets
-     *
-     * @param boolean $hard             whether to reset data in the database too, or just refresh
-     *                                  the Registry to its state at the beginning of the request
-     * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
-     *                                  or just reset without re-instantiating (handy to set to FALSE if you're not sure if you CAN
-     *                                  currently reinstantiate the singletons at the moment)
-     * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so client
-     *                                  code instead can just change the model context to a different blog id if necessary
-     * @return EE_Registry
-     */
-    public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
-    {
-        $instance = self::instance();
-        EEH_Activation::reset();
-        //properties that get reset
-        $instance->_cache_on = true;
-        $instance->CFG = EE_Config::reset($hard, $reinstantiate);
-        $instance->CART = null;
-        $instance->MRM = null;
-        $instance->AssetsRegistry = null;
-        $instance->AssetsRegistry = $instance->create('EventEspresso\core\services\assets\Registry');
-        //messages reset
-        EED_Messages::reset();
-        if ($reset_models) {
-            foreach (array_keys($instance->non_abstract_db_models) as $model_name) {
-                $instance->reset_model($model_name);
-            }
-        }
-        $instance->LIB = new stdClass();
-        return $instance;
-    }
-
-
-
-    /**
-     * @override magic methods
-     * @return void
-     */
-    public final function __destruct()
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     * @param $b
-     */
-    public final function __call($a, $b)
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     */
-    public final function __get($a)
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     * @param $b
-     */
-    public final function __set($a, $b)
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     */
-    public final function __isset($a)
-    {
-    }
+	/**
+	 *    EE_Registry Object
+	 *
+	 * @var EE_Registry $_instance
+	 * @access    private
+	 */
+	private static $_instance = null;
+
+	/**
+	 * @var EE_Dependency_Map $_dependency_map
+	 * @access    protected
+	 */
+	protected $_dependency_map = null;
+
+	/**
+	 * @var array $_class_abbreviations
+	 * @access    protected
+	 */
+	protected $_class_abbreviations = array();
+
+	/**
+	 * @access public
+	 * @var \EventEspresso\core\services\commands\CommandBusInterface $BUS
+	 */
+	public $BUS;
+
+	/**
+	 *    EE_Cart Object
+	 *
+	 * @access    public
+	 * @var    EE_Cart $CART
+	 */
+	public $CART = null;
+
+	/**
+	 *    EE_Config Object
+	 *
+	 * @access    public
+	 * @var    EE_Config $CFG
+	 */
+	public $CFG = null;
+
+	/**
+	 * EE_Network_Config Object
+	 *
+	 * @access public
+	 * @var EE_Network_Config $NET_CFG
+	 */
+	public $NET_CFG = null;
+
+	/**
+	 *    StdClass object for storing library classes in
+	 *
+	 * @public LIB
+	 * @var StdClass $LIB
+	 */
+	public $LIB = null;
+
+	/**
+	 *    EE_Request_Handler Object
+	 *
+	 * @access    public
+	 * @var    EE_Request_Handler $REQ
+	 */
+	public $REQ = null;
+
+	/**
+	 *    EE_Session Object
+	 *
+	 * @access    public
+	 * @var    EE_Session $SSN
+	 */
+	public $SSN = null;
+
+	/**
+	 * holds the ee capabilities object.
+	 *
+	 * @since 4.5.0
+	 * @var EE_Capabilities
+	 */
+	public $CAP = null;
+
+	/**
+	 * holds the EE_Message_Resource_Manager object.
+	 *
+	 * @since 4.9.0
+	 * @var EE_Message_Resource_Manager
+	 */
+	public $MRM = null;
+
+
+	/**
+	 * Holds the Assets Registry instance
+	 * @var Registry
+	 */
+	public $AssetsRegistry = null;
+
+	/**
+	 *    $addons - StdClass object for holding addons which have registered themselves to work with EE core
+	 *
+	 * @access    public
+	 * @var    EE_Addon[]
+	 */
+	public $addons = null;
+
+	/**
+	 *    $models
+	 * @access    public
+	 * @var    EEM_Base[] $models keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
+	 */
+	public $models = array();
+
+	/**
+	 *    $modules
+	 * @access    public
+	 * @var    EED_Module[] $modules
+	 */
+	public $modules = null;
+
+	/**
+	 *    $shortcodes
+	 * @access    public
+	 * @var    EES_Shortcode[] $shortcodes
+	 */
+	public $shortcodes = null;
+
+	/**
+	 *    $widgets
+	 * @access    public
+	 * @var    WP_Widget[] $widgets
+	 */
+	public $widgets = null;
+
+	/**
+	 * $non_abstract_db_models
+	 * @access public
+	 * @var array this is an array of all implemented model names (i.e. not the parent abstract models, or models
+	 * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
+	 * Keys are model "short names" (eg "Event") as used in model relations, and values are
+	 * classnames (eg "EEM_Event")
+	 */
+	public $non_abstract_db_models = array();
+
+
+	/**
+	 *    $i18n_js_strings - internationalization for JS strings
+	 *    usage:   EE_Registry::i18n_js_strings['string_key'] = __( 'string to translate.', 'event_espresso' );
+	 *    in js file:  var translatedString = eei18n.string_key;
+	 *
+	 * @access    public
+	 * @var    array
+	 */
+	public static $i18n_js_strings = array();
+
+
+	/**
+	 *    $main_file - path to espresso.php
+	 *
+	 * @access    public
+	 * @var    array
+	 */
+	public $main_file;
+
+	/**
+	 * array of ReflectionClass objects where the key is the class name
+	 *
+	 * @access    public
+	 * @var ReflectionClass[]
+	 */
+	public $_reflectors;
+
+	/**
+	 * boolean flag to indicate whether or not to load/save dependencies from/to the cache
+	 *
+	 * @access    protected
+	 * @var boolean $_cache_on
+	 */
+	protected $_cache_on = true;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param  \EE_Dependency_Map $dependency_map
+	 * @return \EE_Registry instance
+	 */
+	public static function instance(\EE_Dependency_Map $dependency_map = null)
+	{
+		// check if class object is instantiated
+		if ( ! self::$_instance instanceof EE_Registry) {
+			self::$_instance = new EE_Registry($dependency_map);
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 *protected constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access protected
+	 * @param  \EE_Dependency_Map $dependency_map
+	 * @return \EE_Registry
+	 */
+	protected function __construct(\EE_Dependency_Map $dependency_map)
+	{
+		$this->_dependency_map = $dependency_map;
+		add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
+	}
+
+
+
+	/**
+	 * initialize
+	 */
+	public function initialize()
+	{
+		$this->_class_abbreviations = apply_filters(
+			'FHEE__EE_Registry____construct___class_abbreviations',
+			array(
+				'EE_Config'                                       => 'CFG',
+				'EE_Session'                                      => 'SSN',
+				'EE_Capabilities'                                 => 'CAP',
+				'EE_Cart'                                         => 'CART',
+				'EE_Network_Config'                               => 'NET_CFG',
+				'EE_Request_Handler'                              => 'REQ',
+				'EE_Message_Resource_Manager'                     => 'MRM',
+				'EventEspresso\core\services\commands\CommandBus' => 'BUS',
+				'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
+			)
+		);
+		// class library
+		$this->LIB = new stdClass();
+		$this->addons = new stdClass();
+		$this->modules = new stdClass();
+		$this->shortcodes = new stdClass();
+		$this->widgets = new stdClass();
+		$this->load_core('Base', array(), true);
+		// add our request and response objects to the cache
+		$request_loader = $this->_dependency_map->class_loader('EE_Request');
+		$this->_set_cached_class(
+			$request_loader(),
+			'EE_Request'
+		);
+		$response_loader = $this->_dependency_map->class_loader('EE_Response');
+		$this->_set_cached_class(
+			$response_loader(),
+			'EE_Response'
+		);
+		add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
+	}
+
+
+
+	/**
+	 *    init
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function init()
+	{
+		// Get current page protocol
+		$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
+		// Output admin-ajax.php URL with same protocol as current page
+		self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
+		self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false;
+	}
+
+
+
+	/**
+	 * localize_i18n_js_strings
+	 *
+	 * @return string
+	 */
+	public static function localize_i18n_js_strings()
+	{
+		$i18n_js_strings = (array)EE_Registry::$i18n_js_strings;
+		foreach ($i18n_js_strings as $key => $value) {
+			if (is_scalar($value)) {
+				$i18n_js_strings[$key] = html_entity_decode((string)$value, ENT_QUOTES, 'UTF-8');
+			}
+		}
+		return "/* <![CDATA[ */ var eei18n = " . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
+	}
+
+
+
+	/**
+	 * @param mixed string | EED_Module $module
+	 */
+	public function add_module($module)
+	{
+		if ($module instanceof EED_Module) {
+			$module_class = get_class($module);
+			$this->modules->{$module_class} = $module;
+		} else {
+			if ( ! class_exists('EE_Module_Request_Router')) {
+				$this->load_core('Module_Request_Router');
+			}
+			$this->modules->{$module} = EE_Module_Request_Router::module_factory($module);
+		}
+	}
+
+
+
+	/**
+	 * @param string $module_name
+	 * @return mixed EED_Module | NULL
+	 */
+	public function get_module($module_name = '')
+	{
+		return isset($this->modules->{$module_name}) ? $this->modules->{$module_name} : null;
+	}
+
+
+
+	/**
+	 *    loads core classes - must be singletons
+	 *
+	 * @access    public
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 */
+	public function load_core($class_name, $arguments = array(), $load_only = false)
+	{
+		$core_paths = apply_filters(
+			'FHEE__EE_Registry__load_core__core_paths',
+			array(
+				EE_CORE,
+				EE_ADMIN,
+				EE_CPTS,
+				EE_CORE . 'data_migration_scripts' . DS,
+				EE_CORE . 'request_stack' . DS,
+				EE_CORE . 'middleware' . DS,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load($core_paths, 'EE_', $class_name, 'core', $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 *    loads service classes
+	 *
+	 * @access    public
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 */
+	public function load_service($class_name, $arguments = array(), $load_only = false)
+	{
+		$service_paths = apply_filters(
+			'FHEE__EE_Registry__load_service__service_paths',
+			array(
+				EE_CORE . 'services' . DS,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load($service_paths, 'EE_', $class_name, 'class', $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 *    loads data_migration_scripts
+	 *
+	 * @access    public
+	 * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
+	 * @param mixed  $arguments
+	 * @return EE_Data_Migration_Script_Base|mixed
+	 */
+	public function load_dms($class_name, $arguments = array())
+	{
+		// retrieve instantiated class
+		return $this->_load(EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(), 'EE_DMS_', $class_name, 'dms', $arguments, false, false, false);
+	}
+
+
+
+	/**
+	 *    loads object creating classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: attendee
+	 * @param mixed  $arguments  - an array of arguments to pass to the class
+	 * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to instantiate
+	 * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then set this to FALSE (ie. when instantiating model objects from client in a loop)
+	 * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate (default)
+	 * @return EE_Base_Class | bool
+	 */
+	public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
+	{
+		$paths = apply_filters('FHEE__EE_Registry__load_class__paths', array(
+			EE_CORE,
+			EE_CLASSES,
+			EE_BUSINESS,
+		));
+		// retrieve instantiated class
+		return $this->_load($paths, 'EE_', $class_name, 'class', $arguments, $from_db, $cache, $load_only);
+	}
+
+
+
+	/**
+	 *    loads helper classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EEH_Base | bool
+	 */
+	public function load_helper($class_name, $arguments = array(), $load_only = true)
+	{
+		// todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
+		$helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
+		// retrieve instantiated class
+		return $this->_load($helper_paths, 'EEH_', $class_name, 'helper', $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 *    loads core classes - must be singletons
+	 *
+	 * @access    public
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @param bool   $cache      whether to cache the object or not.
+	 * @return mixed
+	 */
+	public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
+	{
+		$paths = array(
+			EE_LIBRARIES,
+			EE_LIBRARIES . 'messages' . DS,
+			EE_LIBRARIES . 'shortcodes' . DS,
+			EE_LIBRARIES . 'qtips' . DS,
+			EE_LIBRARIES . 'payment_methods' . DS,
+		);
+		// retrieve instantiated class
+		return $this->_load($paths, 'EE_', $class_name, 'lib', $arguments, false, $cache, $load_only);
+	}
+
+
+
+	/**
+	 *    loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EEM_Base | bool
+	 */
+	public function load_model($class_name, $arguments = array(), $load_only = false)
+	{
+		$paths = apply_filters('FHEE__EE_Registry__load_model__paths', array(
+			EE_MODELS,
+			EE_CORE,
+		));
+		// retrieve instantiated class
+		return $this->_load($paths, 'EEM_', $class_name, 'model', $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 *    loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed | bool
+	 */
+	public function load_model_class($class_name, $arguments = array(), $load_only = true)
+	{
+		$paths = array(
+			EE_MODELS . 'fields' . DS,
+			EE_MODELS . 'helpers' . DS,
+			EE_MODELS . 'relations' . DS,
+			EE_MODELS . 'strategies' . DS,
+		);
+		// retrieve instantiated class
+		return $this->_load($paths, 'EE_', $class_name, '', $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 * Determines if $model_name is the name of an actual EE model.
+	 *
+	 * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
+	 * @return boolean
+	 */
+	public function is_model_name($model_name)
+	{
+		return isset($this->models[$model_name]) ? true : false;
+	}
+
+
+
+	/**
+	 *    generic class loader
+	 *
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $file_name    - file name  ie:  my_file.php, including extension
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 */
+	public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
+	{
+		// retrieve instantiated class
+		return $this->_load($path_to_file, '', $file_name, $type, $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 *    load_addon
+	 *
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $class_name   - full class name  ie:  My_Class
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EE_Addon
+	 */
+	public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
+	{
+		// retrieve instantiated class
+		return $this->_load($path_to_file, 'addon', $class_name, $type, $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 * instantiates, caches, and automatically resolves dependencies
+	 * for classes that use a Fully Qualified Class Name.
+	 * if the class is not capable of being loaded using PSR-4 autoloading,
+	 * then you need to use one of the existing load_*() methods
+	 * which can resolve the classname and filepath from the passed arguments
+	 *
+	 * @param bool|string $class_name   Fully Qualified Class Name
+	 * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
+	 * @param bool        $from_db      some classes are instantiated from the db
+	 *                                  and thus call a different method to instantiate
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
+	 * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
+	 * @return mixed                    null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 */
+	public function create(
+		$class_name = false,
+		$arguments = array(),
+		$cache = false,
+		$from_db = false,
+		$load_only = false,
+		$addon = false
+	) {
+		$class_name = ltrim($class_name, '\\');
+		$class_name = $this->_dependency_map->get_alias($class_name);
+		if ( ! class_exists($class_name)) {
+			// maybe the class is registered with a preceding \
+			$class_name = strpos($class_name, '\\') !== 0 ? '\\' . $class_name : $class_name;
+			// still doesn't exist ?
+			if ( ! class_exists($class_name)) {
+				return null;
+			}
+		}
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only) {
+			return true;
+		}
+		$addon = $addon ? 'addon' : '';
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $addon);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}
+		// instantiate the requested object
+		$class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
+		if ($this->_cache_on && $cache) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class($class_obj, $class_name, $addon, $from_db);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+
+	/**
+	 * instantiates, caches, and injects dependencies for classes
+	 *
+	 * @param array       $file_paths   an array of paths to folders to look in
+	 * @param string      $class_prefix EE  or EEM or... ???
+	 * @param bool|string $class_name   $class name
+	 * @param string      $type         file type - core? class? helper? model?
+	 * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
+	 * @param bool        $from_db      some classes are instantiated from the db
+	 *                                  and thus call a different method to instantiate
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
+	 * @return null|object|bool         null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 */
+	protected function _load(
+		$file_paths = array(),
+		$class_prefix = 'EE_',
+		$class_name = false,
+		$type = 'class',
+		$arguments = array(),
+		$from_db = false,
+		$cache = true,
+		$load_only = false
+	) {
+		$class_name = ltrim($class_name, '\\');
+		// strip php file extension
+		$class_name = str_replace('.php', '', trim($class_name));
+		// does the class have a prefix ?
+		if ( ! empty($class_prefix) && $class_prefix != 'addon') {
+			// make sure $class_prefix is uppercase
+			$class_prefix = strtoupper(trim($class_prefix));
+			// add class prefix ONCE!!!
+			$class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
+		}
+		$class_name = $this->_dependency_map->get_alias($class_name);
+		$class_exists = class_exists($class_name);
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only && $class_exists) {
+			return true;
+		}
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $class_prefix);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}
+		// if the class doesn't already exist.. then we need to try and find the file and load it
+		if ( ! $class_exists) {
+			// get full path to file
+			$path = $this->_resolve_path($class_name, $type, $file_paths);
+			// load the file
+			$loaded = $this->_require_file($path, $class_name, $type, $file_paths);
+			// if loading failed, or we are only loading a file but NOT instantiating an object
+			if ( ! $loaded || $load_only) {
+				// return boolean if only loading, or null if an object was expected
+				return $load_only ? $loaded : null;
+			}
+		}
+		// instantiate the requested object
+		$class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
+		if ($this->_cache_on && $cache) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class($class_obj, $class_name, $class_prefix, $from_db);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+
+	/**
+	 * _get_cached_class
+	 * attempts to find a cached version of the requested class
+	 * by looking in the following places:
+	 *        $this->{$class_abbreviation}            ie:    $this->CART
+	 *        $this->{$class_name}                        ie:    $this->Some_Class
+	 *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
+	 *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *
+	 * @access protected
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @return mixed
+	 */
+	protected function _get_cached_class($class_name, $class_prefix = '')
+	{
+		if (isset($this->_class_abbreviations[$class_name])) {
+			$class_abbreviation = $this->_class_abbreviations[$class_name];
+		} else {
+			// have to specify something, but not anything that will conflict
+			$class_abbreviation = 'FANCY_BATMAN_PANTS';
+		}
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation}) && ! is_null($this->{$class_abbreviation})) {
+			return $this->{$class_abbreviation};
+		} else if (isset ($this->{$class_name})) {
+			return $this->{$class_name};
+		} else if (isset ($this->LIB->{$class_name})) {
+			return $this->LIB->{$class_name};
+		} else if ($class_prefix == 'addon' && isset ($this->addons->{$class_name})) {
+			return $this->addons->{$class_name};
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * _resolve_path
+	 * attempts to find a full valid filepath for the requested class.
+	 * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
+	 * then returns that path if the target file has been found and is readable
+	 *
+	 * @access protected
+	 * @param string $class_name
+	 * @param string $type
+	 * @param array  $file_paths
+	 * @return string | bool
+	 */
+	protected function _resolve_path($class_name, $type = '', $file_paths = array())
+	{
+		// make sure $file_paths is an array
+		$file_paths = is_array($file_paths) ? $file_paths : array($file_paths);
+		// cycle thru paths
+		foreach ($file_paths as $key => $file_path) {
+			// convert all separators to proper DS, if no filepath, then use EE_CLASSES
+			$file_path = $file_path ? str_replace(array('/', '\\'), DS, $file_path) : EE_CLASSES;
+			// prep file type
+			$type = ! empty($type) ? trim($type, '.') . '.' : '';
+			// build full file path
+			$file_paths[$key] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php';
+			//does the file exist and can be read ?
+			if (is_readable($file_paths[$key])) {
+				return $file_paths[$key];
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * _require_file
+	 * basically just performs a require_once()
+	 * but with some error handling
+	 *
+	 * @access protected
+	 * @param  string $path
+	 * @param  string $class_name
+	 * @param  string $type
+	 * @param  array  $file_paths
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	protected function _require_file($path, $class_name, $type = '', $file_paths = array())
+	{
+		// don't give up! you gotta...
+		try {
+			//does the file exist and can it be read ?
+			if ( ! $path) {
+				// so sorry, can't find the file
+				throw new EE_Error (
+					sprintf(
+						__('The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s', 'event_espresso'),
+						trim($type, '.'),
+						$class_name,
+						'<br />' . implode(',<br />', $file_paths)
+					)
+				);
+			}
+			// get the file
+			require_once($path);
+			// if the class isn't already declared somewhere
+			if (class_exists($class_name, false) === false) {
+				// so sorry, not a class
+				throw new EE_Error(
+					sprintf(
+						__('The %s file %s does not appear to contain the %s Class.', 'event_espresso'),
+						$type,
+						$path,
+						$class_name
+					)
+				);
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * _create_object
+	 * Attempts to instantiate the requested class via any of the
+	 * commonly used instantiation methods employed throughout EE.
+	 * The priority for instantiation is as follows:
+	 *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
+	 *        - model objects via their 'new_instance_from_db' method
+	 *        - model objects via their 'new_instance' method
+	 *        - "singleton" classes" via their 'instance' method
+	 *    - standard instantiable classes via their __constructor
+	 * Prior to instantiation, if the classname exists in the dependency_map,
+	 * then the constructor for the requested class will be examined to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 *
+	 * @access protected
+	 * @param string $class_name
+	 * @param array  $arguments
+	 * @param string $type
+	 * @param bool   $from_db
+	 * @return null | object
+	 * @throws \EE_Error
+	 */
+	protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
+	{
+		$class_obj = null;
+		$instantiation_mode = '0) none';
+		// don't give up! you gotta...
+		try {
+			// create reflection
+			$reflector = $this->get_ReflectionClass($class_name);
+			// make sure arguments are an array
+			$arguments = is_array($arguments) ? $arguments : array($arguments);
+			// and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
+			// else wrap it in an additional array so that it doesn't get split into multiple parameters
+			$arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
+				? $arguments
+				: array($arguments);
+			// attempt to inject dependencies ?
+			if ($this->_dependency_map->has($class_name)) {
+				$arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
+			}
+			// instantiate the class if possible
+			if ($reflector->isAbstract()) {
+				// nothing to instantiate, loading file was enough
+				// does not throw an exception so $instantiation_mode is unused
+				// $instantiation_mode = "1) no constructor abstract class";
+				$class_obj = true;
+			} else if ($reflector->getConstructor() === null && $reflector->isInstantiable() && empty($arguments)) {
+				// no constructor = static methods only... nothing to instantiate, loading file was enough
+				$instantiation_mode = "2) no constructor but instantiable";
+				$class_obj = $reflector->newInstance();
+			} else if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
+				$instantiation_mode = "3) new_instance_from_db()";
+				$class_obj = call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
+			} else if (method_exists($class_name, 'new_instance')) {
+				$instantiation_mode = "4) new_instance()";
+				$class_obj = call_user_func_array(array($class_name, 'new_instance'), $arguments);
+			} else if (method_exists($class_name, 'instance')) {
+				$instantiation_mode = "5) instance()";
+				$class_obj = call_user_func_array(array($class_name, 'instance'), $arguments);
+			} else if ($reflector->isInstantiable()) {
+				$instantiation_mode = "6) constructor";
+				$class_obj = $reflector->newInstanceArgs($arguments);
+			} else {
+				// heh ? something's not right !
+				throw new EE_Error(
+					sprintf(
+						__('The %s file %s could not be instantiated.', 'event_espresso'),
+						$type,
+						$class_name
+					)
+				);
+			}
+		} catch (Exception $e) {
+			if ( ! $e instanceof EE_Error) {
+				$e = new EE_Error(
+					sprintf(
+						__('The following error occurred while attempting to instantiate "%1$s": %2$s %3$s %2$s instantiation mode : %4$s', 'event_espresso'),
+						$class_name,
+						'<br />',
+						$e->getMessage(),
+						$instantiation_mode
+					)
+				);
+			}
+			$e->get_error();
+		}
+		return $class_obj;
+	}
+
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
+	 * @param array $array
+	 * @return bool
+	 */
+	protected function _array_is_numerically_and_sequentially_indexed(array $array)
+	{
+		return ! empty($array) ? array_keys($array) === range(0, count($array) - 1) : true;
+	}
+
+
+
+	/**
+	 * getReflectionClass
+	 * checks if a ReflectionClass object has already been generated for a class
+	 * and returns that instead of creating a new one
+	 *
+	 * @access public
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 */
+	public function get_ReflectionClass($class_name)
+	{
+		if (
+			! isset($this->_reflectors[$class_name])
+			|| ! $this->_reflectors[$class_name] instanceof ReflectionClass
+		) {
+			$this->_reflectors[$class_name] = new ReflectionClass($class_name);
+		}
+		return $this->_reflectors[$class_name];
+	}
+
+
+
+	/**
+	 * _resolve_dependencies
+	 * examines the constructor for the requested class to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
+	 * For example:
+	 *        if attempting to load a class "Foo" with the following constructor:
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
+	 *        but only IF they are NOT already present in the incoming arguments array,
+	 *        and the correct classes can be loaded
+	 *
+	 * @access protected
+	 * @param ReflectionClass $reflector
+	 * @param string          $class_name
+	 * @param array           $arguments
+	 * @return array
+	 * @throws \ReflectionException
+	 */
+	protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, $arguments = array())
+	{
+		// let's examine the constructor
+		$constructor = $reflector->getConstructor();
+		// whu? huh? nothing?
+		if ( ! $constructor) {
+			return $arguments;
+		}
+		// get constructor parameters
+		$params = $constructor->getParameters();
+		// and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
+		$argument_keys = array_keys($arguments);
+		// now loop thru all of the constructors expected parameters
+		foreach ($params as $index => $param) {
+			// is this a dependency for a specific class ?
+			$param_class = $param->getClass() ? $param->getClass()->name : null;
+			if (
+				// param is not even a class
+				empty($param_class)
+				// and something already exists in the incoming arguments for this param
+				&& isset($argument_keys[$index], $arguments[$argument_keys[$index]])
+			) {
+				// so let's skip this argument and move on to the next
+				continue;
+			} else if (
+				// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
+				! empty($param_class)
+				&& isset($argument_keys[$index], $arguments[$argument_keys[$index]])
+				&& $arguments[$argument_keys[$index]] instanceof $param_class
+			) {
+				// skip this argument and move on to the next
+				continue;
+			} else if (
+				// parameter is type hinted as a class, and should be injected
+				! empty($param_class)
+				&& $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
+			) {
+				$arguments = $this->_resolve_dependency($class_name, $param_class, $arguments, $index);
+			} else {
+				try {
+					$arguments[$index] = $param->getDefaultValue();
+				} catch (ReflectionException $e) {
+					throw new ReflectionException(
+						sprintf(
+							__('%1$s for parameter "$%2$s"', 'event_espresso'),
+							$e->getMessage(),
+							$param->getName()
+						)
+					);
+				}
+			}
+		}
+		return $arguments;
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param string $class_name
+	 * @param string $param_class
+	 * @param array  $arguments
+	 * @param mixed  $index
+	 * @return array
+	 */
+	protected function _resolve_dependency($class_name, $param_class, $arguments, $index)
+	{
+		$dependency = null;
+		// should dependency be loaded from cache ?
+		$cache_on = $this->_dependency_map->loading_strategy_for_class_dependency($class_name, $param_class)
+					!== EE_Dependency_Map::load_new_object
+			? true
+			: false;
+		// we might have a dependency...
+		// let's MAYBE try and find it in our cache if that's what's been requested
+		$cached_class = $cache_on ? $this->_get_cached_class($param_class) : null;
+		// and grab it if it exists
+		if ($cached_class instanceof $param_class) {
+			$dependency = $cached_class;
+		} else if ($param_class != $class_name) {
+			// obtain the loader method from the dependency map
+			$loader = $this->_dependency_map->class_loader($param_class);
+			// is loader a custom closure ?
+			if ($loader instanceof Closure) {
+				$dependency = $loader();
+			} else {
+				// set the cache on property for the recursive loading call
+				$this->_cache_on = $cache_on;
+				// if not, then let's try and load it via the registry
+				if (method_exists($this, $loader)) {
+					$dependency = $this->{$loader}($param_class);
+				} else {
+					$dependency = $this->create($param_class, array(), $cache_on);
+				}
+			}
+		}
+		// did we successfully find the correct dependency ?
+		if ($dependency instanceof $param_class) {
+			// then let's inject it into the incoming array of arguments at the correct location
+			if (isset($argument_keys[$index])) {
+				$arguments[$argument_keys[$index]] = $dependency;
+			} else {
+				$arguments[$index] = $dependency;
+			}
+		}
+		return $arguments;
+	}
+
+
+
+	/**
+	 * _set_cached_class
+	 * attempts to cache the instantiated class locally
+	 * in one of the following places, in the following order:
+	 *        $this->{class_abbreviation}   ie:    $this->CART
+	 *        $this->{$class_name}          ie:    $this->Some_Class
+	 *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
+	 *
+	 * @access protected
+	 * @param object $class_obj
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param bool   $from_db
+	 * @return void
+	 */
+	protected function _set_cached_class($class_obj, $class_name, $class_prefix = '', $from_db = false)
+	{
+		if (empty($class_obj)) {
+			return;
+		}
+		// return newly instantiated class
+		if (isset($this->_class_abbreviations[$class_name])) {
+			$class_abbreviation = $this->_class_abbreviations[$class_name];
+			$this->{$class_abbreviation} = $class_obj;
+		} else if (property_exists($this, $class_name)) {
+			$this->{$class_name} = $class_obj;
+		} else if ($class_prefix == 'addon') {
+			$this->addons->{$class_name} = $class_obj;
+		} else if ( ! $from_db) {
+			$this->LIB->{$class_name} = $class_obj;
+		}
+	}
+
+
+
+	/**
+	 * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
+	 *
+	 * @param string $classname PLEASE NOTE: the class name needs to match what's registered
+	 *                          in the EE_Dependency_Map::$_class_loaders array,
+	 *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
+	 * @param array  $arguments
+	 * @return object
+	 */
+	public static function factory($classname, $arguments = array())
+	{
+		$loader = self::instance()->_dependency_map->class_loader($classname);
+		if ($loader instanceof Closure) {
+			return $loader($arguments);
+		} else if (method_exists(EE_Registry::instance(), $loader)) {
+			return EE_Registry::instance()->{$loader}($classname, $arguments);
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * Gets the addon by its name/slug (not classname. For that, just
+	 * use the classname as the property name on EE_Config::instance()->addons)
+	 *
+	 * @param string $name
+	 * @return EE_Addon
+	 */
+	public function get_addon_by_name($name)
+	{
+		foreach ($this->addons as $addon) {
+			if ($addon->name() == $name) {
+				return $addon;
+			}
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * Gets an array of all the registered addons, where the keys are their names. (ie, what each returns for their name() function) They're already available on EE_Config::instance()->addons as properties, where each property's name is
+	 * the addon's classname. So if you just want to get the addon by classname, use EE_Config::instance()->addons->{classname}
+	 *
+	 * @return EE_Addon[] where the KEYS are the addon's name()
+	 */
+	public function get_addons_by_name()
+	{
+		$addons = array();
+		foreach ($this->addons as $addon) {
+			$addons[$addon->name()] = $addon;
+		}
+		return $addons;
+	}
+
+
+
+	/**
+	 * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
+	 * a stale copy of it around
+	 *
+	 * @param string $model_name
+	 * @return \EEM_Base
+	 * @throws \EE_Error
+	 */
+	public function reset_model($model_name)
+	{
+		$model_class_name = strpos($model_name, 'EEM_') !== 0 ? "EEM_{$model_name}" : $model_name;
+		if ( ! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
+			return null;
+		}
+		//get that model reset it and make sure we nuke the old reference to it
+		if ($this->LIB->{$model_class_name} instanceof $model_class_name && is_callable(array($model_class_name, 'reset'))) {
+			$this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset();
+		} else {
+			throw new EE_Error(sprintf(__('Model %s does not have a method "reset"', 'event_espresso'), $model_name));
+		}
+		return $this->LIB->{$model_class_name};
+	}
+
+
+
+	/**
+	 * Resets the registry.
+	 * The criteria for what gets reset is based on what can be shared between sites on the same request when switch_to_blog
+	 * is used in a multisite install.  Here is a list of things that are NOT reset.
+	 * - $_dependency_map
+	 * - $_class_abbreviations
+	 * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
+	 * - $REQ:  Still on the same request so no need to change.
+	 * - $CAP: There is no site specific state in the EE_Capability class.
+	 * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only one Session
+	 *         can be active in a single request.  Resetting could resolve in "headers already sent" errors.
+	 * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
+	 *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
+	 *             switch or on the restore.
+	 * - $modules
+	 * - $shortcodes
+	 * - $widgets
+	 *
+	 * @param boolean $hard             whether to reset data in the database too, or just refresh
+	 *                                  the Registry to its state at the beginning of the request
+	 * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
+	 *                                  or just reset without re-instantiating (handy to set to FALSE if you're not sure if you CAN
+	 *                                  currently reinstantiate the singletons at the moment)
+	 * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so client
+	 *                                  code instead can just change the model context to a different blog id if necessary
+	 * @return EE_Registry
+	 */
+	public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
+	{
+		$instance = self::instance();
+		EEH_Activation::reset();
+		//properties that get reset
+		$instance->_cache_on = true;
+		$instance->CFG = EE_Config::reset($hard, $reinstantiate);
+		$instance->CART = null;
+		$instance->MRM = null;
+		$instance->AssetsRegistry = null;
+		$instance->AssetsRegistry = $instance->create('EventEspresso\core\services\assets\Registry');
+		//messages reset
+		EED_Messages::reset();
+		if ($reset_models) {
+			foreach (array_keys($instance->non_abstract_db_models) as $model_name) {
+				$instance->reset_model($model_name);
+			}
+		}
+		$instance->LIB = new stdClass();
+		return $instance;
+	}
+
+
+
+	/**
+	 * @override magic methods
+	 * @return void
+	 */
+	public final function __destruct()
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 * @param $b
+	 */
+	public final function __call($a, $b)
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 */
+	public final function __get($a)
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 * @param $b
+	 */
+	public final function __set($a, $b)
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 */
+	public final function __isset($a)
+	{
+	}
 
 
 
-    /**
-     * @param $a
-     */
-    public final function __unset($a)
-    {
-    }
+	/**
+	 * @param $a
+	 */
+	public final function __unset($a)
+	{
+	}
 
 
 
-    /**
-     * @return array
-     */
-    public final function __sleep()
-    {
-        return array();
-    }
+	/**
+	 * @return array
+	 */
+	public final function __sleep()
+	{
+		return array();
+	}
 
 
 
-    public final function __wakeup()
-    {
-    }
+	public final function __wakeup()
+	{
+	}
 
 
 
-    /**
-     * @return string
-     */
-    public final function __toString()
-    {
-        return '';
-    }
+	/**
+	 * @return string
+	 */
+	public final function __toString()
+	{
+		return '';
+	}
 
 
 
-    public final function __invoke()
-    {
-    }
+	public final function __invoke()
+	{
+	}
 
 
 
-    public final static function __set_state($array = array())
-    {
-        return EE_Registry::instance();
-    }
+	public final static function __set_state($array = array())
+	{
+		return EE_Registry::instance();
+	}
 
 
 
-    public final function __clone()
-    {
-    }
+	public final function __clone()
+	{
+	}
 
 
 
-    /**
-     * @param $a
-     * @param $b
-     */
-    public final static function __callStatic($a, $b)
-    {
-    }
+	/**
+	 * @param $a
+	 * @param $b
+	 */
+	public final static function __callStatic($a, $b)
+	{
+	}
 
 
 
-    /**
-     * Gets all the custom post type models defined
-     *
-     * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
-     */
-    public function cpt_models()
-    {
-        $cpt_models = array();
-        foreach ($this->non_abstract_db_models as $short_name => $classname) {
-            if (is_subclass_of($classname, 'EEM_CPT_Base')) {
-                $cpt_models[$short_name] = $classname;
-            }
-        }
-        return $cpt_models;
-    }
+	/**
+	 * Gets all the custom post type models defined
+	 *
+	 * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
+	 */
+	public function cpt_models()
+	{
+		$cpt_models = array();
+		foreach ($this->non_abstract_db_models as $short_name => $classname) {
+			if (is_subclass_of($classname, 'EEM_CPT_Base')) {
+				$cpt_models[$short_name] = $classname;
+			}
+		}
+		return $cpt_models;
+	}
 
 
 
-    /**
-     * @return \EE_Config
-     */
-    public static function CFG()
-    {
-        return self::instance()->CFG;
-    }
+	/**
+	 * @return \EE_Config
+	 */
+	public static function CFG()
+	{
+		return self::instance()->CFG;
+	}
 
 
 }

core/EE_Dependency_Map.core.php

Indentation +648 added lines, -648 removed lines

@@ -4,7 +4,7 @@ 
 use EventEspresso\core\services\loaders\LoaderInterface;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -22,653 +22,653 @@ 
 {
 
 
-    /**
-     * This means that the requested class dependency is not present in the dependency map
-     */
-    const not_registered = 0;
-
-
-    /**
-     * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class.
-     */
-    const load_new_object = 1;
-
-    /**
-     * This instructs class loaders to return a previously instantiated and cached object for the requested class.
-     * IF a previously instantiated object does not exist, a new one will be created and added to the cache.
-     */
-    const load_from_cache = 2;
-
-    /**
-     * @type EE_Dependency_Map $_instance
-     */
-    protected static $_instance;
-
-    /**
-     * @type EE_Request $request
-     */
-    protected $_request;
-
-    /**
-     * @type EE_Response $response
-     */
-    protected $_response;
-
-    /**
-     * @type LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * @type array $_dependency_map
-     */
-    protected $_dependency_map = array();
-
-    /**
-     * @type array $_class_loaders
-     */
-    protected $_class_loaders = array();
-
-    /**
-     * @type array $_aliases
-     */
-    protected $_aliases = array();
-
-
-
-    /**
-     * EE_Dependency_Map constructor.
-     *
-     * @param EE_Request  $request
-     * @param EE_Response $response
-     */
-    protected function __construct(EE_Request $request, EE_Response $response)
-    {
-        $this->_request = $request;
-        $this->_response = $response;
-        add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
-        do_action('EE_Dependency_Map____construct');
-    }
-
-
-
-    /**
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function initialize()
-    {
-        $this->_register_core_dependencies();
-        $this->_register_core_class_loaders();
-        $this->_register_core_aliases();
-    }
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param EE_Request  $request
-     * @param EE_Response $response
-     * @return EE_Dependency_Map
-     */
-    public static function instance(EE_Request $request = null, EE_Response $response = null)
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Dependency_Map) {
-            self::$_instance = new EE_Dependency_Map($request, $response);
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * @param LoaderInterface $loader
-     */
-    public function setLoader(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
-
-
-
-    /**
-     * @param string $class
-     * @param array  $dependencies
-     * @return boolean
-     */
-    public static function register_dependencies($class, $dependencies)
-    {
-        if (! isset(self::$_instance->_dependency_map[$class])) {
-            // we need to make sure that any aliases used when registering a dependency
-            // get resolved to the correct class name
-            foreach ((array)$dependencies as $dependency => $load_source) {
-                $alias = self::$_instance->get_alias($dependency);
-                unset($dependencies[$dependency]);
-                $dependencies[$alias] = $load_source;
-            }
-            self::$_instance->_dependency_map[$class] = (array)$dependencies;
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @param string $class_name
-     * @param string $loader
-     * @return bool
-     * @throws EE_Error
-     */
-    public static function register_class_loader($class_name, $loader = 'load_core')
-    {
-        // check that loader is callable or method starts with "load_" and exists in EE_Registry
-        if (
-            ! is_callable($loader)
-            && (
-                strpos($loader, 'load_') !== 0
-                || ! method_exists('EE_Registry', $loader)
-            )
-        ) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('"%1$s" is not a valid loader method on EE_Registry.', 'event_espresso'),
-                    $loader
-                )
-            );
-        }
-        $class_name = self::$_instance->get_alias($class_name);
-        if (! isset(self::$_instance->_class_loaders[$class_name])) {
-            self::$_instance->_class_loaders[$class_name] = $loader;
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function dependency_map()
-    {
-        return $this->_dependency_map;
-    }
-
-
-
-    /**
-     * returns TRUE if dependency map contains a listing for the provided class name
-     *
-     * @param string $class_name
-     * @return boolean
-     */
-    public function has($class_name = '')
-    {
-        return isset($this->_dependency_map[$class_name]) ? true : false;
-    }
-
-
-
-    /**
-     * returns TRUE if dependency map contains a listing for the provided class name AND dependency
-     *
-     * @param string $class_name
-     * @param string $dependency
-     * @return bool
-     */
-    public function has_dependency_for_class($class_name = '', $dependency = '')
-    {
-        $dependency = $this->get_alias($dependency);
-        return isset($this->_dependency_map[$class_name], $this->_dependency_map[$class_name][$dependency])
-            ? true
-            : false;
-    }
-
-
-
-    /**
-     * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned
-     *
-     * @param string $class_name
-     * @param string $dependency
-     * @return int
-     */
-    public function loading_strategy_for_class_dependency($class_name = '', $dependency = '')
-    {
-        $dependency = $this->get_alias($dependency);
-        return $this->has_dependency_for_class($class_name, $dependency)
-            ? $this->_dependency_map[$class_name][$dependency]
-            : EE_Dependency_Map::not_registered;
-    }
-
-
-
-    /**
-     * @param string $class_name
-     * @return string | Closure
-     */
-    public function class_loader($class_name)
-    {
-        $class_name = $this->get_alias($class_name);
-        return isset($this->_class_loaders[$class_name]) ? $this->_class_loaders[$class_name] : '';
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function class_loaders()
-    {
-        return $this->_class_loaders;
-    }
-
-
-
-    /**
-     * adds an alias for a classname
-     *
-     * @param string $class_name the class name that should be used (concrete class to replace interface)
-     * @param string $alias      the class name that would be type hinted for (abstract parent or interface)
-     * @param string $for_class  the class that has the dependency (is type hinting for the interface)
-     */
-    public function add_alias($class_name, $alias, $for_class = '')
-    {
-        if ($for_class !== '') {
-            if (! isset($this->_aliases[$for_class])) {
-                $this->_aliases[$for_class] = array();
-            }
-            $this->_aliases[$for_class][$class_name] = $alias;
-        }
-        $this->_aliases[$class_name] = $alias;
-    }
-
-
-
-    /**
-     * returns TRUE if the provided class name has an alias
-     *
-     * @param string $class_name
-     * @param string $for_class
-     * @return bool
-     */
-    public function has_alias($class_name = '', $for_class = '')
-    {
-        return isset($this->_aliases[$for_class], $this->_aliases[$for_class][$class_name])
-               || (
-                   isset($this->_aliases[$class_name])
-                   && ! is_array($this->_aliases[$class_name])
-               );
-    }
-
-
-
-    /**
-     * returns alias for class name if one exists, otherwise returns the original classname
-     * functions recursively, so that multiple aliases can be used to drill down to a classname
-     *  for example:
-     *      if the following two entries were added to the _aliases array:
-     *          array(
-     *              'interface_alias'           => 'some\namespace\interface'
-     *              'some\namespace\interface'  => 'some\namespace\classname'
-     *          )
-     *      then one could use EE_Registry::instance()->create( 'interface_alias' )
-     *      to load an instance of 'some\namespace\classname'
-     *
-     * @param string $class_name
-     * @param string $for_class
-     * @return string
-     */
-    public function get_alias($class_name = '', $for_class = '')
-    {
-        if (! $this->has_alias($class_name, $for_class)) {
-            return $class_name;
-        }
-        if ($for_class !== '') {
-            return $this->get_alias($this->_aliases[$for_class][$class_name], $for_class);
-        }
-        return $this->get_alias($this->_aliases[$class_name]);
-    }
-
-
-
-    /**
-     * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache,
-     * if one exists, or whether a new object should be generated every time the requested class is loaded.
-     * This is done by using the following class constants:
-     *        EE_Dependency_Map::load_from_cache - loads previously instantiated object
-     *        EE_Dependency_Map::load_new_object - generates a new object every time
-     */
-    protected function _register_core_dependencies()
-    {
-        $this->_dependency_map = array(
-            'EE_Request_Handler'                                                                                          => array(
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_System'                                                                                                   => array(
-                'EE_Registry' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Session'                                                                                                  => array(
-                'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
-                'EE_Encryption'                                           => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Cart'                                                                                                     => array(
-                'EE_Session' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Front_Controller'                                                                                         => array(
-                'EE_Registry'              => EE_Dependency_Map::load_from_cache,
-                'EE_Request_Handler'       => EE_Dependency_Map::load_from_cache,
-                'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messenger_Collection_Loader'                                                                              => array(
-                'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object,
-            ),
-            'EE_Message_Type_Collection_Loader'                                                                           => array(
-                'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object,
-            ),
-            'EE_Message_Resource_Manager'                                                                                 => array(
-                'EE_Messenger_Collection_Loader'    => EE_Dependency_Map::load_new_object,
-                'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object,
-                'EEM_Message_Template_Group'        => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Message_Factory'                                                                                          => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_messages'                                                                                                 => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messages_Generator'                                                                                       => array(
-                'EE_Messages_Queue'                    => EE_Dependency_Map::load_new_object,
-                'EE_Messages_Data_Handler_Collection'  => EE_Dependency_Map::load_new_object,
-                'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object,
-                'EEH_Parse_Shortcodes'                 => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messages_Processor'                                                                                       => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messages_Queue'                                                                                           => array(
-                'EE_Message_Repository' => EE_Dependency_Map::load_new_object,
-            ),
-            'EE_Messages_Template_Defaults'                                                                               => array(
-                'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache,
-                'EEM_Message_Template'       => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Message_To_Generate_From_Request'                                                                         => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-                'EE_Request_Handler'          => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CommandBus'                                                             => array(
-                'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\services\commands\CommandHandler'                                                              => array(
-                'EE_Registry'         => EE_Dependency_Map::load_from_cache,
-                'CommandBusInterface' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CommandHandlerManager'                                                  => array(
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CompositeCommandHandler'                                                => array(
-                'EventEspresso\core\services\commands\CommandBus'     => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CommandFactory'                                                         => array(
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\middleware\CapChecker'                                                  => array(
-                'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker'                                         => array(
-                'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker'                                     => array(
-                'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler'                          => array(
-                'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler'                     => array(
-                'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler'                    => array(
-                'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler'         => array(
-                'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array(
-                'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler'                              => array(
-                'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler'                              => array(
-                'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\registration\CancelRegistrationService'                                   => array(
-                'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\database\TableManager'                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Data_Migration_Class_Base'                                                                                => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_1_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_2_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_3_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_4_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_5_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_6_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_7_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_8_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_9_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\assets\Registry'                                                                 => array(
-                'EE_Template_Config' => EE_Dependency_Map::load_from_cache,
-                'EE_Currency_Config' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled'                                             => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout'                                              => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees'                                        => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEvents'                                                => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou'                                              => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector'                                        => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage'                                               => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\cache\BasicCacheManager'                                                         => array(
-                'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\cache\PostRelatedCacheManager'                                                   => array(
-                'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
-            ),
-        );
-    }
-
-
-
-    /**
-     * Registers how core classes are loaded.
-     * This can either be done by simply providing the name of one of the EE_Registry loader methods such as:
-     *        'EE_Request_Handler' => 'load_core'
-     *        'EE_Messages_Queue'  => 'load_lib'
-     *        'EEH_Debug_Tools'    => 'load_helper'
-     * or, if greater control is required, by providing a custom closure. For example:
-     *        'Some_Class' => function () {
-     *            return new Some_Class();
-     *        },
-     * This is required for instantiating dependencies
-     * where an interface has been type hinted in a class constructor. For example:
-     *        'Required_Interface' => function () {
-     *            return new A_Class_That_Implements_Required_Interface();
-     *        },
-     */
-    protected function _register_core_class_loaders()
-    {
-        //for PHP5.3 compat, we need to register any properties called here in a variable because `$this` cannot
-        //be used in a closure.
-        $request = &$this->_request;
-        $response = &$this->_response;
-        $loader = &$this->loader;
-        $this->_class_loaders = array(
-            //load_core
-            'EE_Capabilities'                      => 'load_core',
-            'EE_Encryption'                        => 'load_core',
-            'EE_Front_Controller'                  => 'load_core',
-            'EE_Module_Request_Router'             => 'load_core',
-            'EE_Registry'                          => 'load_core',
-            'EE_Request'                           => function () use (&$request) {
-                return $request;
-            },
-            'EE_Response'                          => function () use (&$response) {
-                return $response;
-            },
-            'EE_Request_Handler'                   => 'load_core',
-            'EE_Session'                           => 'load_core',
-            'EE_System'                            => 'load_core',
-            //load_lib
-            'EE_Message_Resource_Manager'          => 'load_lib',
-            'EE_Message_Type_Collection'           => 'load_lib',
-            'EE_Message_Type_Collection_Loader'    => 'load_lib',
-            'EE_Messenger_Collection'              => 'load_lib',
-            'EE_Messenger_Collection_Loader'       => 'load_lib',
-            'EE_Messages_Processor'                => 'load_lib',
-            'EE_Message_Repository'                => 'load_lib',
-            'EE_Messages_Queue'                    => 'load_lib',
-            'EE_Messages_Data_Handler_Collection'  => 'load_lib',
-            'EE_Message_Template_Group_Collection' => 'load_lib',
-            'EE_Messages_Generator'                => function () {
-                return EE_Registry::instance()->load_lib(
-                    'Messages_Generator',
-                    array(),
-                    false,
-                    false
-                );
-            },
-            'EE_Messages_Template_Defaults'        => function ($arguments = array()) {
-                return EE_Registry::instance()->load_lib(
-                    'Messages_Template_Defaults',
-                    $arguments,
-                    false,
-                    false
-                );
-            },
-            //load_model
-            'EEM_Message_Template_Group'           => 'load_model',
-            'EEM_Message_Template'                 => 'load_model',
-            //load_helper
-            'EEH_Parse_Shortcodes'                 => function () {
-                if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
-                    return new EEH_Parse_Shortcodes();
-                }
-                return null;
-            },
-            'EE_Template_Config'                   => function () {
-                return EE_Config::instance()->template_settings;
-            },
-            'EE_Currency_Config'                   => function () {
-                return EE_Config::instance()->currency;
-            },
-            'EventEspresso\core\services\loaders\Loader' => function () use (&$loader) {
-                return $loader;
-            },
-        );
-    }
-
-
-
-    /**
-     * can be used for supplying alternate names for classes,
-     * or for connecting interface names to instantiable classes
-     */
-    protected function _register_core_aliases()
-    {
-        $this->_aliases = array(
-            'CommandBusInterface'                                                 => 'EventEspresso\core\services\commands\CommandBusInterface',
-            'EventEspresso\core\services\commands\CommandBusInterface'            => 'EventEspresso\core\services\commands\CommandBus',
-            'CommandHandlerManagerInterface'                                      => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
-            'EventEspresso\core\services\commands\CommandHandlerManagerInterface' => 'EventEspresso\core\services\commands\CommandHandlerManager',
-            'CapChecker'                                                          => 'EventEspresso\core\services\commands\middleware\CapChecker',
-            'AddActionHook'                                                       => 'EventEspresso\core\services\commands\middleware\AddActionHook',
-            'CapabilitiesChecker'                                                 => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
-            'CapabilitiesCheckerInterface'                                        => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface',
-            'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
-            'CreateRegistrationService'                                           => 'EventEspresso\core\domain\services\registration\CreateRegistrationService',
-            'CreateRegCodeCommandHandler'                                         => 'EventEspresso\core\services\commands\registration\CreateRegCodeCommand',
-            'CreateRegUrlLinkCommandHandler'                                      => 'EventEspresso\core\services\commands\registration\CreateRegUrlLinkCommand',
-            'CreateRegistrationCommandHandler'                                    => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
-            'CopyRegistrationDetailsCommandHandler'                               => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand',
-            'CopyRegistrationPaymentsCommandHandler'                              => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand',
-            'CancelRegistrationAndTicketLineItemCommandHandler'                   => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler',
-            'UpdateRegistrationAndTransactionAfterChangeCommandHandler'           => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler',
-            'CreateTicketLineItemCommandHandler'                                  => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand',
-            'TableManager'                                                        => 'EventEspresso\core\services\database\TableManager',
-            'TableAnalysis'                                                       => 'EventEspresso\core\services\database\TableAnalysis',
-            'EspressoShortcode'                                                   => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
-            'ShortcodeInterface'                                                  => 'EventEspresso\core\services\shortcodes\ShortcodeInterface',
-            'EventEspresso\core\services\shortcodes\ShortcodeInterface'           => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
-            'EventEspresso\core\services\cache\CacheStorageInterface'             => 'EventEspresso\core\services\cache\TransientCacheStorage',
-            'LoaderInterface'                                                     => 'EventEspresso\core\services\loaders\LoaderInterface',
-            'EventEspresso\core\services\loaders\LoaderInterface'                 => 'EventEspresso\core\services\loaders\Loader',
-            'CommandFactoryInterface'                                             => 'EventEspresso\core\services\commands\CommandFactoryInterface',
-            'EventEspresso\core\services\commands\CommandFactoryInterface'        => 'EventEspresso\core\services\commands\CommandFactory',
-        );
-    }
-
-
-
-    /**
-     * This is used to reset the internal map and class_loaders to their original default state at the beginning of the
-     * request Primarily used by unit tests.
-     */
-    public function reset()
-    {
-        $this->_register_core_class_loaders();
-        $this->_register_core_dependencies();
-    }
+	/**
+	 * This means that the requested class dependency is not present in the dependency map
+	 */
+	const not_registered = 0;
+
+
+	/**
+	 * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class.
+	 */
+	const load_new_object = 1;
+
+	/**
+	 * This instructs class loaders to return a previously instantiated and cached object for the requested class.
+	 * IF a previously instantiated object does not exist, a new one will be created and added to the cache.
+	 */
+	const load_from_cache = 2;
+
+	/**
+	 * @type EE_Dependency_Map $_instance
+	 */
+	protected static $_instance;
+
+	/**
+	 * @type EE_Request $request
+	 */
+	protected $_request;
+
+	/**
+	 * @type EE_Response $response
+	 */
+	protected $_response;
+
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * @type array $_dependency_map
+	 */
+	protected $_dependency_map = array();
+
+	/**
+	 * @type array $_class_loaders
+	 */
+	protected $_class_loaders = array();
+
+	/**
+	 * @type array $_aliases
+	 */
+	protected $_aliases = array();
+
+
+
+	/**
+	 * EE_Dependency_Map constructor.
+	 *
+	 * @param EE_Request  $request
+	 * @param EE_Response $response
+	 */
+	protected function __construct(EE_Request $request, EE_Response $response)
+	{
+		$this->_request = $request;
+		$this->_response = $response;
+		add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
+		do_action('EE_Dependency_Map____construct');
+	}
+
+
+
+	/**
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function initialize()
+	{
+		$this->_register_core_dependencies();
+		$this->_register_core_class_loaders();
+		$this->_register_core_aliases();
+	}
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param EE_Request  $request
+	 * @param EE_Response $response
+	 * @return EE_Dependency_Map
+	 */
+	public static function instance(EE_Request $request = null, EE_Response $response = null)
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Dependency_Map) {
+			self::$_instance = new EE_Dependency_Map($request, $response);
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * @param LoaderInterface $loader
+	 */
+	public function setLoader(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
+
+
+
+	/**
+	 * @param string $class
+	 * @param array  $dependencies
+	 * @return boolean
+	 */
+	public static function register_dependencies($class, $dependencies)
+	{
+		if (! isset(self::$_instance->_dependency_map[$class])) {
+			// we need to make sure that any aliases used when registering a dependency
+			// get resolved to the correct class name
+			foreach ((array)$dependencies as $dependency => $load_source) {
+				$alias = self::$_instance->get_alias($dependency);
+				unset($dependencies[$dependency]);
+				$dependencies[$alias] = $load_source;
+			}
+			self::$_instance->_dependency_map[$class] = (array)$dependencies;
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $loader
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public static function register_class_loader($class_name, $loader = 'load_core')
+	{
+		// check that loader is callable or method starts with "load_" and exists in EE_Registry
+		if (
+			! is_callable($loader)
+			&& (
+				strpos($loader, 'load_') !== 0
+				|| ! method_exists('EE_Registry', $loader)
+			)
+		) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('"%1$s" is not a valid loader method on EE_Registry.', 'event_espresso'),
+					$loader
+				)
+			);
+		}
+		$class_name = self::$_instance->get_alias($class_name);
+		if (! isset(self::$_instance->_class_loaders[$class_name])) {
+			self::$_instance->_class_loaders[$class_name] = $loader;
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function dependency_map()
+	{
+		return $this->_dependency_map;
+	}
+
+
+
+	/**
+	 * returns TRUE if dependency map contains a listing for the provided class name
+	 *
+	 * @param string $class_name
+	 * @return boolean
+	 */
+	public function has($class_name = '')
+	{
+		return isset($this->_dependency_map[$class_name]) ? true : false;
+	}
+
+
+
+	/**
+	 * returns TRUE if dependency map contains a listing for the provided class name AND dependency
+	 *
+	 * @param string $class_name
+	 * @param string $dependency
+	 * @return bool
+	 */
+	public function has_dependency_for_class($class_name = '', $dependency = '')
+	{
+		$dependency = $this->get_alias($dependency);
+		return isset($this->_dependency_map[$class_name], $this->_dependency_map[$class_name][$dependency])
+			? true
+			: false;
+	}
+
+
+
+	/**
+	 * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned
+	 *
+	 * @param string $class_name
+	 * @param string $dependency
+	 * @return int
+	 */
+	public function loading_strategy_for_class_dependency($class_name = '', $dependency = '')
+	{
+		$dependency = $this->get_alias($dependency);
+		return $this->has_dependency_for_class($class_name, $dependency)
+			? $this->_dependency_map[$class_name][$dependency]
+			: EE_Dependency_Map::not_registered;
+	}
+
+
+
+	/**
+	 * @param string $class_name
+	 * @return string | Closure
+	 */
+	public function class_loader($class_name)
+	{
+		$class_name = $this->get_alias($class_name);
+		return isset($this->_class_loaders[$class_name]) ? $this->_class_loaders[$class_name] : '';
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function class_loaders()
+	{
+		return $this->_class_loaders;
+	}
+
+
+
+	/**
+	 * adds an alias for a classname
+	 *
+	 * @param string $class_name the class name that should be used (concrete class to replace interface)
+	 * @param string $alias      the class name that would be type hinted for (abstract parent or interface)
+	 * @param string $for_class  the class that has the dependency (is type hinting for the interface)
+	 */
+	public function add_alias($class_name, $alias, $for_class = '')
+	{
+		if ($for_class !== '') {
+			if (! isset($this->_aliases[$for_class])) {
+				$this->_aliases[$for_class] = array();
+			}
+			$this->_aliases[$for_class][$class_name] = $alias;
+		}
+		$this->_aliases[$class_name] = $alias;
+	}
+
+
+
+	/**
+	 * returns TRUE if the provided class name has an alias
+	 *
+	 * @param string $class_name
+	 * @param string $for_class
+	 * @return bool
+	 */
+	public function has_alias($class_name = '', $for_class = '')
+	{
+		return isset($this->_aliases[$for_class], $this->_aliases[$for_class][$class_name])
+			   || (
+				   isset($this->_aliases[$class_name])
+				   && ! is_array($this->_aliases[$class_name])
+			   );
+	}
+
+
+
+	/**
+	 * returns alias for class name if one exists, otherwise returns the original classname
+	 * functions recursively, so that multiple aliases can be used to drill down to a classname
+	 *  for example:
+	 *      if the following two entries were added to the _aliases array:
+	 *          array(
+	 *              'interface_alias'           => 'some\namespace\interface'
+	 *              'some\namespace\interface'  => 'some\namespace\classname'
+	 *          )
+	 *      then one could use EE_Registry::instance()->create( 'interface_alias' )
+	 *      to load an instance of 'some\namespace\classname'
+	 *
+	 * @param string $class_name
+	 * @param string $for_class
+	 * @return string
+	 */
+	public function get_alias($class_name = '', $for_class = '')
+	{
+		if (! $this->has_alias($class_name, $for_class)) {
+			return $class_name;
+		}
+		if ($for_class !== '') {
+			return $this->get_alias($this->_aliases[$for_class][$class_name], $for_class);
+		}
+		return $this->get_alias($this->_aliases[$class_name]);
+	}
+
+
+
+	/**
+	 * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache,
+	 * if one exists, or whether a new object should be generated every time the requested class is loaded.
+	 * This is done by using the following class constants:
+	 *        EE_Dependency_Map::load_from_cache - loads previously instantiated object
+	 *        EE_Dependency_Map::load_new_object - generates a new object every time
+	 */
+	protected function _register_core_dependencies()
+	{
+		$this->_dependency_map = array(
+			'EE_Request_Handler'                                                                                          => array(
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_System'                                                                                                   => array(
+				'EE_Registry' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Session'                                                                                                  => array(
+				'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
+				'EE_Encryption'                                           => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Cart'                                                                                                     => array(
+				'EE_Session' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Front_Controller'                                                                                         => array(
+				'EE_Registry'              => EE_Dependency_Map::load_from_cache,
+				'EE_Request_Handler'       => EE_Dependency_Map::load_from_cache,
+				'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messenger_Collection_Loader'                                                                              => array(
+				'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object,
+			),
+			'EE_Message_Type_Collection_Loader'                                                                           => array(
+				'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object,
+			),
+			'EE_Message_Resource_Manager'                                                                                 => array(
+				'EE_Messenger_Collection_Loader'    => EE_Dependency_Map::load_new_object,
+				'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object,
+				'EEM_Message_Template_Group'        => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Message_Factory'                                                                                          => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_messages'                                                                                                 => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messages_Generator'                                                                                       => array(
+				'EE_Messages_Queue'                    => EE_Dependency_Map::load_new_object,
+				'EE_Messages_Data_Handler_Collection'  => EE_Dependency_Map::load_new_object,
+				'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object,
+				'EEH_Parse_Shortcodes'                 => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messages_Processor'                                                                                       => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messages_Queue'                                                                                           => array(
+				'EE_Message_Repository' => EE_Dependency_Map::load_new_object,
+			),
+			'EE_Messages_Template_Defaults'                                                                               => array(
+				'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache,
+				'EEM_Message_Template'       => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Message_To_Generate_From_Request'                                                                         => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+				'EE_Request_Handler'          => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CommandBus'                                                             => array(
+				'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\services\commands\CommandHandler'                                                              => array(
+				'EE_Registry'         => EE_Dependency_Map::load_from_cache,
+				'CommandBusInterface' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CommandHandlerManager'                                                  => array(
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CompositeCommandHandler'                                                => array(
+				'EventEspresso\core\services\commands\CommandBus'     => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CommandFactory'                                                         => array(
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\middleware\CapChecker'                                                  => array(
+				'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker'                                         => array(
+				'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker'                                     => array(
+				'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler'                          => array(
+				'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler'                     => array(
+				'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler'                    => array(
+				'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler'         => array(
+				'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array(
+				'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler'                              => array(
+				'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler'                              => array(
+				'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\registration\CancelRegistrationService'                                   => array(
+				'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\database\TableManager'                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Data_Migration_Class_Base'                                                                                => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_1_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_2_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_3_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_4_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_5_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_6_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_7_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_8_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_9_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\assets\Registry'                                                                 => array(
+				'EE_Template_Config' => EE_Dependency_Map::load_from_cache,
+				'EE_Currency_Config' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled'                                             => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout'                                              => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees'                                        => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEvents'                                                => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou'                                              => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector'                                        => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage'                                               => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\cache\BasicCacheManager'                                                         => array(
+				'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\cache\PostRelatedCacheManager'                                                   => array(
+				'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
+			),
+		);
+	}
+
+
+
+	/**
+	 * Registers how core classes are loaded.
+	 * This can either be done by simply providing the name of one of the EE_Registry loader methods such as:
+	 *        'EE_Request_Handler' => 'load_core'
+	 *        'EE_Messages_Queue'  => 'load_lib'
+	 *        'EEH_Debug_Tools'    => 'load_helper'
+	 * or, if greater control is required, by providing a custom closure. For example:
+	 *        'Some_Class' => function () {
+	 *            return new Some_Class();
+	 *        },
+	 * This is required for instantiating dependencies
+	 * where an interface has been type hinted in a class constructor. For example:
+	 *        'Required_Interface' => function () {
+	 *            return new A_Class_That_Implements_Required_Interface();
+	 *        },
+	 */
+	protected function _register_core_class_loaders()
+	{
+		//for PHP5.3 compat, we need to register any properties called here in a variable because `$this` cannot
+		//be used in a closure.
+		$request = &$this->_request;
+		$response = &$this->_response;
+		$loader = &$this->loader;
+		$this->_class_loaders = array(
+			//load_core
+			'EE_Capabilities'                      => 'load_core',
+			'EE_Encryption'                        => 'load_core',
+			'EE_Front_Controller'                  => 'load_core',
+			'EE_Module_Request_Router'             => 'load_core',
+			'EE_Registry'                          => 'load_core',
+			'EE_Request'                           => function () use (&$request) {
+				return $request;
+			},
+			'EE_Response'                          => function () use (&$response) {
+				return $response;
+			},
+			'EE_Request_Handler'                   => 'load_core',
+			'EE_Session'                           => 'load_core',
+			'EE_System'                            => 'load_core',
+			//load_lib
+			'EE_Message_Resource_Manager'          => 'load_lib',
+			'EE_Message_Type_Collection'           => 'load_lib',
+			'EE_Message_Type_Collection_Loader'    => 'load_lib',
+			'EE_Messenger_Collection'              => 'load_lib',
+			'EE_Messenger_Collection_Loader'       => 'load_lib',
+			'EE_Messages_Processor'                => 'load_lib',
+			'EE_Message_Repository'                => 'load_lib',
+			'EE_Messages_Queue'                    => 'load_lib',
+			'EE_Messages_Data_Handler_Collection'  => 'load_lib',
+			'EE_Message_Template_Group_Collection' => 'load_lib',
+			'EE_Messages_Generator'                => function () {
+				return EE_Registry::instance()->load_lib(
+					'Messages_Generator',
+					array(),
+					false,
+					false
+				);
+			},
+			'EE_Messages_Template_Defaults'        => function ($arguments = array()) {
+				return EE_Registry::instance()->load_lib(
+					'Messages_Template_Defaults',
+					$arguments,
+					false,
+					false
+				);
+			},
+			//load_model
+			'EEM_Message_Template_Group'           => 'load_model',
+			'EEM_Message_Template'                 => 'load_model',
+			//load_helper
+			'EEH_Parse_Shortcodes'                 => function () {
+				if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
+					return new EEH_Parse_Shortcodes();
+				}
+				return null;
+			},
+			'EE_Template_Config'                   => function () {
+				return EE_Config::instance()->template_settings;
+			},
+			'EE_Currency_Config'                   => function () {
+				return EE_Config::instance()->currency;
+			},
+			'EventEspresso\core\services\loaders\Loader' => function () use (&$loader) {
+				return $loader;
+			},
+		);
+	}
+
+
+
+	/**
+	 * can be used for supplying alternate names for classes,
+	 * or for connecting interface names to instantiable classes
+	 */
+	protected function _register_core_aliases()
+	{
+		$this->_aliases = array(
+			'CommandBusInterface'                                                 => 'EventEspresso\core\services\commands\CommandBusInterface',
+			'EventEspresso\core\services\commands\CommandBusInterface'            => 'EventEspresso\core\services\commands\CommandBus',
+			'CommandHandlerManagerInterface'                                      => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
+			'EventEspresso\core\services\commands\CommandHandlerManagerInterface' => 'EventEspresso\core\services\commands\CommandHandlerManager',
+			'CapChecker'                                                          => 'EventEspresso\core\services\commands\middleware\CapChecker',
+			'AddActionHook'                                                       => 'EventEspresso\core\services\commands\middleware\AddActionHook',
+			'CapabilitiesChecker'                                                 => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
+			'CapabilitiesCheckerInterface'                                        => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface',
+			'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
+			'CreateRegistrationService'                                           => 'EventEspresso\core\domain\services\registration\CreateRegistrationService',
+			'CreateRegCodeCommandHandler'                                         => 'EventEspresso\core\services\commands\registration\CreateRegCodeCommand',
+			'CreateRegUrlLinkCommandHandler'                                      => 'EventEspresso\core\services\commands\registration\CreateRegUrlLinkCommand',
+			'CreateRegistrationCommandHandler'                                    => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
+			'CopyRegistrationDetailsCommandHandler'                               => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand',
+			'CopyRegistrationPaymentsCommandHandler'                              => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand',
+			'CancelRegistrationAndTicketLineItemCommandHandler'                   => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler',
+			'UpdateRegistrationAndTransactionAfterChangeCommandHandler'           => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler',
+			'CreateTicketLineItemCommandHandler'                                  => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand',
+			'TableManager'                                                        => 'EventEspresso\core\services\database\TableManager',
+			'TableAnalysis'                                                       => 'EventEspresso\core\services\database\TableAnalysis',
+			'EspressoShortcode'                                                   => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
+			'ShortcodeInterface'                                                  => 'EventEspresso\core\services\shortcodes\ShortcodeInterface',
+			'EventEspresso\core\services\shortcodes\ShortcodeInterface'           => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
+			'EventEspresso\core\services\cache\CacheStorageInterface'             => 'EventEspresso\core\services\cache\TransientCacheStorage',
+			'LoaderInterface'                                                     => 'EventEspresso\core\services\loaders\LoaderInterface',
+			'EventEspresso\core\services\loaders\LoaderInterface'                 => 'EventEspresso\core\services\loaders\Loader',
+			'CommandFactoryInterface'                                             => 'EventEspresso\core\services\commands\CommandFactoryInterface',
+			'EventEspresso\core\services\commands\CommandFactoryInterface'        => 'EventEspresso\core\services\commands\CommandFactory',
+		);
+	}
+
+
+
+	/**
+	 * This is used to reset the internal map and class_loaders to their original default state at the beginning of the
+	 * request Primarily used by unit tests.
+	 */
+	public function reset()
+	{
+		$this->_register_core_class_loaders();
+		$this->_register_core_dependencies();
+	}
 
 
 }

Spacing +16 added lines, -16 removed lines

@@ -3,7 +3,7 @@ 
 use EventEspresso\core\exceptions\InvalidInterfaceException;
 use EventEspresso\core\services\loaders\LoaderInterface;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -116,7 +116,7 @@ 
     public static function instance(EE_Request $request = null, EE_Response $response = null)
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Dependency_Map) {
+        if ( ! self::$_instance instanceof EE_Dependency_Map) {
             self::$_instance = new EE_Dependency_Map($request, $response);
         }
         return self::$_instance;
@@ -141,15 +141,15 @@ 
      */
     public static function register_dependencies($class, $dependencies)
     {
-        if (! isset(self::$_instance->_dependency_map[$class])) {
+        if ( ! isset(self::$_instance->_dependency_map[$class])) {
             // we need to make sure that any aliases used when registering a dependency
             // get resolved to the correct class name
-            foreach ((array)$dependencies as $dependency => $load_source) {
+            foreach ((array) $dependencies as $dependency => $load_source) {
                 $alias = self::$_instance->get_alias($dependency);
                 unset($dependencies[$dependency]);
                 $dependencies[$alias] = $load_source;
             }
-            self::$_instance->_dependency_map[$class] = (array)$dependencies;
+            self::$_instance->_dependency_map[$class] = (array) $dependencies;
             return true;
         }
         return false;
@@ -181,7 +181,7 @@ 
             );
         }
         $class_name = self::$_instance->get_alias($class_name);
-        if (! isset(self::$_instance->_class_loaders[$class_name])) {
+        if ( ! isset(self::$_instance->_class_loaders[$class_name])) {
             self::$_instance->_class_loaders[$class_name] = $loader;
             return true;
         }
@@ -279,7 +279,7 @@ 
     public function add_alias($class_name, $alias, $for_class = '')
     {
         if ($for_class !== '') {
-            if (! isset($this->_aliases[$for_class])) {
+            if ( ! isset($this->_aliases[$for_class])) {
                 $this->_aliases[$for_class] = array();
             }
             $this->_aliases[$for_class][$class_name] = $alias;
@@ -325,7 +325,7 @@ 
      */
     public function get_alias($class_name = '', $for_class = '')
     {
-        if (! $this->has_alias($class_name, $for_class)) {
+        if ( ! $this->has_alias($class_name, $for_class)) {
             return $class_name;
         }
         if ($for_class !== '') {
@@ -560,10 +560,10 @@ 
             'EE_Front_Controller'                  => 'load_core',
             'EE_Module_Request_Router'             => 'load_core',
             'EE_Registry'                          => 'load_core',
-            'EE_Request'                           => function () use (&$request) {
+            'EE_Request'                           => function() use (&$request) {
                 return $request;
             },
-            'EE_Response'                          => function () use (&$response) {
+            'EE_Response'                          => function() use (&$response) {
                 return $response;
             },
             'EE_Request_Handler'                   => 'load_core',
@@ -580,7 +580,7 @@ 
             'EE_Messages_Queue'                    => 'load_lib',
             'EE_Messages_Data_Handler_Collection'  => 'load_lib',
             'EE_Message_Template_Group_Collection' => 'load_lib',
-            'EE_Messages_Generator'                => function () {
+            'EE_Messages_Generator'                => function() {
                 return EE_Registry::instance()->load_lib(
                     'Messages_Generator',
                     array(),
@@ -588,7 +588,7 @@ 
                     false
                 );
             },
-            'EE_Messages_Template_Defaults'        => function ($arguments = array()) {
+            'EE_Messages_Template_Defaults'        => function($arguments = array()) {
                 return EE_Registry::instance()->load_lib(
                     'Messages_Template_Defaults',
                     $arguments,
@@ -600,19 +600,19 @@ 
             'EEM_Message_Template_Group'           => 'load_model',
             'EEM_Message_Template'                 => 'load_model',
             //load_helper
-            'EEH_Parse_Shortcodes'                 => function () {
+            'EEH_Parse_Shortcodes'                 => function() {
                 if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
                     return new EEH_Parse_Shortcodes();
                 }
                 return null;
             },
-            'EE_Template_Config'                   => function () {
+            'EE_Template_Config'                   => function() {
                 return EE_Config::instance()->template_settings;
             },
-            'EE_Currency_Config'                   => function () {
+            'EE_Currency_Config'                   => function() {
                 return EE_Config::instance()->currency;
             },
-            'EventEspresso\core\services\loaders\Loader' => function () use (&$loader) {
+            'EventEspresso\core\services\loaders\Loader' => function() use (&$loader) {
                 return $loader;
             },
         );

core/services/assets/Registry.php

Spacing +13 added lines, -13 removed lines

@@ -71,7 +71,7 @@ 
         global $wp_version;
         wp_register_script(
             'eejs-core',
-            EE_PLUGIN_DIR_URL . 'core/services/assets/core_assets/eejs-core.js',
+            EE_PLUGIN_DIR_URL.'core/services/assets/core_assets/eejs-core.js',
             array(),
             EVENT_ESPRESSO_VERSION,
             true
@@ -81,7 +81,7 @@ 
             //js.api
             wp_register_script(
                 'eejs-api',
-                EE_LIBRARIES_URL . 'rest_api/assets/js/eejs-api.min.js',
+                EE_LIBRARIES_URL.'rest_api/assets/js/eejs-api.min.js',
                 array('underscore', 'eejs-core'),
                 EVENT_ESPRESSO_VERSION,
                 true
@@ -89,7 +89,7 @@ 
             $this->jsdata['eejs_api_nonce'] = wp_create_nonce('wp_rest');
             $this->jsdata['paths'] = array('rest_route' => rest_url('ee/v4.8.36/'));
         }
-        if (! is_admin()) {
+        if ( ! is_admin()) {
             $this->loadCoreCss();
         }
         $this->loadCoreJs();
@@ -182,7 +182,7 @@ 
      */
     public function addTemplate($template_reference, $template_content)
     {
-        if (! isset($this->jsdata['templates'])) {
+        if ( ! isset($this->jsdata['templates'])) {
             $this->jsdata['templates'] = array();
         }
         //no overrides allowed.
@@ -279,9 +279,9 @@ 
     private function loadCoreCss()
     {
         if ($this->template_config->enable_default_style) {
-            $default_stylesheet_path = is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')
-                ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css'
-                : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css';
+            $default_stylesheet_path = is_readable(EVENT_ESPRESSO_UPLOAD_DIR.'css/style.css')
+                ? EVENT_ESPRESSO_UPLOAD_DIR.'css/espresso_default.css'
+                : EE_GLOBAL_ASSETS_URL.'css/espresso_default.css';
             wp_register_style(
                 'espresso_default',
                 $default_stylesheet_path,
@@ -292,7 +292,7 @@ 
             if ($this->template_config->custom_style_sheet !== null) {
                 wp_register_style(
                     'espresso_custom_css',
-                    EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->template_config->custom_style_sheet,
+                    EVENT_ESPRESSO_UPLOAD_URL.'css/'.$this->template_config->custom_style_sheet,
                     array('espresso_default'),
                     EVENT_ESPRESSO_VERSION
                 );
@@ -310,7 +310,7 @@ 
         // load core js
         wp_register_script(
             'espresso_core',
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js',
             array('jquery'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -328,14 +328,14 @@ 
         // register jQuery Validate and additional methods
         wp_register_script(
             'jquery-validate',
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/jquery.validate.min.js',
             array('jquery'),
             '1.15.0',
             true
         );
         wp_register_script(
             'jquery-validate-extra-methods',
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/jquery.validate.additional-methods.min.js',
             array('jquery', 'jquery-validate'),
             '1.15.0',
             true
@@ -353,14 +353,14 @@ 
         // @link http://josscrowcroft.github.io/accounting.js/
         wp_register_script(
             'ee-accounting-core',
-            EE_THIRD_PARTY_URL . 'accounting/accounting.js',
+            EE_THIRD_PARTY_URL.'accounting/accounting.js',
             array('underscore'),
             '0.3.2',
             true
         );
         wp_register_script(
             'ee-accounting',
-            EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/ee-accounting-config.js',
             array('ee-accounting-core'),
             EVENT_ESPRESSO_VERSION,
             true

Indentation +384 added lines, -384 removed lines

@@ -23,394 +23,394 @@
 class Registry
 {
 
-    /**
-     * @var EE_Template_Config $template_config
-     */
-    protected $template_config;
-
-    /**
-     * @var EE_Currency_Config $currency_config
-     */
-    protected $currency_config;
-
-    /**
-     * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
-     *
-     * @var array
-     */
-    protected $jsdata = array();
-
-
-
-    /**
-     * Registry constructor.
-     * Hooking into WP actions for script registry.
-     *
-     * @param EE_Template_Config $template_config
-     * @param EE_Currency_Config $currency_config
-     */
-    public function __construct(EE_Template_Config $template_config, EE_Currency_Config $currency_config)
-    {
-        $this->template_config = $template_config;
-        $this->currency_config = $currency_config;
-        add_action('wp_enqueue_scripts', array($this, 'scripts'), 1);
-        add_action('admin_enqueue_scripts', array($this, 'scripts'), 1);
-        add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
-        add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
-    }
-
-
-
-    /**
-     * Callback for the WP script actions.
-     * Used to register globally accessible core scripts.
-     * Also used to add the eejs.data object to the source for any js having eejs-core as a dependency.
-     */
-    public function scripts()
-    {
-        global $wp_version;
-        wp_register_script(
-            'eejs-core',
-            EE_PLUGIN_DIR_URL . 'core/services/assets/core_assets/eejs-core.js',
-            array(),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        //only run this if WordPress 4.4.0 > is in use.
-        if (version_compare($wp_version, '4.4.0', '>')) {
-            //js.api
-            wp_register_script(
-                'eejs-api',
-                EE_LIBRARIES_URL . 'rest_api/assets/js/eejs-api.min.js',
-                array('underscore', 'eejs-core'),
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            $this->jsdata['eejs_api_nonce'] = wp_create_nonce('wp_rest');
-            $this->jsdata['paths'] = array('rest_route' => rest_url('ee/v4.8.36/'));
-        }
-        if (! is_admin()) {
-            $this->loadCoreCss();
-        }
-        $this->loadCoreJs();
-        $this->loadJqueryValidate();
-        $this->loadAccountingJs();
-        $this->loadQtipJs();
-    }
-
-
-
-    /**
-     * Call back for the script print in frontend and backend.
-     * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
-     *
-     * @since 4.9.31.rc.015
-     */
-    public function enqueueData()
-    {
-        wp_localize_script('eejs-core', 'eejs', array('data' => $this->jsdata));
-        wp_localize_script('espresso_core', 'eei18n', EE_Registry::$i18n_js_strings);
-        $this->localizeAccountingJs();
-    }
-
-
-
-    /**
-     * Used to add data to eejs.data object.
-     * Note:  Overriding existing data is not allowed.
-     * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
-     * If the data you add is something like this:
-     *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
-     * It will be exposed in the page source as:
-     *  eejs.data.my_plugin_data.foo == gar
-     *
-     * @param string       $key   Key used to access your data
-     * @param string|array $value Value to attach to key
-     * @throws InvalidArgumentException
-     */
-    public function addData($key, $value)
-    {
-        if ($this->verifyDataNotExisting($key)) {
-            $this->jsdata[$key] = $value;
-        }
-    }
-
-
-
-    /**
-     * Similar to addData except this allows for users to push values to an existing key where the values on key are
-     * elements in an array.
-     * When you use this method, the value you include will be appended to the end of an array on $key.
-     * So if the $key was 'test' and you added a value of 'my_data' then it would be represented in the javascript
-     * object like this, eejs.data.test = [ my_data,
-     * ]
-     * If there has already been a scalar value attached to the data object given key, then
-     * this will throw an exception.
-     *
-     * @param string       $key   Key to attach data to.
-     * @param string|array $value Value being registered.
-     * @throws InvalidArgumentException
-     */
-    public function pushData($key, $value)
-    {
-        if (isset($this->jsdata[$key])
-            && ! is_array($this->jsdata[$key])
-        ) {
-            throw new invalidArgumentException(
-                sprintf(
-                    __(
-                        'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
+	/**
+	 * @var EE_Template_Config $template_config
+	 */
+	protected $template_config;
+
+	/**
+	 * @var EE_Currency_Config $currency_config
+	 */
+	protected $currency_config;
+
+	/**
+	 * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
+	 *
+	 * @var array
+	 */
+	protected $jsdata = array();
+
+
+
+	/**
+	 * Registry constructor.
+	 * Hooking into WP actions for script registry.
+	 *
+	 * @param EE_Template_Config $template_config
+	 * @param EE_Currency_Config $currency_config
+	 */
+	public function __construct(EE_Template_Config $template_config, EE_Currency_Config $currency_config)
+	{
+		$this->template_config = $template_config;
+		$this->currency_config = $currency_config;
+		add_action('wp_enqueue_scripts', array($this, 'scripts'), 1);
+		add_action('admin_enqueue_scripts', array($this, 'scripts'), 1);
+		add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
+		add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
+	}
+
+
+
+	/**
+	 * Callback for the WP script actions.
+	 * Used to register globally accessible core scripts.
+	 * Also used to add the eejs.data object to the source for any js having eejs-core as a dependency.
+	 */
+	public function scripts()
+	{
+		global $wp_version;
+		wp_register_script(
+			'eejs-core',
+			EE_PLUGIN_DIR_URL . 'core/services/assets/core_assets/eejs-core.js',
+			array(),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		//only run this if WordPress 4.4.0 > is in use.
+		if (version_compare($wp_version, '4.4.0', '>')) {
+			//js.api
+			wp_register_script(
+				'eejs-api',
+				EE_LIBRARIES_URL . 'rest_api/assets/js/eejs-api.min.js',
+				array('underscore', 'eejs-core'),
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			$this->jsdata['eejs_api_nonce'] = wp_create_nonce('wp_rest');
+			$this->jsdata['paths'] = array('rest_route' => rest_url('ee/v4.8.36/'));
+		}
+		if (! is_admin()) {
+			$this->loadCoreCss();
+		}
+		$this->loadCoreJs();
+		$this->loadJqueryValidate();
+		$this->loadAccountingJs();
+		$this->loadQtipJs();
+	}
+
+
+
+	/**
+	 * Call back for the script print in frontend and backend.
+	 * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
+	 *
+	 * @since 4.9.31.rc.015
+	 */
+	public function enqueueData()
+	{
+		wp_localize_script('eejs-core', 'eejs', array('data' => $this->jsdata));
+		wp_localize_script('espresso_core', 'eei18n', EE_Registry::$i18n_js_strings);
+		$this->localizeAccountingJs();
+	}
+
+
+
+	/**
+	 * Used to add data to eejs.data object.
+	 * Note:  Overriding existing data is not allowed.
+	 * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
+	 * If the data you add is something like this:
+	 *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
+	 * It will be exposed in the page source as:
+	 *  eejs.data.my_plugin_data.foo == gar
+	 *
+	 * @param string       $key   Key used to access your data
+	 * @param string|array $value Value to attach to key
+	 * @throws InvalidArgumentException
+	 */
+	public function addData($key, $value)
+	{
+		if ($this->verifyDataNotExisting($key)) {
+			$this->jsdata[$key] = $value;
+		}
+	}
+
+
+
+	/**
+	 * Similar to addData except this allows for users to push values to an existing key where the values on key are
+	 * elements in an array.
+	 * When you use this method, the value you include will be appended to the end of an array on $key.
+	 * So if the $key was 'test' and you added a value of 'my_data' then it would be represented in the javascript
+	 * object like this, eejs.data.test = [ my_data,
+	 * ]
+	 * If there has already been a scalar value attached to the data object given key, then
+	 * this will throw an exception.
+	 *
+	 * @param string       $key   Key to attach data to.
+	 * @param string|array $value Value being registered.
+	 * @throws InvalidArgumentException
+	 */
+	public function pushData($key, $value)
+	{
+		if (isset($this->jsdata[$key])
+			&& ! is_array($this->jsdata[$key])
+		) {
+			throw new invalidArgumentException(
+				sprintf(
+					__(
+						'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
                          push values to this data element when it is an array.',
-                        'event_espresso'
-                    ),
-                    $key,
-                    __METHOD__
-                )
-            );
-        }
-        $this->jsdata[$key][] = $value;
-    }
-
-
-
-    /**
-     * Used to set content used by javascript for a template.
-     * Note: Overrides of existing registered templates are not allowed.
-     *
-     * @param string $template_reference
-     * @param string $template_content
-     * @throws InvalidArgumentException
-     */
-    public function addTemplate($template_reference, $template_content)
-    {
-        if (! isset($this->jsdata['templates'])) {
-            $this->jsdata['templates'] = array();
-        }
-        //no overrides allowed.
-        if (isset($this->jsdata['templates'][$template_reference])) {
-            throw new invalidArgumentException(
-                sprintf(
-                    __(
-                        'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
-                        'event_espresso'
-                    ),
-                    $template_reference
-                )
-            );
-        }
-        $this->jsdata['templates'][$template_reference] = $template_content;
-    }
-
-
-
-    /**
-     * Retrieve the template content already registered for the given reference.
-     *
-     * @param string $template_reference
-     * @return string
-     */
-    public function getTemplate($template_reference)
-    {
-        return isset($this->jsdata['templates'], $this->jsdata['templates'][$template_reference])
-            ? $this->jsdata['templates'][$template_reference]
-            : '';
-    }
-
-
-
-    /**
-     * Retrieve registered data.
-     *
-     * @param string $key Name of key to attach data to.
-     * @return mixed                If there is no for the given key, then false is returned.
-     */
-    public function getData($key)
-    {
-        return isset($this->jsdata[$key])
-            ? $this->jsdata[$key]
-            : false;
-    }
-
-
-
-    /**
-     * Verifies whether the given data exists already on the jsdata array.
-     * Overriding data is not allowed.
-     *
-     * @param string $key Index for data.
-     * @return bool        If valid then return true.
-     * @throws InvalidArgumentException if data already exists.
-     */
-    protected function verifyDataNotExisting($key)
-    {
-        if (isset($this->jsdata[$key])) {
-            if (is_array($this->jsdata[$key])) {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        __(
-                            'The value for %1$s already exists in the Registry::eejs object.
+						'event_espresso'
+					),
+					$key,
+					__METHOD__
+				)
+			);
+		}
+		$this->jsdata[$key][] = $value;
+	}
+
+
+
+	/**
+	 * Used to set content used by javascript for a template.
+	 * Note: Overrides of existing registered templates are not allowed.
+	 *
+	 * @param string $template_reference
+	 * @param string $template_content
+	 * @throws InvalidArgumentException
+	 */
+	public function addTemplate($template_reference, $template_content)
+	{
+		if (! isset($this->jsdata['templates'])) {
+			$this->jsdata['templates'] = array();
+		}
+		//no overrides allowed.
+		if (isset($this->jsdata['templates'][$template_reference])) {
+			throw new invalidArgumentException(
+				sprintf(
+					__(
+						'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
+						'event_espresso'
+					),
+					$template_reference
+				)
+			);
+		}
+		$this->jsdata['templates'][$template_reference] = $template_content;
+	}
+
+
+
+	/**
+	 * Retrieve the template content already registered for the given reference.
+	 *
+	 * @param string $template_reference
+	 * @return string
+	 */
+	public function getTemplate($template_reference)
+	{
+		return isset($this->jsdata['templates'], $this->jsdata['templates'][$template_reference])
+			? $this->jsdata['templates'][$template_reference]
+			: '';
+	}
+
+
+
+	/**
+	 * Retrieve registered data.
+	 *
+	 * @param string $key Name of key to attach data to.
+	 * @return mixed                If there is no for the given key, then false is returned.
+	 */
+	public function getData($key)
+	{
+		return isset($this->jsdata[$key])
+			? $this->jsdata[$key]
+			: false;
+	}
+
+
+
+	/**
+	 * Verifies whether the given data exists already on the jsdata array.
+	 * Overriding data is not allowed.
+	 *
+	 * @param string $key Index for data.
+	 * @return bool        If valid then return true.
+	 * @throws InvalidArgumentException if data already exists.
+	 */
+	protected function verifyDataNotExisting($key)
+	{
+		if (isset($this->jsdata[$key])) {
+			if (is_array($this->jsdata[$key])) {
+				throw new InvalidArgumentException(
+					sprintf(
+						__(
+							'The value for %1$s already exists in the Registry::eejs object.
                             Overrides are not allowed. Since the value of this data is an array, you may want to use the
                             %2$s method to push your value to the array.',
-                            'event_espresso'
-                        ),
-                        $key,
-                        'pushData()'
-                    )
-                );
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    __(
-                        'The value for %1$s already exists in the Registry::eejs object. Overrides are not
+							'event_espresso'
+						),
+						$key,
+						'pushData()'
+					)
+				);
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					__(
+						'The value for %1$s already exists in the Registry::eejs object. Overrides are not
                         allowed.  Consider attaching your value to a different key',
-                        'event_espresso'
-                    ),
-                    $key
-                )
-            );
-        }
-        return true;
-    }
-
-
-
-    /**
-     * registers core default stylesheets
-     */
-    private function loadCoreCss()
-    {
-        if ($this->template_config->enable_default_style) {
-            $default_stylesheet_path = is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')
-                ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css'
-                : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css';
-            wp_register_style(
-                'espresso_default',
-                $default_stylesheet_path,
-                array('dashicons'),
-                EVENT_ESPRESSO_VERSION
-            );
-            //Load custom style sheet if available
-            if ($this->template_config->custom_style_sheet !== null) {
-                wp_register_style(
-                    'espresso_custom_css',
-                    EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->template_config->custom_style_sheet,
-                    array('espresso_default'),
-                    EVENT_ESPRESSO_VERSION
-                );
-            }
-        }
-    }
-
-
-
-    /**
-     * registers core default javascript
-     */
-    private function loadCoreJs()
-    {
-        // load core js
-        wp_register_script(
-            'espresso_core',
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-            array('jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-    }
-
-
-
-    /**
-     * registers jQuery Validate for form validation
-     */
-    private function loadJqueryValidate()
-    {
-        // register jQuery Validate and additional methods
-        wp_register_script(
-            'jquery-validate',
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
-            array('jquery'),
-            '1.15.0',
-            true
-        );
-        wp_register_script(
-            'jquery-validate-extra-methods',
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
-            array('jquery', 'jquery-validate'),
-            '1.15.0',
-            true
-        );
-    }
-
-
-
-    /**
-     * registers accounting.js for performing client-side calculations
-     */
-    private function loadAccountingJs()
-    {
-        //accounting.js library
-        // @link http://josscrowcroft.github.io/accounting.js/
-        wp_register_script(
-            'ee-accounting-core',
-            EE_THIRD_PARTY_URL . 'accounting/accounting.js',
-            array('underscore'),
-            '0.3.2',
-            true
-        );
-        wp_register_script(
-            'ee-accounting',
-            EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js',
-            array('ee-accounting-core'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-    }
-
-
-
-    /**
-     * registers accounting.js for performing client-side calculations
-     */
-    private function localizeAccountingJs()
-    {
-        wp_localize_script(
-            'ee-accounting',
-            'EE_ACCOUNTING_CFG',
-            array(
-                'currency' => array(
-                    'symbol'    => $this->currency_config->sign,
-                    'format'    => array(
-                        'pos'  => $this->currency_config->sign_b4 ? '%s%v' : '%v%s',
-                        'neg'  => $this->currency_config->sign_b4 ? '- %s%v' : '- %v%s',
-                        'zero' => $this->currency_config->sign_b4 ? '%s--' : '--%s',
-                    ),
-                    'decimal'   => $this->currency_config->dec_mrk,
-                    'thousand'  => $this->currency_config->thsnds,
-                    'precision' => $this->currency_config->dec_plc,
-                ),
-                'number'   => array(
-                    'precision' => 0,
-                    'thousand'  => $this->currency_config->thsnds,
-                    'decimal'   => $this->currency_config->dec_mrk,
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * registers assets for cleaning your ears
-     */
-    private function loadQtipJs()
-    {
-        // qtip is turned OFF by default, but prior to the wp_enqueue_scripts hook,
-        // can be turned back on again via: add_filter('FHEE_load_qtip', '__return_true' );
-        if (apply_filters('FHEE_load_qtip', false)) {
-            EEH_Qtip_Loader::instance()->register_and_enqueue();
-        }
-    }
+						'event_espresso'
+					),
+					$key
+				)
+			);
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * registers core default stylesheets
+	 */
+	private function loadCoreCss()
+	{
+		if ($this->template_config->enable_default_style) {
+			$default_stylesheet_path = is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')
+				? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css'
+				: EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css';
+			wp_register_style(
+				'espresso_default',
+				$default_stylesheet_path,
+				array('dashicons'),
+				EVENT_ESPRESSO_VERSION
+			);
+			//Load custom style sheet if available
+			if ($this->template_config->custom_style_sheet !== null) {
+				wp_register_style(
+					'espresso_custom_css',
+					EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->template_config->custom_style_sheet,
+					array('espresso_default'),
+					EVENT_ESPRESSO_VERSION
+				);
+			}
+		}
+	}
+
+
+
+	/**
+	 * registers core default javascript
+	 */
+	private function loadCoreJs()
+	{
+		// load core js
+		wp_register_script(
+			'espresso_core',
+			EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+			array('jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+	}
+
+
+
+	/**
+	 * registers jQuery Validate for form validation
+	 */
+	private function loadJqueryValidate()
+	{
+		// register jQuery Validate and additional methods
+		wp_register_script(
+			'jquery-validate',
+			EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
+			array('jquery'),
+			'1.15.0',
+			true
+		);
+		wp_register_script(
+			'jquery-validate-extra-methods',
+			EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
+			array('jquery', 'jquery-validate'),
+			'1.15.0',
+			true
+		);
+	}
+
+
+
+	/**
+	 * registers accounting.js for performing client-side calculations
+	 */
+	private function loadAccountingJs()
+	{
+		//accounting.js library
+		// @link http://josscrowcroft.github.io/accounting.js/
+		wp_register_script(
+			'ee-accounting-core',
+			EE_THIRD_PARTY_URL . 'accounting/accounting.js',
+			array('underscore'),
+			'0.3.2',
+			true
+		);
+		wp_register_script(
+			'ee-accounting',
+			EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js',
+			array('ee-accounting-core'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+	}
+
+
+
+	/**
+	 * registers accounting.js for performing client-side calculations
+	 */
+	private function localizeAccountingJs()
+	{
+		wp_localize_script(
+			'ee-accounting',
+			'EE_ACCOUNTING_CFG',
+			array(
+				'currency' => array(
+					'symbol'    => $this->currency_config->sign,
+					'format'    => array(
+						'pos'  => $this->currency_config->sign_b4 ? '%s%v' : '%v%s',
+						'neg'  => $this->currency_config->sign_b4 ? '- %s%v' : '- %v%s',
+						'zero' => $this->currency_config->sign_b4 ? '%s--' : '--%s',
+					),
+					'decimal'   => $this->currency_config->dec_mrk,
+					'thousand'  => $this->currency_config->thsnds,
+					'precision' => $this->currency_config->dec_plc,
+				),
+				'number'   => array(
+					'precision' => 0,
+					'thousand'  => $this->currency_config->thsnds,
+					'decimal'   => $this->currency_config->dec_mrk,
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * registers assets for cleaning your ears
+	 */
+	private function loadQtipJs()
+	{
+		// qtip is turned OFF by default, but prior to the wp_enqueue_scripts hook,
+		// can be turned back on again via: add_filter('FHEE_load_qtip', '__return_true' );
+		if (apply_filters('FHEE_load_qtip', false)) {
+			EEH_Qtip_Loader::instance()->register_and_enqueue();
+		}
+	}
 
 
 

modules/single_page_checkout/EED_Single_Page_Checkout.module.php

Indentation +1849 added lines, -1849 removed lines

@@ -5,7 +5,7 @@ 
 use EventEspresso\core\exceptions\InvalidEntityException;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -20,1854 +20,1854 @@ 
 class EED_Single_Page_Checkout extends EED_Module
 {
 
-    /**
-     * $_initialized - has the SPCO controller already been initialized ?
-     *
-     * @access private
-     * @var bool $_initialized
-     */
-    private static $_initialized = false;
-
-
-    /**
-     * $_checkout_verified - is the EE_Checkout verified as correct for this request ?
-     *
-     * @access private
-     * @var bool $_valid_checkout
-     */
-    private static $_checkout_verified = true;
-
-    /**
-     *    $_reg_steps_array - holds initial array of reg steps
-     *
-     * @access private
-     * @var array $_reg_steps_array
-     */
-    private static $_reg_steps_array = array();
-
-    /**
-     *    $checkout - EE_Checkout object for handling the properties of the current checkout process
-     *
-     * @access public
-     * @var EE_Checkout $checkout
-     */
-    public $checkout;
-
-
-
-    /**
-     * @return EED_Module|EED_Single_Page_Checkout
-     */
-    public static function instance()
-    {
-        add_filter('EED_Single_Page_Checkout__SPCO_active', '__return_true');
-        return parent::get_instance(__CLASS__);
-    }
-
-
-
-    /**
-     * @return EE_CART
-     */
-    public function cart()
-    {
-        return $this->checkout->cart;
-    }
-
-
-
-    /**
-     * @return EE_Transaction
-     */
-    public function transaction()
-    {
-        return $this->checkout->transaction;
-    }
-
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @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
-     *
-     * @access    public
-     * @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_request_handler();
-        EED_Single_Page_Checkout::load_reg_steps();
-        // set ajax hooks
-        add_action('wp_ajax_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step'));
-        add_action('wp_ajax_nopriv_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step'));
-        add_action('wp_ajax_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step'));
-        add_action('wp_ajax_nopriv_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step'));
-        add_action('wp_ajax_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step'));
-        add_action('wp_ajax_nopriv_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step'));
-    }
-
-
-
-    /**
-     *    process ajax request
-     *
-     * @param string $ajax_action
-     * @throws EE_Error
-     */
-    public static function process_ajax_request($ajax_action)
-    {
-        EE_Registry::instance()->REQ->set('action', $ajax_action);
-        EED_Single_Page_Checkout::instance()->_initialize();
-    }
-
-
-
-    /**
-     *    ajax display registration step
-     *
-     * @throws EE_Error
-     */
-    public static function display_reg_step()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('display_spco_reg_step');
-    }
-
-
-
-    /**
-     *    ajax process registration step
-     *
-     * @throws EE_Error
-     */
-    public static function process_reg_step()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('process_reg_step');
-    }
-
-
-
-    /**
-     *    ajax process registration step
-     *
-     * @throws EE_Error
-     */
-    public static function update_reg_step()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('update_reg_step');
-    }
-
-
-
-    /**
-     *   update_checkout
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     */
-    public static function update_checkout()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('update_checkout');
-    }
-
-
-
-    /**
-     *    load_request_handler
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function load_request_handler()
-    {
-        // load core Request_Handler class
-        if (EE_Registry::instance()->REQ !== null) {
-            EE_Registry::instance()->load_core('Request_Handler');
-        }
-    }
-
-
-
-    /**
-     *    set_definitions
-     *
-     * @access    public
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function set_definitions()
-    {
-        if(defined('SPCO_BASE_PATH')) {
-            return;
-        }
-        define(
-            'SPCO_BASE_PATH',
-            rtrim(str_replace(array('\\', '/'), DS, plugin_dir_path(__FILE__)), DS) . DS
-        );
-        define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css' . DS);
-        define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img' . DS);
-        define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js' . DS);
-        define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc' . DS);
-        define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps' . DS);
-        define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates' . DS);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true);
-        EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf(
-            __('%1$sWe\'re sorry, but you\'re registration time has expired.%2$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 except our apologies for any inconvenience this may have caused.%8$s',
-                'event_espresso'),
-            '<h4 class="important-notice">',
-            '</h4>',
-            '<br />',
-            '<p>',
-            '<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
-            '">',
-            '</a>',
-            '</p>'
-        );
-    }
-
-
-
-    /**
-     * load_reg_steps
-     * loads and instantiates each reg step based on the EE_Registry::instance()->CFG->registration->reg_steps array
-     *
-     * @access    private
-     * @throws EE_Error
-     */
-    public static function load_reg_steps()
-    {
-        static $reg_steps_loaded = false;
-        if ($reg_steps_loaded) {
-            return;
-        }
-        // filter list of reg_steps
-        $reg_steps_to_load = (array)apply_filters(
-            'AHEE__SPCO__load_reg_steps__reg_steps_to_load',
-            EED_Single_Page_Checkout::get_reg_steps()
-        );
-        // sort by key (order)
-        ksort($reg_steps_to_load);
-        // loop through folders
-        foreach ($reg_steps_to_load as $order => $reg_step) {
-            // we need a
-            if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
-                // copy over to the reg_steps_array
-                EED_Single_Page_Checkout::$_reg_steps_array[$order] = $reg_step;
-                // register custom key route for each reg step
-                // ie: step=>"slug" - this is the entire reason we load the reg steps array now
-                EE_Config::register_route(
-                    $reg_step['slug'],
-                    'EED_Single_Page_Checkout',
-                    'run',
-                    'step'
-                );
-                // add AJAX or other hooks
-                if (isset($reg_step['has_hooks']) && $reg_step['has_hooks']) {
-                    // setup autoloaders if necessary
-                    if ( ! class_exists($reg_step['class_name'])) {
-                        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(
-                            $reg_step['file_path'],
-                            true
-                        );
-                    }
-                    if (is_callable($reg_step['class_name'], 'set_hooks')) {
-                        call_user_func(array($reg_step['class_name'], 'set_hooks'));
-                    }
-                }
-            }
-        }
-        $reg_steps_loaded = true;
-    }
-
-
-
-    /**
-     *    get_reg_steps
-     *
-     * @access    public
-     * @return    array
-     */
-    public static function get_reg_steps()
-    {
-        $reg_steps = EE_Registry::instance()->CFG->registration->reg_steps;
-        if (empty($reg_steps)) {
-            $reg_steps = array(
-                10  => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'attendee_information',
-                    'class_name' => 'EE_SPCO_Reg_Step_Attendee_Information',
-                    'slug'       => 'attendee_information',
-                    'has_hooks'  => false,
-                ),
-                20  => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'registration_confirmation',
-                    'class_name' => 'EE_SPCO_Reg_Step_Registration_Confirmation',
-                    'slug'       => 'registration_confirmation',
-                    'has_hooks'  => false,
-                ),
-                30  => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'payment_options',
-                    'class_name' => 'EE_SPCO_Reg_Step_Payment_Options',
-                    'slug'       => 'payment_options',
-                    'has_hooks'  => true,
-                ),
-                999 => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'finalize_registration',
-                    'class_name' => 'EE_SPCO_Reg_Step_Finalize_Registration',
-                    'slug'       => 'finalize_registration',
-                    'has_hooks'  => false,
-                ),
-            );
-        }
-        return $reg_steps;
-    }
-
-
-
-    /**
-     *    registration_checkout_for_admin
-     *
-     * @access    public
-     * @return    string
-     * @throws EE_Error
-     */
-    public static function registration_checkout_for_admin()
-    {
-        EED_Single_Page_Checkout::load_request_handler();
-        EE_Registry::instance()->REQ->set('step', 'attendee_information');
-        EE_Registry::instance()->REQ->set('action', 'display_spco_reg_step');
-        EE_Registry::instance()->REQ->set('process_form_submission', false);
-        EED_Single_Page_Checkout::instance()->_initialize();
-        EED_Single_Page_Checkout::instance()->_display_spco_reg_form();
-        return EE_Registry::instance()->REQ->get_output();
-    }
-
-
-
-    /**
-     * process_registration_from_admin
-     *
-     * @access public
-     * @return \EE_Transaction
-     * @throws EE_Error
-     */
-    public static function process_registration_from_admin()
-    {
-        EED_Single_Page_Checkout::load_request_handler();
-        EE_Registry::instance()->REQ->set('step', 'attendee_information');
-        EE_Registry::instance()->REQ->set('action', 'process_reg_step');
-        EE_Registry::instance()->REQ->set('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
-     *
-     * @access    public
-     * @param WP_Query $WP_Query
-     * @return    void
-     * @throws EE_Error
-     */
-    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()
-    {
-        // 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('REQUEST_URI');
-        $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
-     */
-    public static function init($wp_query)
-    {
-        EED_Single_Page_Checkout::instance()->run($wp_query);
-    }
-
-
-
-    /**
-     *    _initialize - initial module setup
-     *
-     * @access    private
-     * @throws EE_Error
-     * @return    void
-     */
-    private function _initialize()
-    {
-        // ensure SPCO doesn't run twice
-        if (EED_Single_Page_Checkout::$_initialized) {
-            return;
-        }
-        try {
-            EED_Single_Page_Checkout::load_reg_steps();
-            $this->_verify_session();
-            // setup the EE_Checkout object
-            $this->checkout = $this->_initialize_checkout();
-            // filter checkout
-            $this->checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize__checkout', $this->checkout);
-            // get the $_GET
-            $this->_get_request_vars();
-            if ($this->_block_bots()) {
-                return;
-            }
-            // filter continue_reg
-            $this->checkout->continue_reg = apply_filters(
-                'FHEE__EED_Single_Page_Checkout__init___continue_reg',
-                true,
-                $this->checkout
-            );
-            // load the reg steps array
-            if ( ! $this->_load_and_instantiate_reg_steps()) {
-                EED_Single_Page_Checkout::$_initialized = true;
-                return;
-            }
-            // set the current step
-            $this->checkout->set_current_step($this->checkout->step);
-            // and the next step
-            $this->checkout->set_next_step();
-            // verify that everything has been setup correctly
-            if ( ! ($this->_verify_transaction_and_get_registrations() && $this->_final_verifications())) {
-                EED_Single_Page_Checkout::$_initialized = true;
-                return;
-            }
-            // lock the transaction
-            $this->checkout->transaction->lock();
-            // make sure all of our cached objects are added to their respective model entity mappers
-            $this->checkout->refresh_all_entities();
-            // set amount owing
-            $this->checkout->amount_owing = $this->checkout->transaction->remaining();
-            // initialize each reg step, which gives them the chance to potentially alter the process
-            $this->_initialize_reg_steps();
-            // DEBUG LOG
-            //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
-            // get reg form
-            if( ! $this->_check_form_submission()) {
-                EED_Single_Page_Checkout::$_initialized = true;
-                return;
-            }
-            // checkout the action!!!
-            $this->_process_form_action();
-            // add some style and make it dance
-            $this->add_styles_and_scripts();
-            // kk... SPCO has successfully run
-            EED_Single_Page_Checkout::$_initialized = true;
-            // set no cache headers and constants
-            EE_System::do_not_cache();
-            // add anchor
-            add_action('loop_start', array($this, 'set_checkout_anchor'), 1);
-            // remove transaction lock
-            add_action('shutdown', array($this, 'unlock_transaction'), 1);
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-
-    /**
-     *    _verify_session
-     * checks that the session is valid and not expired
-     *
-     * @access    private
-     * @throws EE_Error
-     */
-    private function _verify_session()
-    {
-        if ( ! EE_Registry::instance()->SSN instanceof EE_Session) {
-            throw new EE_Error(__('The EE_Session class could not be loaded.', 'event_espresso'));
-        }
-        // is session still valid ?
-        if (
-            EE_Registry::instance()->SSN->expired()
-            && EE_Registry::instance()->REQ->get('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();
-            EE_Error::add_attention(
-                EE_Registry::$i18n_js_strings['registration_expiration_notice'],
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            // EE_Registry::instance()->SSN->reset_expired();
-        }
-    }
-
-
-
-    /**
-     *    _initialize_checkout
-     * loads and instantiates EE_Checkout
-     *
-     * @access    private
-     * @throws EE_Error
-     * @return EE_Checkout
-     */
-    private function _initialize_checkout()
-    {
-        // look in session for existing checkout
-        /** @type EE_Checkout $checkout */
-        $checkout = EE_Registry::instance()->SSN->checkout();
-        // verify
-        if ( ! $checkout instanceof EE_Checkout) {
-            // instantiate EE_Checkout object for handling the properties of the current checkout process
-            $checkout = EE_Registry::instance()->load_file(
-                SPCO_INC_PATH,
-                'EE_Checkout',
-                'class', array(),
-                false
-            );
-        } else {
-            if ($checkout->current_step->is_final_step() && $checkout->exit_spco() === true) {
-                $this->unlock_transaction();
-                wp_safe_redirect($checkout->redirect_url);
-                exit();
-            }
-        }
-        $checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize_checkout__checkout', $checkout);
-        // verify again
-        if ( ! $checkout instanceof EE_Checkout) {
-            throw new EE_Error(__('The EE_Checkout class could not be loaded.', 'event_espresso'));
-        }
-        // reset anything that needs a clean slate for each request
-        $checkout->reset_for_current_request();
-        return $checkout;
-    }
-
-
-
-    /**
-     *    _get_request_vars
-     *
-     * @access    private
-     * @return    void
-     * @throws EE_Error
-     */
-    private function _get_request_vars()
-    {
-        // load classes
-        EED_Single_Page_Checkout::load_request_handler();
-        //make sure this request is marked as belonging to EE
-        EE_Registry::instance()->REQ->set_espresso_page(true);
-        // which step is being requested ?
-        $this->checkout->step = EE_Registry::instance()->REQ->get('step', $this->_get_first_step());
-        // which step is being edited ?
-        $this->checkout->edit_step = EE_Registry::instance()->REQ->get('edit_step', '');
-        // and what we're doing on the current step
-        $this->checkout->action = EE_Registry::instance()->REQ->get('action', 'display_spco_reg_step');
-        // timestamp
-        $this->checkout->uts = EE_Registry::instance()->REQ->get('uts', 0);
-        // returning to edit ?
-        $this->checkout->reg_url_link = EE_Registry::instance()->REQ->get('e_reg_url_link', '');
-        // or some other kind of revisit ?
-        $this->checkout->revisit = filter_var(
-            EE_Registry::instance()->REQ->get('revisit', false),
-            FILTER_VALIDATE_BOOLEAN
-        );
-        // and whether or not to generate a reg form for this request
-        $this->checkout->generate_reg_form = filter_var(
-            EE_Registry::instance()->REQ->get('generate_reg_form', true),
-            FILTER_VALIDATE_BOOLEAN
-        );
-        // and whether or not to process a reg form submission for this request
-        $this->checkout->process_form_submission = filter_var(
-            EE_Registry::instance()->REQ->get(
-                'process_form_submission',
-                $this->checkout->action === 'process_reg_step'
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-        $this->checkout->process_form_submission = filter_var(
-            $this->checkout->action !== 'display_spco_reg_step'
-                ? $this->checkout->process_form_submission
-                : false,
-            FILTER_VALIDATE_BOOLEAN
-        );
-        // $this->_display_request_vars();
-    }
-
-
-
-    /**
-     *  _display_request_vars
-     *
-     * @access    protected
-     * @return    void
-     */
-    protected function _display_request_vars()
-    {
-        if ( ! WP_DEBUG) {
-            return;
-        }
-        EEH_Debug_Tools::printr($_REQUEST, '$_REQUEST', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->step, '$this->checkout->step', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->edit_step, '$this->checkout->edit_step', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->action, '$this->checkout->action', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->reg_url_link, '$this->checkout->reg_url_link', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->revisit, '$this->checkout->revisit', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->generate_reg_form, '$this->checkout->generate_reg_form', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->process_form_submission, '$this->checkout->process_form_submission', __FILE__, __LINE__);
-    }
-
-
-
-    /**
-     * _block_bots
-     * checks that the incoming request has either of the following set:
-     *  a uts (unix timestamp) which indicates that the request was redirected from the Ticket Selector
-     *  a REG URL Link, which indicates that the request is a return visit to SPCO for a valid TXN
-     * so if you're not coming from the Ticket Selector nor returning for a valid IP...
-     * then where you coming from man?
-     *
-     * @return boolean
-     */
-    private function _block_bots()
-    {
-        $invalid_checkout_access = EED_Invalid_Checkout_Access::getInvalidCheckoutAccess();
-        if ($invalid_checkout_access->checkoutAccessIsInvalid($this->checkout)) {
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     *    _get_first_step
-     *  gets slug for first step in $_reg_steps_array
-     *
-     * @access    private
-     * @throws EE_Error
-     * @return    string
-     */
-    private function _get_first_step()
-    {
-        $first_step = reset(EED_Single_Page_Checkout::$_reg_steps_array);
-        return isset($first_step['slug']) ? $first_step['slug'] : 'attendee_information';
-    }
-
-
-
-    /**
-     *    _load_and_instantiate_reg_steps
-     *  instantiates each reg step based on the loaded reg_steps array
-     *
-     * @access    private
-     * @throws EE_Error
-     * @return    bool
-     */
-    private function _load_and_instantiate_reg_steps()
-    {
-        do_action('AHEE__Single_Page_Checkout___load_and_instantiate_reg_steps__start', $this->checkout);
-        // have reg_steps already been instantiated ?
-        if (
-            empty($this->checkout->reg_steps)
-            || apply_filters('FHEE__Single_Page_Checkout__load_reg_steps__reload_reg_steps', false, $this->checkout)
-        ) {
-            // if not, then loop through raw reg steps array
-            foreach (EED_Single_Page_Checkout::$_reg_steps_array as $order => $reg_step) {
-                if ( ! $this->_load_and_instantiate_reg_step($reg_step, $order)) {
-                    return false;
-                }
-            }
-            EE_Registry::instance()->CFG->registration->skip_reg_confirmation = true;
-            EE_Registry::instance()->CFG->registration->reg_confirmation_last = true;
-            // skip the registration_confirmation page ?
-            if (EE_Registry::instance()->CFG->registration->skip_reg_confirmation) {
-                // just remove it from the reg steps array
-                $this->checkout->remove_reg_step('registration_confirmation', false);
-            } else if (
-                isset($this->checkout->reg_steps['registration_confirmation'])
-                && EE_Registry::instance()->CFG->registration->reg_confirmation_last
-            ) {
-                // set the order to something big like 100
-                $this->checkout->set_reg_step_order('registration_confirmation', 100);
-            }
-            // 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(
-                __('No Reg Steps were loaded..', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        // make reg step details available to JS
-        $this->checkout->set_reg_step_JSON_info();
-        return true;
-    }
-
-
-
-    /**
-     *     _load_and_instantiate_reg_step
-     *
-     * @access    private
-     * @param array $reg_step
-     * @param int   $order
-     * @return bool
-     */
-    private function _load_and_instantiate_reg_step($reg_step = array(), $order = 0)
-    {
-        // we need a file_path, class_name, and slug to add a reg step
-        if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
-            // if editing a specific step, but this is NOT that step... (and it's not the 'finalize_registration' step)
-            if (
-                $this->checkout->reg_url_link
-                && $this->checkout->step !== $reg_step['slug']
-                && $reg_step['slug'] !== 'finalize_registration'
-                // normally at this point we would NOT load the reg step, but this filter can change that
-                && apply_filters(
-                    'FHEE__Single_Page_Checkout___load_and_instantiate_reg_step__bypass_reg_step',
-                    true,
-                    $reg_step,
-                    $this->checkout
-                )
-            ) {
-                return true;
-            }
-            // instantiate step class using file path and class name
-            $reg_step_obj = EE_Registry::instance()->load_file(
-                $reg_step['file_path'],
-                $reg_step['class_name'],
-                'class',
-                $this->checkout,
-                false
-            );
-            // did we gets the goods ?
-            if ($reg_step_obj instanceof EE_SPCO_Reg_Step) {
-                // set reg step order based on config
-                $reg_step_obj->set_order($order);
-                // add instantiated reg step object to the master reg steps array
-                $this->checkout->add_reg_step($reg_step_obj);
-            } else {
-                EE_Error::add_error(
-                    __('The current step could not be set.', 'event_espresso'),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                return false;
-            }
-        } else {
-            if (WP_DEBUG) {
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            'A registration step could not be loaded. One or more of the following data points is invalid:%4$s%5$sFile Path: %1$s%6$s%5$sClass Name: %2$s%6$s%5$sSlug: %3$s%6$s%7$s',
-                            'event_espresso'
-                        ),
-                        isset($reg_step['file_path']) ? $reg_step['file_path'] : '',
-                        isset($reg_step['class_name']) ? $reg_step['class_name'] : '',
-                        isset($reg_step['slug']) ? $reg_step['slug'] : '',
-                        '<ul>',
-                        '<li>',
-                        '</li>',
-                        '</ul>'
-                    ),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * _verify_transaction_and_get_registrations
-     *
-     * @access private
-     * @return bool
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws EE_Error
-     */
-    private function _verify_transaction_and_get_registrations()
-    {
-        // was there already a valid transaction in the checkout from the session ?
-        if ( ! $this->checkout->transaction instanceof EE_Transaction) {
-            // get transaction from db or session
-            $this->checkout->transaction = $this->checkout->reg_url_link && ! is_admin()
-                ? $this->_get_transaction_and_cart_for_previous_visit()
-                : $this->_get_cart_for_current_session_and_setup_new_transaction();
-            if ( ! $this->checkout->transaction instanceof EE_Transaction) {
-                EE_Error::add_error(
-                    __('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();
-                EED_Single_Page_Checkout::$_initialized = true;
-                return false;
-            }
-            // and the registrations for the transaction
-            $this->_get_registrations($this->checkout->transaction);
-        }
-        return true;
-    }
-
-
-
-    /**
-     * _get_transaction_and_cart_for_previous_visit
-     *
-     * @access private
-     * @return mixed EE_Transaction|NULL
-     */
-    private function _get_transaction_and_cart_for_previous_visit()
-    {
-        /** @var $TXN_model EEM_Transaction */
-        $TXN_model = EE_Registry::instance()->load_model('Transaction');
-        // because the reg_url_link is present in the request,
-        // this is a return visit to SPCO, so we'll get the transaction data from the db
-        $transaction = $TXN_model->get_transaction_from_reg_url_link($this->checkout->reg_url_link);
-        // verify transaction
-        if ($transaction instanceof EE_Transaction) {
-            // and get the cart that was used for that transaction
-            $this->checkout->cart = $this->_get_cart_for_transaction($transaction);
-            return $transaction;
-        }
-        EE_Error::add_error(
-            __('Your Registration and Transaction information could not be retrieved from the db.', 'event_espresso'),
-            __FILE__, __FUNCTION__, __LINE__
-        );
-        return null;
-
-    }
-
-
-
-    /**
-     * _get_cart_for_transaction
-     *
-     * @access private
-     * @param EE_Transaction $transaction
-     * @return EE_Cart
-     */
-    private function _get_cart_for_transaction($transaction)
-    {
-        return $this->checkout->get_cart_for_transaction($transaction);
-    }
-
-
-
-    /**
-     * get_cart_for_transaction
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @return EE_Cart
-     */
-    public function get_cart_for_transaction(EE_Transaction $transaction)
-    {
-        return $this->checkout->get_cart_for_transaction($transaction);
-    }
-
-
-
-    /**
-     * _get_transaction_and_cart_for_current_session
-     *    generates a new EE_Transaction object and adds it to the $_transaction property.
-     *
-     * @access private
-     * @return EE_Transaction
-     * @throws EE_Error
-     */
-    private function _get_cart_for_current_session_and_setup_new_transaction()
-    {
-        //  if there's no transaction, then this is the FIRST visit to SPCO
-        // so load up the cart ( passing nothing for the TXN because it doesn't exist yet )
-        $this->checkout->cart = $this->_get_cart_for_transaction(null);
-        // and then create a new transaction
-        $transaction = $this->_initialize_transaction();
-        // verify transaction
-        if ($transaction instanceof EE_Transaction) {
-            // save it so that we have an ID for other objects to use
-            $transaction->save();
-            // and save TXN data to the cart
-            $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn($transaction->ID());
-        } else {
-            EE_Error::add_error(
-                __('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.
-     *
-     * @access private
-     * @return mixed EE_Transaction|NULL
-     */
-    private function _initialize_transaction()
-    {
-        try {
-            // ensure cart totals have been calculated
-            $this->checkout->cart->get_grand_total()->recalculate_total_including_taxes();
-            // grab the cart grand total
-            $cart_total = $this->checkout->cart->get_cart_grand_total();
-            // create new TXN
-            $transaction = EE_Transaction::new_instance(
-                array(
-                    'TXN_reg_steps' => $this->checkout->initialize_txn_reg_steps_array(),
-                    'TXN_total'     => $cart_total > 0 ? $cart_total : 0,
-                    'TXN_paid'      => 0,
-                    'STS_ID'        => EEM_Transaction::failed_status_code,
-                )
-            );
-            // save it so that we have an ID for other objects to use
-            $transaction->save();
-            // set cron job for following up on TXNs after their session has expired
-            EE_Cron_Tasks::schedule_expired_transaction_check(
-                EE_Registry::instance()->SSN->expiration() + 1,
-                $transaction->ID()
-            );
-            return $transaction;
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return null;
-    }
-
-
-    /**
-     * _get_registrations
-     *
-     * @access private
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws EE_Error
-     */
-    private function _get_registrations(EE_Transaction $transaction)
-    {
-        // first step: grab the registrants  { : o
-        $registrations = $transaction->registrations($this->checkout->reg_cache_where_params, true);
-        // 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, false);
-            // still nothing ? well as long as this isn't a revisit
-            if (empty($registrations) && ! $this->checkout->revisit) {
-                // generate new registrations from scratch
-                $registrations = $this->_initialize_registrations($transaction);
-            }
-        }
-        // sort by their original registration order
-        usort($registrations, array('EED_Single_Page_Checkout', 'sort_registrations_by_REG_count'));
-        // then loop thru the array
-        foreach ($registrations as $registration) {
-            // verify each registration
-            if ($registration instanceof EE_Registration) {
-                // we display all attendee info for the primary registrant
-                if ($this->checkout->reg_url_link === $registration->reg_url_link()
-                    && $registration->is_primary_registrant()
-                ) {
-                    $this->checkout->primary_revisit = true;
-                    break;
-                }
-                if ($this->checkout->revisit
-                           && $this->checkout->reg_url_link !== $registration->reg_url_link()
-                ) {
-                    // but hide info if it doesn't belong to you
-                    $transaction->clear_cache('Registration', $registration->ID());
-                }
-                $this->checkout->set_reg_status_updated($registration->ID(), false);
-            }
-        }
-    }
-
-
-    /**
-     *    adds related EE_Registration objects for each ticket in the cart to the current EE_Transaction object
-     *
-     * @access private
-     * @param EE_Transaction $transaction
-     * @return    array
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws EE_Error
-     */
-    private function _initialize_registrations(EE_Transaction $transaction)
-    {
-        $att_nmbr = 0;
-        $registrations = array();
-        if ($transaction instanceof EE_Transaction) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            $this->checkout->total_ticket_count = $this->checkout->cart->all_ticket_quantity_count();
-            // now let's add the cart items to the $transaction
-            foreach ($this->checkout->cart->get_tickets() as $line_item) {
-                //do the following for each ticket of this type they selected
-                for ($x = 1; $x <= $line_item->quantity(); $x++) {
-                    $att_nmbr++;
-                    /** @var EventEspresso\core\services\commands\registration\CreateRegistrationCommand $CreateRegistrationCommand */
-                    $CreateRegistrationCommand = EE_Registry::instance()->create(
-                        'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
-                        array(
-                            $transaction,
-                            $line_item,
-                            $att_nmbr,
-                            $this->checkout->total_ticket_count,
-                        )
-                    );
-                    // override capabilities for frontend registrations
-                    if ( ! is_admin()) {
-                        $CreateRegistrationCommand->setCapCheck(
-                            new PublicCapabilities('', 'create_new_registration')
-                        );
-                    }
-                    $registration = EE_Registry::instance()->BUS->execute($CreateRegistrationCommand);
-                    if ( ! $registration instanceof EE_Registration) {
-                        throw new InvalidEntityException($registration, 'EE_Registration');
-                    }
-                    $registrations[ $registration->ID() ] = $registration;
-                }
-            }
-            $registration_processor->fix_reg_final_price_rounding_issue($transaction);
-        }
-        return $registrations;
-    }
-
-
-
-    /**
-     * sorts registrations by REG_count
-     *
-     * @access public
-     * @param EE_Registration $reg_A
-     * @param EE_Registration $reg_B
-     * @return int
-     */
-    public static function sort_registrations_by_REG_count(EE_Registration $reg_A, EE_Registration $reg_B)
-    {
-        // this shouldn't ever happen within the same TXN, but oh well
-        if ($reg_A->count() === $reg_B->count()) {
-            return 0;
-        }
-        return ($reg_A->count() > $reg_B->count()) ? 1 : -1;
-    }
-
-
-
-    /**
-     *    _final_verifications
-     * just makes sure that everything is set up correctly before proceeding
-     *
-     * @access    private
-     * @return    bool
-     * @throws EE_Error
-     */
-    private function _final_verifications()
-    {
-        // filter checkout
-        $this->checkout = apply_filters(
-            'FHEE__EED_Single_Page_Checkout___final_verifications__checkout',
-            $this->checkout
-        );
-        //verify that current step is still set correctly
-        if ( ! $this->checkout->current_step instanceof EE_SPCO_Reg_Step) {
-            EE_Error::add_error(
-                __('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(
-                    __('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(
-                    __(
-                        'We\'re sorry but there appears to be an error with the "reg_url_link" or the transaction itself. Please refresh the page and try again or contact support.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        // now that things have been kinda sufficiently verified,
-        // let's add the checkout to the session so that it's available to other systems
-        EE_Registry::instance()->SSN->set_checkout($this->checkout);
-        return true;
-    }
-
-
-
-    /**
-     *    _initialize_reg_steps
-     * first makes sure that EE_Transaction_Processor::set_reg_step_initiated() is called as required
-     * then loops thru all of the active reg steps and calls the initialize_reg_step() method
-     *
-     * @access    private
-     * @param bool $reinitializing
-     * @throws EE_Error
-     */
-    private function _initialize_reg_steps($reinitializing = false)
-    {
-        $this->checkout->set_reg_step_initiated($this->checkout->current_step);
-        // loop thru all steps to call their individual "initialize" methods and set i18n strings for JS
-        foreach ($this->checkout->reg_steps as $reg_step) {
-            if ( ! $reg_step->initialize_reg_step()) {
-                // if not initialized then maybe this step is being removed...
-                if ( ! $reinitializing && $reg_step->is_current_step()) {
-                    // if it was the current step, then we need to start over here
-                    $this->_initialize_reg_steps(true);
-                    return;
-                }
-                continue;
-            }
-            // add css and JS for current step
-            $reg_step->enqueue_styles_and_scripts();
-            // i18n
-            $reg_step->translate_js_strings();
-            if ($reg_step->is_current_step()) {
-                // the text that appears on the reg step form submit button
-                $reg_step->set_submit_button_text();
-            }
-        }
-        // dynamically creates hook point like: AHEE__Single_Page_Checkout___initialize_reg_step__attendee_information
-        do_action(
-            "AHEE__Single_Page_Checkout___initialize_reg_step__{$this->checkout->current_step->slug()}",
-            $this->checkout->current_step
-        );
-    }
-
-
-
-    /**
-     * _check_form_submission
-     *
-     * @access private
-     * @return boolean
-     */
-    private function _check_form_submission()
-    {
-        //does this request require the reg form to be generated ?
-        if ($this->checkout->generate_reg_form) {
-            // ever heard that song by Blue Rodeo ?
-            try {
-                $this->checkout->current_step->reg_form = $this->checkout->current_step->generate_reg_form();
-                // if not displaying a form, then check for form submission
-                if (
-                    $this->checkout->process_form_submission
-                    && $this->checkout->current_step->reg_form->was_submitted()
-                ) {
-                    // clear out any old data in case this step is being run again
-                    $this->checkout->current_step->set_valid_data(array());
-                    // capture submitted form data
-                    $this->checkout->current_step->reg_form->receive_form_submission(
-                        apply_filters(
-                            'FHEE__Single_Page_Checkout___check_form_submission__request_params',
-                            EE_Registry::instance()->REQ->params(),
-                            $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() !== '') {
-                            $submission_error_messages = array();
-                            // bad, bad, bad registrant
-                            foreach (
-                                $this->checkout->current_step->reg_form->get_validation_errors_accumulated()
-                                as $validation_error
-                            ) {
-                                if ($validation_error instanceof EE_Validation_Error) {
-                                    $submission_error_messages[] = sprintf(
-                                        __('%s : %s', 'event_espresso'),
-                                        $validation_error->get_form_section()->html_label_text(),
-                                        $validation_error->getMessage()
-                                    );
-                                }
-                            }
-                            EE_Error::add_error(
-                                implode('<br />', $submission_error_messages),
-                                __FILE__, __FUNCTION__, __LINE__
-                            );
-                        }
-                        // well not really... what will happen is
-                        // we'll just get redirected back to redo the current step
-                        $this->go_to_next_step();
-                        return false;
-                    }
-                }
-            } catch (EE_Error $e) {
-                $e->get_error();
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * _process_action
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     */
-    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 (EE_Registry::instance()->REQ->ajax) {
-                    $this->checkout->json_response->set_reg_step_html(
-                        $this->checkout->current_step->display_reg_form()
-                    );
-                }
-                break;
-            default :
-                // meh... do one of those other steps first
-                if (
-                    ! empty($this->checkout->action)
-                    && is_callable(array($this->checkout->current_step, $this->checkout->action))
-                ) {
-                    // dynamically creates hook point like:
-                    //   AHEE__Single_Page_Checkout__before_attendee_information__process_reg_step
-                    do_action(
-                        "AHEE__Single_Page_Checkout__before_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
-                        $this->checkout->current_step
-                    );
-                    // call action on current step
-                    if (call_user_func(array($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(
-                            __(
-                                '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();
-    }
-
-
-
-    /**
-     *        add_styles_and_scripts
-     *
-     * @access        public
-     * @return        void
-     */
-    public function add_styles_and_scripts()
-    {
-        // i18n
-        $this->translate_js_strings();
-        if ($this->checkout->admin_request) {
-            add_action('admin_enqueue_scripts', array($this, 'enqueue_styles_and_scripts'), 10);
-        } else {
-            add_action('wp_enqueue_scripts', array($this, 'enqueue_styles_and_scripts'), 10);
-        }
-    }
-
-
-
-    /**
-     *        translate_js_strings
-     *
-     * @access        public
-     * @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'] = __(
-            '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'] = __(
-            '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'] = __(
-            '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'] = __(
-            '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'] = __(
-            'This registration step could not be completed. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_coupon'] = __(
-            '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(
-            __(
-                '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'] = __('years', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_months'] = __('months', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_weeks'] = __('weeks', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_days'] = __('days', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_hours'] = __('hours', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_minutes'] = __('minutes', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_seconds'] = __('seconds', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_year'] = __('year', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_month'] = __('month', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_week'] = __('week', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_day'] = __('day', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_hour'] = __('hour', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_minute'] = __('minute', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_second'] = __('second', 'event_espresso');
-        EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf(
-            __(
-                '%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 except our apologies for any inconvenience this may have caused.%8$s',
-                'event_espresso'
-            ),
-            '<h4 class="important-notice">',
-            '</h4>',
-            '<br />',
-            '<p>',
-            '<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
-            '">',
-            '</a>',
-            '</p>'
-        );
-        EE_Registry::$i18n_js_strings['ajax_submit'] = apply_filters(
-            'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
-            true
-        );
-        EE_Registry::$i18n_js_strings['session_extension'] = absint(
-            apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS)
-        );
-        EE_Registry::$i18n_js_strings['session_expiration'] = gmdate(
-            'M d, Y H:i:s',
-            EE_Registry::instance()->SSN->expiration() + (get_option('gmt_offset') * HOUR_IN_SECONDS)
-        );
-    }
-
-
-
-    /**
-     *    enqueue_styles_and_scripts
-     *
-     * @access        public
-     * @return        void
-     * @throws EE_Error
-     */
-    public function enqueue_styles_and_scripts()
-    {
-        // load css
-        wp_register_style(
-            'single_page_checkout',
-            SPCO_CSS_URL . 'single_page_checkout.css',
-            array('espresso_default'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('single_page_checkout');
-        // load JS
-        wp_register_script(
-            'jquery_plugin',
-            EE_THIRD_PARTY_URL . 'jquery	.plugin.min.js',
-            array('jquery'),
-            '1.0.1',
-            true
-        );
-        wp_register_script(
-            'jquery_countdown',
-            EE_THIRD_PARTY_URL . 'jquery	.countdown.min.js',
-            array('jquery_plugin'),
-            '2.0.2',
-            true
-        );
-        wp_register_script(
-            'single_page_checkout',
-            SPCO_JS_URL . 'single_page_checkout.js',
-            array('espresso_core', 'underscore', 'ee_form_section_validation', 'jquery_countdown'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        if ($this->checkout->registration_form instanceof EE_Form_Section_Proper) {
-            $this->checkout->registration_form->enqueue_js();
-        }
-        if ($this->checkout->current_step->reg_form instanceof EE_Form_Section_Proper) {
-            $this->checkout->current_step->reg_form->enqueue_js();
-        }
-        wp_enqueue_script('single_page_checkout');
-        /**
-         * global action hook for enqueueing styles and scripts with
-         * spco calls.
-         */
-        do_action('AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts', $this);
-        /**
-         * dynamic action hook for enqueueing styles and scripts with spco calls.
-         * The hook will end up being something like:
-         *      AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information
-         */
-        do_action(
-            'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__' . $this->checkout->current_step->slug(),
-            $this
-        );
-    }
-
-
-
-    /**
-     *    display the Registration Single Page Checkout Form
-     *
-     * @access    private
-     * @return    void
-     * @throws EE_Error
-     */
-    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) {
-            EE_Registry::instance()->REQ->add_output($this->checkout->current_step->display_reg_form());
-        } else {
-            // add powered by EE msg
-            add_action('AHEE__SPCO__reg_form_footer', array('EED_Single_Page_Checkout', 'display_registration_footer'));
-            $empty_cart = count(
-                $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params)
-            ) < 1;
-            EE_Registry::$i18n_js_strings['empty_cart'] = $empty_cart;
-            $cookies_not_set_msg = '';
-            if ($empty_cart && ! isset($_COOKIE['ee_cookie_test'])) {
-                $cookies_not_set_msg = apply_filters(
-                    'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg',
-                    sprintf(
-                        __(
-                            '%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">',
-                        '</div>',
-                        '<h6 class="important-notice">',
-                        '</h6>',
-                        '<p>',
-                        '</p>',
-                        '<br />',
-                        '<a href="http://www.whatarecookies.com/enable.asp" target="_blank">',
-                        '</a>'
-                    )
-                );
-            }
-            $this->checkout->registration_form = new EE_Form_Section_Proper(
-                array(
-                    'name'            => 'single-page-checkout',
-                    'html_id'         => 'ee-single-page-checkout-dv',
-                    'layout_strategy' =>
-                        new EE_Template_Layout(
-                            array(
-                                'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php',
-                                'template_args'        => array(
-                                    'empty_cart'              => $empty_cart,
-                                    'revisit'                 => $this->checkout->revisit,
-                                    'reg_steps'               => $this->checkout->reg_steps,
-                                    'next_step'               => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                        ? $this->checkout->next_step->slug()
-                                        : '',
-                                    'cancel_page_url'         => $this->checkout->cancel_page_url,
-                                    'empty_msg'               => apply_filters(
-                                        'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg',
-                                        sprintf(
-                                            __(
-                                                'You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.',
-                                                'event_espresso'
-                                            ),
-                                            '<a href="'
-                                            . get_post_type_archive_link('espresso_events')
-                                            . '" title="',
-                                            '">',
-                                            '</a>'
-                                        )
-                                    ),
-                                    'cookies_not_set_msg'     => $cookies_not_set_msg,
-                                    'registration_time_limit' => $this->checkout->get_registration_time_limit(),
-                                    'session_expiration'      => gmdate(
-                                        'M d, Y H:i:s',
-                                        EE_Registry::instance()->SSN->expiration()
-                                        + (get_option('gmt_offset') * HOUR_IN_SECONDS)
-                                    ),
-                                ),
-                            )
-                        ),
-                )
-            );
-            // load template and add to output sent that gets filtered into the_content()
-            EE_Registry::instance()->REQ->add_output($this->checkout->registration_form->get_html());
-        }
-    }
-
-
-
-    /**
-     *    add_extra_finalize_registration_inputs
-     *
-     * @access    public
-     * @param $next_step
-     * @internal  param string $label
-     * @return void
-     */
-    public function add_extra_finalize_registration_inputs($next_step)
-    {
-        if ($next_step === 'finalize_registration') {
-            echo '<div id="spco-extra-finalize_registration-inputs-dv"></div>';
-        }
-    }
-
-
-
-    /**
-     *    display_registration_footer
-     *
-     * @access    public
-     * @return    string
-     */
-    public static function display_registration_footer()
-    {
-        if (
-        apply_filters(
-            'FHEE__EE_Front__Controller__show_reg_footer',
-            EE_Registry::instance()->CFG->admin->show_reg_footer
-        )
-        ) {
-            add_filter(
-                'FHEE__EEH_Template__powered_by_event_espresso__url',
-                function ($url) {
-                    return apply_filters('FHEE__EE_Front_Controller__registration_footer__url', $url);
-                }
-            );
-            echo apply_filters(
-                'FHEE__EE_Front_Controller__display_registration_footer',
-                \EEH_Template::powered_by_event_espresso(
-                    '',
-                    'espresso-registration-footer-dv',
-                    array('utm_content' => 'registration_checkout')
-                )
-            );
-        }
-        return '';
-    }
-
-
-
-    /**
-     *    unlock_transaction
-     *
-     * @access    public
-     * @return    void
-     * @throws EE_Error
-     */
-    public function unlock_transaction()
-    {
-        if ($this->checkout->transaction instanceof EE_Transaction) {
-            $this->checkout->transaction->unlock();
-        }
-    }
-
-
-
-    /**
-     *        _setup_redirect
-     *
-     * @access    private
-     * @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
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     */
-    public function go_to_next_step()
-    {
-        if (EE_Registry::instance()->REQ->ajax) {
-            // capture contents of output buffer we started earlier in the request, and insert into JSON response
-            $this->checkout->json_response->set_unexpected_errors(ob_get_clean());
-        }
-        $this->unlock_transaction();
-        // just return for these conditions
-        if (
-            $this->checkout->admin_request
-            || $this->checkout->action === 'redirect_form'
-            || $this->checkout->action === 'update_checkout'
-        ) {
-            return;
-        }
-        // AJAX response
-        $this->_handle_json_response();
-        // redirect to next step or the Thank You page
-        $this->_handle_html_redirects();
-        // hmmm... must be something wrong, so let's just display the form again !
-        $this->_display_spco_reg_form();
-    }
-
-
-
-    /**
-     *   _handle_json_response
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _handle_json_response()
-    {
-        // if this is an ajax request
-        if (EE_Registry::instance()->REQ->ajax) {
-            // DEBUG LOG
-            //$this->checkout->log(
-            //	__CLASS__, __FUNCTION__, __LINE__,
-            //	array(
-            //		'json_response_redirect_url' => $this->checkout->json_response->redirect_url(),
-            //		'redirect'                   => $this->checkout->redirect,
-            //		'continue_reg'               => $this->checkout->continue_reg,
-            //	)
-            //);
-            $this->checkout->json_response->set_registration_time_limit(
-                $this->checkout->get_registration_time_limit()
-            );
-            $this->checkout->json_response->set_payment_amount($this->checkout->amount_owing);
-            // just send the ajax (
-            $json_response = apply_filters(
-                'FHEE__EE_Single_Page_Checkout__JSON_response',
-                $this->checkout->json_response
-            );
-            echo $json_response;
-            exit();
-        }
-    }
-
-
-
-    /**
-     *   _handle_redirects
-     *
-     * @access protected
-     * @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, true);
-            // DEBUG LOG
-            //$this->checkout->log(
-            //	__CLASS__, __FUNCTION__, __LINE__,
-            //	array(
-            //		'headers_sent' => headers_sent(),
-            //		'redirect_url'     => $this->checkout->redirect_url,
-            //		'headers_list'    => headers_list(),
-            //	)
-            //);
-            wp_safe_redirect($this->checkout->redirect_url);
-            exit();
-        }
-    }
-
-
-
-    /**
-     *   set_checkout_anchor
-     *
-     * @access public
-     * @return void
-     */
-    public function set_checkout_anchor()
-    {
-        echo '<a id="checkout" style="float: left; margin-left: -999em;"></a>';
-    }
+	/**
+	 * $_initialized - has the SPCO controller already been initialized ?
+	 *
+	 * @access private
+	 * @var bool $_initialized
+	 */
+	private static $_initialized = false;
+
+
+	/**
+	 * $_checkout_verified - is the EE_Checkout verified as correct for this request ?
+	 *
+	 * @access private
+	 * @var bool $_valid_checkout
+	 */
+	private static $_checkout_verified = true;
+
+	/**
+	 *    $_reg_steps_array - holds initial array of reg steps
+	 *
+	 * @access private
+	 * @var array $_reg_steps_array
+	 */
+	private static $_reg_steps_array = array();
+
+	/**
+	 *    $checkout - EE_Checkout object for handling the properties of the current checkout process
+	 *
+	 * @access public
+	 * @var EE_Checkout $checkout
+	 */
+	public $checkout;
+
+
+
+	/**
+	 * @return EED_Module|EED_Single_Page_Checkout
+	 */
+	public static function instance()
+	{
+		add_filter('EED_Single_Page_Checkout__SPCO_active', '__return_true');
+		return parent::get_instance(__CLASS__);
+	}
+
+
+
+	/**
+	 * @return EE_CART
+	 */
+	public function cart()
+	{
+		return $this->checkout->cart;
+	}
+
+
+
+	/**
+	 * @return EE_Transaction
+	 */
+	public function transaction()
+	{
+		return $this->checkout->transaction;
+	}
+
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @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
+	 *
+	 * @access    public
+	 * @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_request_handler();
+		EED_Single_Page_Checkout::load_reg_steps();
+		// set ajax hooks
+		add_action('wp_ajax_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step'));
+		add_action('wp_ajax_nopriv_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step'));
+		add_action('wp_ajax_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step'));
+		add_action('wp_ajax_nopriv_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step'));
+		add_action('wp_ajax_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step'));
+		add_action('wp_ajax_nopriv_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step'));
+	}
+
+
+
+	/**
+	 *    process ajax request
+	 *
+	 * @param string $ajax_action
+	 * @throws EE_Error
+	 */
+	public static function process_ajax_request($ajax_action)
+	{
+		EE_Registry::instance()->REQ->set('action', $ajax_action);
+		EED_Single_Page_Checkout::instance()->_initialize();
+	}
+
+
+
+	/**
+	 *    ajax display registration step
+	 *
+	 * @throws EE_Error
+	 */
+	public static function display_reg_step()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('display_spco_reg_step');
+	}
+
+
+
+	/**
+	 *    ajax process registration step
+	 *
+	 * @throws EE_Error
+	 */
+	public static function process_reg_step()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('process_reg_step');
+	}
+
+
+
+	/**
+	 *    ajax process registration step
+	 *
+	 * @throws EE_Error
+	 */
+	public static function update_reg_step()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('update_reg_step');
+	}
+
+
+
+	/**
+	 *   update_checkout
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function update_checkout()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('update_checkout');
+	}
+
+
+
+	/**
+	 *    load_request_handler
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function load_request_handler()
+	{
+		// load core Request_Handler class
+		if (EE_Registry::instance()->REQ !== null) {
+			EE_Registry::instance()->load_core('Request_Handler');
+		}
+	}
+
+
+
+	/**
+	 *    set_definitions
+	 *
+	 * @access    public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function set_definitions()
+	{
+		if(defined('SPCO_BASE_PATH')) {
+			return;
+		}
+		define(
+			'SPCO_BASE_PATH',
+			rtrim(str_replace(array('\\', '/'), DS, plugin_dir_path(__FILE__)), DS) . DS
+		);
+		define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css' . DS);
+		define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img' . DS);
+		define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js' . DS);
+		define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc' . DS);
+		define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps' . DS);
+		define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates' . DS);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true);
+		EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf(
+			__('%1$sWe\'re sorry, but you\'re registration time has expired.%2$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 except our apologies for any inconvenience this may have caused.%8$s',
+				'event_espresso'),
+			'<h4 class="important-notice">',
+			'</h4>',
+			'<br />',
+			'<p>',
+			'<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
+			'">',
+			'</a>',
+			'</p>'
+		);
+	}
+
+
+
+	/**
+	 * load_reg_steps
+	 * loads and instantiates each reg step based on the EE_Registry::instance()->CFG->registration->reg_steps array
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 */
+	public static function load_reg_steps()
+	{
+		static $reg_steps_loaded = false;
+		if ($reg_steps_loaded) {
+			return;
+		}
+		// filter list of reg_steps
+		$reg_steps_to_load = (array)apply_filters(
+			'AHEE__SPCO__load_reg_steps__reg_steps_to_load',
+			EED_Single_Page_Checkout::get_reg_steps()
+		);
+		// sort by key (order)
+		ksort($reg_steps_to_load);
+		// loop through folders
+		foreach ($reg_steps_to_load as $order => $reg_step) {
+			// we need a
+			if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
+				// copy over to the reg_steps_array
+				EED_Single_Page_Checkout::$_reg_steps_array[$order] = $reg_step;
+				// register custom key route for each reg step
+				// ie: step=>"slug" - this is the entire reason we load the reg steps array now
+				EE_Config::register_route(
+					$reg_step['slug'],
+					'EED_Single_Page_Checkout',
+					'run',
+					'step'
+				);
+				// add AJAX or other hooks
+				if (isset($reg_step['has_hooks']) && $reg_step['has_hooks']) {
+					// setup autoloaders if necessary
+					if ( ! class_exists($reg_step['class_name'])) {
+						EEH_Autoloader::register_autoloaders_for_each_file_in_folder(
+							$reg_step['file_path'],
+							true
+						);
+					}
+					if (is_callable($reg_step['class_name'], 'set_hooks')) {
+						call_user_func(array($reg_step['class_name'], 'set_hooks'));
+					}
+				}
+			}
+		}
+		$reg_steps_loaded = true;
+	}
+
+
+
+	/**
+	 *    get_reg_steps
+	 *
+	 * @access    public
+	 * @return    array
+	 */
+	public static function get_reg_steps()
+	{
+		$reg_steps = EE_Registry::instance()->CFG->registration->reg_steps;
+		if (empty($reg_steps)) {
+			$reg_steps = array(
+				10  => array(
+					'file_path'  => SPCO_REG_STEPS_PATH . 'attendee_information',
+					'class_name' => 'EE_SPCO_Reg_Step_Attendee_Information',
+					'slug'       => 'attendee_information',
+					'has_hooks'  => false,
+				),
+				20  => array(
+					'file_path'  => SPCO_REG_STEPS_PATH . 'registration_confirmation',
+					'class_name' => 'EE_SPCO_Reg_Step_Registration_Confirmation',
+					'slug'       => 'registration_confirmation',
+					'has_hooks'  => false,
+				),
+				30  => array(
+					'file_path'  => SPCO_REG_STEPS_PATH . 'payment_options',
+					'class_name' => 'EE_SPCO_Reg_Step_Payment_Options',
+					'slug'       => 'payment_options',
+					'has_hooks'  => true,
+				),
+				999 => array(
+					'file_path'  => SPCO_REG_STEPS_PATH . 'finalize_registration',
+					'class_name' => 'EE_SPCO_Reg_Step_Finalize_Registration',
+					'slug'       => 'finalize_registration',
+					'has_hooks'  => false,
+				),
+			);
+		}
+		return $reg_steps;
+	}
+
+
+
+	/**
+	 *    registration_checkout_for_admin
+	 *
+	 * @access    public
+	 * @return    string
+	 * @throws EE_Error
+	 */
+	public static function registration_checkout_for_admin()
+	{
+		EED_Single_Page_Checkout::load_request_handler();
+		EE_Registry::instance()->REQ->set('step', 'attendee_information');
+		EE_Registry::instance()->REQ->set('action', 'display_spco_reg_step');
+		EE_Registry::instance()->REQ->set('process_form_submission', false);
+		EED_Single_Page_Checkout::instance()->_initialize();
+		EED_Single_Page_Checkout::instance()->_display_spco_reg_form();
+		return EE_Registry::instance()->REQ->get_output();
+	}
+
+
+
+	/**
+	 * process_registration_from_admin
+	 *
+	 * @access public
+	 * @return \EE_Transaction
+	 * @throws EE_Error
+	 */
+	public static function process_registration_from_admin()
+	{
+		EED_Single_Page_Checkout::load_request_handler();
+		EE_Registry::instance()->REQ->set('step', 'attendee_information');
+		EE_Registry::instance()->REQ->set('action', 'process_reg_step');
+		EE_Registry::instance()->REQ->set('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
+	 *
+	 * @access    public
+	 * @param WP_Query $WP_Query
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	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()
+	{
+		// 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('REQUEST_URI');
+		$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
+	 */
+	public static function init($wp_query)
+	{
+		EED_Single_Page_Checkout::instance()->run($wp_query);
+	}
+
+
+
+	/**
+	 *    _initialize - initial module setup
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 * @return    void
+	 */
+	private function _initialize()
+	{
+		// ensure SPCO doesn't run twice
+		if (EED_Single_Page_Checkout::$_initialized) {
+			return;
+		}
+		try {
+			EED_Single_Page_Checkout::load_reg_steps();
+			$this->_verify_session();
+			// setup the EE_Checkout object
+			$this->checkout = $this->_initialize_checkout();
+			// filter checkout
+			$this->checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize__checkout', $this->checkout);
+			// get the $_GET
+			$this->_get_request_vars();
+			if ($this->_block_bots()) {
+				return;
+			}
+			// filter continue_reg
+			$this->checkout->continue_reg = apply_filters(
+				'FHEE__EED_Single_Page_Checkout__init___continue_reg',
+				true,
+				$this->checkout
+			);
+			// load the reg steps array
+			if ( ! $this->_load_and_instantiate_reg_steps()) {
+				EED_Single_Page_Checkout::$_initialized = true;
+				return;
+			}
+			// set the current step
+			$this->checkout->set_current_step($this->checkout->step);
+			// and the next step
+			$this->checkout->set_next_step();
+			// verify that everything has been setup correctly
+			if ( ! ($this->_verify_transaction_and_get_registrations() && $this->_final_verifications())) {
+				EED_Single_Page_Checkout::$_initialized = true;
+				return;
+			}
+			// lock the transaction
+			$this->checkout->transaction->lock();
+			// make sure all of our cached objects are added to their respective model entity mappers
+			$this->checkout->refresh_all_entities();
+			// set amount owing
+			$this->checkout->amount_owing = $this->checkout->transaction->remaining();
+			// initialize each reg step, which gives them the chance to potentially alter the process
+			$this->_initialize_reg_steps();
+			// DEBUG LOG
+			//$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
+			// get reg form
+			if( ! $this->_check_form_submission()) {
+				EED_Single_Page_Checkout::$_initialized = true;
+				return;
+			}
+			// checkout the action!!!
+			$this->_process_form_action();
+			// add some style and make it dance
+			$this->add_styles_and_scripts();
+			// kk... SPCO has successfully run
+			EED_Single_Page_Checkout::$_initialized = true;
+			// set no cache headers and constants
+			EE_System::do_not_cache();
+			// add anchor
+			add_action('loop_start', array($this, 'set_checkout_anchor'), 1);
+			// remove transaction lock
+			add_action('shutdown', array($this, 'unlock_transaction'), 1);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+
+	/**
+	 *    _verify_session
+	 * checks that the session is valid and not expired
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 */
+	private function _verify_session()
+	{
+		if ( ! EE_Registry::instance()->SSN instanceof EE_Session) {
+			throw new EE_Error(__('The EE_Session class could not be loaded.', 'event_espresso'));
+		}
+		// is session still valid ?
+		if (
+			EE_Registry::instance()->SSN->expired()
+			&& EE_Registry::instance()->REQ->get('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();
+			EE_Error::add_attention(
+				EE_Registry::$i18n_js_strings['registration_expiration_notice'],
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			// EE_Registry::instance()->SSN->reset_expired();
+		}
+	}
+
+
+
+	/**
+	 *    _initialize_checkout
+	 * loads and instantiates EE_Checkout
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 * @return EE_Checkout
+	 */
+	private function _initialize_checkout()
+	{
+		// look in session for existing checkout
+		/** @type EE_Checkout $checkout */
+		$checkout = EE_Registry::instance()->SSN->checkout();
+		// verify
+		if ( ! $checkout instanceof EE_Checkout) {
+			// instantiate EE_Checkout object for handling the properties of the current checkout process
+			$checkout = EE_Registry::instance()->load_file(
+				SPCO_INC_PATH,
+				'EE_Checkout',
+				'class', array(),
+				false
+			);
+		} else {
+			if ($checkout->current_step->is_final_step() && $checkout->exit_spco() === true) {
+				$this->unlock_transaction();
+				wp_safe_redirect($checkout->redirect_url);
+				exit();
+			}
+		}
+		$checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize_checkout__checkout', $checkout);
+		// verify again
+		if ( ! $checkout instanceof EE_Checkout) {
+			throw new EE_Error(__('The EE_Checkout class could not be loaded.', 'event_espresso'));
+		}
+		// reset anything that needs a clean slate for each request
+		$checkout->reset_for_current_request();
+		return $checkout;
+	}
+
+
+
+	/**
+	 *    _get_request_vars
+	 *
+	 * @access    private
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	private function _get_request_vars()
+	{
+		// load classes
+		EED_Single_Page_Checkout::load_request_handler();
+		//make sure this request is marked as belonging to EE
+		EE_Registry::instance()->REQ->set_espresso_page(true);
+		// which step is being requested ?
+		$this->checkout->step = EE_Registry::instance()->REQ->get('step', $this->_get_first_step());
+		// which step is being edited ?
+		$this->checkout->edit_step = EE_Registry::instance()->REQ->get('edit_step', '');
+		// and what we're doing on the current step
+		$this->checkout->action = EE_Registry::instance()->REQ->get('action', 'display_spco_reg_step');
+		// timestamp
+		$this->checkout->uts = EE_Registry::instance()->REQ->get('uts', 0);
+		// returning to edit ?
+		$this->checkout->reg_url_link = EE_Registry::instance()->REQ->get('e_reg_url_link', '');
+		// or some other kind of revisit ?
+		$this->checkout->revisit = filter_var(
+			EE_Registry::instance()->REQ->get('revisit', false),
+			FILTER_VALIDATE_BOOLEAN
+		);
+		// and whether or not to generate a reg form for this request
+		$this->checkout->generate_reg_form = filter_var(
+			EE_Registry::instance()->REQ->get('generate_reg_form', true),
+			FILTER_VALIDATE_BOOLEAN
+		);
+		// and whether or not to process a reg form submission for this request
+		$this->checkout->process_form_submission = filter_var(
+			EE_Registry::instance()->REQ->get(
+				'process_form_submission',
+				$this->checkout->action === 'process_reg_step'
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+		$this->checkout->process_form_submission = filter_var(
+			$this->checkout->action !== 'display_spco_reg_step'
+				? $this->checkout->process_form_submission
+				: false,
+			FILTER_VALIDATE_BOOLEAN
+		);
+		// $this->_display_request_vars();
+	}
+
+
+
+	/**
+	 *  _display_request_vars
+	 *
+	 * @access    protected
+	 * @return    void
+	 */
+	protected function _display_request_vars()
+	{
+		if ( ! WP_DEBUG) {
+			return;
+		}
+		EEH_Debug_Tools::printr($_REQUEST, '$_REQUEST', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->step, '$this->checkout->step', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->edit_step, '$this->checkout->edit_step', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->action, '$this->checkout->action', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->reg_url_link, '$this->checkout->reg_url_link', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->revisit, '$this->checkout->revisit', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->generate_reg_form, '$this->checkout->generate_reg_form', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->process_form_submission, '$this->checkout->process_form_submission', __FILE__, __LINE__);
+	}
+
+
+
+	/**
+	 * _block_bots
+	 * checks that the incoming request has either of the following set:
+	 *  a uts (unix timestamp) which indicates that the request was redirected from the Ticket Selector
+	 *  a REG URL Link, which indicates that the request is a return visit to SPCO for a valid TXN
+	 * so if you're not coming from the Ticket Selector nor returning for a valid IP...
+	 * then where you coming from man?
+	 *
+	 * @return boolean
+	 */
+	private function _block_bots()
+	{
+		$invalid_checkout_access = EED_Invalid_Checkout_Access::getInvalidCheckoutAccess();
+		if ($invalid_checkout_access->checkoutAccessIsInvalid($this->checkout)) {
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 *    _get_first_step
+	 *  gets slug for first step in $_reg_steps_array
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 * @return    string
+	 */
+	private function _get_first_step()
+	{
+		$first_step = reset(EED_Single_Page_Checkout::$_reg_steps_array);
+		return isset($first_step['slug']) ? $first_step['slug'] : 'attendee_information';
+	}
+
+
+
+	/**
+	 *    _load_and_instantiate_reg_steps
+	 *  instantiates each reg step based on the loaded reg_steps array
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 * @return    bool
+	 */
+	private function _load_and_instantiate_reg_steps()
+	{
+		do_action('AHEE__Single_Page_Checkout___load_and_instantiate_reg_steps__start', $this->checkout);
+		// have reg_steps already been instantiated ?
+		if (
+			empty($this->checkout->reg_steps)
+			|| apply_filters('FHEE__Single_Page_Checkout__load_reg_steps__reload_reg_steps', false, $this->checkout)
+		) {
+			// if not, then loop through raw reg steps array
+			foreach (EED_Single_Page_Checkout::$_reg_steps_array as $order => $reg_step) {
+				if ( ! $this->_load_and_instantiate_reg_step($reg_step, $order)) {
+					return false;
+				}
+			}
+			EE_Registry::instance()->CFG->registration->skip_reg_confirmation = true;
+			EE_Registry::instance()->CFG->registration->reg_confirmation_last = true;
+			// skip the registration_confirmation page ?
+			if (EE_Registry::instance()->CFG->registration->skip_reg_confirmation) {
+				// just remove it from the reg steps array
+				$this->checkout->remove_reg_step('registration_confirmation', false);
+			} else if (
+				isset($this->checkout->reg_steps['registration_confirmation'])
+				&& EE_Registry::instance()->CFG->registration->reg_confirmation_last
+			) {
+				// set the order to something big like 100
+				$this->checkout->set_reg_step_order('registration_confirmation', 100);
+			}
+			// 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(
+				__('No Reg Steps were loaded..', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		// make reg step details available to JS
+		$this->checkout->set_reg_step_JSON_info();
+		return true;
+	}
+
+
+
+	/**
+	 *     _load_and_instantiate_reg_step
+	 *
+	 * @access    private
+	 * @param array $reg_step
+	 * @param int   $order
+	 * @return bool
+	 */
+	private function _load_and_instantiate_reg_step($reg_step = array(), $order = 0)
+	{
+		// we need a file_path, class_name, and slug to add a reg step
+		if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
+			// if editing a specific step, but this is NOT that step... (and it's not the 'finalize_registration' step)
+			if (
+				$this->checkout->reg_url_link
+				&& $this->checkout->step !== $reg_step['slug']
+				&& $reg_step['slug'] !== 'finalize_registration'
+				// normally at this point we would NOT load the reg step, but this filter can change that
+				&& apply_filters(
+					'FHEE__Single_Page_Checkout___load_and_instantiate_reg_step__bypass_reg_step',
+					true,
+					$reg_step,
+					$this->checkout
+				)
+			) {
+				return true;
+			}
+			// instantiate step class using file path and class name
+			$reg_step_obj = EE_Registry::instance()->load_file(
+				$reg_step['file_path'],
+				$reg_step['class_name'],
+				'class',
+				$this->checkout,
+				false
+			);
+			// did we gets the goods ?
+			if ($reg_step_obj instanceof EE_SPCO_Reg_Step) {
+				// set reg step order based on config
+				$reg_step_obj->set_order($order);
+				// add instantiated reg step object to the master reg steps array
+				$this->checkout->add_reg_step($reg_step_obj);
+			} else {
+				EE_Error::add_error(
+					__('The current step could not be set.', 'event_espresso'),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				return false;
+			}
+		} else {
+			if (WP_DEBUG) {
+				EE_Error::add_error(
+					sprintf(
+						__(
+							'A registration step could not be loaded. One or more of the following data points is invalid:%4$s%5$sFile Path: %1$s%6$s%5$sClass Name: %2$s%6$s%5$sSlug: %3$s%6$s%7$s',
+							'event_espresso'
+						),
+						isset($reg_step['file_path']) ? $reg_step['file_path'] : '',
+						isset($reg_step['class_name']) ? $reg_step['class_name'] : '',
+						isset($reg_step['slug']) ? $reg_step['slug'] : '',
+						'<ul>',
+						'<li>',
+						'</li>',
+						'</ul>'
+					),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * _verify_transaction_and_get_registrations
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws EE_Error
+	 */
+	private function _verify_transaction_and_get_registrations()
+	{
+		// was there already a valid transaction in the checkout from the session ?
+		if ( ! $this->checkout->transaction instanceof EE_Transaction) {
+			// get transaction from db or session
+			$this->checkout->transaction = $this->checkout->reg_url_link && ! is_admin()
+				? $this->_get_transaction_and_cart_for_previous_visit()
+				: $this->_get_cart_for_current_session_and_setup_new_transaction();
+			if ( ! $this->checkout->transaction instanceof EE_Transaction) {
+				EE_Error::add_error(
+					__('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();
+				EED_Single_Page_Checkout::$_initialized = true;
+				return false;
+			}
+			// and the registrations for the transaction
+			$this->_get_registrations($this->checkout->transaction);
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * _get_transaction_and_cart_for_previous_visit
+	 *
+	 * @access private
+	 * @return mixed EE_Transaction|NULL
+	 */
+	private function _get_transaction_and_cart_for_previous_visit()
+	{
+		/** @var $TXN_model EEM_Transaction */
+		$TXN_model = EE_Registry::instance()->load_model('Transaction');
+		// because the reg_url_link is present in the request,
+		// this is a return visit to SPCO, so we'll get the transaction data from the db
+		$transaction = $TXN_model->get_transaction_from_reg_url_link($this->checkout->reg_url_link);
+		// verify transaction
+		if ($transaction instanceof EE_Transaction) {
+			// and get the cart that was used for that transaction
+			$this->checkout->cart = $this->_get_cart_for_transaction($transaction);
+			return $transaction;
+		}
+		EE_Error::add_error(
+			__('Your Registration and Transaction information could not be retrieved from the db.', 'event_espresso'),
+			__FILE__, __FUNCTION__, __LINE__
+		);
+		return null;
+
+	}
+
+
+
+	/**
+	 * _get_cart_for_transaction
+	 *
+	 * @access private
+	 * @param EE_Transaction $transaction
+	 * @return EE_Cart
+	 */
+	private function _get_cart_for_transaction($transaction)
+	{
+		return $this->checkout->get_cart_for_transaction($transaction);
+	}
+
+
+
+	/**
+	 * get_cart_for_transaction
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @return EE_Cart
+	 */
+	public function get_cart_for_transaction(EE_Transaction $transaction)
+	{
+		return $this->checkout->get_cart_for_transaction($transaction);
+	}
+
+
+
+	/**
+	 * _get_transaction_and_cart_for_current_session
+	 *    generates a new EE_Transaction object and adds it to the $_transaction property.
+	 *
+	 * @access private
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 */
+	private function _get_cart_for_current_session_and_setup_new_transaction()
+	{
+		//  if there's no transaction, then this is the FIRST visit to SPCO
+		// so load up the cart ( passing nothing for the TXN because it doesn't exist yet )
+		$this->checkout->cart = $this->_get_cart_for_transaction(null);
+		// and then create a new transaction
+		$transaction = $this->_initialize_transaction();
+		// verify transaction
+		if ($transaction instanceof EE_Transaction) {
+			// save it so that we have an ID for other objects to use
+			$transaction->save();
+			// and save TXN data to the cart
+			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn($transaction->ID());
+		} else {
+			EE_Error::add_error(
+				__('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.
+	 *
+	 * @access private
+	 * @return mixed EE_Transaction|NULL
+	 */
+	private function _initialize_transaction()
+	{
+		try {
+			// ensure cart totals have been calculated
+			$this->checkout->cart->get_grand_total()->recalculate_total_including_taxes();
+			// grab the cart grand total
+			$cart_total = $this->checkout->cart->get_cart_grand_total();
+			// create new TXN
+			$transaction = EE_Transaction::new_instance(
+				array(
+					'TXN_reg_steps' => $this->checkout->initialize_txn_reg_steps_array(),
+					'TXN_total'     => $cart_total > 0 ? $cart_total : 0,
+					'TXN_paid'      => 0,
+					'STS_ID'        => EEM_Transaction::failed_status_code,
+				)
+			);
+			// save it so that we have an ID for other objects to use
+			$transaction->save();
+			// set cron job for following up on TXNs after their session has expired
+			EE_Cron_Tasks::schedule_expired_transaction_check(
+				EE_Registry::instance()->SSN->expiration() + 1,
+				$transaction->ID()
+			);
+			return $transaction;
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return null;
+	}
+
+
+	/**
+	 * _get_registrations
+	 *
+	 * @access private
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws EE_Error
+	 */
+	private function _get_registrations(EE_Transaction $transaction)
+	{
+		// first step: grab the registrants  { : o
+		$registrations = $transaction->registrations($this->checkout->reg_cache_where_params, true);
+		// 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, false);
+			// still nothing ? well as long as this isn't a revisit
+			if (empty($registrations) && ! $this->checkout->revisit) {
+				// generate new registrations from scratch
+				$registrations = $this->_initialize_registrations($transaction);
+			}
+		}
+		// sort by their original registration order
+		usort($registrations, array('EED_Single_Page_Checkout', 'sort_registrations_by_REG_count'));
+		// then loop thru the array
+		foreach ($registrations as $registration) {
+			// verify each registration
+			if ($registration instanceof EE_Registration) {
+				// we display all attendee info for the primary registrant
+				if ($this->checkout->reg_url_link === $registration->reg_url_link()
+					&& $registration->is_primary_registrant()
+				) {
+					$this->checkout->primary_revisit = true;
+					break;
+				}
+				if ($this->checkout->revisit
+						   && $this->checkout->reg_url_link !== $registration->reg_url_link()
+				) {
+					// but hide info if it doesn't belong to you
+					$transaction->clear_cache('Registration', $registration->ID());
+				}
+				$this->checkout->set_reg_status_updated($registration->ID(), false);
+			}
+		}
+	}
+
+
+	/**
+	 *    adds related EE_Registration objects for each ticket in the cart to the current EE_Transaction object
+	 *
+	 * @access private
+	 * @param EE_Transaction $transaction
+	 * @return    array
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws EE_Error
+	 */
+	private function _initialize_registrations(EE_Transaction $transaction)
+	{
+		$att_nmbr = 0;
+		$registrations = array();
+		if ($transaction instanceof EE_Transaction) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			$this->checkout->total_ticket_count = $this->checkout->cart->all_ticket_quantity_count();
+			// now let's add the cart items to the $transaction
+			foreach ($this->checkout->cart->get_tickets() as $line_item) {
+				//do the following for each ticket of this type they selected
+				for ($x = 1; $x <= $line_item->quantity(); $x++) {
+					$att_nmbr++;
+					/** @var EventEspresso\core\services\commands\registration\CreateRegistrationCommand $CreateRegistrationCommand */
+					$CreateRegistrationCommand = EE_Registry::instance()->create(
+						'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
+						array(
+							$transaction,
+							$line_item,
+							$att_nmbr,
+							$this->checkout->total_ticket_count,
+						)
+					);
+					// override capabilities for frontend registrations
+					if ( ! is_admin()) {
+						$CreateRegistrationCommand->setCapCheck(
+							new PublicCapabilities('', 'create_new_registration')
+						);
+					}
+					$registration = EE_Registry::instance()->BUS->execute($CreateRegistrationCommand);
+					if ( ! $registration instanceof EE_Registration) {
+						throw new InvalidEntityException($registration, 'EE_Registration');
+					}
+					$registrations[ $registration->ID() ] = $registration;
+				}
+			}
+			$registration_processor->fix_reg_final_price_rounding_issue($transaction);
+		}
+		return $registrations;
+	}
+
+
+
+	/**
+	 * sorts registrations by REG_count
+	 *
+	 * @access public
+	 * @param EE_Registration $reg_A
+	 * @param EE_Registration $reg_B
+	 * @return int
+	 */
+	public static function sort_registrations_by_REG_count(EE_Registration $reg_A, EE_Registration $reg_B)
+	{
+		// this shouldn't ever happen within the same TXN, but oh well
+		if ($reg_A->count() === $reg_B->count()) {
+			return 0;
+		}
+		return ($reg_A->count() > $reg_B->count()) ? 1 : -1;
+	}
+
+
+
+	/**
+	 *    _final_verifications
+	 * just makes sure that everything is set up correctly before proceeding
+	 *
+	 * @access    private
+	 * @return    bool
+	 * @throws EE_Error
+	 */
+	private function _final_verifications()
+	{
+		// filter checkout
+		$this->checkout = apply_filters(
+			'FHEE__EED_Single_Page_Checkout___final_verifications__checkout',
+			$this->checkout
+		);
+		//verify that current step is still set correctly
+		if ( ! $this->checkout->current_step instanceof EE_SPCO_Reg_Step) {
+			EE_Error::add_error(
+				__('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(
+					__('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(
+					__(
+						'We\'re sorry but there appears to be an error with the "reg_url_link" or the transaction itself. Please refresh the page and try again or contact support.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		// now that things have been kinda sufficiently verified,
+		// let's add the checkout to the session so that it's available to other systems
+		EE_Registry::instance()->SSN->set_checkout($this->checkout);
+		return true;
+	}
+
+
+
+	/**
+	 *    _initialize_reg_steps
+	 * first makes sure that EE_Transaction_Processor::set_reg_step_initiated() is called as required
+	 * then loops thru all of the active reg steps and calls the initialize_reg_step() method
+	 *
+	 * @access    private
+	 * @param bool $reinitializing
+	 * @throws EE_Error
+	 */
+	private function _initialize_reg_steps($reinitializing = false)
+	{
+		$this->checkout->set_reg_step_initiated($this->checkout->current_step);
+		// loop thru all steps to call their individual "initialize" methods and set i18n strings for JS
+		foreach ($this->checkout->reg_steps as $reg_step) {
+			if ( ! $reg_step->initialize_reg_step()) {
+				// if not initialized then maybe this step is being removed...
+				if ( ! $reinitializing && $reg_step->is_current_step()) {
+					// if it was the current step, then we need to start over here
+					$this->_initialize_reg_steps(true);
+					return;
+				}
+				continue;
+			}
+			// add css and JS for current step
+			$reg_step->enqueue_styles_and_scripts();
+			// i18n
+			$reg_step->translate_js_strings();
+			if ($reg_step->is_current_step()) {
+				// the text that appears on the reg step form submit button
+				$reg_step->set_submit_button_text();
+			}
+		}
+		// dynamically creates hook point like: AHEE__Single_Page_Checkout___initialize_reg_step__attendee_information
+		do_action(
+			"AHEE__Single_Page_Checkout___initialize_reg_step__{$this->checkout->current_step->slug()}",
+			$this->checkout->current_step
+		);
+	}
+
+
+
+	/**
+	 * _check_form_submission
+	 *
+	 * @access private
+	 * @return boolean
+	 */
+	private function _check_form_submission()
+	{
+		//does this request require the reg form to be generated ?
+		if ($this->checkout->generate_reg_form) {
+			// ever heard that song by Blue Rodeo ?
+			try {
+				$this->checkout->current_step->reg_form = $this->checkout->current_step->generate_reg_form();
+				// if not displaying a form, then check for form submission
+				if (
+					$this->checkout->process_form_submission
+					&& $this->checkout->current_step->reg_form->was_submitted()
+				) {
+					// clear out any old data in case this step is being run again
+					$this->checkout->current_step->set_valid_data(array());
+					// capture submitted form data
+					$this->checkout->current_step->reg_form->receive_form_submission(
+						apply_filters(
+							'FHEE__Single_Page_Checkout___check_form_submission__request_params',
+							EE_Registry::instance()->REQ->params(),
+							$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() !== '') {
+							$submission_error_messages = array();
+							// bad, bad, bad registrant
+							foreach (
+								$this->checkout->current_step->reg_form->get_validation_errors_accumulated()
+								as $validation_error
+							) {
+								if ($validation_error instanceof EE_Validation_Error) {
+									$submission_error_messages[] = sprintf(
+										__('%s : %s', 'event_espresso'),
+										$validation_error->get_form_section()->html_label_text(),
+										$validation_error->getMessage()
+									);
+								}
+							}
+							EE_Error::add_error(
+								implode('<br />', $submission_error_messages),
+								__FILE__, __FUNCTION__, __LINE__
+							);
+						}
+						// well not really... what will happen is
+						// we'll just get redirected back to redo the current step
+						$this->go_to_next_step();
+						return false;
+					}
+				}
+			} catch (EE_Error $e) {
+				$e->get_error();
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * _process_action
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 */
+	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 (EE_Registry::instance()->REQ->ajax) {
+					$this->checkout->json_response->set_reg_step_html(
+						$this->checkout->current_step->display_reg_form()
+					);
+				}
+				break;
+			default :
+				// meh... do one of those other steps first
+				if (
+					! empty($this->checkout->action)
+					&& is_callable(array($this->checkout->current_step, $this->checkout->action))
+				) {
+					// dynamically creates hook point like:
+					//   AHEE__Single_Page_Checkout__before_attendee_information__process_reg_step
+					do_action(
+						"AHEE__Single_Page_Checkout__before_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
+						$this->checkout->current_step
+					);
+					// call action on current step
+					if (call_user_func(array($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(
+							__(
+								'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();
+	}
+
+
+
+	/**
+	 *        add_styles_and_scripts
+	 *
+	 * @access        public
+	 * @return        void
+	 */
+	public function add_styles_and_scripts()
+	{
+		// i18n
+		$this->translate_js_strings();
+		if ($this->checkout->admin_request) {
+			add_action('admin_enqueue_scripts', array($this, 'enqueue_styles_and_scripts'), 10);
+		} else {
+			add_action('wp_enqueue_scripts', array($this, 'enqueue_styles_and_scripts'), 10);
+		}
+	}
+
+
+
+	/**
+	 *        translate_js_strings
+	 *
+	 * @access        public
+	 * @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'] = __(
+			'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'] = __(
+			'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'] = __(
+			'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'] = __(
+			'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'] = __(
+			'This registration step could not be completed. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_coupon'] = __(
+			'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(
+			__(
+				'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'] = __('years', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_months'] = __('months', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_weeks'] = __('weeks', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_days'] = __('days', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_hours'] = __('hours', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_minutes'] = __('minutes', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_seconds'] = __('seconds', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_year'] = __('year', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_month'] = __('month', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_week'] = __('week', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_day'] = __('day', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_hour'] = __('hour', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_minute'] = __('minute', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_second'] = __('second', 'event_espresso');
+		EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf(
+			__(
+				'%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 except our apologies for any inconvenience this may have caused.%8$s',
+				'event_espresso'
+			),
+			'<h4 class="important-notice">',
+			'</h4>',
+			'<br />',
+			'<p>',
+			'<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
+			'">',
+			'</a>',
+			'</p>'
+		);
+		EE_Registry::$i18n_js_strings['ajax_submit'] = apply_filters(
+			'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
+			true
+		);
+		EE_Registry::$i18n_js_strings['session_extension'] = absint(
+			apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS)
+		);
+		EE_Registry::$i18n_js_strings['session_expiration'] = gmdate(
+			'M d, Y H:i:s',
+			EE_Registry::instance()->SSN->expiration() + (get_option('gmt_offset') * HOUR_IN_SECONDS)
+		);
+	}
+
+
+
+	/**
+	 *    enqueue_styles_and_scripts
+	 *
+	 * @access        public
+	 * @return        void
+	 * @throws EE_Error
+	 */
+	public function enqueue_styles_and_scripts()
+	{
+		// load css
+		wp_register_style(
+			'single_page_checkout',
+			SPCO_CSS_URL . 'single_page_checkout.css',
+			array('espresso_default'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('single_page_checkout');
+		// load JS
+		wp_register_script(
+			'jquery_plugin',
+			EE_THIRD_PARTY_URL . 'jquery	.plugin.min.js',
+			array('jquery'),
+			'1.0.1',
+			true
+		);
+		wp_register_script(
+			'jquery_countdown',
+			EE_THIRD_PARTY_URL . 'jquery	.countdown.min.js',
+			array('jquery_plugin'),
+			'2.0.2',
+			true
+		);
+		wp_register_script(
+			'single_page_checkout',
+			SPCO_JS_URL . 'single_page_checkout.js',
+			array('espresso_core', 'underscore', 'ee_form_section_validation', 'jquery_countdown'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		if ($this->checkout->registration_form instanceof EE_Form_Section_Proper) {
+			$this->checkout->registration_form->enqueue_js();
+		}
+		if ($this->checkout->current_step->reg_form instanceof EE_Form_Section_Proper) {
+			$this->checkout->current_step->reg_form->enqueue_js();
+		}
+		wp_enqueue_script('single_page_checkout');
+		/**
+		 * global action hook for enqueueing styles and scripts with
+		 * spco calls.
+		 */
+		do_action('AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts', $this);
+		/**
+		 * dynamic action hook for enqueueing styles and scripts with spco calls.
+		 * The hook will end up being something like:
+		 *      AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information
+		 */
+		do_action(
+			'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__' . $this->checkout->current_step->slug(),
+			$this
+		);
+	}
+
+
+
+	/**
+	 *    display the Registration Single Page Checkout Form
+	 *
+	 * @access    private
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	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) {
+			EE_Registry::instance()->REQ->add_output($this->checkout->current_step->display_reg_form());
+		} else {
+			// add powered by EE msg
+			add_action('AHEE__SPCO__reg_form_footer', array('EED_Single_Page_Checkout', 'display_registration_footer'));
+			$empty_cart = count(
+				$this->checkout->transaction->registrations($this->checkout->reg_cache_where_params)
+			) < 1;
+			EE_Registry::$i18n_js_strings['empty_cart'] = $empty_cart;
+			$cookies_not_set_msg = '';
+			if ($empty_cart && ! isset($_COOKIE['ee_cookie_test'])) {
+				$cookies_not_set_msg = apply_filters(
+					'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg',
+					sprintf(
+						__(
+							'%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">',
+						'</div>',
+						'<h6 class="important-notice">',
+						'</h6>',
+						'<p>',
+						'</p>',
+						'<br />',
+						'<a href="http://www.whatarecookies.com/enable.asp" target="_blank">',
+						'</a>'
+					)
+				);
+			}
+			$this->checkout->registration_form = new EE_Form_Section_Proper(
+				array(
+					'name'            => 'single-page-checkout',
+					'html_id'         => 'ee-single-page-checkout-dv',
+					'layout_strategy' =>
+						new EE_Template_Layout(
+							array(
+								'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php',
+								'template_args'        => array(
+									'empty_cart'              => $empty_cart,
+									'revisit'                 => $this->checkout->revisit,
+									'reg_steps'               => $this->checkout->reg_steps,
+									'next_step'               => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+										? $this->checkout->next_step->slug()
+										: '',
+									'cancel_page_url'         => $this->checkout->cancel_page_url,
+									'empty_msg'               => apply_filters(
+										'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg',
+										sprintf(
+											__(
+												'You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.',
+												'event_espresso'
+											),
+											'<a href="'
+											. get_post_type_archive_link('espresso_events')
+											. '" title="',
+											'">',
+											'</a>'
+										)
+									),
+									'cookies_not_set_msg'     => $cookies_not_set_msg,
+									'registration_time_limit' => $this->checkout->get_registration_time_limit(),
+									'session_expiration'      => gmdate(
+										'M d, Y H:i:s',
+										EE_Registry::instance()->SSN->expiration()
+										+ (get_option('gmt_offset') * HOUR_IN_SECONDS)
+									),
+								),
+							)
+						),
+				)
+			);
+			// load template and add to output sent that gets filtered into the_content()
+			EE_Registry::instance()->REQ->add_output($this->checkout->registration_form->get_html());
+		}
+	}
+
+
+
+	/**
+	 *    add_extra_finalize_registration_inputs
+	 *
+	 * @access    public
+	 * @param $next_step
+	 * @internal  param string $label
+	 * @return void
+	 */
+	public function add_extra_finalize_registration_inputs($next_step)
+	{
+		if ($next_step === 'finalize_registration') {
+			echo '<div id="spco-extra-finalize_registration-inputs-dv"></div>';
+		}
+	}
+
+
+
+	/**
+	 *    display_registration_footer
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public static function display_registration_footer()
+	{
+		if (
+		apply_filters(
+			'FHEE__EE_Front__Controller__show_reg_footer',
+			EE_Registry::instance()->CFG->admin->show_reg_footer
+		)
+		) {
+			add_filter(
+				'FHEE__EEH_Template__powered_by_event_espresso__url',
+				function ($url) {
+					return apply_filters('FHEE__EE_Front_Controller__registration_footer__url', $url);
+				}
+			);
+			echo apply_filters(
+				'FHEE__EE_Front_Controller__display_registration_footer',
+				\EEH_Template::powered_by_event_espresso(
+					'',
+					'espresso-registration-footer-dv',
+					array('utm_content' => 'registration_checkout')
+				)
+			);
+		}
+		return '';
+	}
+
+
+
+	/**
+	 *    unlock_transaction
+	 *
+	 * @access    public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public function unlock_transaction()
+	{
+		if ($this->checkout->transaction instanceof EE_Transaction) {
+			$this->checkout->transaction->unlock();
+		}
+	}
+
+
+
+	/**
+	 *        _setup_redirect
+	 *
+	 * @access    private
+	 * @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
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function go_to_next_step()
+	{
+		if (EE_Registry::instance()->REQ->ajax) {
+			// capture contents of output buffer we started earlier in the request, and insert into JSON response
+			$this->checkout->json_response->set_unexpected_errors(ob_get_clean());
+		}
+		$this->unlock_transaction();
+		// just return for these conditions
+		if (
+			$this->checkout->admin_request
+			|| $this->checkout->action === 'redirect_form'
+			|| $this->checkout->action === 'update_checkout'
+		) {
+			return;
+		}
+		// AJAX response
+		$this->_handle_json_response();
+		// redirect to next step or the Thank You page
+		$this->_handle_html_redirects();
+		// hmmm... must be something wrong, so let's just display the form again !
+		$this->_display_spco_reg_form();
+	}
+
+
+
+	/**
+	 *   _handle_json_response
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _handle_json_response()
+	{
+		// if this is an ajax request
+		if (EE_Registry::instance()->REQ->ajax) {
+			// DEBUG LOG
+			//$this->checkout->log(
+			//	__CLASS__, __FUNCTION__, __LINE__,
+			//	array(
+			//		'json_response_redirect_url' => $this->checkout->json_response->redirect_url(),
+			//		'redirect'                   => $this->checkout->redirect,
+			//		'continue_reg'               => $this->checkout->continue_reg,
+			//	)
+			//);
+			$this->checkout->json_response->set_registration_time_limit(
+				$this->checkout->get_registration_time_limit()
+			);
+			$this->checkout->json_response->set_payment_amount($this->checkout->amount_owing);
+			// just send the ajax (
+			$json_response = apply_filters(
+				'FHEE__EE_Single_Page_Checkout__JSON_response',
+				$this->checkout->json_response
+			);
+			echo $json_response;
+			exit();
+		}
+	}
+
+
+
+	/**
+	 *   _handle_redirects
+	 *
+	 * @access protected
+	 * @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, true);
+			// DEBUG LOG
+			//$this->checkout->log(
+			//	__CLASS__, __FUNCTION__, __LINE__,
+			//	array(
+			//		'headers_sent' => headers_sent(),
+			//		'redirect_url'     => $this->checkout->redirect_url,
+			//		'headers_list'    => headers_list(),
+			//	)
+			//);
+			wp_safe_redirect($this->checkout->redirect_url);
+			exit();
+		}
+	}
+
+
+
+	/**
+	 *   set_checkout_anchor
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function set_checkout_anchor()
+	{
+		echo '<a id="checkout" style="float: left; margin-left: -999em;"></a>';
+	}
 
 
 

Spacing +25 added lines, -25 removed lines

@@ -218,19 +218,19 @@ 
      */
     public static function set_definitions()
     {
-        if(defined('SPCO_BASE_PATH')) {
+        if (defined('SPCO_BASE_PATH')) {
             return;
         }
         define(
             'SPCO_BASE_PATH',
-            rtrim(str_replace(array('\\', '/'), DS, plugin_dir_path(__FILE__)), DS) . DS
+            rtrim(str_replace(array('\\', '/'), DS, plugin_dir_path(__FILE__)), DS).DS
         );
-        define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css' . DS);
-        define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img' . DS);
-        define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js' . DS);
-        define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc' . DS);
-        define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps' . DS);
-        define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates' . DS);
+        define('SPCO_CSS_URL', plugin_dir_url(__FILE__).'css'.DS);
+        define('SPCO_IMG_URL', plugin_dir_url(__FILE__).'img'.DS);
+        define('SPCO_JS_URL', plugin_dir_url(__FILE__).'js'.DS);
+        define('SPCO_INC_PATH', SPCO_BASE_PATH.'inc'.DS);
+        define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH.'reg_steps'.DS);
+        define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH.'templates'.DS);
         EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true);
         EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf(
             __('%1$sWe\'re sorry, but you\'re registration time has expired.%2$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 except our apologies for any inconvenience this may have caused.%8$s',
@@ -239,7 +239,7 @@ 
             '</h4>',
             '<br />',
             '<p>',
-            '<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
+            '<a href="'.get_post_type_archive_link('espresso_events').'" title="',
             '">',
             '</a>',
             '</p>'
@@ -262,7 +262,7 @@ 
             return;
         }
         // filter list of reg_steps
-        $reg_steps_to_load = (array)apply_filters(
+        $reg_steps_to_load = (array) apply_filters(
             'AHEE__SPCO__load_reg_steps__reg_steps_to_load',
             EED_Single_Page_Checkout::get_reg_steps()
         );
@@ -314,25 +314,25 @@ 
         if (empty($reg_steps)) {
             $reg_steps = array(
                 10  => array(
-                    '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,
                 ),
                 20  => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'registration_confirmation',
+                    'file_path'  => SPCO_REG_STEPS_PATH.'registration_confirmation',
                     'class_name' => 'EE_SPCO_Reg_Step_Registration_Confirmation',
                     'slug'       => 'registration_confirmation',
                     'has_hooks'  => false,
                 ),
                 30  => array(
-                    '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 => array(
-                    '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,
@@ -516,7 +516,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;
             }
@@ -1114,7 +1114,7 @@ 
                     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);
@@ -1375,7 +1375,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...
@@ -1500,7 +1500,7 @@ 
             '</h4>',
             '<br />',
             '<p>',
-            '<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
+            '<a href="'.get_post_type_archive_link('espresso_events').'" title="',
             '">',
             '</a>',
             '</p>'
@@ -1532,7 +1532,7 @@ 
         // load css
         wp_register_style(
             'single_page_checkout',
-            SPCO_CSS_URL . 'single_page_checkout.css',
+            SPCO_CSS_URL.'single_page_checkout.css',
             array('espresso_default'),
             EVENT_ESPRESSO_VERSION
         );
@@ -1540,21 +1540,21 @@ 
         // load JS
         wp_register_script(
             'jquery_plugin',
-            EE_THIRD_PARTY_URL . 'jquery	.plugin.min.js',
+            EE_THIRD_PARTY_URL.'jquery	.plugin.min.js',
             array('jquery'),
             '1.0.1',
             true
         );
         wp_register_script(
             'jquery_countdown',
-            EE_THIRD_PARTY_URL . 'jquery	.countdown.min.js',
+            EE_THIRD_PARTY_URL.'jquery	.countdown.min.js',
             array('jquery_plugin'),
             '2.0.2',
             true
         );
         wp_register_script(
             'single_page_checkout',
-            SPCO_JS_URL . 'single_page_checkout.js',
+            SPCO_JS_URL.'single_page_checkout.js',
             array('espresso_core', 'underscore', 'ee_form_section_validation', 'jquery_countdown'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -1577,7 +1577,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
         );
     }
@@ -1631,7 +1631,7 @@ 
                     'layout_strategy' =>
                         new EE_Template_Layout(
                             array(
-                                'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php',
+                                'layout_template_file' => SPCO_TEMPLATES_PATH.'registration_page_wrapper.template.php',
                                 'template_args'        => array(
                                     'empty_cart'              => $empty_cart,
                                     'revisit'                 => $this->checkout->revisit,
@@ -1706,7 +1706,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);
                 }
             );

modules/thank_you_page/EED_Thank_You_Page.module.php

Indentation +916 added lines, -916 removed lines

@@ -14,757 +14,757 @@ 
 class EED_Thank_You_Page extends EED_Module
 {
 
-    /**
-     * time in seconds to wait for the IPN to arrive before telling the registrant to bugger off ( 1200s = 20 minutes )
-     */
-    const IPN_wait_time = 1200;
-
-    /**
-     * The transaction specified by the reg_url_link passed from the Request, or from the Session
-     *
-     * @var EE_Transaction $_current_txn
-     */
-    private $_current_txn;
-
-    /**
-     * @var EE_Registration $_primary_registrant
-     */
-    private $_primary_registrant;
-
-    /**
-     * The reg_url_link passed from the Request, or from the Session
-     *
-     * @var string $_reg_url_link
-     */
-    private $_reg_url_link;
-
-    /**
-     * whether the incoming reg_url_link is for the primary registrant or not
-     *
-     * @var boolean $_is_primary
-     */
-    private $_is_primary;
-
-    /**
-     * The URL for revisiting the SPCO attendee information step
-     *
-     * @var string $_SPCO_attendee_information_url
-     */
-    private $_SPCO_attendee_information_url;
-
-    /**
-     * The URL for revisiting the SPCO payment options step
-     *
-     * @var string $_SPCO_payment_options_url
-     */
-    private $_SPCO_payment_options_url;
-
-    /**
-     * whether to display the Payment Options link
-     *
-     * @var boolean $_show_try_pay_again_link
-     */
-    private $_show_try_pay_again_link = false;
-
-    /**
-     * whether payments are allowed at this time
-     *
-     * @var boolean $_payments_closed
-     */
-    private $_payments_closed = false;
-
-    /**
-     * whether the selected payment method is Bank, Check , Invoice, etc
-     *
-     * @var boolean $_is_offline_payment_method
-     */
-    private $_is_offline_payment_method = true;
-
-
-
-    /**
-     * @return EED_Module|EED_Thank_You_Page
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * set_hooks - for hooking into EE Core, modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks()
-    {
-        add_action('wp_loaded', array('EED_Thank_You_Page', 'set_definitions'), 2);
-    }
-
-
-
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks_admin()
-    {
-        // AJAX for IPN monitoring
-        add_filter('heartbeat_received', array('EED_Thank_You_Page', 'thank_you_page_IPN_monitor'), 10, 3);
-        add_filter(
-            'heartbeat_nopriv_received',
-            array('EED_Thank_You_Page', 'thank_you_page_IPN_monitor'),
-            10,
-            3
-        );
-        add_action(
-            'wp_ajax_espresso_resend_reg_confirmation_email',
-            array('EED_Thank_You_Page', 'resend_reg_confirmation_email'),
-            10,
-            2
-        );
-        add_action(
-            'wp_ajax_nopriv_espresso_resend_reg_confirmation_email',
-            array('EED_Thank_You_Page', 'resend_reg_confirmation_email'),
-            10,
-            2
-        );
-    }
-
-
-
-    /**
-     * set_definitions
-     *
-     * @return void
-     */
-    public static function set_definitions()
-    {
-        define('THANK_YOU_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
-        define('THANK_YOU_TEMPLATES_PATH', str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates' . DS);
-    }
-
-
-
-    /**
-     * get_txn
-     *
-     * @return EE_Transaction
-     */
-    public function get_txn()
-    {
-        if ($this->_current_txn instanceof EE_Transaction) {
-            return $this->_current_txn;
-        }
-        $TXN_model = EE_Registry::instance()->load_model('Transaction');
-        if ( ! $TXN_model instanceof EEM_Transaction) {
-            EE_Error::add_error(
-                __('The transaction model could not be established.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        //get the transaction. yes, we may have just loaded it, but it may have been updated, or this may be via an ajax request
-        $this->_current_txn = $TXN_model->get_transaction_from_reg_url_link($this->_reg_url_link);
-        // verify TXN
-        if (WP_DEBUG && ! $this->_current_txn instanceof EE_Transaction) {
-            EE_Error::add_error(
-                __(
-                    'No transaction information could be retrieved or the transaction data is not of the correct type.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $this->_current_txn;
-    }
-
-
-
-    /**
-     * get_txn_payments
-     *
-     * @param int $since
-     * @return mixed array of EE_Payment || FALSE
-     * @throws \EE_Error
-     */
-    public function get_txn_payments($since = 0)
-    {
-        if ( ! $this->get_txn()) {
-            return false;
-        }
-        $args = array('order_by' => array('PAY_timestamp' => 'ASC'));
-        if ($since > 0) {
-            $args[0] = array('PAY_timestamp' => array('>', $since));
-        }
-        // get array of payments with most recent first
-        return $this->_current_txn->payments($args);
-    }
-
-
-
-    /**
-     * get_reg_url_link
-     *
-     * @return void
-     */
-    private function _get_reg_url_link()
-    {
-        if ( ! empty($this->_reg_url_link)) {
-            return;
-        }
-        // only do thank you page stuff if we have a REG_url_link in the url
-        if (WP_DEBUG && ! EE_Registry::instance()->REQ->is_set('e_reg_url_link')) {
-            EE_Error::add_error(
-                __(
-                    'No transaction information could be retrieved because the registration URL link is missing or invalid.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return;
-        }
-        // check for reg_url_link
-        $this->_reg_url_link = EE_Registry::instance()->REQ->get('e_reg_url_link');
-    }
-
-
-
-    /**
-     * set_reg_url_link
-     *
-     * @param string $reg_url_link
-     */
-    public function set_reg_url_link($reg_url_link = null)
-    {
-        $this->_reg_url_link = ! empty($reg_url_link) ? $reg_url_link : $this->_reg_url_link;
-    }
-
-
-
-    /**
-     * run - initial module setup
-     * this method is primarily used for activating resources in the EE_Front_Controller thru the use of filters
-     *
-     * @param WP $WP
-     * @return void
-     * @throws \EE_Error
-     */
-    public function run($WP)
-    {
-
-    }
-
-
-
-    /**
-     * load_resources
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public function load_resources() {
-        $this->_get_reg_url_link();
-        // resend_reg_confirmation_email ?
-        if (EE_Registry::instance()->REQ->is_set('resend')) {
-            EED_Thank_You_Page::resend_reg_confirmation_email();
-        }
-        EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        $this->_translate_strings();
-        // load assets
-        add_action('wp_enqueue_scripts', array($this, 'load_js'), 10);
-    }
-
-
-
-    /**
-     * load_js
-     *
-     * @return void
-     */
-    protected function _translate_strings()
-    {
-        EE_Registry::$i18n_js_strings['e_reg_url_link'] = $this->_reg_url_link;
-        EE_Registry::$i18n_js_strings['initial_access'] = time();
-        EE_Registry::$i18n_js_strings['IPN_wait_time'] = EED_Thank_You_Page::IPN_wait_time;
-        EE_Registry::$i18n_js_strings['TXN_complete'] = EEM_Transaction::complete_status_code;
-        EE_Registry::$i18n_js_strings['TXN_incomplete'] = EEM_Transaction::incomplete_status_code;
-        EE_Registry::$i18n_js_strings['checking_for_new_payments'] = __(
-            'checking for new payments...',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['loading_payment_info'] = __(
-            'loading payment information...',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['server_error'] = __(
-            'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['slow_IPN'] = apply_filters(
-            'EED_Thank_You_Page__load_js__slow_IPN',
-            sprintf(
-                __(
-                    '%sThe Payment Notification appears to be taking longer than usual to arrive. Maybe check back later or just wait for your payment and registration confirmation results to be sent to you via email. We apologize for any inconvenience this may have caused.%s',
-                    'event_espresso'
-                ),
-                '<div id="espresso-thank-you-page-slow-IPN-dv" class="ee-attention jst-left">',
-                '</div>'
-            )
-        );
-    }
-
-
-
-    /**
-     * load_js
-     *
-     * @return void
-     */
-    public function load_js()
-    {
-        wp_register_script(
-            'thank_you_page',
-            THANK_YOU_ASSETS_URL . 'thank_you_page.js',
-            array('espresso_core', 'heartbeat'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('thank_you_page');
-        wp_enqueue_style('espresso_default');
-    }
-
-
-
-    /**
-     * init
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public function init()
-    {
-        $this->_get_reg_url_link();
-        if ( ! $this->get_txn()) {
-            echo EEH_HTML::div(
-                EEH_HTML::h4(__('We\'re sorry...', 'event_espresso'), '', '') .
-                sprintf(
-                    __(
-                        'This is a system page for displaying transaction information after a purchase.%1$sYou are most likely seeing this notice because you have navigated to this page%1$sthrough some means other than completing a transaction.%1$sSorry for the disappointment, but you will most likely find nothing of interest here.%1$s%1$s',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                ),
-                '',
-                'ee-attention'
-            );
-            return null;
-        }
-        // if we've made it to the Thank You page, then let's toggle any "Failed" transactions to "Incomplete"
-        if ($this->_current_txn->status_ID() === EEM_Transaction::failed_status_code) {
-            $this->_current_txn->set_status(EEM_Transaction::incomplete_status_code);
-            $this->_current_txn->save();
-        }
-        $this->_primary_registrant = $this->_current_txn->primary_registration() instanceof EE_Registration
-            ? $this->_current_txn->primary_registration()
-            : null;
-        $this->_is_primary = $this->_primary_registrant->reg_url_link() === $this->_reg_url_link ? true : false;
-        $show_try_pay_again_link_default = apply_filters(
-            'AFEE__EED_Thank_You_Page__init__show_try_pay_again_link_default',
-            true
-        );
-        $this->_show_try_pay_again_link = $show_try_pay_again_link_default;
-        // txn status ?
-        if ($this->_current_txn->is_completed()) {
-            $this->_show_try_pay_again_link = $show_try_pay_again_link_default;
-        } else if (
-            $this->_current_txn->is_incomplete()
-            && ($this->_primary_registrant->is_approved()
-                || $this->_primary_registrant->is_pending_payment())
-        ) {
-            $this->_show_try_pay_again_link = true;
-        } else if ($this->_primary_registrant->is_approved() || $this->_primary_registrant->is_pending_payment()) {
-            // its pending
-            $this->_show_try_pay_again_link = isset(
-                                                  EE_Registry::instance()->CFG->registration->show_pending_payment_options
-                                              )
-                                              && EE_Registry::instance()->CFG->registration->show_pending_payment_options
-                ? true
-                : $show_try_pay_again_link_default;
-        }
-        $this->_payments_closed = ! $this->_current_txn->payment_method() instanceof EE_Payment_Method
-            ? true
-            : false;
-        $this->_is_offline_payment_method = false;
-        if (
-            // if payment method is unknown
-            ! $this->_current_txn->payment_method() instanceof EE_Payment_Method
-            || (
-                // or is an offline payment method
-                $this->_current_txn->payment_method() instanceof EE_Payment_Method
-                && $this->_current_txn->payment_method()->is_off_line()
-            )
-        ) {
-            $this->_is_offline_payment_method = true;
-        }
-        // link to SPCO
-        $revisit_spco_url = add_query_arg(
-            array('ee' => '_register', 'revisit' => true, 'e_reg_url_link' => $this->_reg_url_link),
-            EE_Registry::instance()->CFG->core->reg_page_url()
-        );
-        // link to SPCO payment_options
-        $this->_SPCO_payment_options_url = $this->_primary_registrant instanceof EE_Registration
-            ? $this->_primary_registrant->payment_overview_url()
-            : add_query_arg(
-                array('step' => 'payment_options'),
-                $revisit_spco_url
-            );
-        // link to SPCO attendee_information
-        $this->_SPCO_attendee_information_url = $this->_primary_registrant instanceof EE_Registration
-            ? $this->_primary_registrant->edit_attendee_information_url()
-            : false;
-        do_action('AHEE__EED_Thank_You_Page__init_end', $this->_current_txn);
-        // set no cache headers and constants
-        EE_System::do_not_cache();
-    }
-
-
-
-    /**
-     * display_thank_you_page_results
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function thank_you_page_results()
-    {
-        $this->init();
-        if ( ! $this->_current_txn instanceof EE_Transaction) {
-            return EE_Error::get_notices();
-        }
-        // link to receipt
-        $template_args['TXN_receipt_url'] = $this->_current_txn->receipt_url('html');
-        if ( ! empty($template_args['TXN_receipt_url'])) {
-            $template_args['order_conf_desc'] = __(
-                '%1$sCongratulations%2$sYour registration has been successfully processed.%3$sCheck your email for your registration confirmation or click the button below to view / download / print a full description of your purchases and registration information.',
-                'event_espresso'
-            );
-        } else {
-            $template_args['order_conf_desc'] = __(
-                '%1$sCongratulations%2$sYour registration has been successfully processed.%3$sCheck your email for your registration confirmation.',
-                'event_espresso'
-            );
-        }
-        $template_args['transaction'] = $this->_current_txn;
-        $template_args['revisit'] = EE_Registry::instance()->REQ->get('revisit', false);
-        add_action('AHEE__thank_you_page_overview_template__content', array($this, 'get_registration_details'));
-        if ($this->_is_primary && ! $this->_current_txn->is_free()) {
-            add_action('AHEE__thank_you_page_overview_template__content', array($this, 'get_ajax_content'));
-        }
-        return EEH_Template::locate_template(
-            THANK_YOU_TEMPLATES_PATH . 'thank-you-page-overview.template.php',
-            $template_args,
-            true,
-            true
-        );
-    }
-
-
-
-    /**
-     * thank_you_page_IPN_monitor
-     * this basically just pulls the TXN based on the reg_url_link sent from the server,
-     * then checks that the TXN status is not failed, and that no other errors have been generated.
-     * it also calculates the IPN wait time since the Thank You page was first loaded
-     *
-     * @param array $response
-     * @param array $data
-     * @return array
-     * @throws \EE_Error
-     */
-    public static function thank_you_page_IPN_monitor($response = array(), $data = array())
-    {
-        // does this heartbeat contain our data ?
-        if ( ! isset($data['espresso_thank_you_page'])) {
-            return $response;
-        }
-        // check for reg_url_link in the incoming heartbeat data
-        if ( ! isset($data['espresso_thank_you_page']['e_reg_url_link'])) {
-            $response['espresso_thank_you_page'] = array(
-                'errors' => ! empty($notices['errors'])
-                    ? $notices['errors']
-                    : __(
-                        'No transaction information could be retrieved because the registration URL link is missing or invalid.',
-                        'event_espresso'
-                    )
-            );
-            return $response;
-        }
-        // kk heartbeat has our data
-        $response['espresso_thank_you_page'] = array();
-        // set_definitions, instantiate the thank you page class, and get the ball rolling
-        EED_Thank_You_Page::set_definitions();
-        /** @var $espresso_thank_you_page EED_Thank_You_Page */
-        $espresso_thank_you_page = EED_Thank_You_Page::instance();
-        $espresso_thank_you_page->set_reg_url_link($data['espresso_thank_you_page']['e_reg_url_link']);
-        $espresso_thank_you_page->init();
-        //get TXN
-        $TXN = $espresso_thank_you_page->get_txn();
-        // no TXN? then get out
-        if ( ! $TXN instanceof EE_Transaction) {
-            $notices = EE_Error::get_notices();
-            $response['espresso_thank_you_page'] = array(
-                'errors' => ! empty($notices['errors'])
-                    ? $notices['errors']
-                    : sprintf(
-                        __(
-                            'The information for your transaction could not be retrieved from the server or the transaction data received was invalid because of a technical reason. (%s)',
-                            'event_espresso'
-                        ),
-                        __LINE__
-                    )
-            );
-            return $response;
-        }
-        // grab transient of TXN's status
-        $txn_status = isset($data['espresso_thank_you_page']['txn_status'])
-            ? $data['espresso_thank_you_page']['txn_status']
-            : null;
-        // has the TXN status changed since we last checked (or empty because this is the first time running through this code)?
-        if ($txn_status !== $TXN->status_ID()) {
-            // switch between two possible basic outcomes
-            switch ($TXN->status_ID()) {
-                // TXN has been updated in some way
-                case EEM_Transaction::overpaid_status_code:
-                case EEM_Transaction::complete_status_code:
-                case EEM_Transaction::incomplete_status_code:
-                    // send updated TXN results back to client,
-                    $response['espresso_thank_you_page'] = array(
-                        'transaction_details' => $espresso_thank_you_page->get_transaction_details(),
-                        'txn_status'          => $TXN->status_ID()
-                    );
-                    break;
-                // or we have a bad TXN, or really slow IPN, so calculate the wait time and send that back...
-                case EEM_Transaction::failed_status_code:
-                default:
-                    // keep on waiting...
-                    return $espresso_thank_you_page->_update_server_wait_time($data['espresso_thank_you_page']);
-            }
-            // or is the TXN still failed (never been updated) ???
-        } else if ($TXN->failed()) {
-            // keep on waiting...
-            return $espresso_thank_you_page->_update_server_wait_time($data['espresso_thank_you_page']);
-        }
-        // TXN is happening so let's get the payments now
-        // if we've already gotten payments then the heartbeat data will contain the timestamp of the last time we checked
-        $since = isset($data['espresso_thank_you_page']['get_payments_since'])
-            ? $data['espresso_thank_you_page']['get_payments_since']
-            : 0;
-        // then check for payments
-        $payments = $espresso_thank_you_page->get_txn_payments($since);
-        // has a payment been processed ?
-        if ( ! empty($payments) || $espresso_thank_you_page->_is_offline_payment_method) {
-            if ($since) {
-                $response['espresso_thank_you_page'] = array(
-                    'new_payments'        => $espresso_thank_you_page->get_new_payments($payments),
-                    'transaction_details' => $espresso_thank_you_page->get_transaction_details(),
-                    'txn_status'          => $TXN->status_ID()
-                );
-            } else {
-                $response['espresso_thank_you_page']['payment_details'] = $espresso_thank_you_page->get_payment_details(
-                    $payments
-                );
-            }
-            // reset time to check for payments
-            $response['espresso_thank_you_page']['get_payments_since'] = time();
-        } else {
-            $response['espresso_thank_you_page']['get_payments_since'] = $since;
-        }
-        return $response;
-    }
-
-
-
-    /**
-     * _update_server_wait_time
-     *
-     * @param array $thank_you_page_data thank you page portion of the incoming JSON array from the WP heartbeat data
-     * @return array
-     * @throws \EE_Error
-     */
-    private function _update_server_wait_time($thank_you_page_data = array())
-    {
-        $response['espresso_thank_you_page'] = array(
-            'still_waiting' => isset($thank_you_page_data['initial_access'])
-                ? time() - $thank_you_page_data['initial_access']
-                : 0,
-            'txn_status'    => $this->_current_txn->status_ID()
-        );
-        return $response;
-    }
-
-
-
-    /**
-     * get_registration_details
-     *
-     * @throws \EE_Error
-     */
-    public function get_registration_details()
-    {
-        //prepare variables for displaying
-        $template_args = array();
-        $template_args['transaction'] = $this->_current_txn;
-        $template_args['reg_url_link'] = $this->_reg_url_link;
-        $template_args['is_primary'] = $this->_is_primary;
-        $template_args['SPCO_attendee_information_url'] = $this->_SPCO_attendee_information_url;
-        $template_args['resend_reg_confirmation_url'] = add_query_arg(
-            array('token' => $this->_reg_url_link, 'resend_reg_confirmation' => 'true'),
-            EE_Registry::instance()->CFG->core->thank_you_page_url()
-        );
-        // verify template arguments
-        EEH_Template_Validator::verify_instanceof($template_args['transaction'], '$transaction', 'EE_Transaction');
-        EEH_Template_Validator::verify_isnt_null(
-            $template_args['SPCO_attendee_information_url'],
-            '$SPCO_attendee_information_url'
-        );
-        echo EEH_Template::locate_template(
-            THANK_YOU_TEMPLATES_PATH . 'thank-you-page-registration-details.template.php',
-            $template_args,
-            true,
-            true
-        );
-    }
-
-
-
-    /**
-     * resend_reg_confirmation_email
-     *
-     * @throws \EE_Error
-     */
-    public static function resend_reg_confirmation_email()
-    {
-        EE_Registry::instance()->load_core('Request_Handler');
-        $reg_url_link = EE_Registry::instance()->REQ->get('token');
-        // was a REG_ID passed ?
-        if ($reg_url_link) {
-            $registration = EE_Registry::instance()->load_model('Registration')->get_one(
-                array(array('REG_url_link' => $reg_url_link))
-            );
-            if ($registration instanceof EE_Registration) {
-                // resend email
-                EED_Messages::process_resend(array('_REG_ID' => $registration->ID()));
-            } else {
-                EE_Error::add_error(
-                    __(
-                        'The Registration Confirmation email could not be sent because a valid Registration could not be retrieved from the database.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } else {
-            EE_Error::add_error(
-                __(
-                    'The Registration Confirmation email could not be sent because a registration token is missing or invalid.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // request sent via AJAX ?
-        if (EE_FRONT_AJAX) {
-            echo wp_json_encode(EE_Error::get_notices(false));
-            die();
-            // or was JS disabled ?
-        } else {
-            // save errors so that they get picked up on the next request
-            EE_Error::get_notices(true, true);
-            wp_safe_redirect(
-                add_query_arg(
-                    array('e_reg_url_link' => $reg_url_link),
-                    EE_Registry::instance()->CFG->core->thank_you_page_url()
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * get_ajax_content
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public function get_ajax_content()
-    {
-        if ( ! $this->get_txn()) {
-            return;
-        }
-        // first determine which event(s) require pre-approval or not
-        $events = array();
-        $events_requiring_pre_approval = array();
-        foreach ($this->_current_txn->registrations() as $registration) {
-            if ($registration instanceof EE_Registration) {
-                $event = $registration->event();
-                if ($event instanceof EE_Event) {
-                    if ($registration->is_not_approved() && $registration->event() instanceof EE_Event) {
-                        $events_requiring_pre_approval[$event->ID()] = $event;
-                    } else {
-                        $events[$event->ID()] = $event;
-                    }
-                }
-            }
-        }
-        $this->display_details_for_events_requiring_pre_approval($events_requiring_pre_approval);
-        $this->display_details_for_events($events);
-    }
-
-
-
-    /**
-     * display_details_for_events
-     *
-     * @param EE_Event[] $events
-     * @return void
-     */
-    public function display_details_for_events($events = array())
-    {
-        if ( ! empty($events)) {
-            ?>
+	/**
+	 * time in seconds to wait for the IPN to arrive before telling the registrant to bugger off ( 1200s = 20 minutes )
+	 */
+	const IPN_wait_time = 1200;
+
+	/**
+	 * The transaction specified by the reg_url_link passed from the Request, or from the Session
+	 *
+	 * @var EE_Transaction $_current_txn
+	 */
+	private $_current_txn;
+
+	/**
+	 * @var EE_Registration $_primary_registrant
+	 */
+	private $_primary_registrant;
+
+	/**
+	 * The reg_url_link passed from the Request, or from the Session
+	 *
+	 * @var string $_reg_url_link
+	 */
+	private $_reg_url_link;
+
+	/**
+	 * whether the incoming reg_url_link is for the primary registrant or not
+	 *
+	 * @var boolean $_is_primary
+	 */
+	private $_is_primary;
+
+	/**
+	 * The URL for revisiting the SPCO attendee information step
+	 *
+	 * @var string $_SPCO_attendee_information_url
+	 */
+	private $_SPCO_attendee_information_url;
+
+	/**
+	 * The URL for revisiting the SPCO payment options step
+	 *
+	 * @var string $_SPCO_payment_options_url
+	 */
+	private $_SPCO_payment_options_url;
+
+	/**
+	 * whether to display the Payment Options link
+	 *
+	 * @var boolean $_show_try_pay_again_link
+	 */
+	private $_show_try_pay_again_link = false;
+
+	/**
+	 * whether payments are allowed at this time
+	 *
+	 * @var boolean $_payments_closed
+	 */
+	private $_payments_closed = false;
+
+	/**
+	 * whether the selected payment method is Bank, Check , Invoice, etc
+	 *
+	 * @var boolean $_is_offline_payment_method
+	 */
+	private $_is_offline_payment_method = true;
+
+
+
+	/**
+	 * @return EED_Module|EED_Thank_You_Page
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks()
+	{
+		add_action('wp_loaded', array('EED_Thank_You_Page', 'set_definitions'), 2);
+	}
+
+
+
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin()
+	{
+		// AJAX for IPN monitoring
+		add_filter('heartbeat_received', array('EED_Thank_You_Page', 'thank_you_page_IPN_monitor'), 10, 3);
+		add_filter(
+			'heartbeat_nopriv_received',
+			array('EED_Thank_You_Page', 'thank_you_page_IPN_monitor'),
+			10,
+			3
+		);
+		add_action(
+			'wp_ajax_espresso_resend_reg_confirmation_email',
+			array('EED_Thank_You_Page', 'resend_reg_confirmation_email'),
+			10,
+			2
+		);
+		add_action(
+			'wp_ajax_nopriv_espresso_resend_reg_confirmation_email',
+			array('EED_Thank_You_Page', 'resend_reg_confirmation_email'),
+			10,
+			2
+		);
+	}
+
+
+
+	/**
+	 * set_definitions
+	 *
+	 * @return void
+	 */
+	public static function set_definitions()
+	{
+		define('THANK_YOU_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
+		define('THANK_YOU_TEMPLATES_PATH', str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates' . DS);
+	}
+
+
+
+	/**
+	 * get_txn
+	 *
+	 * @return EE_Transaction
+	 */
+	public function get_txn()
+	{
+		if ($this->_current_txn instanceof EE_Transaction) {
+			return $this->_current_txn;
+		}
+		$TXN_model = EE_Registry::instance()->load_model('Transaction');
+		if ( ! $TXN_model instanceof EEM_Transaction) {
+			EE_Error::add_error(
+				__('The transaction model could not be established.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		//get the transaction. yes, we may have just loaded it, but it may have been updated, or this may be via an ajax request
+		$this->_current_txn = $TXN_model->get_transaction_from_reg_url_link($this->_reg_url_link);
+		// verify TXN
+		if (WP_DEBUG && ! $this->_current_txn instanceof EE_Transaction) {
+			EE_Error::add_error(
+				__(
+					'No transaction information could be retrieved or the transaction data is not of the correct type.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $this->_current_txn;
+	}
+
+
+
+	/**
+	 * get_txn_payments
+	 *
+	 * @param int $since
+	 * @return mixed array of EE_Payment || FALSE
+	 * @throws \EE_Error
+	 */
+	public function get_txn_payments($since = 0)
+	{
+		if ( ! $this->get_txn()) {
+			return false;
+		}
+		$args = array('order_by' => array('PAY_timestamp' => 'ASC'));
+		if ($since > 0) {
+			$args[0] = array('PAY_timestamp' => array('>', $since));
+		}
+		// get array of payments with most recent first
+		return $this->_current_txn->payments($args);
+	}
+
+
+
+	/**
+	 * get_reg_url_link
+	 *
+	 * @return void
+	 */
+	private function _get_reg_url_link()
+	{
+		if ( ! empty($this->_reg_url_link)) {
+			return;
+		}
+		// only do thank you page stuff if we have a REG_url_link in the url
+		if (WP_DEBUG && ! EE_Registry::instance()->REQ->is_set('e_reg_url_link')) {
+			EE_Error::add_error(
+				__(
+					'No transaction information could be retrieved because the registration URL link is missing or invalid.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return;
+		}
+		// check for reg_url_link
+		$this->_reg_url_link = EE_Registry::instance()->REQ->get('e_reg_url_link');
+	}
+
+
+
+	/**
+	 * set_reg_url_link
+	 *
+	 * @param string $reg_url_link
+	 */
+	public function set_reg_url_link($reg_url_link = null)
+	{
+		$this->_reg_url_link = ! empty($reg_url_link) ? $reg_url_link : $this->_reg_url_link;
+	}
+
+
+
+	/**
+	 * run - initial module setup
+	 * this method is primarily used for activating resources in the EE_Front_Controller thru the use of filters
+	 *
+	 * @param WP $WP
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function run($WP)
+	{
+
+	}
+
+
+
+	/**
+	 * load_resources
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function load_resources() {
+		$this->_get_reg_url_link();
+		// resend_reg_confirmation_email ?
+		if (EE_Registry::instance()->REQ->is_set('resend')) {
+			EED_Thank_You_Page::resend_reg_confirmation_email();
+		}
+		EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		$this->_translate_strings();
+		// load assets
+		add_action('wp_enqueue_scripts', array($this, 'load_js'), 10);
+	}
+
+
+
+	/**
+	 * load_js
+	 *
+	 * @return void
+	 */
+	protected function _translate_strings()
+	{
+		EE_Registry::$i18n_js_strings['e_reg_url_link'] = $this->_reg_url_link;
+		EE_Registry::$i18n_js_strings['initial_access'] = time();
+		EE_Registry::$i18n_js_strings['IPN_wait_time'] = EED_Thank_You_Page::IPN_wait_time;
+		EE_Registry::$i18n_js_strings['TXN_complete'] = EEM_Transaction::complete_status_code;
+		EE_Registry::$i18n_js_strings['TXN_incomplete'] = EEM_Transaction::incomplete_status_code;
+		EE_Registry::$i18n_js_strings['checking_for_new_payments'] = __(
+			'checking for new payments...',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['loading_payment_info'] = __(
+			'loading payment information...',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['server_error'] = __(
+			'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['slow_IPN'] = apply_filters(
+			'EED_Thank_You_Page__load_js__slow_IPN',
+			sprintf(
+				__(
+					'%sThe Payment Notification appears to be taking longer than usual to arrive. Maybe check back later or just wait for your payment and registration confirmation results to be sent to you via email. We apologize for any inconvenience this may have caused.%s',
+					'event_espresso'
+				),
+				'<div id="espresso-thank-you-page-slow-IPN-dv" class="ee-attention jst-left">',
+				'</div>'
+			)
+		);
+	}
+
+
+
+	/**
+	 * load_js
+	 *
+	 * @return void
+	 */
+	public function load_js()
+	{
+		wp_register_script(
+			'thank_you_page',
+			THANK_YOU_ASSETS_URL . 'thank_you_page.js',
+			array('espresso_core', 'heartbeat'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('thank_you_page');
+		wp_enqueue_style('espresso_default');
+	}
+
+
+
+	/**
+	 * init
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function init()
+	{
+		$this->_get_reg_url_link();
+		if ( ! $this->get_txn()) {
+			echo EEH_HTML::div(
+				EEH_HTML::h4(__('We\'re sorry...', 'event_espresso'), '', '') .
+				sprintf(
+					__(
+						'This is a system page for displaying transaction information after a purchase.%1$sYou are most likely seeing this notice because you have navigated to this page%1$sthrough some means other than completing a transaction.%1$sSorry for the disappointment, but you will most likely find nothing of interest here.%1$s%1$s',
+						'event_espresso'
+					),
+					'<br/>'
+				),
+				'',
+				'ee-attention'
+			);
+			return null;
+		}
+		// if we've made it to the Thank You page, then let's toggle any "Failed" transactions to "Incomplete"
+		if ($this->_current_txn->status_ID() === EEM_Transaction::failed_status_code) {
+			$this->_current_txn->set_status(EEM_Transaction::incomplete_status_code);
+			$this->_current_txn->save();
+		}
+		$this->_primary_registrant = $this->_current_txn->primary_registration() instanceof EE_Registration
+			? $this->_current_txn->primary_registration()
+			: null;
+		$this->_is_primary = $this->_primary_registrant->reg_url_link() === $this->_reg_url_link ? true : false;
+		$show_try_pay_again_link_default = apply_filters(
+			'AFEE__EED_Thank_You_Page__init__show_try_pay_again_link_default',
+			true
+		);
+		$this->_show_try_pay_again_link = $show_try_pay_again_link_default;
+		// txn status ?
+		if ($this->_current_txn->is_completed()) {
+			$this->_show_try_pay_again_link = $show_try_pay_again_link_default;
+		} else if (
+			$this->_current_txn->is_incomplete()
+			&& ($this->_primary_registrant->is_approved()
+				|| $this->_primary_registrant->is_pending_payment())
+		) {
+			$this->_show_try_pay_again_link = true;
+		} else if ($this->_primary_registrant->is_approved() || $this->_primary_registrant->is_pending_payment()) {
+			// its pending
+			$this->_show_try_pay_again_link = isset(
+												  EE_Registry::instance()->CFG->registration->show_pending_payment_options
+											  )
+											  && EE_Registry::instance()->CFG->registration->show_pending_payment_options
+				? true
+				: $show_try_pay_again_link_default;
+		}
+		$this->_payments_closed = ! $this->_current_txn->payment_method() instanceof EE_Payment_Method
+			? true
+			: false;
+		$this->_is_offline_payment_method = false;
+		if (
+			// if payment method is unknown
+			! $this->_current_txn->payment_method() instanceof EE_Payment_Method
+			|| (
+				// or is an offline payment method
+				$this->_current_txn->payment_method() instanceof EE_Payment_Method
+				&& $this->_current_txn->payment_method()->is_off_line()
+			)
+		) {
+			$this->_is_offline_payment_method = true;
+		}
+		// link to SPCO
+		$revisit_spco_url = add_query_arg(
+			array('ee' => '_register', 'revisit' => true, 'e_reg_url_link' => $this->_reg_url_link),
+			EE_Registry::instance()->CFG->core->reg_page_url()
+		);
+		// link to SPCO payment_options
+		$this->_SPCO_payment_options_url = $this->_primary_registrant instanceof EE_Registration
+			? $this->_primary_registrant->payment_overview_url()
+			: add_query_arg(
+				array('step' => 'payment_options'),
+				$revisit_spco_url
+			);
+		// link to SPCO attendee_information
+		$this->_SPCO_attendee_information_url = $this->_primary_registrant instanceof EE_Registration
+			? $this->_primary_registrant->edit_attendee_information_url()
+			: false;
+		do_action('AHEE__EED_Thank_You_Page__init_end', $this->_current_txn);
+		// set no cache headers and constants
+		EE_System::do_not_cache();
+	}
+
+
+
+	/**
+	 * display_thank_you_page_results
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function thank_you_page_results()
+	{
+		$this->init();
+		if ( ! $this->_current_txn instanceof EE_Transaction) {
+			return EE_Error::get_notices();
+		}
+		// link to receipt
+		$template_args['TXN_receipt_url'] = $this->_current_txn->receipt_url('html');
+		if ( ! empty($template_args['TXN_receipt_url'])) {
+			$template_args['order_conf_desc'] = __(
+				'%1$sCongratulations%2$sYour registration has been successfully processed.%3$sCheck your email for your registration confirmation or click the button below to view / download / print a full description of your purchases and registration information.',
+				'event_espresso'
+			);
+		} else {
+			$template_args['order_conf_desc'] = __(
+				'%1$sCongratulations%2$sYour registration has been successfully processed.%3$sCheck your email for your registration confirmation.',
+				'event_espresso'
+			);
+		}
+		$template_args['transaction'] = $this->_current_txn;
+		$template_args['revisit'] = EE_Registry::instance()->REQ->get('revisit', false);
+		add_action('AHEE__thank_you_page_overview_template__content', array($this, 'get_registration_details'));
+		if ($this->_is_primary && ! $this->_current_txn->is_free()) {
+			add_action('AHEE__thank_you_page_overview_template__content', array($this, 'get_ajax_content'));
+		}
+		return EEH_Template::locate_template(
+			THANK_YOU_TEMPLATES_PATH . 'thank-you-page-overview.template.php',
+			$template_args,
+			true,
+			true
+		);
+	}
+
+
+
+	/**
+	 * thank_you_page_IPN_monitor
+	 * this basically just pulls the TXN based on the reg_url_link sent from the server,
+	 * then checks that the TXN status is not failed, and that no other errors have been generated.
+	 * it also calculates the IPN wait time since the Thank You page was first loaded
+	 *
+	 * @param array $response
+	 * @param array $data
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public static function thank_you_page_IPN_monitor($response = array(), $data = array())
+	{
+		// does this heartbeat contain our data ?
+		if ( ! isset($data['espresso_thank_you_page'])) {
+			return $response;
+		}
+		// check for reg_url_link in the incoming heartbeat data
+		if ( ! isset($data['espresso_thank_you_page']['e_reg_url_link'])) {
+			$response['espresso_thank_you_page'] = array(
+				'errors' => ! empty($notices['errors'])
+					? $notices['errors']
+					: __(
+						'No transaction information could be retrieved because the registration URL link is missing or invalid.',
+						'event_espresso'
+					)
+			);
+			return $response;
+		}
+		// kk heartbeat has our data
+		$response['espresso_thank_you_page'] = array();
+		// set_definitions, instantiate the thank you page class, and get the ball rolling
+		EED_Thank_You_Page::set_definitions();
+		/** @var $espresso_thank_you_page EED_Thank_You_Page */
+		$espresso_thank_you_page = EED_Thank_You_Page::instance();
+		$espresso_thank_you_page->set_reg_url_link($data['espresso_thank_you_page']['e_reg_url_link']);
+		$espresso_thank_you_page->init();
+		//get TXN
+		$TXN = $espresso_thank_you_page->get_txn();
+		// no TXN? then get out
+		if ( ! $TXN instanceof EE_Transaction) {
+			$notices = EE_Error::get_notices();
+			$response['espresso_thank_you_page'] = array(
+				'errors' => ! empty($notices['errors'])
+					? $notices['errors']
+					: sprintf(
+						__(
+							'The information for your transaction could not be retrieved from the server or the transaction data received was invalid because of a technical reason. (%s)',
+							'event_espresso'
+						),
+						__LINE__
+					)
+			);
+			return $response;
+		}
+		// grab transient of TXN's status
+		$txn_status = isset($data['espresso_thank_you_page']['txn_status'])
+			? $data['espresso_thank_you_page']['txn_status']
+			: null;
+		// has the TXN status changed since we last checked (or empty because this is the first time running through this code)?
+		if ($txn_status !== $TXN->status_ID()) {
+			// switch between two possible basic outcomes
+			switch ($TXN->status_ID()) {
+				// TXN has been updated in some way
+				case EEM_Transaction::overpaid_status_code:
+				case EEM_Transaction::complete_status_code:
+				case EEM_Transaction::incomplete_status_code:
+					// send updated TXN results back to client,
+					$response['espresso_thank_you_page'] = array(
+						'transaction_details' => $espresso_thank_you_page->get_transaction_details(),
+						'txn_status'          => $TXN->status_ID()
+					);
+					break;
+				// or we have a bad TXN, or really slow IPN, so calculate the wait time and send that back...
+				case EEM_Transaction::failed_status_code:
+				default:
+					// keep on waiting...
+					return $espresso_thank_you_page->_update_server_wait_time($data['espresso_thank_you_page']);
+			}
+			// or is the TXN still failed (never been updated) ???
+		} else if ($TXN->failed()) {
+			// keep on waiting...
+			return $espresso_thank_you_page->_update_server_wait_time($data['espresso_thank_you_page']);
+		}
+		// TXN is happening so let's get the payments now
+		// if we've already gotten payments then the heartbeat data will contain the timestamp of the last time we checked
+		$since = isset($data['espresso_thank_you_page']['get_payments_since'])
+			? $data['espresso_thank_you_page']['get_payments_since']
+			: 0;
+		// then check for payments
+		$payments = $espresso_thank_you_page->get_txn_payments($since);
+		// has a payment been processed ?
+		if ( ! empty($payments) || $espresso_thank_you_page->_is_offline_payment_method) {
+			if ($since) {
+				$response['espresso_thank_you_page'] = array(
+					'new_payments'        => $espresso_thank_you_page->get_new_payments($payments),
+					'transaction_details' => $espresso_thank_you_page->get_transaction_details(),
+					'txn_status'          => $TXN->status_ID()
+				);
+			} else {
+				$response['espresso_thank_you_page']['payment_details'] = $espresso_thank_you_page->get_payment_details(
+					$payments
+				);
+			}
+			// reset time to check for payments
+			$response['espresso_thank_you_page']['get_payments_since'] = time();
+		} else {
+			$response['espresso_thank_you_page']['get_payments_since'] = $since;
+		}
+		return $response;
+	}
+
+
+
+	/**
+	 * _update_server_wait_time
+	 *
+	 * @param array $thank_you_page_data thank you page portion of the incoming JSON array from the WP heartbeat data
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	private function _update_server_wait_time($thank_you_page_data = array())
+	{
+		$response['espresso_thank_you_page'] = array(
+			'still_waiting' => isset($thank_you_page_data['initial_access'])
+				? time() - $thank_you_page_data['initial_access']
+				: 0,
+			'txn_status'    => $this->_current_txn->status_ID()
+		);
+		return $response;
+	}
+
+
+
+	/**
+	 * get_registration_details
+	 *
+	 * @throws \EE_Error
+	 */
+	public function get_registration_details()
+	{
+		//prepare variables for displaying
+		$template_args = array();
+		$template_args['transaction'] = $this->_current_txn;
+		$template_args['reg_url_link'] = $this->_reg_url_link;
+		$template_args['is_primary'] = $this->_is_primary;
+		$template_args['SPCO_attendee_information_url'] = $this->_SPCO_attendee_information_url;
+		$template_args['resend_reg_confirmation_url'] = add_query_arg(
+			array('token' => $this->_reg_url_link, 'resend_reg_confirmation' => 'true'),
+			EE_Registry::instance()->CFG->core->thank_you_page_url()
+		);
+		// verify template arguments
+		EEH_Template_Validator::verify_instanceof($template_args['transaction'], '$transaction', 'EE_Transaction');
+		EEH_Template_Validator::verify_isnt_null(
+			$template_args['SPCO_attendee_information_url'],
+			'$SPCO_attendee_information_url'
+		);
+		echo EEH_Template::locate_template(
+			THANK_YOU_TEMPLATES_PATH . 'thank-you-page-registration-details.template.php',
+			$template_args,
+			true,
+			true
+		);
+	}
+
+
+
+	/**
+	 * resend_reg_confirmation_email
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function resend_reg_confirmation_email()
+	{
+		EE_Registry::instance()->load_core('Request_Handler');
+		$reg_url_link = EE_Registry::instance()->REQ->get('token');
+		// was a REG_ID passed ?
+		if ($reg_url_link) {
+			$registration = EE_Registry::instance()->load_model('Registration')->get_one(
+				array(array('REG_url_link' => $reg_url_link))
+			);
+			if ($registration instanceof EE_Registration) {
+				// resend email
+				EED_Messages::process_resend(array('_REG_ID' => $registration->ID()));
+			} else {
+				EE_Error::add_error(
+					__(
+						'The Registration Confirmation email could not be sent because a valid Registration could not be retrieved from the database.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} else {
+			EE_Error::add_error(
+				__(
+					'The Registration Confirmation email could not be sent because a registration token is missing or invalid.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// request sent via AJAX ?
+		if (EE_FRONT_AJAX) {
+			echo wp_json_encode(EE_Error::get_notices(false));
+			die();
+			// or was JS disabled ?
+		} else {
+			// save errors so that they get picked up on the next request
+			EE_Error::get_notices(true, true);
+			wp_safe_redirect(
+				add_query_arg(
+					array('e_reg_url_link' => $reg_url_link),
+					EE_Registry::instance()->CFG->core->thank_you_page_url()
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * get_ajax_content
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function get_ajax_content()
+	{
+		if ( ! $this->get_txn()) {
+			return;
+		}
+		// first determine which event(s) require pre-approval or not
+		$events = array();
+		$events_requiring_pre_approval = array();
+		foreach ($this->_current_txn->registrations() as $registration) {
+			if ($registration instanceof EE_Registration) {
+				$event = $registration->event();
+				if ($event instanceof EE_Event) {
+					if ($registration->is_not_approved() && $registration->event() instanceof EE_Event) {
+						$events_requiring_pre_approval[$event->ID()] = $event;
+					} else {
+						$events[$event->ID()] = $event;
+					}
+				}
+			}
+		}
+		$this->display_details_for_events_requiring_pre_approval($events_requiring_pre_approval);
+		$this->display_details_for_events($events);
+	}
+
+
+
+	/**
+	 * display_details_for_events
+	 *
+	 * @param EE_Event[] $events
+	 * @return void
+	 */
+	public function display_details_for_events($events = array())
+	{
+		if ( ! empty($events)) {
+			?>
             <div id="espresso-thank-you-page-ajax-content-dv">
                 <div id="espresso-thank-you-page-ajax-transaction-dv"></div>
                 <div id="espresso-thank-you-page-ajax-payment-dv"></div>
                 <div id="espresso-thank-you-page-ajax-loading-dv">
                     <div id="ee-ajax-loading-dv" class="float-left lt-blue-text">
                         <span class="dashicons dashicons-upload"></span><span id="ee-ajax-loading-msg-spn"><?php _e(
-                                'loading transaction and payment information...',
-                                'event_espresso'
-                            ); ?></span>
+								'loading transaction and payment information...',
+								'event_espresso'
+							); ?></span>
                     </div>
                     <?php if ( ! $this->_is_offline_payment_method && ! $this->_payments_closed) : ?>
                         <p id="ee-ajax-loading-pg" class="highlight-bg small-text clear">
                             <?php echo apply_filters(
-                                'EED_Thank_You_Page__get_ajax_content__waiting_for_IPN_msg',
-                                __(
-                                    'Some payment gateways can take 15 minutes or more to return their payment notification, so please be patient if you require payment confirmation as soon as possible. Please note that as soon as everything is finalized, we will send your full payment and registration confirmation results to you via email.',
-                                    'event_espresso'
-                                )
-                            ); ?>
+								'EED_Thank_You_Page__get_ajax_content__waiting_for_IPN_msg',
+								__(
+									'Some payment gateways can take 15 minutes or more to return their payment notification, so please be patient if you require payment confirmation as soon as possible. Please note that as soon as everything is finalized, we will send your full payment and registration confirmation results to you via email.',
+									'event_espresso'
+								)
+							); ?>
                             <br/>
                             <span class="jst-rght ee-block small-text lt-grey-text">
 								<?php _e('current wait time ', 'event_espresso'); ?>
@@ -775,120 +775,120 @@ 
                 <div class="clear"></div>
             </div>
             <?php
-        }
-    }
+		}
+	}
 
 
 
-    /**
-     * display_details_for_events_requiring_pre_approval
-     *
-     * @param EE_Event[] $events
-     * @return void
-     */
-    public function display_details_for_events_requiring_pre_approval($events = array())
-    {
-        if ( ! empty($events)) {
-            ?>
+	/**
+	 * display_details_for_events_requiring_pre_approval
+	 *
+	 * @param EE_Event[] $events
+	 * @return void
+	 */
+	public function display_details_for_events_requiring_pre_approval($events = array())
+	{
+		if ( ! empty($events)) {
+			?>
             <div id="espresso-thank-you-page-not-approved-message-dv">
                 <h4 class="orange-text"><?php _e('Important Notice:', 'event_espresso'); ?></h4>
                 <p id="events-requiring-pre-approval-pg" class="small-text">
                     <?php echo apply_filters(
-                        'AHEE__EED_Thank_You_Page__get_ajax_content__not_approved_message',
-                        __(
-                            'The following Event(s) you have registered for do not require payment at this time and will not be billed for during this transaction. Billing will only occur after all attendees have been approved by the event organizer. You will be notified when your registration has been processed. If this is a free event, then no billing will occur.',
-                            'event_espresso'
-                        )
-                    ); ?>
+						'AHEE__EED_Thank_You_Page__get_ajax_content__not_approved_message',
+						__(
+							'The following Event(s) you have registered for do not require payment at this time and will not be billed for during this transaction. Billing will only occur after all attendees have been approved by the event organizer. You will be notified when your registration has been processed. If this is a free event, then no billing will occur.',
+							'event_espresso'
+						)
+					); ?>
                 </p>
                 <ul class="events-requiring-pre-approval-ul">
                     <?php foreach ($events as $event) {
-                        if ($event instanceof EE_Event) {
-                            echo '<li><span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>',
-                            $event->name(),
-                            '</li>';
-                        }
-                    } ?>
+						if ($event instanceof EE_Event) {
+							echo '<li><span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>',
+							$event->name(),
+							'</li>';
+						}
+					} ?>
                 </ul>
                 <div class="clear"></div>
             </div>
             <?php
-        }
-    }
-
-
-
-    /**
-     * get_transaction_details
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function get_transaction_details()
-    {
-        //prepare variables for displaying
-        $template_args = array();
-        $template_args['transaction'] = $this->_current_txn;
-        $template_args['reg_url_link'] = $this->_reg_url_link;
-        $template_args['primary_registrant_name'] = $this->_primary_registrant->attendee()->full_name(true);
-        // link to SPCO payment_options
-        $template_args['show_try_pay_again_link'] = $this->_show_try_pay_again_link;
-        $template_args['SPCO_payment_options_url'] = $this->_SPCO_payment_options_url;
-        // verify template arguments
-        EEH_Template_Validator::verify_instanceof($template_args['transaction'], '$transaction', 'EE_Transaction');
-        EEH_Template_Validator::verify_isnt_null(
-            $template_args['show_try_pay_again_link'],
-            '$show_try_pay_again_link'
-        );
-        EEH_Template_Validator::verify_isnt_null(
-            $template_args['SPCO_payment_options_url'],
-            '$SPCO_payment_options_url'
-        );
-        return EEH_Template::locate_template(
-            THANK_YOU_TEMPLATES_PATH . 'thank-you-page-transaction-details.template.php',
-            $template_args,
-            true,
-            true
-        );
-    }
-
-
-
-    /**
-     * get_payment_row_html
-     *
-     * @param EE_Payment $payment
-     * @return string
-     * @throws \EE_Error
-     */
-    public function get_payment_row_html($payment = null)
-    {
-        $html = '';
-        if ($payment instanceof EE_Payment) {
-            if (
-                $payment->payment_method() instanceof EE_Payment_Method
-                && $payment->status() === EEM_Payment::status_id_failed
-                && $payment->payment_method()->is_off_site()
-            ) {
-                // considering the registrant has made it to the Thank You page,
-                // any failed payments may actually be pending and the IPN is just slow
-                // so let's
-                $payment->set_status(EEM_Payment::status_id_pending);
-            }
-            $payment_declined_msg = $payment->STS_ID() === EEM_Payment::status_id_declined
-                ? '<br /><span class="small-text">' . $payment->gateway_response() . '</span>'
-                : '';
-            $html .= '
+		}
+	}
+
+
+
+	/**
+	 * get_transaction_details
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function get_transaction_details()
+	{
+		//prepare variables for displaying
+		$template_args = array();
+		$template_args['transaction'] = $this->_current_txn;
+		$template_args['reg_url_link'] = $this->_reg_url_link;
+		$template_args['primary_registrant_name'] = $this->_primary_registrant->attendee()->full_name(true);
+		// link to SPCO payment_options
+		$template_args['show_try_pay_again_link'] = $this->_show_try_pay_again_link;
+		$template_args['SPCO_payment_options_url'] = $this->_SPCO_payment_options_url;
+		// verify template arguments
+		EEH_Template_Validator::verify_instanceof($template_args['transaction'], '$transaction', 'EE_Transaction');
+		EEH_Template_Validator::verify_isnt_null(
+			$template_args['show_try_pay_again_link'],
+			'$show_try_pay_again_link'
+		);
+		EEH_Template_Validator::verify_isnt_null(
+			$template_args['SPCO_payment_options_url'],
+			'$SPCO_payment_options_url'
+		);
+		return EEH_Template::locate_template(
+			THANK_YOU_TEMPLATES_PATH . 'thank-you-page-transaction-details.template.php',
+			$template_args,
+			true,
+			true
+		);
+	}
+
+
+
+	/**
+	 * get_payment_row_html
+	 *
+	 * @param EE_Payment $payment
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function get_payment_row_html($payment = null)
+	{
+		$html = '';
+		if ($payment instanceof EE_Payment) {
+			if (
+				$payment->payment_method() instanceof EE_Payment_Method
+				&& $payment->status() === EEM_Payment::status_id_failed
+				&& $payment->payment_method()->is_off_site()
+			) {
+				// considering the registrant has made it to the Thank You page,
+				// any failed payments may actually be pending and the IPN is just slow
+				// so let's
+				$payment->set_status(EEM_Payment::status_id_pending);
+			}
+			$payment_declined_msg = $payment->STS_ID() === EEM_Payment::status_id_declined
+				? '<br /><span class="small-text">' . $payment->gateway_response() . '</span>'
+				: '';
+			$html .= '
 				<tr>
 					<td>
 						' . $payment->timestamp() . '
 					</td>
 					<td>
 						' . (
-                $payment->payment_method() instanceof EE_Payment_Method
-                    ? $payment->payment_method()->name()
-                    : __('Unknown', 'event_espresso')
-                ) . '
+				$payment->payment_method() instanceof EE_Payment_Method
+					? $payment->payment_method()->name()
+					: __('Unknown', 'event_espresso')
+				) . '
 					</td>
 					<td class="jst-rght">
 						' . EEH_Template::format_currency($payment->amount()) . '
@@ -897,87 +897,87 @@ 
 						' . $payment->pretty_status(true) . $payment_declined_msg . '
 					</td>
 				</tr>';
-            do_action('AHEE__thank_you_page_payment_details_template__after_each_payment', $payment);
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * get_payment_details
-     *
-     * @param array $payments
-     * @return string
-     * @throws \EE_Error
-     */
-    public function get_payment_details($payments = array())
-    {
-        //prepare variables for displaying
-        $template_args = array();
-        $template_args['transaction'] = $this->_current_txn;
-        $template_args['reg_url_link'] = $this->_reg_url_link;
-        $template_args['payments'] = array();
-        foreach ($payments as $payment) {
-            $template_args['payments'][] = $this->get_payment_row_html($payment);
-        }
-        //create a hacky payment object, but dont save it
-        $payment = EE_Payment::new_instance(
-            array(
-                'TXN_ID'        => $this->_current_txn->ID(),
-                'STS_ID'        => EEM_Payment::status_id_pending,
-                'PAY_timestamp' => time(),
-                'PAY_amount'    => $this->_current_txn->total(),
-                'PMD_ID'        => $this->_current_txn->payment_method_ID()
-            )
-        );
-        $payment_method = $this->_current_txn->payment_method();
-        if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base) {
-            $template_args['gateway_content'] = $payment_method->type_obj()->payment_overview_content($payment);
-        } else {
-            $template_args['gateway_content'] = '';
-        }
-        // link to SPCO payment_options
-        $template_args['show_try_pay_again_link'] = $this->_show_try_pay_again_link;
-        $template_args['SPCO_payment_options_url'] = $this->_SPCO_payment_options_url;
-        // verify template arguments
-        EEH_Template_Validator::verify_instanceof($template_args['transaction'], '$transaction', 'EE_Transaction');
-        EEH_Template_Validator::verify_isnt_null($template_args['payments'], '$payments');
-        EEH_Template_Validator::verify_isnt_null(
-            $template_args['show_try_pay_again_link'],
-            '$show_try_pay_again_link'
-        );
-        EEH_Template_Validator::verify_isnt_null($template_args['gateway_content'], '$gateway_content');
-        EEH_Template_Validator::verify_isnt_null(
-            $template_args['SPCO_payment_options_url'],
-            '$SPCO_payment_options_url'
-        );
-        return EEH_Template::locate_template(
-            THANK_YOU_TEMPLATES_PATH . 'thank-you-page-payment-details.template.php',
-            $template_args,
-            true,
-            true
-        );
-    }
-
-
-
-    /**
-     * get_payment_details
-     *
-     * @param array $payments
-     * @return string
-     * @throws \EE_Error
-     */
-    public function get_new_payments($payments = array())
-    {
-        $payments_html = '';
-        //prepare variables for displaying
-        foreach ($payments as $payment) {
-            $payments_html .= $this->get_payment_row_html($payment);
-        }
-        return $payments_html;
-    }
+			do_action('AHEE__thank_you_page_payment_details_template__after_each_payment', $payment);
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * get_payment_details
+	 *
+	 * @param array $payments
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function get_payment_details($payments = array())
+	{
+		//prepare variables for displaying
+		$template_args = array();
+		$template_args['transaction'] = $this->_current_txn;
+		$template_args['reg_url_link'] = $this->_reg_url_link;
+		$template_args['payments'] = array();
+		foreach ($payments as $payment) {
+			$template_args['payments'][] = $this->get_payment_row_html($payment);
+		}
+		//create a hacky payment object, but dont save it
+		$payment = EE_Payment::new_instance(
+			array(
+				'TXN_ID'        => $this->_current_txn->ID(),
+				'STS_ID'        => EEM_Payment::status_id_pending,
+				'PAY_timestamp' => time(),
+				'PAY_amount'    => $this->_current_txn->total(),
+				'PMD_ID'        => $this->_current_txn->payment_method_ID()
+			)
+		);
+		$payment_method = $this->_current_txn->payment_method();
+		if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base) {
+			$template_args['gateway_content'] = $payment_method->type_obj()->payment_overview_content($payment);
+		} else {
+			$template_args['gateway_content'] = '';
+		}
+		// link to SPCO payment_options
+		$template_args['show_try_pay_again_link'] = $this->_show_try_pay_again_link;
+		$template_args['SPCO_payment_options_url'] = $this->_SPCO_payment_options_url;
+		// verify template arguments
+		EEH_Template_Validator::verify_instanceof($template_args['transaction'], '$transaction', 'EE_Transaction');
+		EEH_Template_Validator::verify_isnt_null($template_args['payments'], '$payments');
+		EEH_Template_Validator::verify_isnt_null(
+			$template_args['show_try_pay_again_link'],
+			'$show_try_pay_again_link'
+		);
+		EEH_Template_Validator::verify_isnt_null($template_args['gateway_content'], '$gateway_content');
+		EEH_Template_Validator::verify_isnt_null(
+			$template_args['SPCO_payment_options_url'],
+			'$SPCO_payment_options_url'
+		);
+		return EEH_Template::locate_template(
+			THANK_YOU_TEMPLATES_PATH . 'thank-you-page-payment-details.template.php',
+			$template_args,
+			true,
+			true
+		);
+	}
+
+
+
+	/**
+	 * get_payment_details
+	 *
+	 * @param array $payments
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function get_new_payments($payments = array())
+	{
+		$payments_html = '';
+		//prepare variables for displaying
+		foreach ($payments as $payment) {
+			$payments_html .= $this->get_payment_row_html($payment);
+		}
+		return $payments_html;
+	}
 
 
 }

caffeinated/admin/extend/transactions/Extend_Transactions_Admin_Page.core.php

Indentation +220 added lines, -220 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -32,224 +32,224 @@ 
 {
 
 
-    /**
-     * This is used to hold the reports template data which is setup early in the request.
-     * @type array
-     */
-    protected $_reports_template_data = array();
-
-    /**
-     * @Constructor
-     * @access public
-     *
-     * @param bool $routing
-     *
-     * @return \Extend_Transactions_Admin_Page
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/templates/');
-        define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/assets/');
-        define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'transactions/assets/');
-    }
-
-
-    /**
-     *    _extend_page_config
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _extend_page_config()
-    {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'transactions';
-
-        $new_page_routes = array(
-            'reports' => array(
-                'func'       => '_transaction_reports',
-                'capability' => 'ee_read_transactions'
-            )
-        );
-
-        $this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
-
-        $new_page_config    = array(
-            'reports' => array(
-                'nav'           => array(
-                    'label' => __('Reports', 'event_espresso'),
-                    'order' => 20
-                ),
-                'help_tabs'     => array(
-                    'transactions_reports_help_tab' => array(
-                        'title'    => __('Transaction Reports', 'event_espresso'),
-                        'filename' => 'transactions_reports'
-                    )
-                ),
-                /*'help_tour' => array( 'Transaction_Reports_Help_Tour' ),*/
-                'require_nonce' => false
-            )
-        );
-        $this->_page_config = array_merge($this->_page_config, $new_page_config);
-    }
-
-
-    /**
-     *    load_scripts_styles_reports
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles_reports()
-    {
-        wp_register_script(
-            'ee-txn-reports-js',
-            TXN_CAF_ASSETS_URL . 'ee-transaction-admin-reports.js',
-            array('google-charts'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-txn-reports-js');
-        $this->_transaction_reports_js_setup();
-        EE_Registry::$i18n_js_strings['currency_format'] = EEH_Money::get_format_for_google_charts();
-    }
-
-
-    /**
-     * This is called when javascript is being enqueued to setup the various data needed for the reports js.
-     * Also $this->{$_reports_template_data} property is set for later usage by the _transaction_reports method.
-     */
-    protected function _transaction_reports_js_setup()
-    {
-        $this->_reports_template_data['admin_reports'][] = $this->_revenue_per_day_report();
-        $this->_reports_template_data['admin_reports'][] = $this->_revenue_per_event_report();
-    }
-
-
-    /**
-     * _transaction_reports
-     *    generates Business Reports regarding Transactions
-     *
-     * @return void
-     */
-    protected function _transaction_reports()
-    {
-        $template_path                              = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
-        $this->_admin_page_title                    = __('Transactions', 'event_espresso');
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
-            $this->_reports_template_data, true);
-
-        // the final template wrapper
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     * _revenue_per_day_report
-     * generates Business Report showing Total Revenue per Day.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     *
-     * @return string
-     */
-    private function _revenue_per_day_report($period = '-1 month')
-    {
-
-        $report_ID = 'txn-admin-revenue-per-day-report-dv';
-
-        $TXN = EEM_Transaction::instance();
-
-        $results  = $TXN->get_revenue_per_day_report($period);
-        $results  = (array)$results;
-        $revenue  = array();
-        $subtitle = '';
-
-        if ($results) {
-            $revenue[] = array(
-                __('Date (only shows dates that have a revenue greater than 1)', 'event_espresso'),
-                __('Total Revenue', 'event_espresso')
-            );
-            foreach ($results as $result) {
-                $revenue[] = array($result->txnDate, (float)$result->revenue);
-            }
-
-            //setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
-            $ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
-            $subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
-                $beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
-        }
-
-        $report_title = esc_html__('Total Revenue per Day', 'event_espresso');
-
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'revenue'   => $revenue,
-            'noResults' => empty($revenue) || count($revenue) === 1,
-            'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
-                '<h2>' . $report_title . '</h2><p>', '</p>')
-        );
-        wp_localize_script('ee-txn-reports-js', 'txnRevPerDay', $report_params);
-
-        return $report_ID;
-    }
-
-
-    /**
-     * _revenue_per_event_report
-     * generates Business Report showing total revenue per event.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     *
-     * @return int
-     */
-    private function _revenue_per_event_report($period = '-1 month')
-    {
-
-        $report_ID = 'txn-admin-revenue-per-event-report-dv';
-
-        $TXN      = EEM_Transaction::instance();
-        $results  = $TXN->get_revenue_per_event_report($period);
-        $results  = (array)$results;
-        $revenue  = array();
-        $subtitle = '';
-
-        if ($results) {
-            $revenue[] = array(
-                __('Event (only events that have a revenue greater than 1 are shown)', 'event_espresso'),
-                __('Total Revenue', 'event_espresso')
-            );
-            foreach ($results as $result) {
-                if ($result->revenue > 1) {
-                    $event_name = stripslashes(html_entity_decode($result->event_name, ENT_QUOTES, 'UTF-8'));
-                    $event_name = wp_trim_words($event_name, 5, '...');
-                    $revenue[]  = array($event_name, (float)$result->revenue);
-                }
-            }
-
-            //setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
-            $ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
-            $subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
-                $beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
-        }
-
-        $report_title = esc_html__('Total Revenue per Event', 'event_espresso');
-
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'revenue'   => $revenue,
-            'noResults' => empty($revenue),
-            'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
-                '<h2>' . $report_title . '</h2><p>', '</p>')
-        );
-        wp_localize_script('ee-txn-reports-js', 'txnRevPerEvent', $report_params);
-
-        return $report_ID;
-    }
+	/**
+	 * This is used to hold the reports template data which is setup early in the request.
+	 * @type array
+	 */
+	protected $_reports_template_data = array();
+
+	/**
+	 * @Constructor
+	 * @access public
+	 *
+	 * @param bool $routing
+	 *
+	 * @return \Extend_Transactions_Admin_Page
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/templates/');
+		define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/assets/');
+		define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'transactions/assets/');
+	}
+
+
+	/**
+	 *    _extend_page_config
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _extend_page_config()
+	{
+		$this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'transactions';
+
+		$new_page_routes = array(
+			'reports' => array(
+				'func'       => '_transaction_reports',
+				'capability' => 'ee_read_transactions'
+			)
+		);
+
+		$this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
+
+		$new_page_config    = array(
+			'reports' => array(
+				'nav'           => array(
+					'label' => __('Reports', 'event_espresso'),
+					'order' => 20
+				),
+				'help_tabs'     => array(
+					'transactions_reports_help_tab' => array(
+						'title'    => __('Transaction Reports', 'event_espresso'),
+						'filename' => 'transactions_reports'
+					)
+				),
+				/*'help_tour' => array( 'Transaction_Reports_Help_Tour' ),*/
+				'require_nonce' => false
+			)
+		);
+		$this->_page_config = array_merge($this->_page_config, $new_page_config);
+	}
+
+
+	/**
+	 *    load_scripts_styles_reports
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles_reports()
+	{
+		wp_register_script(
+			'ee-txn-reports-js',
+			TXN_CAF_ASSETS_URL . 'ee-transaction-admin-reports.js',
+			array('google-charts'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-txn-reports-js');
+		$this->_transaction_reports_js_setup();
+		EE_Registry::$i18n_js_strings['currency_format'] = EEH_Money::get_format_for_google_charts();
+	}
+
+
+	/**
+	 * This is called when javascript is being enqueued to setup the various data needed for the reports js.
+	 * Also $this->{$_reports_template_data} property is set for later usage by the _transaction_reports method.
+	 */
+	protected function _transaction_reports_js_setup()
+	{
+		$this->_reports_template_data['admin_reports'][] = $this->_revenue_per_day_report();
+		$this->_reports_template_data['admin_reports'][] = $this->_revenue_per_event_report();
+	}
+
+
+	/**
+	 * _transaction_reports
+	 *    generates Business Reports regarding Transactions
+	 *
+	 * @return void
+	 */
+	protected function _transaction_reports()
+	{
+		$template_path                              = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+		$this->_admin_page_title                    = __('Transactions', 'event_espresso');
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
+			$this->_reports_template_data, true);
+
+		// the final template wrapper
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * _revenue_per_day_report
+	 * generates Business Report showing Total Revenue per Day.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 *
+	 * @return string
+	 */
+	private function _revenue_per_day_report($period = '-1 month')
+	{
+
+		$report_ID = 'txn-admin-revenue-per-day-report-dv';
+
+		$TXN = EEM_Transaction::instance();
+
+		$results  = $TXN->get_revenue_per_day_report($period);
+		$results  = (array)$results;
+		$revenue  = array();
+		$subtitle = '';
+
+		if ($results) {
+			$revenue[] = array(
+				__('Date (only shows dates that have a revenue greater than 1)', 'event_espresso'),
+				__('Total Revenue', 'event_espresso')
+			);
+			foreach ($results as $result) {
+				$revenue[] = array($result->txnDate, (float)$result->revenue);
+			}
+
+			//setup the date range.
+			$beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+			$ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+			$subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
+				$beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
+		}
+
+		$report_title = esc_html__('Total Revenue per Day', 'event_espresso');
+
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'revenue'   => $revenue,
+			'noResults' => empty($revenue) || count($revenue) === 1,
+			'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
+				'<h2>' . $report_title . '</h2><p>', '</p>')
+		);
+		wp_localize_script('ee-txn-reports-js', 'txnRevPerDay', $report_params);
+
+		return $report_ID;
+	}
+
+
+	/**
+	 * _revenue_per_event_report
+	 * generates Business Report showing total revenue per event.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 *
+	 * @return int
+	 */
+	private function _revenue_per_event_report($period = '-1 month')
+	{
+
+		$report_ID = 'txn-admin-revenue-per-event-report-dv';
+
+		$TXN      = EEM_Transaction::instance();
+		$results  = $TXN->get_revenue_per_event_report($period);
+		$results  = (array)$results;
+		$revenue  = array();
+		$subtitle = '';
+
+		if ($results) {
+			$revenue[] = array(
+				__('Event (only events that have a revenue greater than 1 are shown)', 'event_espresso'),
+				__('Total Revenue', 'event_espresso')
+			);
+			foreach ($results as $result) {
+				if ($result->revenue > 1) {
+					$event_name = stripslashes(html_entity_decode($result->event_name, ENT_QUOTES, 'UTF-8'));
+					$event_name = wp_trim_words($event_name, 5, '...');
+					$revenue[]  = array($event_name, (float)$result->revenue);
+				}
+			}
+
+			//setup the date range.
+			$beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+			$ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+			$subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
+				$beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
+		}
+
+		$report_title = esc_html__('Total Revenue per Event', 'event_espresso');
+
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'revenue'   => $revenue,
+			'noResults' => empty($revenue),
+			'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
+				'<h2>' . $report_title . '</h2><p>', '</p>')
+		);
+		wp_localize_script('ee-txn-reports-js', 'txnRevPerEvent', $report_params);
+
+		return $report_ID;
+	}
 
 }

Spacing +14 added lines, -14 removed lines

@@ -49,9 +49,9 @@ 
     public function __construct($routing = true)
     {
         parent::__construct($routing);
-        define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/templates/');
-        define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/assets/');
-        define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'transactions/assets/');
+        define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND.'transactions/templates/');
+        define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND.'transactions/assets/');
+        define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'transactions/assets/');
     }
 
 
@@ -63,7 +63,7 @@ 
      */
     protected function _extend_page_config()
     {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'transactions';
+        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND.'transactions';
 
         $new_page_routes = array(
             'reports' => array(
@@ -104,7 +104,7 @@ 
     {
         wp_register_script(
             'ee-txn-reports-js',
-            TXN_CAF_ASSETS_URL . 'ee-transaction-admin-reports.js',
+            TXN_CAF_ASSETS_URL.'ee-transaction-admin-reports.js',
             array('google-charts'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -134,7 +134,7 @@ 
      */
     protected function _transaction_reports()
     {
-        $template_path                              = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+        $template_path                              = EE_ADMIN_TEMPLATE.'admin_reports.template.php';
         $this->_admin_page_title                    = __('Transactions', 'event_espresso');
         $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
             $this->_reports_template_data, true);
@@ -160,7 +160,7 @@ 
         $TXN = EEM_Transaction::instance();
 
         $results  = $TXN->get_revenue_per_day_report($period);
-        $results  = (array)$results;
+        $results  = (array) $results;
         $revenue  = array();
         $subtitle = '';
 
@@ -170,11 +170,11 @@ 
                 __('Total Revenue', 'event_espresso')
             );
             foreach ($results as $result) {
-                $revenue[] = array($result->txnDate, (float)$result->revenue);
+                $revenue[] = array($result->txnDate, (float) $result->revenue);
             }
 
             //setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+            $beginning_date = new DateTime('now'.$period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
                 $beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
@@ -189,7 +189,7 @@ 
             'revenue'   => $revenue,
             'noResults' => empty($revenue) || count($revenue) === 1,
             'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
-                '<h2>' . $report_title . '</h2><p>', '</p>')
+                '<h2>'.$report_title.'</h2><p>', '</p>')
         );
         wp_localize_script('ee-txn-reports-js', 'txnRevPerDay', $report_params);
 
@@ -212,7 +212,7 @@ 
 
         $TXN      = EEM_Transaction::instance();
         $results  = $TXN->get_revenue_per_event_report($period);
-        $results  = (array)$results;
+        $results  = (array) $results;
         $revenue  = array();
         $subtitle = '';
 
@@ -225,12 +225,12 @@ 
                 if ($result->revenue > 1) {
                     $event_name = stripslashes(html_entity_decode($result->event_name, ENT_QUOTES, 'UTF-8'));
                     $event_name = wp_trim_words($event_name, 5, '...');
-                    $revenue[]  = array($event_name, (float)$result->revenue);
+                    $revenue[]  = array($event_name, (float) $result->revenue);
                 }
             }
 
             //setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+            $beginning_date = new DateTime('now'.$period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
                 $beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
@@ -245,7 +245,7 @@ 
             'revenue'   => $revenue,
             'noResults' => empty($revenue),
             'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
-                '<h2>' . $report_title . '</h2><p>', '</p>')
+                '<h2>'.$report_title.'</h2><p>', '</p>')
         );
         wp_localize_script('ee-txn-reports-js', 'txnRevPerEvent', $report_params);
 

core/helpers/EEH_Event_View.helper.php

Indentation +94 added lines, -94 removed lines

@@ -32,49 +32,49 @@ 
 
 
 
-    /**
-     * get_event
-     * attempts to retrieve an EE_Event object any way it can
-     *
-     * @param int|WP_Post $EVT_ID
-     * @return EE_Event|null
-     * @throws \EE_Error
-     */
+	/**
+	 * get_event
+	 * attempts to retrieve an EE_Event object any way it can
+	 *
+	 * @param int|WP_Post $EVT_ID
+	 * @return EE_Event|null
+	 * @throws \EE_Error
+	 */
 	public static function get_event( $EVT_ID = 0 ) {
-        // international newspaper?
-        global $post;
-        $EVT_ID = $EVT_ID instanceof WP_Post && $EVT_ID->post_type === 'espresso_events'
-            ? $EVT_ID->ID
-            : absint($EVT_ID);
-        // do we already have the Event  you are looking for?
-        if (EEH_Event_View::$_event instanceof EE_Event && $EVT_ID && EEH_Event_View::$_event->ID() === $EVT_ID) {
-            return EEH_Event_View::$_event;
-        }
-        //reset property so that the new event is cached.
-        EEH_Event_View::$_event = null;
-
-        if ($EVT_ID || $post instanceof WP_Post) {
-            //if the post type is for an event and it has a cached event and we don't have a different incoming $EVT_ID
-            //then let's just use that cached event on the $post object.
-            if (($post instanceof WP_Post 
-                    && $post->post_type === 'espresso_events'
-                    )
-                && isset($post->EE_Event)
-                && ($EVT_ID === 0
-                    || $EVT_ID === $post->ID
-                    )
-            ) {
-                EEH_Event_View::$_event = $post->EE_Event;
-            }
-
-            //If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
-            if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
-                EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-            }
-        }
-
-        return EEH_Event_View::$_event;
-    }
+		// international newspaper?
+		global $post;
+		$EVT_ID = $EVT_ID instanceof WP_Post && $EVT_ID->post_type === 'espresso_events'
+			? $EVT_ID->ID
+			: absint($EVT_ID);
+		// do we already have the Event  you are looking for?
+		if (EEH_Event_View::$_event instanceof EE_Event && $EVT_ID && EEH_Event_View::$_event->ID() === $EVT_ID) {
+			return EEH_Event_View::$_event;
+		}
+		//reset property so that the new event is cached.
+		EEH_Event_View::$_event = null;
+
+		if ($EVT_ID || $post instanceof WP_Post) {
+			//if the post type is for an event and it has a cached event and we don't have a different incoming $EVT_ID
+			//then let's just use that cached event on the $post object.
+			if (($post instanceof WP_Post 
+					&& $post->post_type === 'espresso_events'
+					)
+				&& isset($post->EE_Event)
+				&& ($EVT_ID === 0
+					|| $EVT_ID === $post->ID
+					)
+			) {
+				EEH_Event_View::$_event = $post->EE_Event;
+			}
+
+			//If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
+			if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
+				EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+			}
+		}
+
+		return EEH_Event_View::$_event;
+	}
 
 
 
@@ -150,58 +150,58 @@ 
 	 * @return    string
 	 */
 	public static function event_content_or_excerpt( $num_words = NULL, $more = NULL ) {
-        global $post;
+		global $post;
 		ob_start();
 		if (( is_single() ) || ( is_archive() && espresso_display_full_description_in_event_list() )) {
 			// admin has chosen "full description"
-            // for the "Event Espresso - Events > Templates > Display Description" option
+			// for the "Event Espresso - Events > Templates > Display Description" option
 			the_content();
 		} else if (( is_archive() && espresso_display_excerpt_in_event_list() ) ) {
-            if ( has_excerpt( $post->ID )) {
-                // admin has chosen "excerpt (short desc)"
-                // for the "Event Espresso - Events > Templates > Display Description" option
-                // AND an excerpt actually exists
-                the_excerpt();
-            } else {
-                // admin has chosen "excerpt (short desc)"
-                // for the "Event Espresso - Events > Templates > Display Description" option
-                // but NO excerpt actually exists, so we need to create one
-                if ( ! empty( $num_words )) {
-                    if ( empty( $more )) {
-                        $more_link_text = __( '(more…)' );
-                        $more = ' <a href="' . get_permalink() . '"';
-                        $more .= ' class="more-link"';
-                        $more .= \EED_Events_Archive::link_target();
-                        $more .= '>' . $more_link_text . '</a>';
-                        $more = apply_filters( 'the_content_more_link', $more, $more_link_text );
-                    }
-                    $content = str_replace( 'NOMORELINK', '', get_the_content( 'NOMORELINK' ));
-
-                    $content =  wp_trim_words( $content, $num_words, ' ' ) . $more;
-                } else {
-                    $content =  get_the_content();
-                }
-                global $allowedtags;
-                // make sure links are allowed
-                $allowedtags['a'] = isset($allowedtags['a'])
-                    ? $allowedtags['a']
-                    : array();
-                // as well as target attribute
-                $allowedtags['a']['target'] = isset($allowedtags['a']['target'])
-                    ? $allowedtags['a']['target']
-                    : false;
-                // but get previous value so we can reset it
-                $prev_value = $allowedtags['a']['target'];
-                $allowedtags['a']['target'] = true;
-                $content = wp_kses( $content, $allowedtags );
-                $content = strip_shortcodes( $content );
-                echo apply_filters( 'the_content', $content );
-                $allowedtags['a']['target'] = $prev_value;
-            }
-        } else {
-            // admin has chosen "none"
-            // for the "Event Espresso - Events > Templates > Display Description" option
-            echo apply_filters( 'the_content', '' );
+			if ( has_excerpt( $post->ID )) {
+				// admin has chosen "excerpt (short desc)"
+				// for the "Event Espresso - Events > Templates > Display Description" option
+				// AND an excerpt actually exists
+				the_excerpt();
+			} else {
+				// admin has chosen "excerpt (short desc)"
+				// for the "Event Espresso - Events > Templates > Display Description" option
+				// but NO excerpt actually exists, so we need to create one
+				if ( ! empty( $num_words )) {
+					if ( empty( $more )) {
+						$more_link_text = __( '(more&hellip;)' );
+						$more = ' <a href="' . get_permalink() . '"';
+						$more .= ' class="more-link"';
+						$more .= \EED_Events_Archive::link_target();
+						$more .= '>' . $more_link_text . '</a>';
+						$more = apply_filters( 'the_content_more_link', $more, $more_link_text );
+					}
+					$content = str_replace( 'NOMORELINK', '', get_the_content( 'NOMORELINK' ));
+
+					$content =  wp_trim_words( $content, $num_words, ' ' ) . $more;
+				} else {
+					$content =  get_the_content();
+				}
+				global $allowedtags;
+				// make sure links are allowed
+				$allowedtags['a'] = isset($allowedtags['a'])
+					? $allowedtags['a']
+					: array();
+				// as well as target attribute
+				$allowedtags['a']['target'] = isset($allowedtags['a']['target'])
+					? $allowedtags['a']['target']
+					: false;
+				// but get previous value so we can reset it
+				$prev_value = $allowedtags['a']['target'];
+				$allowedtags['a']['target'] = true;
+				$content = wp_kses( $content, $allowedtags );
+				$content = strip_shortcodes( $content );
+				echo apply_filters( 'the_content', $content );
+				$allowedtags['a']['target'] = $prev_value;
+			}
+		} else {
+			// admin has chosen "none"
+			// for the "Event Espresso - Events > Templates > Display Description" option
+			echo apply_filters( 'the_content', '' );
 		}
 		return ob_get_clean();
 	}
@@ -248,11 +248,11 @@ 
 					$url = get_term_link( $term, 'espresso_venue_categories' );
 					if ( ! is_wp_error( $url ) && (( $hide_uncategorized && strtolower( $term->name ) != __( 'uncategorized', 'event_espresso' )) || ! $hide_uncategorized )) {
 						$category_links[] = '<a href="' . esc_url( $url )
-                                            . '" rel="tag"'
-                                            . \EED_Events_Archive::link_target()
-                                            .'>'
-                                            . $term->name
-                                            . '</a>';
+											. '" rel="tag"'
+											. \EED_Events_Archive::link_target()
+											.'>'
+											. $term->name
+											. '</a>';
 					}
 				}
 			}

admin_pages/about/templates/credits.template.php

Spacing +13 added lines, -13 removed lines

@@ -3,7 +3,7 @@ 
 <ul class="wp-people-group" id="ee-people-group-owners">
 	<li class="wp-person" id="ee-person-sshoultes">
 		<a href="<?php esp_gravatar_profile('seth@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'seth@eventespresso.com', 'Seth Shoultes' ); ?>
+			<?php echo esp_gravatar_image('seth@eventespresso.com', 'Seth Shoultes'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('seth@eventespresso.com'); ?>">
 			Seth Shoultes
@@ -12,7 +12,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-gkoyle">
 		<a href="<?php esp_gravatar_profile('garth@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'garth@eventespresso.com', 'Garth Koyle' ); ?>
+			<?php echo esp_gravatar_image('garth@eventespresso.com', 'Garth Koyle'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('garth@eventespresso.com'); ?>">
 			Garth Koyle
@@ -24,7 +24,7 @@ 
 <ul class="wp-people-group" id="ee-people-group-core-developers">
 	<li class="wp-person" id="ee-person-bchristensen">
 		<a href="<?php esp_gravatar_profile('brent@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'brent@eventespresso.com', 'Brent Christensen' ); ?>
+			<?php echo esp_gravatar_image('brent@eventespresso.com', 'Brent Christensen'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('brent@eventespresso.com'); ?>">
 			Brent Christensen
@@ -33,7 +33,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-dethier">
 		<a href="<?php esp_gravatar_profile('darren@roughsmootheng.in'); ?>">
-			<?php echo esp_gravatar_image( 'darren@roughsmootheng.in', 'Darren Ethier' ); ?>
+			<?php echo esp_gravatar_image('darren@roughsmootheng.in', 'Darren Ethier'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('darren@roughsmootheng.in'); ?>">
 			Darren Ethier
@@ -42,7 +42,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-mnelson">
 		<a href="<?php esp_gravatar_profile('michael@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'michael@eventespresso.com', 'Michael Nelson' ); ?>
+			<?php echo esp_gravatar_image('michael@eventespresso.com', 'Michael Nelson'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('michael@eventespresso.com'); ?>">
 			Michael Nelson
@@ -51,7 +51,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-nkolivoshka">
 		<a href="<?php esp_gravatar_profile('nazar@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'nazar@eventespresso.com', 'Nazar Kolivoshka' ); ?>
+			<?php echo esp_gravatar_image('nazar@eventespresso.com', 'Nazar Kolivoshka'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('nazar@eventespresso.com'); ?>">
 			Nazar Kolivoshka
@@ -63,7 +63,7 @@ 
 <ul class="wp-people-group" id="ee-people-group-support-staff">
 	<li class="wp-person" id="ee-person-jfeck">
 		<a href="<?php esp_gravatar_profile('josh@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'josh@eventespresso.com', 'Josh Feck' ); ?>
+			<?php echo esp_gravatar_image('josh@eventespresso.com', 'Josh Feck'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('josh@eventespresso.com'); ?>">
 			Josh Feck
@@ -71,7 +71,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-twarwick">
 		<a href="<?php esp_gravatar_profile('tony@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'tony@eventespresso.com', 'Tony Warwick' ); ?>
+			<?php echo esp_gravatar_image('tony@eventespresso.com', 'Tony Warwick'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('tony@eventespresso.com'); ?>">
 			Tony Warwick
@@ -79,7 +79,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-lcaum">
 		<a href="<?php esp_gravatar_profile('lorenzo@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'lorenzo@eventespresso.com', 'Lorenzo Caum' ); ?>
+			<?php echo esp_gravatar_image('lorenzo@eventespresso.com', 'Lorenzo Caum'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('lorenzo@eventespresso.com'); ?>">
 			Lorenzo Caum
@@ -89,7 +89,7 @@ 
 </ul>
 <h3 class="wp-people-group"><?php _e('Contributor Recognition', 'event_espresso'); ?></h3>
 <p class="description">
-	<?php printf( __('For every major release we want to recognize the people who contributed to the release via a GitHub pull request. Want to see your name listed here? %sWhen you submit a pull request that gets included in a major release%s, we\'ll add your name here linked to your GitHub profile.', 'event_espresso'), '<a href="https://github.com/eventespresso/event-espresso-core" title="Contribute to Event Espresso by making a pull request via GitHub">', '</a>' ); ?>
+	<?php printf(__('For every major release we want to recognize the people who contributed to the release via a GitHub pull request. Want to see your name listed here? %sWhen you submit a pull request that gets included in a major release%s, we\'ll add your name here linked to your GitHub profile.', 'event_espresso'), '<a href="https://github.com/eventespresso/event-espresso-core" title="Contribute to Event Espresso by making a pull request via GitHub">', '</a>'); ?>
 </p>
 <p class="wp-credits-list">
 	<ul>
@@ -103,7 +103,7 @@ 
 </p>
 <h3 class="wp-people-group"><?php _e('External Libraries', 'event_espresso'); ?></h3>
 <p class="description">
-	<?php printf( __('Along with the libraries %sincluded with WordPress%s, Event Espresso utilizes the following third party libraries:', 'event_espresso'), '<a href="credits.php">', '</a>' ); ?>
+	<?php printf(__('Along with the libraries %sincluded with WordPress%s, Event Espresso utilizes the following third party libraries:', 'event_espresso'), '<a href="credits.php">', '</a>'); ?>
 </p>
 <p class="wp-credits-list">
 	<a href="http://josscrowcroft.github.io/accounting.js/"><?php _e('accounting.js', 'event_espresso'); ?></a>,
@@ -119,10 +119,10 @@ 
 
 <?php
 	function esp_gravatar_profile($email) {
-		echo 'http://www.gravatar.com/' . md5($email);
+		echo 'http://www.gravatar.com/'.md5($email);
 	}
 
 	function esp_gravatar_image($email, $name) {
-		echo '<img src="http://0.gravatar.com/avatar/' . md5($email) . '?s=60" class="gravatar" alt="' . $name . '"/>';
+		echo '<img src="http://0.gravatar.com/avatar/'.md5($email).'?s=60" class="gravatar" alt="'.$name.'"/>';
 	}
 ?>