eventespresso / event-espresso-core

core/admin/EE_Admin_Page_CPT.core.php

Indentation +1388 added lines, -1388 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -24,445 +24,445 @@ 
 {
 
 
-    /**
-     * This gets set in _setup_cpt
-     * It will contain the object for the custom post type.
-     *
-     * @var object
-     */
-    protected $_cpt_object;
-
-
-
-    /**
-     * a boolean flag to set whether the current route is a cpt route or not.
-     *
-     * @var bool
-     */
-    protected $_cpt_route = false;
-
-
-
-    /**
-     * This property allows cpt classes to define multiple routes as cpt routes.
-     * //in this array we define what the custom post type for this route is.
-     * array(
-     * 'route_name' => 'custom_post_type_slug'
-     * )
-     *
-     * @var array
-     */
-    protected $_cpt_routes = array();
-
+	/**
+	 * This gets set in _setup_cpt
+	 * It will contain the object for the custom post type.
+	 *
+	 * @var object
+	 */
+	protected $_cpt_object;
+
+
+
+	/**
+	 * a boolean flag to set whether the current route is a cpt route or not.
+	 *
+	 * @var bool
+	 */
+	protected $_cpt_route = false;
+
+
+
+	/**
+	 * This property allows cpt classes to define multiple routes as cpt routes.
+	 * //in this array we define what the custom post type for this route is.
+	 * array(
+	 * 'route_name' => 'custom_post_type_slug'
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_cpt_routes = array();
+
 
 
-    /**
-     * This simply defines what the corresponding routes WP will be redirected to after completing a post save/update.
-     * in this format:
-     * array(
-     * 'post_type_slug' => 'edit_route'
-     * )
-     *
-     * @var array
-     */
-    protected $_cpt_edit_routes = array();
-
-
-
-    /**
-     * If child classes set the name of their main model via the $_cpt_obj_models property, EE_Admin_Page_CPT will
-     * attempt to retrieve the related object model for the edit pages and assign it to _cpt_page_object. the
-     * _cpt_model_names property should be in the following format: array(
-     * 'route_defined_by_action_param' => 'Model_Name')
-     *
-     * @var array $_cpt_model_names
-     */
-    protected $_cpt_model_names = array();
-
-
-    /**
-     * @var EE_CPT_Base
-     */
-    protected $_cpt_model_obj = false;
-
-
-
-    /**
-     * This will hold an array of autosave containers that will be used to obtain input values and hook into the WP
-     * autosave so we can save our inputs on the save_post hook!  Children classes should add to this array by using
-     * the _register_autosave_containers() method so that we don't override any other containers already registered.
-     * Registration of containers should be done before load_page_dependencies() is run.
-     *
-     * @var array()
-     */
-    protected $_autosave_containers = array();
-    protected $_autosave_fields = array();
-
-    /**
-     * Array mapping from admin actions to their equivalent wp core pages for custom post types. So when a user visits
-     * a page for an action, it will appear as if they were visiting the wp core page for that custom post type
-     *
-     * @var array
-     */
-    protected $_pagenow_map = null;
-
-
-
-    /**
-     * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
-     * saved.  Child classes are required to declare this method.  Typically you would use this to save any additional
-     * data. Keep in mind also that "save_post" runs on EVERY post update to the database. ALSO very important.  When a
-     * post transitions from scheduled to published, the save_post action is fired but you will NOT have any _POST data
-     * containing any extra info you may have from other meta saves.  So MAKE sure that you handle this accordingly.
-     *
-     * @access protected
-     * @abstract
-     * @param  string $post_id The ID of the cpt that was saved (so you can link relationally)
-     * @param  object $post    The post object of the cpt that was saved.
-     * @return void
-     */
-    abstract protected function _insert_update_cpt_item($post_id, $post);
-
-
-
-    /**
-     * This is hooked into the WordPress do_action('trashed_post') hook and runs after a cpt has been trashed.
-     *
-     * @abstract
-     * @access public
-     * @param  string $post_id The ID of the cpt that was trashed
-     * @return void
-     */
-    abstract public function trash_cpt_item($post_id);
-
-
-
-    /**
-     * This is hooked into the WordPress do_action('untrashed_post') hook and runs after a cpt has been untrashed
-     *
-     * @param  string $post_id theID of the cpt that was untrashed
-     * @return void
-     */
-    abstract public function restore_cpt_item($post_id);
-
-
-
-    /**
-     * This is hooked into the WordPress do_action('delete_cpt_item') hook and runs after a cpt has been fully deleted
-     * from the db
-     *
-     * @param  string $post_id the ID of the cpt that was deleted
-     * @return void
-     */
-    abstract public function delete_cpt_item($post_id);
-
-
-
-    /**
-     * Just utilizing the method EE_Admin exposes for doing things before page setup.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _before_page_setup()
-    {
-        $page = isset($this->_req_data['page']) ? $this->_req_data['page'] : $this->page_slug;
-        $this->_cpt_routes = array_merge(array(
-            'create_new' => $this->page_slug,
-            'edit'       => $this->page_slug,
-            'trash'      => $this->page_slug,
-        ), $this->_cpt_routes);
-        //let's see if the current route has a value for cpt_object_slug if it does we use that instead of the page
-        $this->_cpt_object = isset($this->_req_data['action']) && isset($this->_cpt_routes[$this->_req_data['action']])
-            ? get_post_type_object($this->_cpt_routes[$this->_req_data['action']])
-            : get_post_type_object($page);
-        //tweak pagenow for page loading.
-        if ( ! $this->_pagenow_map) {
-            $this->_pagenow_map = array(
-                'create_new' => 'post-new.php',
-                'edit'       => 'post.php',
-                'trash'      => 'post.php',
-            );
-        }
-        add_action('current_screen', array($this, 'modify_pagenow'));
-        //TODO the below will need to be reworked to account for the cpt routes that are NOT based off of page but action param.
-        //get current page from autosave
-        $current_page = isset($this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page'])
-            ? $this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page']
-            : null;
-        $this->_current_page = isset($this->_req_data['current_page'])
-            ? $this->_req_data['current_page']
-            : $current_page;
-        //autosave... make sure its only for the correct page
-        if ( ! empty($this->_current_page) && $this->_current_page == $this->page_slug) {
-            //setup autosave ajax hook
-            //add_action('wp_ajax_ee-autosave', array( $this, 'do_extra_autosave_stuff' ), 10 ); //TODO reactivate when 4.2 autosave is implemented
-        }
-    }
-
-
-
-    /**
-     * Simply ensure that we simulate the correct post route for cpt screens
-     *
-     * @param WP_Screen $current_screen
-     * @return void
-     */
-    public function modify_pagenow($current_screen)
-    {
-        global $pagenow, $hook_suffix;
-        //possibly reset pagenow.
-        if ( ! empty($this->_req_data['page'])
-             && $this->_req_data['page'] == $this->page_slug
-             && ! empty($this->_req_data['action'])
-             && isset($this->_pagenow_map[$this->_req_data['action']])
-        ) {
-            $pagenow = $this->_pagenow_map[$this->_req_data['action']];
-            $hook_suffix = $pagenow;
-        }
-    }
-
-
-
-    /**
-     * This method is used to register additional autosave containers to the _autosave_containers property.
-     *
-     * @todo We should automate this at some point by creating a wrapper for add_post_metabox and in our wrapper we
-     *       automatically register the id for the post metabox as a container.
-     * @param  array $ids an array of ids for containers that hold form inputs we want autosave to pickup.  Typically
-     *                    you would send along the id of a metabox container.
-     * @return void
-     */
-    protected function _register_autosave_containers($ids)
-    {
-        $this->_autosave_containers = array_merge($this->_autosave_fields, (array)$ids);
-    }
-
-
-
-    /**
-     * Something nifty.  We're going to loop through all the registered metaboxes and if the CALLBACK is an instance of
-     * EE_Admin_Page OR EE_Admin_Hooks, then we'll add the id to our _autosave_containers array.
-     */
-    protected function _set_autosave_containers()
-    {
-        global $wp_meta_boxes;
-        $containers = array();
-        if (empty($wp_meta_boxes)) {
-            return;
-        }
-        $current_metaboxes = isset($wp_meta_boxes[$this->page_slug]) ? $wp_meta_boxes[$this->page_slug] : array();
-        foreach ($current_metaboxes as $box_context) {
-            foreach ($box_context as $box_details) {
-                foreach ($box_details as $box) {
-                    if (is_array($box['callback'])
-                        && ($box['callback'][0] instanceof EE_Admin_Page
-                            || $box['callback'][0] instanceof EE_Admin_Hooks)
-                    ) {
-                        $containers[] = $box['id'];
-                    }
-                }
-            }
-        }
-        $this->_autosave_containers = array_merge($this->_autosave_containers, $containers);
-        //add hidden inputs container
-        $this->_autosave_containers[] = 'ee-cpt-hidden-inputs';
-    }
-
-
-
-    protected function _load_autosave_scripts_styles()
-    {
-        /*wp_register_script('cpt-autosave', EE_ADMIN_URL . 'assets/ee-cpt-autosave.js', array('ee-serialize-full-array', 'event_editor_js'), EVENT_ESPRESSO_VERSION, TRUE );
+	/**
+	 * This simply defines what the corresponding routes WP will be redirected to after completing a post save/update.
+	 * in this format:
+	 * array(
+	 * 'post_type_slug' => 'edit_route'
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_cpt_edit_routes = array();
+
+
+
+	/**
+	 * If child classes set the name of their main model via the $_cpt_obj_models property, EE_Admin_Page_CPT will
+	 * attempt to retrieve the related object model for the edit pages and assign it to _cpt_page_object. the
+	 * _cpt_model_names property should be in the following format: array(
+	 * 'route_defined_by_action_param' => 'Model_Name')
+	 *
+	 * @var array $_cpt_model_names
+	 */
+	protected $_cpt_model_names = array();
+
+
+	/**
+	 * @var EE_CPT_Base
+	 */
+	protected $_cpt_model_obj = false;
+
+
+
+	/**
+	 * This will hold an array of autosave containers that will be used to obtain input values and hook into the WP
+	 * autosave so we can save our inputs on the save_post hook!  Children classes should add to this array by using
+	 * the _register_autosave_containers() method so that we don't override any other containers already registered.
+	 * Registration of containers should be done before load_page_dependencies() is run.
+	 *
+	 * @var array()
+	 */
+	protected $_autosave_containers = array();
+	protected $_autosave_fields = array();
+
+	/**
+	 * Array mapping from admin actions to their equivalent wp core pages for custom post types. So when a user visits
+	 * a page for an action, it will appear as if they were visiting the wp core page for that custom post type
+	 *
+	 * @var array
+	 */
+	protected $_pagenow_map = null;
+
+
+
+	/**
+	 * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
+	 * saved.  Child classes are required to declare this method.  Typically you would use this to save any additional
+	 * data. Keep in mind also that "save_post" runs on EVERY post update to the database. ALSO very important.  When a
+	 * post transitions from scheduled to published, the save_post action is fired but you will NOT have any _POST data
+	 * containing any extra info you may have from other meta saves.  So MAKE sure that you handle this accordingly.
+	 *
+	 * @access protected
+	 * @abstract
+	 * @param  string $post_id The ID of the cpt that was saved (so you can link relationally)
+	 * @param  object $post    The post object of the cpt that was saved.
+	 * @return void
+	 */
+	abstract protected function _insert_update_cpt_item($post_id, $post);
+
+
+
+	/**
+	 * This is hooked into the WordPress do_action('trashed_post') hook and runs after a cpt has been trashed.
+	 *
+	 * @abstract
+	 * @access public
+	 * @param  string $post_id The ID of the cpt that was trashed
+	 * @return void
+	 */
+	abstract public function trash_cpt_item($post_id);
+
+
+
+	/**
+	 * This is hooked into the WordPress do_action('untrashed_post') hook and runs after a cpt has been untrashed
+	 *
+	 * @param  string $post_id theID of the cpt that was untrashed
+	 * @return void
+	 */
+	abstract public function restore_cpt_item($post_id);
+
+
+
+	/**
+	 * This is hooked into the WordPress do_action('delete_cpt_item') hook and runs after a cpt has been fully deleted
+	 * from the db
+	 *
+	 * @param  string $post_id the ID of the cpt that was deleted
+	 * @return void
+	 */
+	abstract public function delete_cpt_item($post_id);
+
+
+
+	/**
+	 * Just utilizing the method EE_Admin exposes for doing things before page setup.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _before_page_setup()
+	{
+		$page = isset($this->_req_data['page']) ? $this->_req_data['page'] : $this->page_slug;
+		$this->_cpt_routes = array_merge(array(
+			'create_new' => $this->page_slug,
+			'edit'       => $this->page_slug,
+			'trash'      => $this->page_slug,
+		), $this->_cpt_routes);
+		//let's see if the current route has a value for cpt_object_slug if it does we use that instead of the page
+		$this->_cpt_object = isset($this->_req_data['action']) && isset($this->_cpt_routes[$this->_req_data['action']])
+			? get_post_type_object($this->_cpt_routes[$this->_req_data['action']])
+			: get_post_type_object($page);
+		//tweak pagenow for page loading.
+		if ( ! $this->_pagenow_map) {
+			$this->_pagenow_map = array(
+				'create_new' => 'post-new.php',
+				'edit'       => 'post.php',
+				'trash'      => 'post.php',
+			);
+		}
+		add_action('current_screen', array($this, 'modify_pagenow'));
+		//TODO the below will need to be reworked to account for the cpt routes that are NOT based off of page but action param.
+		//get current page from autosave
+		$current_page = isset($this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page'])
+			? $this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page']
+			: null;
+		$this->_current_page = isset($this->_req_data['current_page'])
+			? $this->_req_data['current_page']
+			: $current_page;
+		//autosave... make sure its only for the correct page
+		if ( ! empty($this->_current_page) && $this->_current_page == $this->page_slug) {
+			//setup autosave ajax hook
+			//add_action('wp_ajax_ee-autosave', array( $this, 'do_extra_autosave_stuff' ), 10 ); //TODO reactivate when 4.2 autosave is implemented
+		}
+	}
+
+
+
+	/**
+	 * Simply ensure that we simulate the correct post route for cpt screens
+	 *
+	 * @param WP_Screen $current_screen
+	 * @return void
+	 */
+	public function modify_pagenow($current_screen)
+	{
+		global $pagenow, $hook_suffix;
+		//possibly reset pagenow.
+		if ( ! empty($this->_req_data['page'])
+			 && $this->_req_data['page'] == $this->page_slug
+			 && ! empty($this->_req_data['action'])
+			 && isset($this->_pagenow_map[$this->_req_data['action']])
+		) {
+			$pagenow = $this->_pagenow_map[$this->_req_data['action']];
+			$hook_suffix = $pagenow;
+		}
+	}
+
+
+
+	/**
+	 * This method is used to register additional autosave containers to the _autosave_containers property.
+	 *
+	 * @todo We should automate this at some point by creating a wrapper for add_post_metabox and in our wrapper we
+	 *       automatically register the id for the post metabox as a container.
+	 * @param  array $ids an array of ids for containers that hold form inputs we want autosave to pickup.  Typically
+	 *                    you would send along the id of a metabox container.
+	 * @return void
+	 */
+	protected function _register_autosave_containers($ids)
+	{
+		$this->_autosave_containers = array_merge($this->_autosave_fields, (array)$ids);
+	}
+
+
+
+	/**
+	 * Something nifty.  We're going to loop through all the registered metaboxes and if the CALLBACK is an instance of
+	 * EE_Admin_Page OR EE_Admin_Hooks, then we'll add the id to our _autosave_containers array.
+	 */
+	protected function _set_autosave_containers()
+	{
+		global $wp_meta_boxes;
+		$containers = array();
+		if (empty($wp_meta_boxes)) {
+			return;
+		}
+		$current_metaboxes = isset($wp_meta_boxes[$this->page_slug]) ? $wp_meta_boxes[$this->page_slug] : array();
+		foreach ($current_metaboxes as $box_context) {
+			foreach ($box_context as $box_details) {
+				foreach ($box_details as $box) {
+					if (is_array($box['callback'])
+						&& ($box['callback'][0] instanceof EE_Admin_Page
+							|| $box['callback'][0] instanceof EE_Admin_Hooks)
+					) {
+						$containers[] = $box['id'];
+					}
+				}
+			}
+		}
+		$this->_autosave_containers = array_merge($this->_autosave_containers, $containers);
+		//add hidden inputs container
+		$this->_autosave_containers[] = 'ee-cpt-hidden-inputs';
+	}
+
+
+
+	protected function _load_autosave_scripts_styles()
+	{
+		/*wp_register_script('cpt-autosave', EE_ADMIN_URL . 'assets/ee-cpt-autosave.js', array('ee-serialize-full-array', 'event_editor_js'), EVENT_ESPRESSO_VERSION, TRUE );
         wp_enqueue_script('cpt-autosave');/**/ //todo re-enable when we start doing autosave again in 4.2
 
-        //filter _autosave_containers
-        $containers = apply_filters('FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers',
-            $this->_autosave_containers, $this);
-        $containers = apply_filters('FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers',
-            $containers, $this);
-
-        wp_localize_script('event_editor_js', 'EE_AUTOSAVE_IDS',
-            $containers); //todo once we enable autosaves, this needs to be switched to localize with "cpt-autosave"
-
-        $unsaved_data_msg = array(
-            'eventmsg'     => sprintf(__("The changes you made to this %s will be lost if you navigate away from this page.",
-                'event_espresso'), $this->_cpt_object->labels->singular_name),
-            'inputChanged' => 0,
-        );
-        wp_localize_script('event_editor_js', 'UNSAVED_DATA_MSG', $unsaved_data_msg);
-    }
-
-
-
-    public function load_page_dependencies()
-    {
-        try {
-            $this->_load_page_dependencies();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-
-    /**
-     * overloading the EE_Admin_Page parent load_page_dependencies so we can get the cpt stuff added in appropriately
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _load_page_dependencies()
-    {
-        //we only add stuff if this is a cpt_route!
-        if ( ! $this->_cpt_route) {
-            parent::_load_page_dependencies();
-            return;
-        }
-        //now let's do some automatic filters into the wp_system and we'll check to make sure the CHILD class automatically has the required methods in place.
-        //the following filters are for setting all the redirects on DEFAULT WP custom post type actions
-        //let's add a hidden input to the post-edit form so we know when we have to trigger our custom redirects!  Otherwise the redirects will happen on ALL post saves which wouldn't be good of course!
-        add_action('edit_form_after_title', array($this, 'cpt_post_form_hidden_input'));
-        //inject our Admin page nav tabs...
-        //let's make sure the nav tabs are set if they aren't already
-        //if ( empty( $this->_nav_tabs ) ) $this->_set_nav_tabs();
-        add_action('post_edit_form_tag', array($this, 'inject_nav_tabs'));
-        //modify the post_updated messages array
-        add_action('post_updated_messages', array($this, 'post_update_messages'), 10);
-        //add shortlink button to cpt edit screens.  We can do this as a universal thing BECAUSE, cpts use the same format for shortlinks as posts!
-        add_filter('pre_get_shortlink', array($this, 'add_shortlink_button_to_editor'), 10, 4);
-        //This basically allows us to change the title of the "publish" metabox area on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class.
-        if ( ! empty($this->_labels['publishbox'])) {
-            $box_label = is_array($this->_labels['publishbox'])
-                         && isset($this->_labels['publishbox'][$this->_req_action])
-                ? $this->_labels['publishbox'][$this->_req_action] : $this->_labels['publishbox'];
-            remove_meta_box('submitdiv', __('Publish'), 'post_submit_meta_box', $this->_cpt_routes[$this->_req_action],
-                'side', 'core');
-            add_meta_box('submitdiv', $box_label, 'post_submit_meta_box', $this->_cpt_routes[$this->_req_action],
-                'side', 'core');
-        }
-        //let's add page_templates metabox if this cpt added support for it.
-        if ($this->_supports_page_templates($this->_cpt_object->name)) {
-            add_meta_box('page_templates', __('Page Template', 'event_espresso'),
-                array($this, 'page_template_meta_box'), $this->_cpt_routes[$this->_req_action], 'side', 'default');
-        }
-        //this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form
-        if (method_exists($this, 'extra_permalink_field_buttons')) {
-            add_filter('get_sample_permalink_html', array($this, 'extra_permalink_field_buttons'), 10, 4);
-        }
-        //add preview button
-        add_filter('get_sample_permalink_html', array($this, 'preview_button_html'), 5, 4);
-        //insert our own post_stati dropdown
-        add_action('post_submitbox_misc_actions', array($this, 'custom_post_stati_dropdown'), 10);
-        //This allows adding additional information to the publish post submitbox on the wp post edit form
-        if (method_exists($this, 'extra_misc_actions_publish_box')) {
-            add_action('post_submitbox_misc_actions', array($this, 'extra_misc_actions_publish_box'), 10);
-        }
-        //This allows for adding additional stuff after the title field on the wp post edit form.  This is also before the wp_editor for post description field.
-        if (method_exists($this, 'edit_form_after_title')) {
-            add_action('edit_form_after_title', array($this, 'edit_form_after_title'), 10);
-        }
-        /**
-         * Filtering WP's esc_url to capture urls pointing to core wp routes so they point to our route.
-         */
-        add_filter('clean_url', array($this, 'switch_core_wp_urls_with_ours'), 10, 3);
-        parent::_load_page_dependencies();
-        //notice we are ALSO going to load the pagenow hook set for this route (see _before_page_setup for the reset of the pagenow global ). This is for any plugins that are doing things properly and hooking into the load page hook for core wp cpt routes.
-        global $pagenow;
-        do_action('load-' . $pagenow);
-        $this->modify_current_screen();
-        add_action('admin_enqueue_scripts', array($this, 'setup_autosave_hooks'), 30);
-        //we route REALLY early.
-        try {
-            $this->_route_admin_request();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-
-    /**
-     * Since we don't want users going to default core wp routes, this will check any wp urls run through the
-     * esc_url() method and if we see a url matching a pattern for our routes, we'll modify it to point to OUR
-     * route instead.
-     *
-     * @param string $good_protocol_url The escaped url.
-     * @param string $original_url      The original url.
-     * @param string $_context          The context sendt to the esc_url method.
-     * @return string possibly a new url for our route.
-     */
-    public function switch_core_wp_urls_with_ours($good_protocol_url, $original_url, $_context)
-    {
-        $routes_to_match = array(
-            0 => array(
-                'edit.php?post_type=espresso_attendees',
-                'admin.php?page=espresso_registrations&action=contact_list',
-            ),
-            1 => array(
-                'edit.php?post_type=' . $this->_cpt_object->name,
-                'admin.php?page=' . $this->_cpt_object->name,
-            ),
-        );
-        foreach ($routes_to_match as $route_matches) {
-            if (strpos($good_protocol_url, $route_matches[0]) !== false) {
-                return str_replace($route_matches[0], $route_matches[1], $good_protocol_url);
-            }
-        }
-        return $good_protocol_url;
-    }
-
-
-
-    /**
-     * Determine whether the current cpt supports page templates or not.
-     *
-     * @since %VER%
-     * @param string $cpt_name The cpt slug we're checking on.
-     * @return bool True supported, false not.
-     */
-    private function _supports_page_templates($cpt_name)
-    {
-
-        $cpt_args = EE_Register_CPTs::get_CPTs();
-        $cpt_args = isset($cpt_args[$cpt_name]) ? $cpt_args[$cpt_name]['args'] : array();
-        $cpt_has_support = ! empty($cpt_args['page_templates']);
-
-        //if the installed version of WP is > 4.7 we do some additional checks.
-        if (EE_Recommended_Versions::check_wp_version('4.7','>=')) {
-            $post_templates = wp_get_theme()->get_post_templates();
-            //if there are $post_templates for this cpt, then we return false for this method because
-            //that means we aren't going to load our page template manager and leave that up to the native
-            //cpt template manager.
-            $cpt_has_support = ! isset($post_templates[$cpt_name]) ? $cpt_has_support : false;
-        }
-
-        return $cpt_has_support;
-    }
-
-
-    /**
-     * Callback for the page_templates metabox selector.
-     *
-     * @since %VER%
-     * @return string html
-     */
-    public function page_template_meta_box()
-    {
-        global $post;
-        $template = '';
-
-        if (EE_Recommended_Versions::check_wp_version('4.7','>=')) {
-            $page_template_count = count(get_page_templates());
-        } else {
-            $page_template_count = count(get_page_templates($post));
-        };
-
-        if ($page_template_count) {
-            $page_template = get_post_meta($post->ID, '_wp_page_template', true);
-            $template      = ! empty($page_template) ? $page_template : '';
-        }
-        ?>
+		//filter _autosave_containers
+		$containers = apply_filters('FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers',
+			$this->_autosave_containers, $this);
+		$containers = apply_filters('FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers',
+			$containers, $this);
+
+		wp_localize_script('event_editor_js', 'EE_AUTOSAVE_IDS',
+			$containers); //todo once we enable autosaves, this needs to be switched to localize with "cpt-autosave"
+
+		$unsaved_data_msg = array(
+			'eventmsg'     => sprintf(__("The changes you made to this %s will be lost if you navigate away from this page.",
+				'event_espresso'), $this->_cpt_object->labels->singular_name),
+			'inputChanged' => 0,
+		);
+		wp_localize_script('event_editor_js', 'UNSAVED_DATA_MSG', $unsaved_data_msg);
+	}
+
+
+
+	public function load_page_dependencies()
+	{
+		try {
+			$this->_load_page_dependencies();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+
+	/**
+	 * overloading the EE_Admin_Page parent load_page_dependencies so we can get the cpt stuff added in appropriately
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _load_page_dependencies()
+	{
+		//we only add stuff if this is a cpt_route!
+		if ( ! $this->_cpt_route) {
+			parent::_load_page_dependencies();
+			return;
+		}
+		//now let's do some automatic filters into the wp_system and we'll check to make sure the CHILD class automatically has the required methods in place.
+		//the following filters are for setting all the redirects on DEFAULT WP custom post type actions
+		//let's add a hidden input to the post-edit form so we know when we have to trigger our custom redirects!  Otherwise the redirects will happen on ALL post saves which wouldn't be good of course!
+		add_action('edit_form_after_title', array($this, 'cpt_post_form_hidden_input'));
+		//inject our Admin page nav tabs...
+		//let's make sure the nav tabs are set if they aren't already
+		//if ( empty( $this->_nav_tabs ) ) $this->_set_nav_tabs();
+		add_action('post_edit_form_tag', array($this, 'inject_nav_tabs'));
+		//modify the post_updated messages array
+		add_action('post_updated_messages', array($this, 'post_update_messages'), 10);
+		//add shortlink button to cpt edit screens.  We can do this as a universal thing BECAUSE, cpts use the same format for shortlinks as posts!
+		add_filter('pre_get_shortlink', array($this, 'add_shortlink_button_to_editor'), 10, 4);
+		//This basically allows us to change the title of the "publish" metabox area on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class.
+		if ( ! empty($this->_labels['publishbox'])) {
+			$box_label = is_array($this->_labels['publishbox'])
+						 && isset($this->_labels['publishbox'][$this->_req_action])
+				? $this->_labels['publishbox'][$this->_req_action] : $this->_labels['publishbox'];
+			remove_meta_box('submitdiv', __('Publish'), 'post_submit_meta_box', $this->_cpt_routes[$this->_req_action],
+				'side', 'core');
+			add_meta_box('submitdiv', $box_label, 'post_submit_meta_box', $this->_cpt_routes[$this->_req_action],
+				'side', 'core');
+		}
+		//let's add page_templates metabox if this cpt added support for it.
+		if ($this->_supports_page_templates($this->_cpt_object->name)) {
+			add_meta_box('page_templates', __('Page Template', 'event_espresso'),
+				array($this, 'page_template_meta_box'), $this->_cpt_routes[$this->_req_action], 'side', 'default');
+		}
+		//this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form
+		if (method_exists($this, 'extra_permalink_field_buttons')) {
+			add_filter('get_sample_permalink_html', array($this, 'extra_permalink_field_buttons'), 10, 4);
+		}
+		//add preview button
+		add_filter('get_sample_permalink_html', array($this, 'preview_button_html'), 5, 4);
+		//insert our own post_stati dropdown
+		add_action('post_submitbox_misc_actions', array($this, 'custom_post_stati_dropdown'), 10);
+		//This allows adding additional information to the publish post submitbox on the wp post edit form
+		if (method_exists($this, 'extra_misc_actions_publish_box')) {
+			add_action('post_submitbox_misc_actions', array($this, 'extra_misc_actions_publish_box'), 10);
+		}
+		//This allows for adding additional stuff after the title field on the wp post edit form.  This is also before the wp_editor for post description field.
+		if (method_exists($this, 'edit_form_after_title')) {
+			add_action('edit_form_after_title', array($this, 'edit_form_after_title'), 10);
+		}
+		/**
+		 * Filtering WP's esc_url to capture urls pointing to core wp routes so they point to our route.
+		 */
+		add_filter('clean_url', array($this, 'switch_core_wp_urls_with_ours'), 10, 3);
+		parent::_load_page_dependencies();
+		//notice we are ALSO going to load the pagenow hook set for this route (see _before_page_setup for the reset of the pagenow global ). This is for any plugins that are doing things properly and hooking into the load page hook for core wp cpt routes.
+		global $pagenow;
+		do_action('load-' . $pagenow);
+		$this->modify_current_screen();
+		add_action('admin_enqueue_scripts', array($this, 'setup_autosave_hooks'), 30);
+		//we route REALLY early.
+		try {
+			$this->_route_admin_request();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+
+	/**
+	 * Since we don't want users going to default core wp routes, this will check any wp urls run through the
+	 * esc_url() method and if we see a url matching a pattern for our routes, we'll modify it to point to OUR
+	 * route instead.
+	 *
+	 * @param string $good_protocol_url The escaped url.
+	 * @param string $original_url      The original url.
+	 * @param string $_context          The context sendt to the esc_url method.
+	 * @return string possibly a new url for our route.
+	 */
+	public function switch_core_wp_urls_with_ours($good_protocol_url, $original_url, $_context)
+	{
+		$routes_to_match = array(
+			0 => array(
+				'edit.php?post_type=espresso_attendees',
+				'admin.php?page=espresso_registrations&action=contact_list',
+			),
+			1 => array(
+				'edit.php?post_type=' . $this->_cpt_object->name,
+				'admin.php?page=' . $this->_cpt_object->name,
+			),
+		);
+		foreach ($routes_to_match as $route_matches) {
+			if (strpos($good_protocol_url, $route_matches[0]) !== false) {
+				return str_replace($route_matches[0], $route_matches[1], $good_protocol_url);
+			}
+		}
+		return $good_protocol_url;
+	}
+
+
+
+	/**
+	 * Determine whether the current cpt supports page templates or not.
+	 *
+	 * @since %VER%
+	 * @param string $cpt_name The cpt slug we're checking on.
+	 * @return bool True supported, false not.
+	 */
+	private function _supports_page_templates($cpt_name)
+	{
+
+		$cpt_args = EE_Register_CPTs::get_CPTs();
+		$cpt_args = isset($cpt_args[$cpt_name]) ? $cpt_args[$cpt_name]['args'] : array();
+		$cpt_has_support = ! empty($cpt_args['page_templates']);
+
+		//if the installed version of WP is > 4.7 we do some additional checks.
+		if (EE_Recommended_Versions::check_wp_version('4.7','>=')) {
+			$post_templates = wp_get_theme()->get_post_templates();
+			//if there are $post_templates for this cpt, then we return false for this method because
+			//that means we aren't going to load our page template manager and leave that up to the native
+			//cpt template manager.
+			$cpt_has_support = ! isset($post_templates[$cpt_name]) ? $cpt_has_support : false;
+		}
+
+		return $cpt_has_support;
+	}
+
+
+	/**
+	 * Callback for the page_templates metabox selector.
+	 *
+	 * @since %VER%
+	 * @return string html
+	 */
+	public function page_template_meta_box()
+	{
+		global $post;
+		$template = '';
+
+		if (EE_Recommended_Versions::check_wp_version('4.7','>=')) {
+			$page_template_count = count(get_page_templates());
+		} else {
+			$page_template_count = count(get_page_templates($post));
+		};
+
+		if ($page_template_count) {
+			$page_template = get_post_meta($post->ID, '_wp_page_template', true);
+			$template      = ! empty($page_template) ? $page_template : '';
+		}
+		?>
         <p><strong><?php _e('Template') ?></strong></p>
         <label class="screen-reader-text" for="page_template"><?php _e('Page Template') ?></label><select
             name="page_template" id="page_template">
@@ -470,437 +470,437 @@ 
         <?php page_template_dropdown($template); ?>
     </select>
         <?php
-    }
-
-
-
-    /**
-     * if this post is a draft or scheduled post then we provide a preview button for user to click
-     * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
-     *
-     * @param  string $return    the current html
-     * @param  int    $id        the post id for the page
-     * @param  string $new_title What the title is
-     * @param  string $new_slug  what the slug is
-     * @return string            The new html string for the permalink area
-     */
-    public function preview_button_html($return, $id, $new_title, $new_slug)
-    {
-        $post = get_post($id);
-        if ('publish' != get_post_status($post)) {
-            //include shims for the `get_preview_post_link` function
-            require_once( EE_CORE . 'wordpress-shims.php' );
-            $return .= '<span_id="view-post-btn"><a target="_blank" href="'
-                       . get_preview_post_link($id)
-                       . '" class="button button-small">'
-                       . __('Preview', 'event_espresso')
-                       . '</a></span>'
-                       . "\n";
-        }
-        return $return;
-    }
-
-
-
-    /**
-     * add our custom post stati dropdown on the wp post page for this cpt
-     *
-     * @return string html for dropdown
-     */
-    public function custom_post_stati_dropdown()
-    {
-
-        $statuses         = $this->_cpt_model_obj->get_custom_post_statuses();
-        $cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses)
-            ? $statuses[$this->_cpt_model_obj->status()]
-            : '';
-        $template_args    = array(
-            'cur_status'            => $this->_cpt_model_obj->status(),
-            'statuses'              => $statuses,
-            'cur_status_label'      => $cur_status_label,
-            'localized_status_save' => sprintf(__('Save %s', 'event_espresso'), $cur_status_label),
-        );
-        //we'll add a trash post status (WP doesn't add one for some reason)
-        if ($this->_cpt_model_obj->status() == 'trash') {
-            $template_args['cur_status_label'] = __('Trashed', 'event_espresso');
-            $statuses['trash']                 = __('Trashed', 'event_espresso');
-            $template_args['statuses']         = $statuses;
-        }
-
-        $template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-
-    public function setup_autosave_hooks()
-    {
-        $this->_set_autosave_containers();
-        $this->_load_autosave_scripts_styles();
-    }
-
-
-
-    /**
-     * This is run on all WordPress autosaves AFTER the autosave is complete and sends along a $_POST object (available
-     * in $this->_req_data) containing: post_ID of the saved post autosavenonce for the saved post We'll do the check
-     * for the nonce in here, but then this method looks for two things:
-     * 1. Execute a method (if exists) matching 'ee_autosave_' and appended with the given route. OR
-     * 2. do_actions() for global or class specific actions that have been registered (for plugins/addons not in an
-     * EE_Admin_Page class. PLEASE NOTE: Data will be returned using the _return_json() object and so the
-     * $_template_args property should be used to hold the $data array.  We're expecting the following things set in
-     * template args.
-     *    1. $template_args['error'] = IF there is an error you can add the message in here.
-     *    2. $template_args['data']['items'] = an array of items that are setup in key index pairs of 'where_values_go'
-     *    => 'values_to_add'.  In other words, for the datetime metabox we'll have something like
-     *    $this->_template_args['data']['items'] = array(
-     *        'event-datetime-ids' => '1,2,3';
-     *    );
-     *    Keep in mind the following things:
-     *    - "where" index is for the input with the id as that string.
-     *    - "what" index is what will be used for the value of that input.
-     *
-     * @return void
-     */
-    public function do_extra_autosave_stuff()
-    {
-        //next let's check for the autosave nonce (we'll use _verify_nonce )
-        $nonce = isset($this->_req_data['autosavenonce']) ? $this->_req_data['autosavenonce'] : null;
-        $this->_verify_nonce($nonce, 'autosave');
-        //make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it)
-        if ( ! defined('DOING_AUTOSAVE')) {
-            define('DOING_AUTOSAVE', true);
-        }
-        //if we made it here then the nonce checked out.  Let's run our methods and actions
-        if (method_exists($this, '_ee_autosave_' . $this->_current_view)) {
-            call_user_func(array($this, '_ee_autosave_' . $this->_current_view));
-        } else {
-            $this->_template_args['success'] = true;
-        }
-        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this);
-        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this);
-        //now let's return json
-        $this->_return_json();
-    }
-
-
-
-    /**
-     * This takes care of setting up default routes and pages that utilize the core WP admin pages.
-     * Child classes can override the defaults (in cases for adding metaboxes etc.)
-     * but take care that you include the defaults here otherwise your core WP admin pages for the cpt won't work!
-     *
-     * @access protected
-     * @throws EE_Error
-     * @return void
-     */
-    protected function _extend_page_config_for_cpt()
-    {
-        //before doing anything we need to make sure this runs ONLY when the loaded page matches the set page_slug
-        if ((isset($this->_req_data['page']) && $this->_req_data['page'] != $this->page_slug)) {
-            return;
-        }
-        //set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes
-        if ( ! empty($this->_cpt_object)) {
-            $this->_page_routes = array_merge(array(
-                'create_new' => '_create_new_cpt_item',
-                'edit'       => '_edit_cpt_item',
-            ), $this->_page_routes);
-            $this->_page_config = array_merge(array(
-                'create_new' => array(
-                    'nav'           => array(
-                        'label' => $this->_cpt_object->labels->add_new_item,
-                        'order' => 5,
-                    ),
-                    'require_nonce' => false,
-                ),
-                'edit'       => array(
-                    'nav'           => array(
-                        'label'      => $this->_cpt_object->labels->edit_item,
-                        'order'      => 5,
-                        'persistent' => false,
-                        'url'        => '',
-                    ),
-                    'require_nonce' => false,
-                ),
-            ),
-                $this->_page_config
-            );
-        }
-        //load the next section only if this is a matching cpt route as set in the cpt routes array.
-        if ( ! isset($this->_cpt_routes[$this->_req_action])) {
-            return;
-        }
-        $this->_cpt_route = isset($this->_cpt_routes[$this->_req_action]) ? true : false;
-        //add_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', array( $this, 'modify_current_screen') );
-        if (empty($this->_cpt_object)) {
-            $msg = sprintf(__('This page has been set as being related to a registered custom post type, however, the custom post type object could not be retrieved. There are two possible reasons for this:  1. The "%s" does not match a registered post type. or 2. The custom post type is not registered for the "%s" action as indexed in the "$_cpt_routes" property on this class (%s).'),
-                $this->page_slug, $this->_req_action, get_class($this));
-            throw new EE_Error($msg);
-        }
-        if ($this->_cpt_route) {
-            $id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
-            $this->_set_model_object($id);
-        }
-    }
-
-
-
-    /**
-     * Sets the _cpt_model_object property using what has been set for the _cpt_model_name and a given id.
-     *
-     * @access protected
-     * @param int  $id The id to retrieve the model object for. If empty we set a default object.
-     * @param bool $ignore_route_check
-     */
-    protected function _set_model_object($id = null, $ignore_route_check = false)
-    {
-        $model = null;
-        if (
-            empty($this->_cpt_model_names)
-            || (
-                ! $ignore_route_check
-                && ! isset($this->_cpt_routes[$this->_req_action])
-            ) || (
-                $this->_cpt_model_obj instanceof EE_CPT_Base
-                && $this->_cpt_model_obj->ID() === $id
-            )
-        ) {
-            //get out cuz we either don't have a model name OR the object has already been set and it has the same id as what has been sent.
-            return;
-        }
-        //if ignore_route_check is true, then get the model name via EE_Register_CPTs
-        if ($ignore_route_check) {
-            $model_names = EE_Register_CPTs::get_cpt_model_names();
-            $post_type   = get_post_type($id);
-            if (isset($model_names[$post_type])) {
-                $model = EE_Registry::instance()->load_model($model_names[$post_type]);
-            }
-        } else {
-            $model = EE_Registry::instance()->load_model($this->_cpt_model_names[$this->_req_action]);
-        }
-        if ($model instanceof EEM_Base) {
-            $this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object();
-        }
-        do_action('AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object');
-    }
-
-
-
-    /**
-     * admin_init_global
-     * This runs all the code that we want executed within the WP admin_init hook.
-     * This method executes for ALL EE Admin pages.
-     *
-     * @access public
-     * @return void
-     */
-    public function admin_init_global()
-    {
-        $post = isset($this->_req_data['post']) ? get_post($this->_req_data['post']) : null;
-        //its possible this is a new save so let's catch that instead
-        $post = isset($this->_req_data['post_ID']) ? get_post($this->_req_data['post_ID']) : $post;
-        $post_type = $post ? $post->post_type : false;
-        $current_route = isset($this->_req_data['current_route']) ? $this->_req_data['current_route']
-            : 'shouldneverwork';
-        $route_to_check = $post_type && isset($this->_cpt_routes[$current_route]) ? $this->_cpt_routes[$current_route]
-            : '';
-        add_filter('get_delete_post_link', array($this, 'modify_delete_post_link'), 10, 3);
-        add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 3);
-        if ($post_type === $route_to_check) {
-            add_filter('redirect_post_location', array($this, 'cpt_post_location_redirect'), 10, 2);
-            //catch trashed wp redirect
-            add_filter('wp_redirect', array($this, 'cpt_trash_post_location_redirect'), 10, 2);
-        }
-        //now let's filter redirect if we're on a revision page and the revision is for an event CPT.
-        $revision = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null;
-        if ( ! empty($revision)) {
-            $action = isset($this->_req_data['action']) ? $this->_req_data['action'] : null;
-            //doing a restore?
-            if ( ! empty($action) && $action == 'restore') {
-                //get post for revision
-                $rev_post = get_post($revision);
-                $rev_parent = get_post($rev_post->post_parent);
-                //only do our redirect filter AND our restore revision action if the post_type for the parent is one of our cpts.
-                if ($rev_parent && $rev_parent->post_type == $this->page_slug) {
-                    add_filter('wp_redirect', array($this, 'revision_redirect'), 10, 2);
-                    //restores of revisions
-                    add_action('wp_restore_post_revision', array($this, 'restore_revision'), 10, 2);
-                }
-            }
-        }
-        //NOTE we ONLY want to run these hooks if we're on the right class for the given post type.  Otherwise we could see some really freaky things happen!
-        if ($post_type && $post_type === $route_to_check) {
-            //$post_id, $post
-            add_action('save_post', array($this, 'insert_update'), 10, 3);
-            //$post_id
-            add_action('trashed_post', array($this, 'before_trash_cpt_item'), 10);
-            add_action('trashed_post', array($this, 'dont_permanently_delete_ee_cpts'), 10);
-            add_action('untrashed_post', array($this, 'before_restore_cpt_item'), 10);
-            add_action('after_delete_post', array($this, 'before_delete_cpt_item'), 10);
-        }
-    }
-
-
-
-    /**
-     * Callback for the WordPress trashed_post hook.
-     * Execute some basic checks before calling the trash_cpt_item declared in the child class.
-     *
-     * @param int $post_id
-     */
-    public function before_trash_cpt_item($post_id)
-    {
-        $this->_set_model_object($post_id, true);
-        //if our cpt object isn't existent then get out immediately.
-        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->trash_cpt_item($post_id);
-    }
-
-
-
-    /**
-     * Callback for the WordPress untrashed_post hook.
-     * Execute some basic checks before calling the restore_cpt_method in the child class.
-     *
-     * @param $post_id
-     */
-    public function before_restore_cpt_item($post_id)
-    {
-        $this->_set_model_object($post_id, true);
-        //if our cpt object isn't existent then get out immediately.
-        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->restore_cpt_item($post_id);
-    }
-
-
-
-    /**
-     * Callback for the WordPress after_delete_post hook.
-     * Execute some basic checks before calling the delete_cpt_item method in the child class.
-     *
-     * @param $post_id
-     */
-    public function before_delete_cpt_item($post_id)
-    {
-        $this->_set_model_object($post_id, true);
-        //if our cpt object isn't existent then get out immediately.
-        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->delete_cpt_item($post_id);
-    }
-
-
-
-    /**
-     * This simply verifies if the cpt_model_object is instantiated for the given page and throws an error message
-     * accordingly.
-     *
-     * @access public
-     * @throws EE_Error
-     * @return void
-     */
-    public function verify_cpt_object()
-    {
-        $label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label;
-        // verify event object
-        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) {
-            throw new EE_Error(sprintf(__('Something has gone wrong with the page load because we are unable to set up the object for the %1$s.  This usually happens when the given id for the page route is NOT for the correct custom post type for this page',
-                'event_espresso'), $label));
-        }
-        //if auto-draft then throw an error
-        if ($this->_cpt_model_obj->get('status') == 'auto-draft') {
-            EE_Error::overwrite_errors();
-            EE_Error::add_error(sprintf(__('This %1$s was saved without a title, description, or excerpt which means that none of the extra details you added were saved properly.  All autodrafts will show up in the "draft" view of your event list table.  You can delete them from there. Please click the "Add %1$s" button to refresh and restart.'),
-                $label), __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-
-    /**
-     * admin_footer_scripts_global
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
-     * will apply on ALL EE_Admin pages.
-     *
-     * @access public
-     * @return void
-     */
-    public function admin_footer_scripts_global()
-    {
-        $this->_add_admin_page_ajax_loading_img();
-        $this->_add_admin_page_overlay();
-    }
-
-
-
-    /**
-     * add in any global scripts for cpt routes
-     *
-     * @return void
-     */
-    public function load_global_scripts_styles()
-    {
-        parent::load_global_scripts_styles();
-        if ($this->_cpt_model_obj instanceof EE_CPT_Base) {
-            //setup custom post status object for localize script but only if we've got a cpt object
-            $statuses = $this->_cpt_model_obj->get_custom_post_statuses();
-            if ( ! empty($statuses)) {
-                //get ALL statuses!
-                $statuses = $this->_cpt_model_obj->get_all_post_statuses();
-                //setup object
-                $ee_cpt_statuses = array();
-                foreach ($statuses as $status => $label) {
-                    $ee_cpt_statuses[$status] = array(
-                        'label'      => $label,
-                        'save_label' => sprintf(__('Save as %s', 'event_espresso'), $label),
-                    );
-                }
-                wp_localize_script('ee_admin_js', 'eeCPTstatuses', $ee_cpt_statuses);
-            }
-        }
-    }
-
-
-
-    /**
-     * This is a wrapper for the insert/update routes for cpt items so we can add things that are common to ALL
-     * insert/updates
-     *
-     * @param  int     $post_id ID of post being updated
-     * @param  WP_Post $post    Post object from WP
-     * @param  bool    $update  Whether this is an update or a new save.
-     * @return void
-     */
-    public function insert_update($post_id, $post, $update)
-    {
-        //make sure that if this is a revision OR trash action that we don't do any updates!
-        if (
-            isset($this->_req_data['action'])
-            && (
-                $this->_req_data['action'] == 'restore'
-                || $this->_req_data['action'] == 'trash'
-            )
-        ) {
-            return;
-        }
-        $this->_set_model_object($post_id, true);
-        //if our cpt object is not instantiated and its NOT the same post_id as what is triggering this callback, then exit.
-        if ($update
-            && (
-                ! $this->_cpt_model_obj instanceof EE_CPT_Base
-                || $this->_cpt_model_obj->ID() !== $post_id
-            )
-        ) {
-            return;
-        }
-        //check for autosave and update our req_data property accordingly.
-        /*if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE && isset( $this->_req_data['ee_autosave_data'] ) ) {
+	}
+
+
+
+	/**
+	 * if this post is a draft or scheduled post then we provide a preview button for user to click
+	 * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
+	 *
+	 * @param  string $return    the current html
+	 * @param  int    $id        the post id for the page
+	 * @param  string $new_title What the title is
+	 * @param  string $new_slug  what the slug is
+	 * @return string            The new html string for the permalink area
+	 */
+	public function preview_button_html($return, $id, $new_title, $new_slug)
+	{
+		$post = get_post($id);
+		if ('publish' != get_post_status($post)) {
+			//include shims for the `get_preview_post_link` function
+			require_once( EE_CORE . 'wordpress-shims.php' );
+			$return .= '<span_id="view-post-btn"><a target="_blank" href="'
+					   . get_preview_post_link($id)
+					   . '" class="button button-small">'
+					   . __('Preview', 'event_espresso')
+					   . '</a></span>'
+					   . "\n";
+		}
+		return $return;
+	}
+
+
+
+	/**
+	 * add our custom post stati dropdown on the wp post page for this cpt
+	 *
+	 * @return string html for dropdown
+	 */
+	public function custom_post_stati_dropdown()
+	{
+
+		$statuses         = $this->_cpt_model_obj->get_custom_post_statuses();
+		$cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses)
+			? $statuses[$this->_cpt_model_obj->status()]
+			: '';
+		$template_args    = array(
+			'cur_status'            => $this->_cpt_model_obj->status(),
+			'statuses'              => $statuses,
+			'cur_status_label'      => $cur_status_label,
+			'localized_status_save' => sprintf(__('Save %s', 'event_espresso'), $cur_status_label),
+		);
+		//we'll add a trash post status (WP doesn't add one for some reason)
+		if ($this->_cpt_model_obj->status() == 'trash') {
+			$template_args['cur_status_label'] = __('Trashed', 'event_espresso');
+			$statuses['trash']                 = __('Trashed', 'event_espresso');
+			$template_args['statuses']         = $statuses;
+		}
+
+		$template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+
+	public function setup_autosave_hooks()
+	{
+		$this->_set_autosave_containers();
+		$this->_load_autosave_scripts_styles();
+	}
+
+
+
+	/**
+	 * This is run on all WordPress autosaves AFTER the autosave is complete and sends along a $_POST object (available
+	 * in $this->_req_data) containing: post_ID of the saved post autosavenonce for the saved post We'll do the check
+	 * for the nonce in here, but then this method looks for two things:
+	 * 1. Execute a method (if exists) matching 'ee_autosave_' and appended with the given route. OR
+	 * 2. do_actions() for global or class specific actions that have been registered (for plugins/addons not in an
+	 * EE_Admin_Page class. PLEASE NOTE: Data will be returned using the _return_json() object and so the
+	 * $_template_args property should be used to hold the $data array.  We're expecting the following things set in
+	 * template args.
+	 *    1. $template_args['error'] = IF there is an error you can add the message in here.
+	 *    2. $template_args['data']['items'] = an array of items that are setup in key index pairs of 'where_values_go'
+	 *    => 'values_to_add'.  In other words, for the datetime metabox we'll have something like
+	 *    $this->_template_args['data']['items'] = array(
+	 *        'event-datetime-ids' => '1,2,3';
+	 *    );
+	 *    Keep in mind the following things:
+	 *    - "where" index is for the input with the id as that string.
+	 *    - "what" index is what will be used for the value of that input.
+	 *
+	 * @return void
+	 */
+	public function do_extra_autosave_stuff()
+	{
+		//next let's check for the autosave nonce (we'll use _verify_nonce )
+		$nonce = isset($this->_req_data['autosavenonce']) ? $this->_req_data['autosavenonce'] : null;
+		$this->_verify_nonce($nonce, 'autosave');
+		//make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it)
+		if ( ! defined('DOING_AUTOSAVE')) {
+			define('DOING_AUTOSAVE', true);
+		}
+		//if we made it here then the nonce checked out.  Let's run our methods and actions
+		if (method_exists($this, '_ee_autosave_' . $this->_current_view)) {
+			call_user_func(array($this, '_ee_autosave_' . $this->_current_view));
+		} else {
+			$this->_template_args['success'] = true;
+		}
+		do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this);
+		do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this);
+		//now let's return json
+		$this->_return_json();
+	}
+
+
+
+	/**
+	 * This takes care of setting up default routes and pages that utilize the core WP admin pages.
+	 * Child classes can override the defaults (in cases for adding metaboxes etc.)
+	 * but take care that you include the defaults here otherwise your core WP admin pages for the cpt won't work!
+	 *
+	 * @access protected
+	 * @throws EE_Error
+	 * @return void
+	 */
+	protected function _extend_page_config_for_cpt()
+	{
+		//before doing anything we need to make sure this runs ONLY when the loaded page matches the set page_slug
+		if ((isset($this->_req_data['page']) && $this->_req_data['page'] != $this->page_slug)) {
+			return;
+		}
+		//set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes
+		if ( ! empty($this->_cpt_object)) {
+			$this->_page_routes = array_merge(array(
+				'create_new' => '_create_new_cpt_item',
+				'edit'       => '_edit_cpt_item',
+			), $this->_page_routes);
+			$this->_page_config = array_merge(array(
+				'create_new' => array(
+					'nav'           => array(
+						'label' => $this->_cpt_object->labels->add_new_item,
+						'order' => 5,
+					),
+					'require_nonce' => false,
+				),
+				'edit'       => array(
+					'nav'           => array(
+						'label'      => $this->_cpt_object->labels->edit_item,
+						'order'      => 5,
+						'persistent' => false,
+						'url'        => '',
+					),
+					'require_nonce' => false,
+				),
+			),
+				$this->_page_config
+			);
+		}
+		//load the next section only if this is a matching cpt route as set in the cpt routes array.
+		if ( ! isset($this->_cpt_routes[$this->_req_action])) {
+			return;
+		}
+		$this->_cpt_route = isset($this->_cpt_routes[$this->_req_action]) ? true : false;
+		//add_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', array( $this, 'modify_current_screen') );
+		if (empty($this->_cpt_object)) {
+			$msg = sprintf(__('This page has been set as being related to a registered custom post type, however, the custom post type object could not be retrieved. There are two possible reasons for this:  1. The "%s" does not match a registered post type. or 2. The custom post type is not registered for the "%s" action as indexed in the "$_cpt_routes" property on this class (%s).'),
+				$this->page_slug, $this->_req_action, get_class($this));
+			throw new EE_Error($msg);
+		}
+		if ($this->_cpt_route) {
+			$id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
+			$this->_set_model_object($id);
+		}
+	}
+
+
+
+	/**
+	 * Sets the _cpt_model_object property using what has been set for the _cpt_model_name and a given id.
+	 *
+	 * @access protected
+	 * @param int  $id The id to retrieve the model object for. If empty we set a default object.
+	 * @param bool $ignore_route_check
+	 */
+	protected function _set_model_object($id = null, $ignore_route_check = false)
+	{
+		$model = null;
+		if (
+			empty($this->_cpt_model_names)
+			|| (
+				! $ignore_route_check
+				&& ! isset($this->_cpt_routes[$this->_req_action])
+			) || (
+				$this->_cpt_model_obj instanceof EE_CPT_Base
+				&& $this->_cpt_model_obj->ID() === $id
+			)
+		) {
+			//get out cuz we either don't have a model name OR the object has already been set and it has the same id as what has been sent.
+			return;
+		}
+		//if ignore_route_check is true, then get the model name via EE_Register_CPTs
+		if ($ignore_route_check) {
+			$model_names = EE_Register_CPTs::get_cpt_model_names();
+			$post_type   = get_post_type($id);
+			if (isset($model_names[$post_type])) {
+				$model = EE_Registry::instance()->load_model($model_names[$post_type]);
+			}
+		} else {
+			$model = EE_Registry::instance()->load_model($this->_cpt_model_names[$this->_req_action]);
+		}
+		if ($model instanceof EEM_Base) {
+			$this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object();
+		}
+		do_action('AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object');
+	}
+
+
+
+	/**
+	 * admin_init_global
+	 * This runs all the code that we want executed within the WP admin_init hook.
+	 * This method executes for ALL EE Admin pages.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function admin_init_global()
+	{
+		$post = isset($this->_req_data['post']) ? get_post($this->_req_data['post']) : null;
+		//its possible this is a new save so let's catch that instead
+		$post = isset($this->_req_data['post_ID']) ? get_post($this->_req_data['post_ID']) : $post;
+		$post_type = $post ? $post->post_type : false;
+		$current_route = isset($this->_req_data['current_route']) ? $this->_req_data['current_route']
+			: 'shouldneverwork';
+		$route_to_check = $post_type && isset($this->_cpt_routes[$current_route]) ? $this->_cpt_routes[$current_route]
+			: '';
+		add_filter('get_delete_post_link', array($this, 'modify_delete_post_link'), 10, 3);
+		add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 3);
+		if ($post_type === $route_to_check) {
+			add_filter('redirect_post_location', array($this, 'cpt_post_location_redirect'), 10, 2);
+			//catch trashed wp redirect
+			add_filter('wp_redirect', array($this, 'cpt_trash_post_location_redirect'), 10, 2);
+		}
+		//now let's filter redirect if we're on a revision page and the revision is for an event CPT.
+		$revision = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null;
+		if ( ! empty($revision)) {
+			$action = isset($this->_req_data['action']) ? $this->_req_data['action'] : null;
+			//doing a restore?
+			if ( ! empty($action) && $action == 'restore') {
+				//get post for revision
+				$rev_post = get_post($revision);
+				$rev_parent = get_post($rev_post->post_parent);
+				//only do our redirect filter AND our restore revision action if the post_type for the parent is one of our cpts.
+				if ($rev_parent && $rev_parent->post_type == $this->page_slug) {
+					add_filter('wp_redirect', array($this, 'revision_redirect'), 10, 2);
+					//restores of revisions
+					add_action('wp_restore_post_revision', array($this, 'restore_revision'), 10, 2);
+				}
+			}
+		}
+		//NOTE we ONLY want to run these hooks if we're on the right class for the given post type.  Otherwise we could see some really freaky things happen!
+		if ($post_type && $post_type === $route_to_check) {
+			//$post_id, $post
+			add_action('save_post', array($this, 'insert_update'), 10, 3);
+			//$post_id
+			add_action('trashed_post', array($this, 'before_trash_cpt_item'), 10);
+			add_action('trashed_post', array($this, 'dont_permanently_delete_ee_cpts'), 10);
+			add_action('untrashed_post', array($this, 'before_restore_cpt_item'), 10);
+			add_action('after_delete_post', array($this, 'before_delete_cpt_item'), 10);
+		}
+	}
+
+
+
+	/**
+	 * Callback for the WordPress trashed_post hook.
+	 * Execute some basic checks before calling the trash_cpt_item declared in the child class.
+	 *
+	 * @param int $post_id
+	 */
+	public function before_trash_cpt_item($post_id)
+	{
+		$this->_set_model_object($post_id, true);
+		//if our cpt object isn't existent then get out immediately.
+		if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->trash_cpt_item($post_id);
+	}
+
+
+
+	/**
+	 * Callback for the WordPress untrashed_post hook.
+	 * Execute some basic checks before calling the restore_cpt_method in the child class.
+	 *
+	 * @param $post_id
+	 */
+	public function before_restore_cpt_item($post_id)
+	{
+		$this->_set_model_object($post_id, true);
+		//if our cpt object isn't existent then get out immediately.
+		if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->restore_cpt_item($post_id);
+	}
+
+
+
+	/**
+	 * Callback for the WordPress after_delete_post hook.
+	 * Execute some basic checks before calling the delete_cpt_item method in the child class.
+	 *
+	 * @param $post_id
+	 */
+	public function before_delete_cpt_item($post_id)
+	{
+		$this->_set_model_object($post_id, true);
+		//if our cpt object isn't existent then get out immediately.
+		if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->delete_cpt_item($post_id);
+	}
+
+
+
+	/**
+	 * This simply verifies if the cpt_model_object is instantiated for the given page and throws an error message
+	 * accordingly.
+	 *
+	 * @access public
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public function verify_cpt_object()
+	{
+		$label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label;
+		// verify event object
+		if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) {
+			throw new EE_Error(sprintf(__('Something has gone wrong with the page load because we are unable to set up the object for the %1$s.  This usually happens when the given id for the page route is NOT for the correct custom post type for this page',
+				'event_espresso'), $label));
+		}
+		//if auto-draft then throw an error
+		if ($this->_cpt_model_obj->get('status') == 'auto-draft') {
+			EE_Error::overwrite_errors();
+			EE_Error::add_error(sprintf(__('This %1$s was saved without a title, description, or excerpt which means that none of the extra details you added were saved properly.  All autodrafts will show up in the "draft" view of your event list table.  You can delete them from there. Please click the "Add %1$s" button to refresh and restart.'),
+				$label), __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+
+	/**
+	 * admin_footer_scripts_global
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
+	 * will apply on ALL EE_Admin pages.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function admin_footer_scripts_global()
+	{
+		$this->_add_admin_page_ajax_loading_img();
+		$this->_add_admin_page_overlay();
+	}
+
+
+
+	/**
+	 * add in any global scripts for cpt routes
+	 *
+	 * @return void
+	 */
+	public function load_global_scripts_styles()
+	{
+		parent::load_global_scripts_styles();
+		if ($this->_cpt_model_obj instanceof EE_CPT_Base) {
+			//setup custom post status object for localize script but only if we've got a cpt object
+			$statuses = $this->_cpt_model_obj->get_custom_post_statuses();
+			if ( ! empty($statuses)) {
+				//get ALL statuses!
+				$statuses = $this->_cpt_model_obj->get_all_post_statuses();
+				//setup object
+				$ee_cpt_statuses = array();
+				foreach ($statuses as $status => $label) {
+					$ee_cpt_statuses[$status] = array(
+						'label'      => $label,
+						'save_label' => sprintf(__('Save as %s', 'event_espresso'), $label),
+					);
+				}
+				wp_localize_script('ee_admin_js', 'eeCPTstatuses', $ee_cpt_statuses);
+			}
+		}
+	}
+
+
+
+	/**
+	 * This is a wrapper for the insert/update routes for cpt items so we can add things that are common to ALL
+	 * insert/updates
+	 *
+	 * @param  int     $post_id ID of post being updated
+	 * @param  WP_Post $post    Post object from WP
+	 * @param  bool    $update  Whether this is an update or a new save.
+	 * @return void
+	 */
+	public function insert_update($post_id, $post, $update)
+	{
+		//make sure that if this is a revision OR trash action that we don't do any updates!
+		if (
+			isset($this->_req_data['action'])
+			&& (
+				$this->_req_data['action'] == 'restore'
+				|| $this->_req_data['action'] == 'trash'
+			)
+		) {
+			return;
+		}
+		$this->_set_model_object($post_id, true);
+		//if our cpt object is not instantiated and its NOT the same post_id as what is triggering this callback, then exit.
+		if ($update
+			&& (
+				! $this->_cpt_model_obj instanceof EE_CPT_Base
+				|| $this->_cpt_model_obj->ID() !== $post_id
+			)
+		) {
+			return;
+		}
+		//check for autosave and update our req_data property accordingly.
+		/*if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE && isset( $this->_req_data['ee_autosave_data'] ) ) {
             foreach( (array) $this->_req_data['ee_autosave_data'] as $id => $values ) {
 
                 foreach ( (array) $values as $key => $value ) {
@@ -910,536 +910,536 @@ 
 
         }/**/ //TODO reactivate after autosave is implemented in 4.2
 
-        //take care of updating any selected page_template IF this cpt supports it.
-        if ($this->_supports_page_templates($post->post_type) && ! empty($this->_req_data['page_template'])) {
-            //wp version aware.
-            if (EE_Recommended_Versions::check_wp_version('4.7', '>=')) {
-                $page_templates = wp_get_theme()->get_page_templates();
-            } else {
-                $post->page_template = $this->_req_data['page_template'];
-                $page_templates      = wp_get_theme()->get_page_templates($post);
-            }
-            if ('default' != $this->_req_data['page_template'] && ! isset($page_templates[$this->_req_data['page_template']])) {
-                EE_Error::add_error(__('Invalid Page Template.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            } else {
-                update_post_meta($post_id, '_wp_page_template', $this->_req_data['page_template']);
-            }
-        }
-        if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
-            return;
-        } //TODO we'll remove this after reimplementing autosave in 4.2
-        $this->_insert_update_cpt_item($post_id, $post);
-    }
-
-
-
-    /**
-     * This hooks into the wp_trash_post() function and removes the `_wp_trash_meta_status` and `_wp_trash_meta_time`
-     * post meta IF the trashed post is one of our CPT's - note this method should only be called with our cpt routes
-     * so we don't have to check for our CPT.
-     *
-     * @param  int $post_id ID of the post
-     * @return void
-     */
-    public function dont_permanently_delete_ee_cpts($post_id)
-    {
-        //only do this if we're actually processing one of our CPTs
-        //if our cpt object isn't existent then get out immediately.
-        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) {
-            return;
-        }
-        delete_post_meta($post_id, '_wp_trash_meta_status');
-        delete_post_meta($post_id, '_wp_trash_meta_time');
-        //our cpts may have comments so let's take care of that too
-        delete_post_meta($post_id, '_wp_trash_meta_comments_status');
-    }
-
-
-
-    /**
-     * This is a wrapper for the restore_cpt_revision route for cpt items so we can make sure that when a revision is
-     * triggered that we restore related items.  In order to work cpt classes MUST have a restore_cpt_revision method
-     * in them.  We also have our OWN action in here so addons can hook into the restore process easily.
-     *
-     * @param  int $post_id     ID of cpt item
-     * @param  int $revision_id ID of revision being restored
-     * @return void
-     */
-    public function restore_revision($post_id, $revision_id)
-    {
-        $this->_restore_cpt_item($post_id, $revision_id);
-        //global action
-        do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id);
-        //class specific action so you can limit hooking into a specific page.
-        do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id);
-    }
-
-
-
-    /**
-     * @see restore_revision() for details
-     * @param  int $post_id     ID of cpt item
-     * @param  int $revision_id ID of revision for item
-     * @return void
-     */
-    abstract protected function _restore_cpt_item($post_id, $revision_id);
-
-
-
-    /**
-     * Execution of this method is added to the end of the load_page_dependencies method in the parent
-     * so that we can fix a bug where default core metaboxes were not being called in the sidebar.
-     * To fix we have to reset the current_screen using the page_slug
-     * (which is identical - or should be - to our registered_post_type id.)
-     * Also, since the core WP file loads the admin_header.php for WP
-     * (and there are a bunch of other things edit-form-advanced.php loads that need to happen really early)
-     * we need to load it NOW, hence our _route_admin_request in here. (Otherwise screen options won't be set).
-     *
-     * @return void
-     */
-    public function modify_current_screen()
-    {
-        //ONLY do this if the current page_route IS a cpt route
-        if ( ! $this->_cpt_route) {
-            return;
-        }
-        //routing things REALLY early b/c this is a cpt admin page
-        set_current_screen($this->_cpt_routes[$this->_req_action]);
-        $this->_current_screen       = get_current_screen();
-        $this->_current_screen->base = 'event-espresso';
-        $this->_add_help_tabs(); //we make sure we add any help tabs back in!
-        /*try {
+		//take care of updating any selected page_template IF this cpt supports it.
+		if ($this->_supports_page_templates($post->post_type) && ! empty($this->_req_data['page_template'])) {
+			//wp version aware.
+			if (EE_Recommended_Versions::check_wp_version('4.7', '>=')) {
+				$page_templates = wp_get_theme()->get_page_templates();
+			} else {
+				$post->page_template = $this->_req_data['page_template'];
+				$page_templates      = wp_get_theme()->get_page_templates($post);
+			}
+			if ('default' != $this->_req_data['page_template'] && ! isset($page_templates[$this->_req_data['page_template']])) {
+				EE_Error::add_error(__('Invalid Page Template.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			} else {
+				update_post_meta($post_id, '_wp_page_template', $this->_req_data['page_template']);
+			}
+		}
+		if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
+			return;
+		} //TODO we'll remove this after reimplementing autosave in 4.2
+		$this->_insert_update_cpt_item($post_id, $post);
+	}
+
+
+
+	/**
+	 * This hooks into the wp_trash_post() function and removes the `_wp_trash_meta_status` and `_wp_trash_meta_time`
+	 * post meta IF the trashed post is one of our CPT's - note this method should only be called with our cpt routes
+	 * so we don't have to check for our CPT.
+	 *
+	 * @param  int $post_id ID of the post
+	 * @return void
+	 */
+	public function dont_permanently_delete_ee_cpts($post_id)
+	{
+		//only do this if we're actually processing one of our CPTs
+		//if our cpt object isn't existent then get out immediately.
+		if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) {
+			return;
+		}
+		delete_post_meta($post_id, '_wp_trash_meta_status');
+		delete_post_meta($post_id, '_wp_trash_meta_time');
+		//our cpts may have comments so let's take care of that too
+		delete_post_meta($post_id, '_wp_trash_meta_comments_status');
+	}
+
+
+
+	/**
+	 * This is a wrapper for the restore_cpt_revision route for cpt items so we can make sure that when a revision is
+	 * triggered that we restore related items.  In order to work cpt classes MUST have a restore_cpt_revision method
+	 * in them.  We also have our OWN action in here so addons can hook into the restore process easily.
+	 *
+	 * @param  int $post_id     ID of cpt item
+	 * @param  int $revision_id ID of revision being restored
+	 * @return void
+	 */
+	public function restore_revision($post_id, $revision_id)
+	{
+		$this->_restore_cpt_item($post_id, $revision_id);
+		//global action
+		do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id);
+		//class specific action so you can limit hooking into a specific page.
+		do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id);
+	}
+
+
+
+	/**
+	 * @see restore_revision() for details
+	 * @param  int $post_id     ID of cpt item
+	 * @param  int $revision_id ID of revision for item
+	 * @return void
+	 */
+	abstract protected function _restore_cpt_item($post_id, $revision_id);
+
+
+
+	/**
+	 * Execution of this method is added to the end of the load_page_dependencies method in the parent
+	 * so that we can fix a bug where default core metaboxes were not being called in the sidebar.
+	 * To fix we have to reset the current_screen using the page_slug
+	 * (which is identical - or should be - to our registered_post_type id.)
+	 * Also, since the core WP file loads the admin_header.php for WP
+	 * (and there are a bunch of other things edit-form-advanced.php loads that need to happen really early)
+	 * we need to load it NOW, hence our _route_admin_request in here. (Otherwise screen options won't be set).
+	 *
+	 * @return void
+	 */
+	public function modify_current_screen()
+	{
+		//ONLY do this if the current page_route IS a cpt route
+		if ( ! $this->_cpt_route) {
+			return;
+		}
+		//routing things REALLY early b/c this is a cpt admin page
+		set_current_screen($this->_cpt_routes[$this->_req_action]);
+		$this->_current_screen       = get_current_screen();
+		$this->_current_screen->base = 'event-espresso';
+		$this->_add_help_tabs(); //we make sure we add any help tabs back in!
+		/*try {
             $this->_route_admin_request();
         } catch ( EE_Error $e ) {
             $e->get_error();
         }/**/
-    }
-
-
-
-    /**
-     * This allows child classes to modify the default editor title that appears when people add a new or edit an
-     * existing CPT item.     * This uses the _labels property set by the child class via _define_page_props. Just make
-     * sure you have a key in _labels property that equals 'editor_title' and the value can be whatever you want the
-     * default to be.
-     *
-     * @param string $title The new title (or existing if there is no editor_title defined)
-     * @return string
-     */
-    public function add_custom_editor_default_title($title)
-    {
-        return isset($this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]])
-            ? $this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]]
-            : $title;
-    }
-
-
-
-    /**
-     * hooks into the wp_get_shortlink button and makes sure that the shortlink gets generated
-     *
-     * @param string $shortlink   The already generated shortlink
-     * @param int    $id          Post ID for this item
-     * @param string $context     The context for the link
-     * @param bool   $allow_slugs Whether to allow post slugs in the shortlink.
-     * @return string
-     */
-    public function add_shortlink_button_to_editor($shortlink, $id, $context, $allow_slugs)
-    {
-        if ( ! empty($id) && '' != get_option('permalink_structure')) {
-            $post = get_post($id);
-            if (isset($post->post_type) && $this->page_slug == $post->post_type) {
-                $shortlink = home_url('?p=' . $post->ID);
-            }
-        }
-        return $shortlink;
-    }
-
-
-
-    /**
-     * overriding the parent route_admin_request method so we DON'T run the route twice on cpt core page loads (it's
-     * already run in modify_current_screen())
-     *
-     * @return void
-     */
-    public function route_admin_request()
-    {
-        if ($this->_cpt_route) {
-            return;
-        }
-        try {
-            $this->_route_admin_request();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-
-    /**
-     * Add a hidden form input to cpt core pages so that we know to do redirects to our routes on saves
-     *
-     * @return string html
-     */
-    public function cpt_post_form_hidden_input()
-    {
-        echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="' . $this->_admin_base_url . '" />';
-        //we're also going to add the route value and the current page so we can direct autosave parsing correctly
-        echo '<div id="ee-cpt-hidden-inputs">';
-        echo '<input type="hidden" id="current_route" name="current_route" value="' . $this->_current_view . '" />';
-        echo '<input type="hidden" id="current_page" name="current_page" value="' . $this->page_slug . '" />';
-        echo '</div>';
-    }
-
-
-
-    /**
-     * This allows us to redirect the location of revision restores when they happen so it goes to our CPT routes.
-     *
-     * @param  string $location Original location url
-     * @param  int    $status   Status for http header
-     * @return string           new (or original) url to redirect to.
-     */
-    public function revision_redirect($location, $status)
-    {
-        //get revision
-        $rev_id = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null;
-        //can't do anything without revision so let's get out if not present
-        if (empty($rev_id)) {
-            return $location;
-        }
-        //get rev_post_data
-        $rev = get_post($rev_id);
-        $admin_url = $this->_admin_base_url;
-        $query_args = array(
-            'action'   => 'edit',
-            'post'     => $rev->post_parent,
-            'revision' => $rev_id,
-            'message'  => 5,
-        );
-        $this->_process_notices($query_args, true);
-        return self::add_query_args_and_nonce($query_args, $admin_url);
-    }
-
-
-
-    /**
-     * Modify the edit post link generated by wp core function so that EE CPTs get setup differently.
-     *
-     * @param  string $link    the original generated link
-     * @param  int    $id      post id
-     * @param  string $context optional, defaults to display.  How to write the '&'
-     * @return string          the link
-     */
-    public function modify_edit_post_link($link, $id, $context)
-    {
-        $post = get_post($id);
-        if ( ! isset($this->_req_data['action'])
-             || ! isset($this->_cpt_routes[$this->_req_data['action']])
-             || $post->post_type !== $this->_cpt_routes[$this->_req_data['action']]
-        ) {
-            return $link;
-        }
-        $query_args = array(
-            'action' => isset($this->_cpt_edit_routes[$post->post_type])
-                ? $this->_cpt_edit_routes[$post->post_type]
-                : 'edit',
-            'post'   => $id,
-        );
-        return self::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-    }
-
-
-
-    /**
-     * Modify the trash link on our cpt edit pages so it has the required query var for triggering redirect properly on
-     * our routes.
-     *
-     * @param  string $delete_link  original delete link
-     * @param  int    $post_id      id of cpt object
-     * @param  bool   $force_delete whether this is forcing a hard delete instead of trash
-     * @return string               new delete link
-     */
-    public function modify_delete_post_link($delete_link, $post_id, $force_delete)
-    {
-        $post = get_post($post_id);
-        if ( ! isset($this->_req_data['action'])
-             || (isset($this->_cpt_routes[$this->_req_data['action']])
-                 && $post->post_type !== $this->_cpt_routes[$this->_req_data['action']])
-        ) {
-            return $delete_link;
-        }
-        return add_query_arg(array('current_route' => 'trash'), $delete_link);
-    }
-
-
-
-    /**
-     * This hooks into the wp_redirect filter and if trashed is detected, then we'll redirect to the appropriate EE
-     * route
-     *
-     * @param  string $location url
-     * @param  string $status   status
-     * @return string           url to redirect to
-     */
-    public function cpt_trash_post_location_redirect($location, $status)
-    {
-        if (isset($this->_req_data['action']) && $this->_req_data['action'] !== 'trash' && empty($this->_req_data['post'])) {
-            return $location;
-        }
-
-        $post              = get_post($this->_req_data['post']);
-        $query_args        = array('action' => 'default');
-        $this->_cpt_object = get_post_type_object($post->post_type);
-        EE_Error::add_success(sprintf(__('%s trashed.', 'event_espresso'), $this->_cpt_object->labels->singular_name));
-        $this->_process_notices($query_args, true);
-        return self::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-    }
-
-
-
-    /**
-     * This is the callback for the 'redirect_post_location' filter in wp-admin/post.php
-     * so that we can hijack the default redirect locations for wp custom post types
-     * that WE'RE using and send back to OUR routes.  This should only be hooked in on the right route.
-     *
-     * @param  string $location This is the incoming currently set redirect location
-     * @param  string $post_id  This is the 'ID' value of the wp_posts table
-     * @return string           the new location to redirect to
-     */
-    public function cpt_post_location_redirect($location, $post_id)
-    {
-        //we DO have a match so let's setup the url
-        //we have to get the post to determine our route
-        $post       = get_post($post_id);
-        $edit_route = $this->_cpt_edit_routes[$post->post_type];
-        //shared query_args
-        $query_args = array('action' => $edit_route, 'post' => $post_id);
-        $admin_url  = $this->_admin_base_url;
-        if (isset($this->_req_data['save']) || isset($this->_req_data['publish'])) {
-            $status = get_post_status($post_id);
-            if (isset($this->_req_data['publish'])) {
-                switch ($status) {
-                    case 'pending':
-                        $message = 8;
-                        break;
-                    case 'future':
-                        $message = 9;
-                        break;
-                    default:
-                        $message = 6;
-                }
-            } else {
-                $message = 'draft' == $status ? 10 : 1;
-            }
-        } else if (isset($this->_req_data['addmeta']) && $this->_req_data['addmeta']) {
-            $message = 2;
-            //			$append = '#postcustom';
-        } else if (isset($this->_req_data['deletemeta']) && $this->_req_data['deletemeta']) {
-            $message = 3;
-            //			$append = '#postcustom';
-        } elseif ($this->_req_data['action'] == 'post-quickpress-save-cont') {
-            $message = 7;
-        } else {
-            $message = 4;
-        }
-        //change the message if the post type is not viewable on the frontend
-        $this->_cpt_object = get_post_type_object($post->post_type);
-        $message           = $message === 1 && ! $this->_cpt_object->publicly_queryable ? 4 : $message;
-        $query_args = array_merge(array('message' => $message), $query_args);
-        $this->_process_notices($query_args, true);
-        return self::add_query_args_and_nonce($query_args, $admin_url);
-    }
-
-
-
-    /**
-     * This method is called to inject nav tabs on core WP cpt pages
-     *
-     * @access public
-     * @return string html
-     */
-    public function inject_nav_tabs()
-    {
-        //can we hijack and insert the nav_tabs?
-        $nav_tabs = $this->_get_main_nav_tabs();
-        //first close off existing form tag
-        $html = '>';
-        $html .= $nav_tabs;
-        //now let's handle the remaining tag ( missing ">" is CORRECT )
-        $html .= '<span></span';
-        echo $html;
-    }
-
-
-
-    /**
-     * This just sets up the post update messages when an update form is loaded
-     *
-     * @access public
-     * @param  array $messages the original messages array
-     * @return array           the new messages array
-     */
-    public function post_update_messages($messages)
-    {
-        global $post;
-        $id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
-        $id = empty($id) && is_object($post) ? $post->ID : null;
-        //		$post_type = $post ? $post->post_type : false;
-        /*$current_route = isset($this->_req_data['current_route']) ? $this->_req_data['current_route'] : 'shouldneverwork';
+	}
+
+
+
+	/**
+	 * This allows child classes to modify the default editor title that appears when people add a new or edit an
+	 * existing CPT item.     * This uses the _labels property set by the child class via _define_page_props. Just make
+	 * sure you have a key in _labels property that equals 'editor_title' and the value can be whatever you want the
+	 * default to be.
+	 *
+	 * @param string $title The new title (or existing if there is no editor_title defined)
+	 * @return string
+	 */
+	public function add_custom_editor_default_title($title)
+	{
+		return isset($this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]])
+			? $this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]]
+			: $title;
+	}
+
+
+
+	/**
+	 * hooks into the wp_get_shortlink button and makes sure that the shortlink gets generated
+	 *
+	 * @param string $shortlink   The already generated shortlink
+	 * @param int    $id          Post ID for this item
+	 * @param string $context     The context for the link
+	 * @param bool   $allow_slugs Whether to allow post slugs in the shortlink.
+	 * @return string
+	 */
+	public function add_shortlink_button_to_editor($shortlink, $id, $context, $allow_slugs)
+	{
+		if ( ! empty($id) && '' != get_option('permalink_structure')) {
+			$post = get_post($id);
+			if (isset($post->post_type) && $this->page_slug == $post->post_type) {
+				$shortlink = home_url('?p=' . $post->ID);
+			}
+		}
+		return $shortlink;
+	}
+
+
+
+	/**
+	 * overriding the parent route_admin_request method so we DON'T run the route twice on cpt core page loads (it's
+	 * already run in modify_current_screen())
+	 *
+	 * @return void
+	 */
+	public function route_admin_request()
+	{
+		if ($this->_cpt_route) {
+			return;
+		}
+		try {
+			$this->_route_admin_request();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+
+	/**
+	 * Add a hidden form input to cpt core pages so that we know to do redirects to our routes on saves
+	 *
+	 * @return string html
+	 */
+	public function cpt_post_form_hidden_input()
+	{
+		echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="' . $this->_admin_base_url . '" />';
+		//we're also going to add the route value and the current page so we can direct autosave parsing correctly
+		echo '<div id="ee-cpt-hidden-inputs">';
+		echo '<input type="hidden" id="current_route" name="current_route" value="' . $this->_current_view . '" />';
+		echo '<input type="hidden" id="current_page" name="current_page" value="' . $this->page_slug . '" />';
+		echo '</div>';
+	}
+
+
+
+	/**
+	 * This allows us to redirect the location of revision restores when they happen so it goes to our CPT routes.
+	 *
+	 * @param  string $location Original location url
+	 * @param  int    $status   Status for http header
+	 * @return string           new (or original) url to redirect to.
+	 */
+	public function revision_redirect($location, $status)
+	{
+		//get revision
+		$rev_id = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null;
+		//can't do anything without revision so let's get out if not present
+		if (empty($rev_id)) {
+			return $location;
+		}
+		//get rev_post_data
+		$rev = get_post($rev_id);
+		$admin_url = $this->_admin_base_url;
+		$query_args = array(
+			'action'   => 'edit',
+			'post'     => $rev->post_parent,
+			'revision' => $rev_id,
+			'message'  => 5,
+		);
+		$this->_process_notices($query_args, true);
+		return self::add_query_args_and_nonce($query_args, $admin_url);
+	}
+
+
+
+	/**
+	 * Modify the edit post link generated by wp core function so that EE CPTs get setup differently.
+	 *
+	 * @param  string $link    the original generated link
+	 * @param  int    $id      post id
+	 * @param  string $context optional, defaults to display.  How to write the '&'
+	 * @return string          the link
+	 */
+	public function modify_edit_post_link($link, $id, $context)
+	{
+		$post = get_post($id);
+		if ( ! isset($this->_req_data['action'])
+			 || ! isset($this->_cpt_routes[$this->_req_data['action']])
+			 || $post->post_type !== $this->_cpt_routes[$this->_req_data['action']]
+		) {
+			return $link;
+		}
+		$query_args = array(
+			'action' => isset($this->_cpt_edit_routes[$post->post_type])
+				? $this->_cpt_edit_routes[$post->post_type]
+				: 'edit',
+			'post'   => $id,
+		);
+		return self::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+	}
+
+
+
+	/**
+	 * Modify the trash link on our cpt edit pages so it has the required query var for triggering redirect properly on
+	 * our routes.
+	 *
+	 * @param  string $delete_link  original delete link
+	 * @param  int    $post_id      id of cpt object
+	 * @param  bool   $force_delete whether this is forcing a hard delete instead of trash
+	 * @return string               new delete link
+	 */
+	public function modify_delete_post_link($delete_link, $post_id, $force_delete)
+	{
+		$post = get_post($post_id);
+		if ( ! isset($this->_req_data['action'])
+			 || (isset($this->_cpt_routes[$this->_req_data['action']])
+				 && $post->post_type !== $this->_cpt_routes[$this->_req_data['action']])
+		) {
+			return $delete_link;
+		}
+		return add_query_arg(array('current_route' => 'trash'), $delete_link);
+	}
+
+
+
+	/**
+	 * This hooks into the wp_redirect filter and if trashed is detected, then we'll redirect to the appropriate EE
+	 * route
+	 *
+	 * @param  string $location url
+	 * @param  string $status   status
+	 * @return string           url to redirect to
+	 */
+	public function cpt_trash_post_location_redirect($location, $status)
+	{
+		if (isset($this->_req_data['action']) && $this->_req_data['action'] !== 'trash' && empty($this->_req_data['post'])) {
+			return $location;
+		}
+
+		$post              = get_post($this->_req_data['post']);
+		$query_args        = array('action' => 'default');
+		$this->_cpt_object = get_post_type_object($post->post_type);
+		EE_Error::add_success(sprintf(__('%s trashed.', 'event_espresso'), $this->_cpt_object->labels->singular_name));
+		$this->_process_notices($query_args, true);
+		return self::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+	}
+
+
+
+	/**
+	 * This is the callback for the 'redirect_post_location' filter in wp-admin/post.php
+	 * so that we can hijack the default redirect locations for wp custom post types
+	 * that WE'RE using and send back to OUR routes.  This should only be hooked in on the right route.
+	 *
+	 * @param  string $location This is the incoming currently set redirect location
+	 * @param  string $post_id  This is the 'ID' value of the wp_posts table
+	 * @return string           the new location to redirect to
+	 */
+	public function cpt_post_location_redirect($location, $post_id)
+	{
+		//we DO have a match so let's setup the url
+		//we have to get the post to determine our route
+		$post       = get_post($post_id);
+		$edit_route = $this->_cpt_edit_routes[$post->post_type];
+		//shared query_args
+		$query_args = array('action' => $edit_route, 'post' => $post_id);
+		$admin_url  = $this->_admin_base_url;
+		if (isset($this->_req_data['save']) || isset($this->_req_data['publish'])) {
+			$status = get_post_status($post_id);
+			if (isset($this->_req_data['publish'])) {
+				switch ($status) {
+					case 'pending':
+						$message = 8;
+						break;
+					case 'future':
+						$message = 9;
+						break;
+					default:
+						$message = 6;
+				}
+			} else {
+				$message = 'draft' == $status ? 10 : 1;
+			}
+		} else if (isset($this->_req_data['addmeta']) && $this->_req_data['addmeta']) {
+			$message = 2;
+			//			$append = '#postcustom';
+		} else if (isset($this->_req_data['deletemeta']) && $this->_req_data['deletemeta']) {
+			$message = 3;
+			//			$append = '#postcustom';
+		} elseif ($this->_req_data['action'] == 'post-quickpress-save-cont') {
+			$message = 7;
+		} else {
+			$message = 4;
+		}
+		//change the message if the post type is not viewable on the frontend
+		$this->_cpt_object = get_post_type_object($post->post_type);
+		$message           = $message === 1 && ! $this->_cpt_object->publicly_queryable ? 4 : $message;
+		$query_args = array_merge(array('message' => $message), $query_args);
+		$this->_process_notices($query_args, true);
+		return self::add_query_args_and_nonce($query_args, $admin_url);
+	}
+
+
+
+	/**
+	 * This method is called to inject nav tabs on core WP cpt pages
+	 *
+	 * @access public
+	 * @return string html
+	 */
+	public function inject_nav_tabs()
+	{
+		//can we hijack and insert the nav_tabs?
+		$nav_tabs = $this->_get_main_nav_tabs();
+		//first close off existing form tag
+		$html = '>';
+		$html .= $nav_tabs;
+		//now let's handle the remaining tag ( missing ">" is CORRECT )
+		$html .= '<span></span';
+		echo $html;
+	}
+
+
+
+	/**
+	 * This just sets up the post update messages when an update form is loaded
+	 *
+	 * @access public
+	 * @param  array $messages the original messages array
+	 * @return array           the new messages array
+	 */
+	public function post_update_messages($messages)
+	{
+		global $post;
+		$id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
+		$id = empty($id) && is_object($post) ? $post->ID : null;
+		//		$post_type = $post ? $post->post_type : false;
+		/*$current_route = isset($this->_req_data['current_route']) ? $this->_req_data['current_route'] : 'shouldneverwork';
 
         $route_to_check = $post_type && isset( $this->_cpt_routes[$current_route]) ? $this->_cpt_routes[$current_route] : '';/**/
-        $messages[$post->post_type] = array(
-            0 => '', //Unused. Messages start at index 1.
-            1 => sprintf(
-                __('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
-                '</a>'
-            ),
-            2 => __('Custom field updated'),
-            3 => __('Custom field deleted.'),
-            4 => sprintf(__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
-            5 => isset($_GET['revision']) ? sprintf(__('%s restored to revision from %s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name, wp_post_revision_title((int)$_GET['revision'], false))
-                : false,
-            6 => sprintf(
-                __('%1$s published. %2$sView %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
-                '</a>'
-            ),
-            7 => sprintf(__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
-            8 => sprintf(
-                __('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">',
-                '</a>'
-            ),
-            9 => sprintf(
-                __('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<strong>' . date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)) . '</strong>',
-                '<a target="_blank" href="' . esc_url(get_permalink($id)),
-                '</a>'
-            ),
-            10 => sprintf(
-                __('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))),
-                '</a>'
-            ),
-        );
-        return $messages;
-    }
-
-
-
-    /**
-     * default method for the 'create_new' route for cpt admin pages.
-     * For reference what to include in here, see wp-admin/post-new.php
-     *
-     * @access  protected
-     * @return string template for add new cpt form
-     */
-    protected function _create_new_cpt_item()
-    {
-        global $post, $title, $is_IE, $post_type, $post_type_object;
-        $post_type        = $this->_cpt_routes[$this->_req_action];
-        $post_type_object = $this->_cpt_object;
-        $title            = $post_type_object->labels->add_new_item;
-        $editing          = true;
-        wp_enqueue_script('autosave');
-        $post    = $post = get_default_post_to_edit($this->_cpt_routes[$this->_req_action], true);
-        $post_ID = $post->ID;
-        $is_IE   = $is_IE;
-        add_action('admin_print_styles', array($this, 'add_new_admin_page_global'));
-        //modify the default editor title field with default title.
-        add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10);
-        include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
-    }
-
-
-
-    public function add_new_admin_page_global()
-    {
-        $admin_page = ! empty($this->_req_data['post']) ? 'post-php' : 'post-new-php';
-        ?>
+		$messages[$post->post_type] = array(
+			0 => '', //Unused. Messages start at index 1.
+			1 => sprintf(
+				__('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a href="' . esc_url(get_permalink($id)) . '">',
+				'</a>'
+			),
+			2 => __('Custom field updated'),
+			3 => __('Custom field deleted.'),
+			4 => sprintf(__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
+			5 => isset($_GET['revision']) ? sprintf(__('%s restored to revision from %s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name, wp_post_revision_title((int)$_GET['revision'], false))
+				: false,
+			6 => sprintf(
+				__('%1$s published. %2$sView %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a href="' . esc_url(get_permalink($id)) . '">',
+				'</a>'
+			),
+			7 => sprintf(__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
+			8 => sprintf(
+				__('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">',
+				'</a>'
+			),
+			9 => sprintf(
+				__('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<strong>' . date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)) . '</strong>',
+				'<a target="_blank" href="' . esc_url(get_permalink($id)),
+				'</a>'
+			),
+			10 => sprintf(
+				__('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))),
+				'</a>'
+			),
+		);
+		return $messages;
+	}
+
+
+
+	/**
+	 * default method for the 'create_new' route for cpt admin pages.
+	 * For reference what to include in here, see wp-admin/post-new.php
+	 *
+	 * @access  protected
+	 * @return string template for add new cpt form
+	 */
+	protected function _create_new_cpt_item()
+	{
+		global $post, $title, $is_IE, $post_type, $post_type_object;
+		$post_type        = $this->_cpt_routes[$this->_req_action];
+		$post_type_object = $this->_cpt_object;
+		$title            = $post_type_object->labels->add_new_item;
+		$editing          = true;
+		wp_enqueue_script('autosave');
+		$post    = $post = get_default_post_to_edit($this->_cpt_routes[$this->_req_action], true);
+		$post_ID = $post->ID;
+		$is_IE   = $is_IE;
+		add_action('admin_print_styles', array($this, 'add_new_admin_page_global'));
+		//modify the default editor title field with default title.
+		add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10);
+		include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
+	}
+
+
+
+	public function add_new_admin_page_global()
+	{
+		$admin_page = ! empty($this->_req_data['post']) ? 'post-php' : 'post-new-php';
+		?>
         <script type="text/javascript">
             adminpage = '<?php echo $admin_page; ?>';
         </script>
         <?php
-    }
-
-
-
-    /**
-     * default method for the 'edit' route for cpt admin pages
-     * For reference on what to put in here, refer to wp-admin/post.php
-     *
-     * @access protected
-     * @return string   template for edit cpt form
-     */
-    protected function _edit_cpt_item()
-    {
-        global $post, $title, $is_IE, $post_type, $post_type_object;
-        $post_id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
-        $post = ! empty($post_id) ? get_post($post_id, OBJECT, 'edit') : null;
-        if (empty ($post)) {
-            wp_die(__('You attempted to edit an item that doesn&#8217;t exist. Perhaps it was deleted?'));
-        }
-        if ( ! empty($_GET['get-post-lock'])) {
-            wp_set_post_lock($post_id);
-            wp_redirect(get_edit_post_link($post_id, 'url'));
-            exit();
-        }
-
-        // template vars
-        $editing          = true;
-        $post_ID          = $post_id;
-        $post_type        = $this->_cpt_routes[$this->_req_action];
-        $post_type_object = $this->_cpt_object;
-
-        if ( ! wp_check_post_lock($post->ID)) {
-            $active_post_lock = wp_set_post_lock($post->ID);
-            //wp_enqueue_script('autosave');
-        }
-        $title = $this->_cpt_object->labels->edit_item;
-        add_action('admin_footer', '_admin_notice_post_locked');
-        if (isset($this->_cpt_routes[$this->_req_data['action']])
-            && ! isset($this->_labels['hide_add_button_on_cpt_route'][$this->_req_data['action']])
-        ) {
-            $create_new_action = apply_filters('FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action',
-                'create_new', $this);
-            $post_new_file = EE_Admin_Page::add_query_args_and_nonce(array(
-                'action' => $create_new_action,
-                'page'   => $this->page_slug,
-            ), 'admin.php');
-        }
-        if (post_type_supports($this->_cpt_routes[$this->_req_action], 'comments')) {
-            wp_enqueue_script('admin-comments');
-            enqueue_comment_hotkeys_js();
-        }
-        add_action('admin_print_styles', array($this, 'add_new_admin_page_global'));
-        //modify the default editor title field with default title.
-        add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10);
-        include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
-    }
-
-
-
-    /**
-     * some getters
-     */
-    /**
-     * This returns the protected _cpt_model_obj property
-     *
-     * @return EE_CPT_Base
-     */
-    public function get_cpt_model_obj()
-    {
-        return $this->_cpt_model_obj;
-    }
+	}
+
+
+
+	/**
+	 * default method for the 'edit' route for cpt admin pages
+	 * For reference on what to put in here, refer to wp-admin/post.php
+	 *
+	 * @access protected
+	 * @return string   template for edit cpt form
+	 */
+	protected function _edit_cpt_item()
+	{
+		global $post, $title, $is_IE, $post_type, $post_type_object;
+		$post_id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
+		$post = ! empty($post_id) ? get_post($post_id, OBJECT, 'edit') : null;
+		if (empty ($post)) {
+			wp_die(__('You attempted to edit an item that doesn&#8217;t exist. Perhaps it was deleted?'));
+		}
+		if ( ! empty($_GET['get-post-lock'])) {
+			wp_set_post_lock($post_id);
+			wp_redirect(get_edit_post_link($post_id, 'url'));
+			exit();
+		}
+
+		// template vars
+		$editing          = true;
+		$post_ID          = $post_id;
+		$post_type        = $this->_cpt_routes[$this->_req_action];
+		$post_type_object = $this->_cpt_object;
+
+		if ( ! wp_check_post_lock($post->ID)) {
+			$active_post_lock = wp_set_post_lock($post->ID);
+			//wp_enqueue_script('autosave');
+		}
+		$title = $this->_cpt_object->labels->edit_item;
+		add_action('admin_footer', '_admin_notice_post_locked');
+		if (isset($this->_cpt_routes[$this->_req_data['action']])
+			&& ! isset($this->_labels['hide_add_button_on_cpt_route'][$this->_req_data['action']])
+		) {
+			$create_new_action = apply_filters('FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action',
+				'create_new', $this);
+			$post_new_file = EE_Admin_Page::add_query_args_and_nonce(array(
+				'action' => $create_new_action,
+				'page'   => $this->page_slug,
+			), 'admin.php');
+		}
+		if (post_type_supports($this->_cpt_routes[$this->_req_action], 'comments')) {
+			wp_enqueue_script('admin-comments');
+			enqueue_comment_hotkeys_js();
+		}
+		add_action('admin_print_styles', array($this, 'add_new_admin_page_global'));
+		//modify the default editor title field with default title.
+		add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10);
+		include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
+	}
+
+
+
+	/**
+	 * some getters
+	 */
+	/**
+	 * This returns the protected _cpt_model_obj property
+	 *
+	 * @return EE_CPT_Base
+	 */
+	public function get_cpt_model_obj()
+	{
+		return $this->_cpt_model_obj;
+	}
 
 }

Spacing +26 added lines, -26 removed lines

@@ -235,7 +235,7 @@ 
      */
     protected function _register_autosave_containers($ids)
     {
-        $this->_autosave_containers = array_merge($this->_autosave_fields, (array)$ids);
+        $this->_autosave_containers = array_merge($this->_autosave_fields, (array) $ids);
     }
 
 
@@ -279,7 +279,7 @@ 
         //filter _autosave_containers
         $containers = apply_filters('FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers',
             $this->_autosave_containers, $this);
-        $containers = apply_filters('FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers',
+        $containers = apply_filters('FHEE__EE_Admin_Page_CPT__'.get_class($this).'___load_autosave_scripts_styles__containers',
             $containers, $this);
 
         wp_localize_script('event_editor_js', 'EE_AUTOSAVE_IDS',
@@ -369,7 +369,7 @@ 
         parent::_load_page_dependencies();
         //notice we are ALSO going to load the pagenow hook set for this route (see _before_page_setup for the reset of the pagenow global ). This is for any plugins that are doing things properly and hooking into the load page hook for core wp cpt routes.
         global $pagenow;
-        do_action('load-' . $pagenow);
+        do_action('load-'.$pagenow);
         $this->modify_current_screen();
         add_action('admin_enqueue_scripts', array($this, 'setup_autosave_hooks'), 30);
         //we route REALLY early.
@@ -400,8 +400,8 @@ 
                 'admin.php?page=espresso_registrations&action=contact_list',
             ),
             1 => array(
-                'edit.php?post_type=' . $this->_cpt_object->name,
-                'admin.php?page=' . $this->_cpt_object->name,
+                'edit.php?post_type='.$this->_cpt_object->name,
+                'admin.php?page='.$this->_cpt_object->name,
             ),
         );
         foreach ($routes_to_match as $route_matches) {
@@ -429,7 +429,7 @@ 
         $cpt_has_support = ! empty($cpt_args['page_templates']);
 
         //if the installed version of WP is > 4.7 we do some additional checks.
-        if (EE_Recommended_Versions::check_wp_version('4.7','>=')) {
+        if (EE_Recommended_Versions::check_wp_version('4.7', '>=')) {
             $post_templates = wp_get_theme()->get_post_templates();
             //if there are $post_templates for this cpt, then we return false for this method because
             //that means we aren't going to load our page template manager and leave that up to the native
@@ -452,7 +452,7 @@ 
         global $post;
         $template = '';
 
-        if (EE_Recommended_Versions::check_wp_version('4.7','>=')) {
+        if (EE_Recommended_Versions::check_wp_version('4.7', '>=')) {
             $page_template_count = count(get_page_templates());
         } else {
             $page_template_count = count(get_page_templates($post));
@@ -489,7 +489,7 @@ 
         $post = get_post($id);
         if ('publish' != get_post_status($post)) {
             //include shims for the `get_preview_post_link` function
-            require_once( EE_CORE . 'wordpress-shims.php' );
+            require_once(EE_CORE.'wordpress-shims.php');
             $return .= '<span_id="view-post-btn"><a target="_blank" href="'
                        . get_preview_post_link($id)
                        . '" class="button button-small">'
@@ -527,7 +527,7 @@ 
             $template_args['statuses']         = $statuses;
         }
 
-        $template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php';
+        $template = EE_ADMIN_TEMPLATE.'status_dropdown.template.php';
         EEH_Template::display_template($template, $template_args);
     }
 
@@ -572,13 +572,13 @@ 
             define('DOING_AUTOSAVE', true);
         }
         //if we made it here then the nonce checked out.  Let's run our methods and actions
-        if (method_exists($this, '_ee_autosave_' . $this->_current_view)) {
-            call_user_func(array($this, '_ee_autosave_' . $this->_current_view));
+        if (method_exists($this, '_ee_autosave_'.$this->_current_view)) {
+            call_user_func(array($this, '_ee_autosave_'.$this->_current_view));
         } else {
             $this->_template_args['success'] = true;
         }
         do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this);
-        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this);
+        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_'.get_class($this), $this);
         //now let's return json
         $this->_return_json();
     }
@@ -971,7 +971,7 @@ 
         //global action
         do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id);
         //class specific action so you can limit hooking into a specific page.
-        do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id);
+        do_action('AHEE_EE_Admin_Page_CPT_'.get_class($this).'__restore_revision', $post_id, $revision_id);
     }
 
 
@@ -1049,7 +1049,7 @@ 
         if ( ! empty($id) && '' != get_option('permalink_structure')) {
             $post = get_post($id);
             if (isset($post->post_type) && $this->page_slug == $post->post_type) {
-                $shortlink = home_url('?p=' . $post->ID);
+                $shortlink = home_url('?p='.$post->ID);
             }
         }
         return $shortlink;
@@ -1084,11 +1084,11 @@ 
      */
     public function cpt_post_form_hidden_input()
     {
-        echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="' . $this->_admin_base_url . '" />';
+        echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="'.$this->_admin_base_url.'" />';
         //we're also going to add the route value and the current page so we can direct autosave parsing correctly
         echo '<div id="ee-cpt-hidden-inputs">';
-        echo '<input type="hidden" id="current_route" name="current_route" value="' . $this->_current_view . '" />';
-        echo '<input type="hidden" id="current_page" name="current_page" value="' . $this->page_slug . '" />';
+        echo '<input type="hidden" id="current_route" name="current_route" value="'.$this->_current_view.'" />';
+        echo '<input type="hidden" id="current_page" name="current_page" value="'.$this->page_slug.'" />';
         echo '</div>';
     }
 
@@ -1295,39 +1295,39 @@ 
             1 => sprintf(
                 __('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
+                '<a href="'.esc_url(get_permalink($id)).'">',
                 '</a>'
             ),
             2 => __('Custom field updated'),
             3 => __('Custom field deleted.'),
             4 => sprintf(__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
             5 => isset($_GET['revision']) ? sprintf(__('%s restored to revision from %s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name, wp_post_revision_title((int)$_GET['revision'], false))
+                $this->_cpt_object->labels->singular_name, wp_post_revision_title((int) $_GET['revision'], false))
                 : false,
             6 => sprintf(
                 __('%1$s published. %2$sView %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
+                '<a href="'.esc_url(get_permalink($id)).'">',
                 '</a>'
             ),
             7 => sprintf(__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
             8 => sprintf(
                 __('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">',
+                '<a target="_blank" href="'.esc_url(add_query_arg('preview', 'true', get_permalink($id))).'">',
                 '</a>'
             ),
             9 => sprintf(
                 __('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<strong>' . date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)) . '</strong>',
-                '<a target="_blank" href="' . esc_url(get_permalink($id)),
+                '<strong>'.date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)).'</strong>',
+                '<a target="_blank" href="'.esc_url(get_permalink($id)),
                 '</a>'
             ),
             10 => sprintf(
                 __('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))),
+                '<a target="_blank" href="'.esc_url(add_query_arg('preview', 'true', get_permalink($id))),
                 '</a>'
             ),
         );
@@ -1357,7 +1357,7 @@ 
         add_action('admin_print_styles', array($this, 'add_new_admin_page_global'));
         //modify the default editor title field with default title.
         add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10);
-        include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
+        include_once WP_ADMIN_PATH.'edit-form-advanced.php';
     }
 
 
@@ -1424,7 +1424,7 @@ 
         add_action('admin_print_styles', array($this, 'add_new_admin_page_global'));
         //modify the default editor title field with default title.
         add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10);
-        include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
+        include_once WP_ADMIN_PATH.'edit-form-advanced.php';
     }
 
 

core/EE_System.core.php

Indentation +1423 added lines, -1423 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -16,1428 +16,1428 @@ 
 {
 
 
-    /**
-     * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
-     * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
-     */
-    const req_type_normal = 0;
-
-    /**
-     * Indicates this is a brand new installation of EE so we should install
-     * tables and default data etc
-     */
-    const req_type_new_activation = 1;
-
-    /**
-     * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
-     * and we just exited maintenance mode). We MUST check the database is setup properly
-     * and that default data is setup too
-     */
-    const req_type_reactivation = 2;
-
-    /**
-     * indicates that EE has been upgraded since its previous request.
-     * We may have data migration scripts to call and will want to trigger maintenance mode
-     */
-    const req_type_upgrade = 3;
-
-    /**
-     * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
-     */
-    const req_type_downgrade = 4;
-
-    /**
-     * @deprecated since version 4.6.0.dev.006
-     * Now whenever a new_activation is detected the request type is still just
-     * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
-     * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
-     * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
-     * (Specifically, when the migration manager indicates migrations are finished
-     * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
-     */
-    const req_type_activation_but_not_installed = 5;
-
-    /**
-     * option prefix for recording the activation history (like core's "espresso_db_update") of addons
-     */
-    const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
-
-
-    /**
-     *    instance of the EE_System object
-     *
-     * @var    $_instance
-     * @access    private
-     */
-    private static $_instance = null;
-
-    /**
-     * @type  EE_Registry $Registry
-     * @access    protected
-     */
-    protected $registry;
-
-    /**
-     * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
-     * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
-     *
-     * @var int
-     */
-    private $_req_type;
-
-    /**
-     * Whether or not there was a non-micro version change in EE core version during this request
-     *
-     * @var boolean
-     */
-    private $_major_version_change = false;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param  \EE_Registry $Registry
-     * @return \EE_System
-     */
-    public static function instance(EE_Registry $Registry = null)
-    {
-        // check if class object is instantiated
-        if ( ! self::$_instance instanceof EE_System) {
-            self::$_instance = new self($Registry);
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * resets the instance and returns it
-     *
-     * @return EE_System
-     */
-    public static function reset()
-    {
-        self::$_instance->_req_type = null;
-        //make sure none of the old hooks are left hanging around
-        remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-        //we need to reset the migration manager in order for it to detect DMSs properly
-        EE_Data_Migration_Manager::reset();
-        self::instance()->detect_activations_or_upgrades();
-        self::instance()->perform_activations_upgrades_and_migrations();
-        return self::instance();
-    }
-
-
-
-    /**
-     *    sets hooks for running rest of system
-     *    provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     *    starting EE Addons from any other point may lead to problems
-     *
-     * @access private
-     * @param  \EE_Registry $Registry
-     */
-    private function __construct(EE_Registry $Registry)
-    {
-        $this->registry = $Registry;
-        do_action('AHEE__EE_System__construct__begin', $this);
-        // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
-        add_action('AHEE__EE_Bootstrap__load_espresso_addons', array($this, 'load_espresso_addons'));
-        // when an ee addon is activated, we want to call the core hook(s) again
-        // because the newly-activated addon didn't get a chance to run at all
-        add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
-        // detect whether install or upgrade
-        add_action('AHEE__EE_Bootstrap__detect_activations_or_upgrades', array($this, 'detect_activations_or_upgrades'),
-            3);
-        // load EE_Config, EE_Textdomain, etc
-        add_action('AHEE__EE_Bootstrap__load_core_configuration', array($this, 'load_core_configuration'), 5);
-        // load EE_Config, EE_Textdomain, etc
-        add_action('AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
-            array($this, 'register_shortcodes_modules_and_widgets'), 7);
-        // you wanna get going? I wanna get going... let's get going!
-        add_action('AHEE__EE_Bootstrap__brew_espresso', array($this, 'brew_espresso'), 9);
-        //other housekeeping
-        //exclude EE critical pages from wp_list_pages
-        add_filter('wp_list_pages_excludes', array($this, 'remove_pages_from_wp_list_pages'), 10);
-        // ALL EE Addons should use the following hook point to attach their initial setup too
-        // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
-        do_action('AHEE__EE_System__construct__complete', $this);
-    }
-
-
-
-    /**
-     * load_espresso_addons
-     * allow addons to load first so that they can set hooks for running DMS's, etc
-     * this is hooked into both:
-     *    'AHEE__EE_Bootstrap__load_core_configuration'
-     *        which runs during the WP 'plugins_loaded' action at priority 5
-     *    and the WP 'activate_plugin' hookpoint
-     *
-     * @access public
-     * @return void
-     */
-    public function load_espresso_addons()
-    {
-        // set autoloaders for all of the classes implementing EEI_Plugin_API
-        // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
-        //load and setup EE_Capabilities
-        $this->registry->load_core('Capabilities');
-        //caps need to be initialized on every request so that capability maps are set.
-        //@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
-        $this->registry->CAP->init_caps();
-        do_action('AHEE__EE_System__load_espresso_addons');
-        //if the WP API basic auth plugin isn't already loaded, load it now.
-        //We want it for mobile apps. Just include the entire plugin
-        //also, don't load the basic auth when a plugin is getting activated, because
-        //it could be the basic auth plugin, and it doesn't check if its methods are already defined
-        //and causes a fatal error
-        if ( ! function_exists('json_basic_auth_handler')
-             && ! function_exists('json_basic_auth_error')
-             && ! (
-                isset($_GET['action'])
-                && in_array($_GET['action'], array('activate', 'activate-selected'))
-            )
-             && ! (
-                isset($_GET['activate'])
-                && $_GET['activate'] === 'true'
-            )
-        ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
-        }
-        do_action('AHEE__EE_System__load_espresso_addons__complete');
-    }
-
-
-
-    /**
-     * detect_activations_or_upgrades
-     * Checks for activation or upgrade of core first;
-     * then also checks if any registered addons have been activated or upgraded
-     * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
-     * which runs during the WP 'plugins_loaded' action at priority 3
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_activations_or_upgrades()
-    {
-        //first off: let's make sure to handle core
-        $this->detect_if_activation_or_upgrade();
-        foreach ($this->registry->addons as $addon) {
-            //detect teh request type for that addon
-            $addon->detect_activation_or_upgrade();
-        }
-    }
-
-
-
-    /**
-     * detect_if_activation_or_upgrade
-     * Takes care of detecting whether this is a brand new install or code upgrade,
-     * and either setting up the DB or setting up maintenance mode etc.
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_if_activation_or_upgrade()
-    {
-        do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
-        // load M-Mode class
-        $this->registry->load_core('Maintenance_Mode');
-        // check if db has been updated, or if its a brand-new installation
-        $espresso_db_update = $this->fix_espresso_db_upgrade_option();
-        $request_type = $this->detect_req_type($espresso_db_update);
-        //EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
-                //migrations may be required now that we've upgraded
-                EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                //				echo "done upgrade";die;
-                break;
-            case EE_System::req_type_downgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
-                //its possible migrations are no longer required
-                EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                //				$this->_maybe_redirect_to_ee_about();
-                break;
-        }
-        do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
-    }
-
-
-
-    /**
-     * Updates the list of installed versions and sets hooks for
-     * initializing the database later during the request
-     *
-     * @param array $espresso_db_update
-     */
-    protected function _handle_core_version_change($espresso_db_update)
-    {
-        $this->update_list_of_installed_versions($espresso_db_update);
-        //get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
-        add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required'));
-    }
-
-
-
-    /**
-     * standardizes the wp option 'espresso_db_upgrade' which actually stores
-     * information about what versions of EE have been installed and activated,
-     * NOT necessarily the state of the database
-     *
-     * @param null $espresso_db_update
-     * @internal param array $espresso_db_update_value the value of the WordPress option. If not supplied, fetches it
-     *           from the options table
-     * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
-     */
-    private function fix_espresso_db_upgrade_option($espresso_db_update = null)
-    {
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if ( ! $espresso_db_update) {
-            $espresso_db_update = get_option('espresso_db_update');
-        }
-        // check that option is an array
-        if ( ! is_array($espresso_db_update)) {
-            // if option is FALSE, then it never existed
-            if ($espresso_db_update === false) {
-                // make $espresso_db_update an array and save option with autoload OFF
-                $espresso_db_update = array();
-                add_option('espresso_db_update', $espresso_db_update, '', 'no');
-            } else {
-                // option is NOT FALSE but also is NOT an array, so make it an array and save it
-                $espresso_db_update = array($espresso_db_update => array());
-                update_option('espresso_db_update', $espresso_db_update);
-            }
-        } else {
-            $corrected_db_update = array();
-            //if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
-            foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
-                if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
-                    //the key is an int, and the value IS NOT an array
-                    //so it must be numerically-indexed, where values are versions installed...
-                    //fix it!
-                    $version_string = $should_be_array;
-                    $corrected_db_update[$version_string] = array('unknown-date');
-                } else {
-                    //ok it checks out
-                    $corrected_db_update[$should_be_version_string] = $should_be_array;
-                }
-            }
-            $espresso_db_update = $corrected_db_update;
-            update_option('espresso_db_update', $espresso_db_update);
-        }
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
-        return $espresso_db_update;
-    }
-
-
-
-    /**
-     * Does the traditional work of setting up the plugin's database and adding default data.
-     * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
-     * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
-     * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
-     * so that it will be done when migrations are finished
-     *
-     * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
-     * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
-     *                                       This is a resource-intensive job
-     *                                       so we prefer to only do it when necessary
-     * @return void
-     */
-    public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
-    {
-        $request_type = $this->detect_req_type();
-        //only initialize system if we're not in maintenance mode.
-        if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
-            update_option('ee_flush_rewrite_rules', true);
-            if ($verify_schema) {
-                EEH_Activation::initialize_db_and_folders();
-            }
-            EEH_Activation::initialize_db_content();
-            EEH_Activation::system_initialization();
-            if ($initialize_addons_too) {
-                $this->initialize_addons();
-            }
-        } else {
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
-        }
-        if ($request_type === EE_System::req_type_new_activation
-            || $request_type === EE_System::req_type_reactivation
-            || (
-                $request_type === EE_System::req_type_upgrade
-                && $this->is_major_version_change()
-            )
-        ) {
-            add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
-        }
-    }
-
-
-
-    /**
-     * Initializes the db for all registered addons
-     */
-    public function initialize_addons()
-    {
-        //foreach registered addon, make sure its db is up-to-date too
-        foreach ($this->registry->addons as $addon) {
-            $addon->initialize_db_if_no_migrations_required();
-        }
-    }
-
-
-
-    /**
-     * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
-     *
-     * @param    array  $version_history
-     * @param    string $current_version_to_add version to be added to the version history
-     * @return    boolean success as to whether or not this option was changed
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
-    {
-        if ( ! $version_history) {
-            $version_history = $this->fix_espresso_db_upgrade_option($version_history);
-        }
-        if ($current_version_to_add == null) {
-            $current_version_to_add = espresso_version();
-        }
-        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
-        // re-save
-        return update_option('espresso_db_update', $version_history);
-    }
-
-
-
-    /**
-     * Detects if the current version indicated in the has existed in the list of
-     * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
-     *
-     * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
-     *                                  If not supplied, fetches it from the options table.
-     *                                  Also, caches its result so later parts of the code can also know whether
-     *                                  there's been an update or not. This way we can add the current version to
-     *                                  espresso_db_update, but still know if this is a new install or not
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public function detect_req_type($espresso_db_update = null)
-    {
-        if ($this->_req_type === null) {
-            $espresso_db_update = ! empty($espresso_db_update) ? $espresso_db_update
-                : $this->fix_espresso_db_upgrade_option();
-            $this->_req_type = $this->detect_req_type_given_activation_history($espresso_db_update,
-                'ee_espresso_activation', espresso_version());
-            $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
-        }
-        return $this->_req_type;
-    }
-
-
-
-    /**
-     * Returns whether or not there was a non-micro version change (ie, change in either
-     * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
-     * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @param $activation_history
-     * @return bool
-     */
-    protected function _detect_major_version_change($activation_history)
-    {
-        $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
-        $previous_version_parts = explode('.', $previous_version);
-        $current_version_parts = explode('.', espresso_version());
-        return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
-               && ($previous_version_parts[0] !== $current_version_parts[0]
-                   || $previous_version_parts[1] !== $current_version_parts[1]
-               );
-    }
-
-
-
-    /**
-     * Returns true if either the major or minor version of EE changed during this request.
-     * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @return bool
-     */
-    public function is_major_version_change()
-    {
-        return $this->_major_version_change;
-    }
-
-
-
-    /**
-     * Determines the request type for any ee addon, given three piece of info: the current array of activation
-     * histories (for core that' 'espresso_db_update' wp option); the name of the wordpress option which is temporarily
-     * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
-     * just activated to (for core that will always be espresso_version())
-     *
-     * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
-     *                                                 ee plugin. for core that's 'espresso_db_update'
-     * @param string $activation_indicator_option_name the name of the wordpress option that is temporarily set to
-     *                                                 indicate that this plugin was just activated
-     * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
-     *                                                 espresso_version())
-     * @return int one of the constants on EE_System::req_type_*
-     */
-    public static function detect_req_type_given_activation_history(
-        $activation_history_for_addon,
-        $activation_indicator_option_name,
-        $version_to_upgrade_to
-    ) {
-        $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
-        if ($activation_history_for_addon) {
-            //it exists, so this isn't a completely new install
-            //check if this version already in that list of previously installed versions
-            if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
-                //it a version we haven't seen before
-                if ($version_is_higher === 1) {
-                    $req_type = EE_System::req_type_upgrade;
-                } else {
-                    $req_type = EE_System::req_type_downgrade;
-                }
-                delete_option($activation_indicator_option_name);
-            } else {
-                // its not an update. maybe a reactivation?
-                if (get_option($activation_indicator_option_name, false)) {
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        //we've seen this version before, but it's an activation. must be a reactivation
-                        $req_type = EE_System::req_type_reactivation;
-                    } else {//$version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                    delete_option($activation_indicator_option_name);
-                } else {
-                    //we've seen this version before and the activation indicate doesn't show it was just activated
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        //we've seen this version before and it's not an activation. its normal request
-                        $req_type = EE_System::req_type_normal;
-                    } else {//$version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                }
-            }
-        } else {
-            //brand new install
-            $req_type = EE_System::req_type_new_activation;
-            delete_option($activation_indicator_option_name);
-        }
-        return $req_type;
-    }
-
-
-
-    /**
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
-     * the $activation_history_for_addon
-     *
-     * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
-     *                                             sometimes containing 'unknown-date'
-     * @param string $version_to_upgrade_to        (current version)
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
-     *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
-     *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
-     *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
-     */
-    protected static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
-    {
-        //find the most recently-activated version
-        $most_recently_active_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
-        return version_compare($version_to_upgrade_to, $most_recently_active_version);
-    }
-
-
-
-    /**
-     * Gets the most recently active version listed in the activation history,
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
-     *
-     * @param array $activation_history  (keys are versions, values are arrays of times activated,
-     *                                   sometimes containing 'unknown-date'
-     * @return string
-     */
-    protected static function _get_most_recently_active_version_from_activation_history($activation_history)
-    {
-        $most_recently_active_version_activation = '1970-01-01 00:00:00';
-        $most_recently_active_version = '0.0.0.dev.000';
-        if (is_array($activation_history)) {
-            foreach ($activation_history as $version => $times_activated) {
-                //check there is a record of when this version was activated. Otherwise,
-                //mark it as unknown
-                if ( ! $times_activated) {
-                    $times_activated = array('unknown-date');
-                }
-                if (is_string($times_activated)) {
-                    $times_activated = array($times_activated);
-                }
-                foreach ($times_activated as $an_activation) {
-                    if ($an_activation != 'unknown-date' && $an_activation > $most_recently_active_version_activation) {
-                        $most_recently_active_version = $version;
-                        $most_recently_active_version_activation = $an_activation == 'unknown-date'
-                            ? '1970-01-01 00:00:00' : $an_activation;
-                    }
-                }
-            }
-        }
-        return $most_recently_active_version;
-    }
-
-
-
-    /**
-     * This redirects to the about EE page after activation
-     *
-     * @return void
-     */
-    public function redirect_to_about_ee()
-    {
-        $notices = EE_Error::get_notices(false);
-        //if current user is an admin and it's not an ajax or rest request
-        if (
-            ! (defined('DOING_AJAX') && DOING_AJAX)
-            && ! (defined('REST_REQUEST') && REST_REQUEST)
-            && ! isset($notices['errors'])
-            && apply_filters(
-                'FHEE__EE_System__redirect_to_about_ee__do_redirect',
-                $this->registry->CAP->current_user_can('manage_options', 'espresso_about_default')
-            )
-        ) {
-            $query_params = array('page' => 'espresso_about');
-            if (EE_System::instance()->detect_req_type() == EE_System::req_type_new_activation) {
-                $query_params['new_activation'] = true;
-            }
-            if (EE_System::instance()->detect_req_type() == EE_System::req_type_reactivation) {
-                $query_params['reactivation'] = true;
-            }
-            $url = add_query_arg($query_params, admin_url('admin.php'));
-            wp_safe_redirect($url);
-            exit();
-        }
-    }
-
-
-
-    /**
-     * load_core_configuration
-     * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
-     * which runs during the WP 'plugins_loaded' action at priority 5
-     *
-     * @return void
-     */
-    public function load_core_configuration()
-    {
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
-        $this->registry->load_core('EE_Load_Textdomain');
-        //load textdomain
-        EE_Load_Textdomain::load_textdomain();
-        // load and setup EE_Config and EE_Network_Config
-        $this->registry->load_core('Config');
-        $this->registry->load_core('Network_Config');
-        // setup autoloaders
-        // enable logging?
-        if ($this->registry->CFG->admin->use_full_logging) {
-            $this->registry->load_core('Log');
-        }
-        // check for activation errors
-        $activation_errors = get_option('ee_plugin_activation_errors', false);
-        if ($activation_errors) {
-            EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
-            update_option('ee_plugin_activation_errors', false);
-        }
-        // get model names
-        $this->_parse_model_names();
-        //load caf stuff a chance to play during the activation process too.
-        $this->_maybe_brew_regular();
-        do_action('AHEE__EE_System__load_core_configuration__complete', $this);
-    }
-
-
-
-    /**
-     * cycles through all of the models/*.model.php files, and assembles an array of model names
-     *
-     * @return void
-     */
-    private function _parse_model_names()
-    {
-        //get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
-        $model_names = array();
-        $non_abstract_db_models = array();
-        foreach ($models as $model) {
-            // get model classname
-            $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
-            $short_name = str_replace('EEM_', '', $classname);
-            $reflectionClass = new ReflectionClass($classname);
-            if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[$short_name] = $classname;
-            }
-            $model_names[$short_name] = $classname;
-        }
-        $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
-        $this->registry->non_abstract_db_models = apply_filters('FHEE__EE_System__parse_implemented_model_names',
-            $non_abstract_db_models);
-    }
-
-
-
-    /**
-     * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
-     * that need to be setup before our EE_System launches.
-     *
-     * @return void
-     */
-    private function _maybe_brew_regular()
-    {
-        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
-        }
-    }
-
-
-
-    /**
-     * register_shortcodes_modules_and_widgets
-     * generate lists of shortcodes and modules, then verify paths and classes
-     * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
-     * which runs during the WP 'plugins_loaded' action at priority 7
-     *
-     * @access public
-     * @return void
-     */
-    public function register_shortcodes_modules_and_widgets()
-    {
-        do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
-        // check for addons using old hookpoint
-        if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
-            $this->_incompatible_addon_error();
-        }
-    }
-
-
-
-    /**
-     * _incompatible_addon_error
-     *
-     * @access public
-     * @return void
-     */
-    private function _incompatible_addon_error()
-    {
-        // get array of classes hooking into here
-        $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook('AHEE__EE_System__register_shortcodes_modules_and_addons');
-        if ( ! empty($class_names)) {
-            $msg = __('The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
-                'event_espresso');
-            $msg .= '<ul>';
-            foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
-                        $class_name) . '</b></li>';
-            }
-            $msg .= '</ul>';
-            $msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
-                'event_espresso');
-            // save list of incompatible addons to wp-options for later use
-            add_option('ee_incompatible_addons', $class_names, '', 'no');
-            if (is_admin()) {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-    }
-
-
-
-    /**
-     * brew_espresso
-     * begins the process of setting hooks for initializing EE in the correct order
-     * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hookpoint
-     * which runs during the WP 'plugins_loaded' action at priority 9
-     *
-     * @return void
-     */
-    public function brew_espresso()
-    {
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
-        // load some final core systems
-        add_action('init', array($this, 'set_hooks_for_core'), 1);
-        add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
-        add_action('init', array($this, 'load_CPTs_and_session'), 5);
-        add_action('init', array($this, 'load_controllers'), 7);
-        add_action('init', array($this, 'core_loaded_and_ready'), 9);
-        add_action('init', array($this, 'initialize'), 10);
-        add_action('init', array($this, 'initialize_last'), 100);
-        add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 100);
-        add_action('admin_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 100);
-        add_action('admin_bar_menu', array($this, 'espresso_toolbar_items'), 100);
-        if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
-            // pew pew pew
-            $this->registry->load_core('PUE');
-            do_action('AHEE__EE_System__brew_espresso__after_pue_init');
-        }
-        do_action('AHEE__EE_System__brew_espresso__complete', $this);
-    }
-
-
-
-    /**
-     *    set_hooks_for_core
-     *
-     * @access public
-     * @return    void
-     */
-    public function set_hooks_for_core()
-    {
-        $this->_deactivate_incompatible_addons();
-        do_action('AHEE__EE_System__set_hooks_for_core');
-    }
-
-
-
-    /**
-     * Using the information gathered in EE_System::_incompatible_addon_error,
-     * deactivates any addons considered incompatible with the current version of EE
-     */
-    private function _deactivate_incompatible_addons()
-    {
-        $incompatible_addons = get_option('ee_incompatible_addons', array());
-        if ( ! empty($incompatible_addons)) {
-            $active_plugins = get_option('active_plugins', array());
-            foreach ($active_plugins as $active_plugin) {
-                foreach ($incompatible_addons as $incompatible_addon) {
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
-                        unset($_GET['activate']);
-                        espresso_deactivate_plugin($active_plugin);
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    perform_activations_upgrades_and_migrations
-     *
-     * @access public
-     * @return    void
-     */
-    public function perform_activations_upgrades_and_migrations()
-    {
-        //first check if we had previously attempted to setup EE's directories but failed
-        if (EEH_Activation::upload_directories_incomplete()) {
-            EEH_Activation::create_upload_directories();
-        }
-        do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-    }
-
-
-
-    /**
-     *    load_CPTs_and_session
-     *
-     * @access public
-     * @return    void
-     */
-    public function load_CPTs_and_session()
-    {
-        do_action('AHEE__EE_System__load_CPTs_and_session__start');
-        // register Custom Post Types
-        $this->registry->load_core('Register_CPTs');
-        do_action('AHEE__EE_System__load_CPTs_and_session__complete');
-    }
-
-
-
-    /**
-     * load_controllers
-     * this is the best place to load any additional controllers that needs access to EE core.
-     * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
-     * time
-     *
-     * @access public
-     * @return void
-     */
-    public function load_controllers()
-    {
-        do_action('AHEE__EE_System__load_controllers__start');
-        // let's get it started
-        if ( ! is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
-            do_action('AHEE__EE_System__load_controllers__load_front_controllers');
-            $this->registry->load_core('Front_Controller', array(), false, true);
-        } else if ( ! EE_FRONT_AJAX) {
-            do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
-            EE_Registry::instance()->load_core('Admin');
-        }
-        do_action('AHEE__EE_System__load_controllers__complete');
-    }
-
-
-
-    /**
-     * core_loaded_and_ready
-     * all of the basic EE core should be loaded at this point and available regardless of M-Mode
-     *
-     * @access public
-     * @return void
-     */
-    public function core_loaded_and_ready()
-    {
-        do_action('AHEE__EE_System__core_loaded_and_ready');
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
-        $this->registry->load_core('Session');
-        //		add_action( 'wp_loaded', array( $this, 'set_hooks_for_shortcodes_modules_and_addons' ), 1 );
-    }
-
-
-
-    /**
-     * initialize
-     * this is the best place to begin initializing client code
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize()
-    {
-        do_action('AHEE__EE_System__initialize');
-    }
-
-
-
-    /**
-     * initialize_last
-     * this is run really late during the WP init hookpoint, and ensures that mostly everything else that needs to
-     * initialize has done so
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize_last()
-    {
-        do_action('AHEE__EE_System__initialize_last');
-    }
-
-
-
-    /**
-     * set_hooks_for_shortcodes_modules_and_addons
-     * this is the best place for other systems to set callbacks for hooking into other parts of EE
-     * this happens at the very beginning of the wp_loaded hookpoint
-     *
-     * @access public
-     * @return void
-     */
-    public function set_hooks_for_shortcodes_modules_and_addons()
-    {
-        //		do_action( 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons' );
-    }
-
-
-
-    /**
-     * do_not_cache
-     * sets no cache headers and defines no cache constants for WP plugins
-     *
-     * @access public
-     * @return void
-     */
-    public static function do_not_cache()
-    {
-        // set no cache constants
-        if ( ! defined('DONOTCACHEPAGE')) {
-            define('DONOTCACHEPAGE', true);
-        }
-        if ( ! defined('DONOTCACHCEOBJECT')) {
-            define('DONOTCACHCEOBJECT', true);
-        }
-        if ( ! defined('DONOTCACHEDB')) {
-            define('DONOTCACHEDB', true);
-        }
-        // add no cache headers
-        add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
-        // plus a little extra for nginx and Google Chrome
-        add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
-
-
-
-    /**
-     *    extra_nocache_headers
-     *
-     * @access    public
-     * @param $headers
-     * @return    array
-     */
-    public static function extra_nocache_headers($headers)
-    {
-        // for NGINX
-        $headers['X-Accel-Expires'] = 0;
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
-        return $headers;
-    }
-
-
-
-    /**
-     *    nocache_headers
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function nocache_headers()
-    {
-        nocache_headers();
-    }
-
-
-
-    /**
-     *    espresso_toolbar_items
-     *
-     * @access public
-     * @param  WP_Admin_Bar $admin_bar
-     * @return void
-     */
-    public function espresso_toolbar_items(WP_Admin_Bar $admin_bar)
-    {
-        // if in full M-Mode, or its an AJAX request, or user is NOT an admin
-        if (EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
-            || defined('DOING_AJAX')
-            || ! $this->registry->CAP->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
-        ) {
-            return;
-        }
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $menu_class = 'espresso_menu_item_class';
-        //we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
-        //because they're only defined in each of their respective constructors
-        //and this might be a frontend request, in which case they aren't available
-        $events_admin_url = admin_url("admin.php?page=espresso_events");
-        $reg_admin_url = admin_url("admin.php?page=espresso_registrations");
-        $extensions_admin_url = admin_url("admin.php?page=espresso_packages");
-        //Top Level
-        $admin_bar->add_menu(array(
-            'id'    => 'espresso-toolbar',
-            'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
-                       . _x('Event Espresso', 'admin bar menu group label', 'event_espresso')
-                       . '</span>',
-            'href'  => $events_admin_url,
-            'meta'  => array(
-                'title' => __('Event Espresso', 'event_espresso'),
-                'class' => $menu_class . 'first',
-            ),
-        ));
-        //Events
-        if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events')) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events',
-                'parent' => 'espresso-toolbar',
-                'title'  => __('Events', 'event_espresso'),
-                'href'   => $events_admin_url,
-                'meta'   => array(
-                    'title'  => __('Events', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if ($this->registry->CAP->current_user_can('ee_edit_events', 'ee_admin_bar_menu_espresso-toolbar-events-new')) {
-            //Events Add New
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-new',
-                'parent' => 'espresso-toolbar-events',
-                'title'  => __('Add New', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'create_new'), $events_admin_url),
-                'meta'   => array(
-                    'title'  => __('Add New', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if (is_single() && (get_post_type() == 'espresso_events')) {
-            //Current post
-            global $post;
-            if ($this->registry->CAP->current_user_can('ee_edit_event',
-                'ee_admin_bar_menu_espresso-toolbar-events-edit', $post->ID)
-            ) {
-                //Events Edit Current Event
-                $admin_bar->add_menu(array(
-                    'id'     => 'espresso-toolbar-events-edit',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => __('Edit Event', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'edit', 'post' => $post->ID),
-                        $events_admin_url),
-                    'meta'   => array(
-                        'title'  => __('Edit Event', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $menu_class,
-                    ),
-                ));
-            }
-        }
-        //Events View
-        if ($this->registry->CAP->current_user_can('ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-view')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-view',
-                'parent' => 'espresso-toolbar-events',
-                'title'  => __('View', 'event_espresso'),
-                'href'   => $events_admin_url,
-                'meta'   => array(
-                    'title'  => __('View', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events-all')) {
-            //Events View All
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-all',
-                'parent' => 'espresso-toolbar-events-view',
-                'title'  => __('All', 'event_espresso'),
-                'href'   => $events_admin_url,
-                'meta'   => array(
-                    'title'  => __('All', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if ($this->registry->CAP->current_user_can('ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-today')
-        ) {
-            //Events View Today
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-today',
-                'parent' => 'espresso-toolbar-events-view',
-                'title'  => __('Today', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
-                    $events_admin_url),
-                'meta'   => array(
-                    'title'  => __('Today', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if ($this->registry->CAP->current_user_can('ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-month')
-        ) {
-            //Events View This Month
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-month',
-                'parent' => 'espresso-toolbar-events-view',
-                'title'  => __('This Month', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
-                    $events_admin_url),
-                'meta'   => array(
-                    'title'  => __('This Month', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations',
-                'parent' => 'espresso-toolbar',
-                'title'  => __('Registrations', 'event_espresso'),
-                'href'   => $reg_admin_url,
-                'meta'   => array(
-                    'title'  => __('Registrations', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today',
-                'parent' => 'espresso-toolbar-registrations',
-                'title'  => __('Today', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
-                    $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Today', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today Completed
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today-approved',
-                'parent' => 'espresso-toolbar-registrations-today',
-                'title'  => __('Approved', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'today',
-                    '_reg_status' => EEM_Registration::status_id_approved,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Approved', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today Pending\
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today-pending',
-                'parent' => 'espresso-toolbar-registrations-today',
-                'title'  => __('Pending', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'     => 'default',
-                    'status'     => 'today',
-                    'reg_status' => EEM_Registration::status_id_pending_payment,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Pending Payment', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today Incomplete
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today-not-approved',
-                'parent' => 'espresso-toolbar-registrations-today',
-                'title'  => __('Not Approved', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'today',
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Not Approved', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today Incomplete
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today-cancelled',
-                'parent' => 'espresso-toolbar-registrations-today',
-                'title'  => __('Cancelled', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'today',
-                    '_reg_status' => EEM_Registration::status_id_cancelled,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Cancelled', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month',
-                'parent' => 'espresso-toolbar-registrations',
-                'title'  => __('This Month', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
-                    $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('This Month', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month Approved
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month-approved',
-                'parent' => 'espresso-toolbar-registrations-month',
-                'title'  => __('Approved', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'month',
-                    '_reg_status' => EEM_Registration::status_id_approved,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Approved', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month Pending
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month-pending',
-                'parent' => 'espresso-toolbar-registrations-month',
-                'title'  => __('Pending', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'month',
-                    '_reg_status' => EEM_Registration::status_id_pending_payment,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Pending', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month Not Approved
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month-not-approved',
-                'parent' => 'espresso-toolbar-registrations-month',
-                'title'  => __('Not Approved', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'month',
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Not Approved', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month Cancelled
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month-cancelled',
-                'parent' => 'espresso-toolbar-registrations-month',
-                'title'  => __('Cancelled', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'month',
-                    '_reg_status' => EEM_Registration::status_id_cancelled,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Cancelled', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Extensions & Services
-        if ($this->registry->CAP->current_user_can('ee_read_ee',
-            'ee_admin_bar_menu_espresso-toolbar-extensions-and-services')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-extensions-and-services',
-                'parent' => 'espresso-toolbar',
-                'title'  => __('Extensions & Services', 'event_espresso'),
-                'href'   => $extensions_admin_url,
-                'meta'   => array(
-                    'title'  => __('Extensions & Services', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-    }
-
-
-
-    /**
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
-     * never returned with the function.
-     *
-     * @param  array $exclude_array any existing pages being excluded are in this array.
-     * @return array
-     */
-    public function remove_pages_from_wp_list_pages($exclude_array)
-    {
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
-    }
-
-
-
-
-
-
-    /***********************************************        WP_ENQUEUE_SCRIPTS HOOK         ***********************************************/
-    /**
-     *    wp_enqueue_scripts
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp_enqueue_scripts()
-    {
-        // unlike other systems, EE_System_scripts loading is turned ON by default, but prior to the init hook, can be turned off via: add_filter( 'FHEE_load_EE_System_scripts', '__return_false' );
-        if (apply_filters('FHEE_load_EE_System_scripts', true)) {
-            // jquery_validate loading is turned OFF by default, but prior to the wp_enqueue_scripts hook, can be turned back on again via:  add_filter( 'FHEE_load_jquery_validate', '__return_true' );
-            if (apply_filters('FHEE_load_jquery_validate', false)) {
-                // 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);
-            }
-        }
-    }
+	/**
+	 * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
+	 * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
+	 */
+	const req_type_normal = 0;
+
+	/**
+	 * Indicates this is a brand new installation of EE so we should install
+	 * tables and default data etc
+	 */
+	const req_type_new_activation = 1;
+
+	/**
+	 * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
+	 * and we just exited maintenance mode). We MUST check the database is setup properly
+	 * and that default data is setup too
+	 */
+	const req_type_reactivation = 2;
+
+	/**
+	 * indicates that EE has been upgraded since its previous request.
+	 * We may have data migration scripts to call and will want to trigger maintenance mode
+	 */
+	const req_type_upgrade = 3;
+
+	/**
+	 * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
+	 */
+	const req_type_downgrade = 4;
+
+	/**
+	 * @deprecated since version 4.6.0.dev.006
+	 * Now whenever a new_activation is detected the request type is still just
+	 * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
+	 * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
+	 * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
+	 * (Specifically, when the migration manager indicates migrations are finished
+	 * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
+	 */
+	const req_type_activation_but_not_installed = 5;
+
+	/**
+	 * option prefix for recording the activation history (like core's "espresso_db_update") of addons
+	 */
+	const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
+
+
+	/**
+	 *    instance of the EE_System object
+	 *
+	 * @var    $_instance
+	 * @access    private
+	 */
+	private static $_instance = null;
+
+	/**
+	 * @type  EE_Registry $Registry
+	 * @access    protected
+	 */
+	protected $registry;
+
+	/**
+	 * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
+	 * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
+	 *
+	 * @var int
+	 */
+	private $_req_type;
+
+	/**
+	 * Whether or not there was a non-micro version change in EE core version during this request
+	 *
+	 * @var boolean
+	 */
+	private $_major_version_change = false;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param  \EE_Registry $Registry
+	 * @return \EE_System
+	 */
+	public static function instance(EE_Registry $Registry = null)
+	{
+		// check if class object is instantiated
+		if ( ! self::$_instance instanceof EE_System) {
+			self::$_instance = new self($Registry);
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * resets the instance and returns it
+	 *
+	 * @return EE_System
+	 */
+	public static function reset()
+	{
+		self::$_instance->_req_type = null;
+		//make sure none of the old hooks are left hanging around
+		remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+		//we need to reset the migration manager in order for it to detect DMSs properly
+		EE_Data_Migration_Manager::reset();
+		self::instance()->detect_activations_or_upgrades();
+		self::instance()->perform_activations_upgrades_and_migrations();
+		return self::instance();
+	}
+
+
+
+	/**
+	 *    sets hooks for running rest of system
+	 *    provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 *    starting EE Addons from any other point may lead to problems
+	 *
+	 * @access private
+	 * @param  \EE_Registry $Registry
+	 */
+	private function __construct(EE_Registry $Registry)
+	{
+		$this->registry = $Registry;
+		do_action('AHEE__EE_System__construct__begin', $this);
+		// allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
+		add_action('AHEE__EE_Bootstrap__load_espresso_addons', array($this, 'load_espresso_addons'));
+		// when an ee addon is activated, we want to call the core hook(s) again
+		// because the newly-activated addon didn't get a chance to run at all
+		add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
+		// detect whether install or upgrade
+		add_action('AHEE__EE_Bootstrap__detect_activations_or_upgrades', array($this, 'detect_activations_or_upgrades'),
+			3);
+		// load EE_Config, EE_Textdomain, etc
+		add_action('AHEE__EE_Bootstrap__load_core_configuration', array($this, 'load_core_configuration'), 5);
+		// load EE_Config, EE_Textdomain, etc
+		add_action('AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
+			array($this, 'register_shortcodes_modules_and_widgets'), 7);
+		// you wanna get going? I wanna get going... let's get going!
+		add_action('AHEE__EE_Bootstrap__brew_espresso', array($this, 'brew_espresso'), 9);
+		//other housekeeping
+		//exclude EE critical pages from wp_list_pages
+		add_filter('wp_list_pages_excludes', array($this, 'remove_pages_from_wp_list_pages'), 10);
+		// ALL EE Addons should use the following hook point to attach their initial setup too
+		// it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
+		do_action('AHEE__EE_System__construct__complete', $this);
+	}
+
+
+
+	/**
+	 * load_espresso_addons
+	 * allow addons to load first so that they can set hooks for running DMS's, etc
+	 * this is hooked into both:
+	 *    'AHEE__EE_Bootstrap__load_core_configuration'
+	 *        which runs during the WP 'plugins_loaded' action at priority 5
+	 *    and the WP 'activate_plugin' hookpoint
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_espresso_addons()
+	{
+		// set autoloaders for all of the classes implementing EEI_Plugin_API
+		// which provide helpers for EE plugin authors to more easily register certain components with EE.
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+		//load and setup EE_Capabilities
+		$this->registry->load_core('Capabilities');
+		//caps need to be initialized on every request so that capability maps are set.
+		//@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
+		$this->registry->CAP->init_caps();
+		do_action('AHEE__EE_System__load_espresso_addons');
+		//if the WP API basic auth plugin isn't already loaded, load it now.
+		//We want it for mobile apps. Just include the entire plugin
+		//also, don't load the basic auth when a plugin is getting activated, because
+		//it could be the basic auth plugin, and it doesn't check if its methods are already defined
+		//and causes a fatal error
+		if ( ! function_exists('json_basic_auth_handler')
+			 && ! function_exists('json_basic_auth_error')
+			 && ! (
+				isset($_GET['action'])
+				&& in_array($_GET['action'], array('activate', 'activate-selected'))
+			)
+			 && ! (
+				isset($_GET['activate'])
+				&& $_GET['activate'] === 'true'
+			)
+		) {
+			include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
+		}
+		do_action('AHEE__EE_System__load_espresso_addons__complete');
+	}
+
+
+
+	/**
+	 * detect_activations_or_upgrades
+	 * Checks for activation or upgrade of core first;
+	 * then also checks if any registered addons have been activated or upgraded
+	 * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
+	 * which runs during the WP 'plugins_loaded' action at priority 3
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_activations_or_upgrades()
+	{
+		//first off: let's make sure to handle core
+		$this->detect_if_activation_or_upgrade();
+		foreach ($this->registry->addons as $addon) {
+			//detect teh request type for that addon
+			$addon->detect_activation_or_upgrade();
+		}
+	}
+
+
+
+	/**
+	 * detect_if_activation_or_upgrade
+	 * Takes care of detecting whether this is a brand new install or code upgrade,
+	 * and either setting up the DB or setting up maintenance mode etc.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_if_activation_or_upgrade()
+	{
+		do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
+		// load M-Mode class
+		$this->registry->load_core('Maintenance_Mode');
+		// check if db has been updated, or if its a brand-new installation
+		$espresso_db_update = $this->fix_espresso_db_upgrade_option();
+		$request_type = $this->detect_req_type($espresso_db_update);
+		//EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
+				//migrations may be required now that we've upgraded
+				EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				//				echo "done upgrade";die;
+				break;
+			case EE_System::req_type_downgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
+				//its possible migrations are no longer required
+				EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				//				$this->_maybe_redirect_to_ee_about();
+				break;
+		}
+		do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
+	}
+
+
+
+	/**
+	 * Updates the list of installed versions and sets hooks for
+	 * initializing the database later during the request
+	 *
+	 * @param array $espresso_db_update
+	 */
+	protected function _handle_core_version_change($espresso_db_update)
+	{
+		$this->update_list_of_installed_versions($espresso_db_update);
+		//get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
+		add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required'));
+	}
+
+
+
+	/**
+	 * standardizes the wp option 'espresso_db_upgrade' which actually stores
+	 * information about what versions of EE have been installed and activated,
+	 * NOT necessarily the state of the database
+	 *
+	 * @param null $espresso_db_update
+	 * @internal param array $espresso_db_update_value the value of the WordPress option. If not supplied, fetches it
+	 *           from the options table
+	 * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
+	 */
+	private function fix_espresso_db_upgrade_option($espresso_db_update = null)
+	{
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
+		if ( ! $espresso_db_update) {
+			$espresso_db_update = get_option('espresso_db_update');
+		}
+		// check that option is an array
+		if ( ! is_array($espresso_db_update)) {
+			// if option is FALSE, then it never existed
+			if ($espresso_db_update === false) {
+				// make $espresso_db_update an array and save option with autoload OFF
+				$espresso_db_update = array();
+				add_option('espresso_db_update', $espresso_db_update, '', 'no');
+			} else {
+				// option is NOT FALSE but also is NOT an array, so make it an array and save it
+				$espresso_db_update = array($espresso_db_update => array());
+				update_option('espresso_db_update', $espresso_db_update);
+			}
+		} else {
+			$corrected_db_update = array();
+			//if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
+			foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
+				if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
+					//the key is an int, and the value IS NOT an array
+					//so it must be numerically-indexed, where values are versions installed...
+					//fix it!
+					$version_string = $should_be_array;
+					$corrected_db_update[$version_string] = array('unknown-date');
+				} else {
+					//ok it checks out
+					$corrected_db_update[$should_be_version_string] = $should_be_array;
+				}
+			}
+			$espresso_db_update = $corrected_db_update;
+			update_option('espresso_db_update', $espresso_db_update);
+		}
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
+		return $espresso_db_update;
+	}
+
+
+
+	/**
+	 * Does the traditional work of setting up the plugin's database and adding default data.
+	 * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
+	 * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
+	 * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
+	 * so that it will be done when migrations are finished
+	 *
+	 * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
+	 * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
+	 *                                       This is a resource-intensive job
+	 *                                       so we prefer to only do it when necessary
+	 * @return void
+	 */
+	public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
+	{
+		$request_type = $this->detect_req_type();
+		//only initialize system if we're not in maintenance mode.
+		if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
+			update_option('ee_flush_rewrite_rules', true);
+			if ($verify_schema) {
+				EEH_Activation::initialize_db_and_folders();
+			}
+			EEH_Activation::initialize_db_content();
+			EEH_Activation::system_initialization();
+			if ($initialize_addons_too) {
+				$this->initialize_addons();
+			}
+		} else {
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
+		}
+		if ($request_type === EE_System::req_type_new_activation
+			|| $request_type === EE_System::req_type_reactivation
+			|| (
+				$request_type === EE_System::req_type_upgrade
+				&& $this->is_major_version_change()
+			)
+		) {
+			add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
+		}
+	}
+
+
+
+	/**
+	 * Initializes the db for all registered addons
+	 */
+	public function initialize_addons()
+	{
+		//foreach registered addon, make sure its db is up-to-date too
+		foreach ($this->registry->addons as $addon) {
+			$addon->initialize_db_if_no_migrations_required();
+		}
+	}
+
+
+
+	/**
+	 * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
+	 *
+	 * @param    array  $version_history
+	 * @param    string $current_version_to_add version to be added to the version history
+	 * @return    boolean success as to whether or not this option was changed
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
+	{
+		if ( ! $version_history) {
+			$version_history = $this->fix_espresso_db_upgrade_option($version_history);
+		}
+		if ($current_version_to_add == null) {
+			$current_version_to_add = espresso_version();
+		}
+		$version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
+		// re-save
+		return update_option('espresso_db_update', $version_history);
+	}
+
+
+
+	/**
+	 * Detects if the current version indicated in the has existed in the list of
+	 * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
+	 *
+	 * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
+	 *                                  If not supplied, fetches it from the options table.
+	 *                                  Also, caches its result so later parts of the code can also know whether
+	 *                                  there's been an update or not. This way we can add the current version to
+	 *                                  espresso_db_update, but still know if this is a new install or not
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public function detect_req_type($espresso_db_update = null)
+	{
+		if ($this->_req_type === null) {
+			$espresso_db_update = ! empty($espresso_db_update) ? $espresso_db_update
+				: $this->fix_espresso_db_upgrade_option();
+			$this->_req_type = $this->detect_req_type_given_activation_history($espresso_db_update,
+				'ee_espresso_activation', espresso_version());
+			$this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
+		}
+		return $this->_req_type;
+	}
+
+
+
+	/**
+	 * Returns whether or not there was a non-micro version change (ie, change in either
+	 * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
+	 * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @param $activation_history
+	 * @return bool
+	 */
+	protected function _detect_major_version_change($activation_history)
+	{
+		$previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
+		$previous_version_parts = explode('.', $previous_version);
+		$current_version_parts = explode('.', espresso_version());
+		return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
+			   && ($previous_version_parts[0] !== $current_version_parts[0]
+				   || $previous_version_parts[1] !== $current_version_parts[1]
+			   );
+	}
+
+
+
+	/**
+	 * Returns true if either the major or minor version of EE changed during this request.
+	 * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @return bool
+	 */
+	public function is_major_version_change()
+	{
+		return $this->_major_version_change;
+	}
+
+
+
+	/**
+	 * Determines the request type for any ee addon, given three piece of info: the current array of activation
+	 * histories (for core that' 'espresso_db_update' wp option); the name of the wordpress option which is temporarily
+	 * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
+	 * just activated to (for core that will always be espresso_version())
+	 *
+	 * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
+	 *                                                 ee plugin. for core that's 'espresso_db_update'
+	 * @param string $activation_indicator_option_name the name of the wordpress option that is temporarily set to
+	 *                                                 indicate that this plugin was just activated
+	 * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
+	 *                                                 espresso_version())
+	 * @return int one of the constants on EE_System::req_type_*
+	 */
+	public static function detect_req_type_given_activation_history(
+		$activation_history_for_addon,
+		$activation_indicator_option_name,
+		$version_to_upgrade_to
+	) {
+		$version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
+		if ($activation_history_for_addon) {
+			//it exists, so this isn't a completely new install
+			//check if this version already in that list of previously installed versions
+			if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
+				//it a version we haven't seen before
+				if ($version_is_higher === 1) {
+					$req_type = EE_System::req_type_upgrade;
+				} else {
+					$req_type = EE_System::req_type_downgrade;
+				}
+				delete_option($activation_indicator_option_name);
+			} else {
+				// its not an update. maybe a reactivation?
+				if (get_option($activation_indicator_option_name, false)) {
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						//we've seen this version before, but it's an activation. must be a reactivation
+						$req_type = EE_System::req_type_reactivation;
+					} else {//$version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+					delete_option($activation_indicator_option_name);
+				} else {
+					//we've seen this version before and the activation indicate doesn't show it was just activated
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						//we've seen this version before and it's not an activation. its normal request
+						$req_type = EE_System::req_type_normal;
+					} else {//$version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+				}
+			}
+		} else {
+			//brand new install
+			$req_type = EE_System::req_type_new_activation;
+			delete_option($activation_indicator_option_name);
+		}
+		return $req_type;
+	}
+
+
+
+	/**
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
+	 * the $activation_history_for_addon
+	 *
+	 * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
+	 *                                             sometimes containing 'unknown-date'
+	 * @param string $version_to_upgrade_to        (current version)
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
+	 *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
+	 *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
+	 *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
+	 */
+	protected static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
+	{
+		//find the most recently-activated version
+		$most_recently_active_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
+		return version_compare($version_to_upgrade_to, $most_recently_active_version);
+	}
+
+
+
+	/**
+	 * Gets the most recently active version listed in the activation history,
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
+	 *
+	 * @param array $activation_history  (keys are versions, values are arrays of times activated,
+	 *                                   sometimes containing 'unknown-date'
+	 * @return string
+	 */
+	protected static function _get_most_recently_active_version_from_activation_history($activation_history)
+	{
+		$most_recently_active_version_activation = '1970-01-01 00:00:00';
+		$most_recently_active_version = '0.0.0.dev.000';
+		if (is_array($activation_history)) {
+			foreach ($activation_history as $version => $times_activated) {
+				//check there is a record of when this version was activated. Otherwise,
+				//mark it as unknown
+				if ( ! $times_activated) {
+					$times_activated = array('unknown-date');
+				}
+				if (is_string($times_activated)) {
+					$times_activated = array($times_activated);
+				}
+				foreach ($times_activated as $an_activation) {
+					if ($an_activation != 'unknown-date' && $an_activation > $most_recently_active_version_activation) {
+						$most_recently_active_version = $version;
+						$most_recently_active_version_activation = $an_activation == 'unknown-date'
+							? '1970-01-01 00:00:00' : $an_activation;
+					}
+				}
+			}
+		}
+		return $most_recently_active_version;
+	}
+
+
+
+	/**
+	 * This redirects to the about EE page after activation
+	 *
+	 * @return void
+	 */
+	public function redirect_to_about_ee()
+	{
+		$notices = EE_Error::get_notices(false);
+		//if current user is an admin and it's not an ajax or rest request
+		if (
+			! (defined('DOING_AJAX') && DOING_AJAX)
+			&& ! (defined('REST_REQUEST') && REST_REQUEST)
+			&& ! isset($notices['errors'])
+			&& apply_filters(
+				'FHEE__EE_System__redirect_to_about_ee__do_redirect',
+				$this->registry->CAP->current_user_can('manage_options', 'espresso_about_default')
+			)
+		) {
+			$query_params = array('page' => 'espresso_about');
+			if (EE_System::instance()->detect_req_type() == EE_System::req_type_new_activation) {
+				$query_params['new_activation'] = true;
+			}
+			if (EE_System::instance()->detect_req_type() == EE_System::req_type_reactivation) {
+				$query_params['reactivation'] = true;
+			}
+			$url = add_query_arg($query_params, admin_url('admin.php'));
+			wp_safe_redirect($url);
+			exit();
+		}
+	}
+
+
+
+	/**
+	 * load_core_configuration
+	 * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
+	 * which runs during the WP 'plugins_loaded' action at priority 5
+	 *
+	 * @return void
+	 */
+	public function load_core_configuration()
+	{
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
+		$this->registry->load_core('EE_Load_Textdomain');
+		//load textdomain
+		EE_Load_Textdomain::load_textdomain();
+		// load and setup EE_Config and EE_Network_Config
+		$this->registry->load_core('Config');
+		$this->registry->load_core('Network_Config');
+		// setup autoloaders
+		// enable logging?
+		if ($this->registry->CFG->admin->use_full_logging) {
+			$this->registry->load_core('Log');
+		}
+		// check for activation errors
+		$activation_errors = get_option('ee_plugin_activation_errors', false);
+		if ($activation_errors) {
+			EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
+			update_option('ee_plugin_activation_errors', false);
+		}
+		// get model names
+		$this->_parse_model_names();
+		//load caf stuff a chance to play during the activation process too.
+		$this->_maybe_brew_regular();
+		do_action('AHEE__EE_System__load_core_configuration__complete', $this);
+	}
+
+
+
+	/**
+	 * cycles through all of the models/*.model.php files, and assembles an array of model names
+	 *
+	 * @return void
+	 */
+	private function _parse_model_names()
+	{
+		//get all the files in the EE_MODELS folder that end in .model.php
+		$models = glob(EE_MODELS . '*.model.php');
+		$model_names = array();
+		$non_abstract_db_models = array();
+		foreach ($models as $model) {
+			// get model classname
+			$classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
+			$short_name = str_replace('EEM_', '', $classname);
+			$reflectionClass = new ReflectionClass($classname);
+			if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
+				$non_abstract_db_models[$short_name] = $classname;
+			}
+			$model_names[$short_name] = $classname;
+		}
+		$this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
+		$this->registry->non_abstract_db_models = apply_filters('FHEE__EE_System__parse_implemented_model_names',
+			$non_abstract_db_models);
+	}
+
+
+
+	/**
+	 * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
+	 * that need to be setup before our EE_System launches.
+	 *
+	 * @return void
+	 */
+	private function _maybe_brew_regular()
+	{
+		if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
+		}
+	}
+
+
+
+	/**
+	 * register_shortcodes_modules_and_widgets
+	 * generate lists of shortcodes and modules, then verify paths and classes
+	 * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
+	 * which runs during the WP 'plugins_loaded' action at priority 7
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function register_shortcodes_modules_and_widgets()
+	{
+		do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
+		// check for addons using old hookpoint
+		if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
+			$this->_incompatible_addon_error();
+		}
+	}
+
+
+
+	/**
+	 * _incompatible_addon_error
+	 *
+	 * @access public
+	 * @return void
+	 */
+	private function _incompatible_addon_error()
+	{
+		// get array of classes hooking into here
+		$class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook('AHEE__EE_System__register_shortcodes_modules_and_addons');
+		if ( ! empty($class_names)) {
+			$msg = __('The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
+				'event_espresso');
+			$msg .= '<ul>';
+			foreach ($class_names as $class_name) {
+				$msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
+						$class_name) . '</b></li>';
+			}
+			$msg .= '</ul>';
+			$msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
+				'event_espresso');
+			// save list of incompatible addons to wp-options for later use
+			add_option('ee_incompatible_addons', $class_names, '', 'no');
+			if (is_admin()) {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+	}
+
+
+
+	/**
+	 * brew_espresso
+	 * begins the process of setting hooks for initializing EE in the correct order
+	 * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hookpoint
+	 * which runs during the WP 'plugins_loaded' action at priority 9
+	 *
+	 * @return void
+	 */
+	public function brew_espresso()
+	{
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
+		// load some final core systems
+		add_action('init', array($this, 'set_hooks_for_core'), 1);
+		add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
+		add_action('init', array($this, 'load_CPTs_and_session'), 5);
+		add_action('init', array($this, 'load_controllers'), 7);
+		add_action('init', array($this, 'core_loaded_and_ready'), 9);
+		add_action('init', array($this, 'initialize'), 10);
+		add_action('init', array($this, 'initialize_last'), 100);
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 100);
+		add_action('admin_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 100);
+		add_action('admin_bar_menu', array($this, 'espresso_toolbar_items'), 100);
+		if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
+			// pew pew pew
+			$this->registry->load_core('PUE');
+			do_action('AHEE__EE_System__brew_espresso__after_pue_init');
+		}
+		do_action('AHEE__EE_System__brew_espresso__complete', $this);
+	}
+
+
+
+	/**
+	 *    set_hooks_for_core
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function set_hooks_for_core()
+	{
+		$this->_deactivate_incompatible_addons();
+		do_action('AHEE__EE_System__set_hooks_for_core');
+	}
+
+
+
+	/**
+	 * Using the information gathered in EE_System::_incompatible_addon_error,
+	 * deactivates any addons considered incompatible with the current version of EE
+	 */
+	private function _deactivate_incompatible_addons()
+	{
+		$incompatible_addons = get_option('ee_incompatible_addons', array());
+		if ( ! empty($incompatible_addons)) {
+			$active_plugins = get_option('active_plugins', array());
+			foreach ($active_plugins as $active_plugin) {
+				foreach ($incompatible_addons as $incompatible_addon) {
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
+						unset($_GET['activate']);
+						espresso_deactivate_plugin($active_plugin);
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    perform_activations_upgrades_and_migrations
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function perform_activations_upgrades_and_migrations()
+	{
+		//first check if we had previously attempted to setup EE's directories but failed
+		if (EEH_Activation::upload_directories_incomplete()) {
+			EEH_Activation::create_upload_directories();
+		}
+		do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+	}
+
+
+
+	/**
+	 *    load_CPTs_and_session
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function load_CPTs_and_session()
+	{
+		do_action('AHEE__EE_System__load_CPTs_and_session__start');
+		// register Custom Post Types
+		$this->registry->load_core('Register_CPTs');
+		do_action('AHEE__EE_System__load_CPTs_and_session__complete');
+	}
+
+
+
+	/**
+	 * load_controllers
+	 * this is the best place to load any additional controllers that needs access to EE core.
+	 * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
+	 * time
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_controllers()
+	{
+		do_action('AHEE__EE_System__load_controllers__start');
+		// let's get it started
+		if ( ! is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
+			do_action('AHEE__EE_System__load_controllers__load_front_controllers');
+			$this->registry->load_core('Front_Controller', array(), false, true);
+		} else if ( ! EE_FRONT_AJAX) {
+			do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
+			EE_Registry::instance()->load_core('Admin');
+		}
+		do_action('AHEE__EE_System__load_controllers__complete');
+	}
+
+
+
+	/**
+	 * core_loaded_and_ready
+	 * all of the basic EE core should be loaded at this point and available regardless of M-Mode
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function core_loaded_and_ready()
+	{
+		do_action('AHEE__EE_System__core_loaded_and_ready');
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
+		$this->registry->load_core('Session');
+		//		add_action( 'wp_loaded', array( $this, 'set_hooks_for_shortcodes_modules_and_addons' ), 1 );
+	}
+
+
+
+	/**
+	 * initialize
+	 * this is the best place to begin initializing client code
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize()
+	{
+		do_action('AHEE__EE_System__initialize');
+	}
+
+
+
+	/**
+	 * initialize_last
+	 * this is run really late during the WP init hookpoint, and ensures that mostly everything else that needs to
+	 * initialize has done so
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize_last()
+	{
+		do_action('AHEE__EE_System__initialize_last');
+	}
+
+
+
+	/**
+	 * set_hooks_for_shortcodes_modules_and_addons
+	 * this is the best place for other systems to set callbacks for hooking into other parts of EE
+	 * this happens at the very beginning of the wp_loaded hookpoint
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function set_hooks_for_shortcodes_modules_and_addons()
+	{
+		//		do_action( 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons' );
+	}
+
+
+
+	/**
+	 * do_not_cache
+	 * sets no cache headers and defines no cache constants for WP plugins
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public static function do_not_cache()
+	{
+		// set no cache constants
+		if ( ! defined('DONOTCACHEPAGE')) {
+			define('DONOTCACHEPAGE', true);
+		}
+		if ( ! defined('DONOTCACHCEOBJECT')) {
+			define('DONOTCACHCEOBJECT', true);
+		}
+		if ( ! defined('DONOTCACHEDB')) {
+			define('DONOTCACHEDB', true);
+		}
+		// add no cache headers
+		add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
+		// plus a little extra for nginx and Google Chrome
+		add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
+
+
+
+	/**
+	 *    extra_nocache_headers
+	 *
+	 * @access    public
+	 * @param $headers
+	 * @return    array
+	 */
+	public static function extra_nocache_headers($headers)
+	{
+		// for NGINX
+		$headers['X-Accel-Expires'] = 0;
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
+		return $headers;
+	}
+
+
+
+	/**
+	 *    nocache_headers
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function nocache_headers()
+	{
+		nocache_headers();
+	}
+
+
+
+	/**
+	 *    espresso_toolbar_items
+	 *
+	 * @access public
+	 * @param  WP_Admin_Bar $admin_bar
+	 * @return void
+	 */
+	public function espresso_toolbar_items(WP_Admin_Bar $admin_bar)
+	{
+		// if in full M-Mode, or its an AJAX request, or user is NOT an admin
+		if (EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
+			|| defined('DOING_AJAX')
+			|| ! $this->registry->CAP->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
+		) {
+			return;
+		}
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$menu_class = 'espresso_menu_item_class';
+		//we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
+		//because they're only defined in each of their respective constructors
+		//and this might be a frontend request, in which case they aren't available
+		$events_admin_url = admin_url("admin.php?page=espresso_events");
+		$reg_admin_url = admin_url("admin.php?page=espresso_registrations");
+		$extensions_admin_url = admin_url("admin.php?page=espresso_packages");
+		//Top Level
+		$admin_bar->add_menu(array(
+			'id'    => 'espresso-toolbar',
+			'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
+					   . _x('Event Espresso', 'admin bar menu group label', 'event_espresso')
+					   . '</span>',
+			'href'  => $events_admin_url,
+			'meta'  => array(
+				'title' => __('Event Espresso', 'event_espresso'),
+				'class' => $menu_class . 'first',
+			),
+		));
+		//Events
+		if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events')) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events',
+				'parent' => 'espresso-toolbar',
+				'title'  => __('Events', 'event_espresso'),
+				'href'   => $events_admin_url,
+				'meta'   => array(
+					'title'  => __('Events', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if ($this->registry->CAP->current_user_can('ee_edit_events', 'ee_admin_bar_menu_espresso-toolbar-events-new')) {
+			//Events Add New
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-new',
+				'parent' => 'espresso-toolbar-events',
+				'title'  => __('Add New', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'create_new'), $events_admin_url),
+				'meta'   => array(
+					'title'  => __('Add New', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if (is_single() && (get_post_type() == 'espresso_events')) {
+			//Current post
+			global $post;
+			if ($this->registry->CAP->current_user_can('ee_edit_event',
+				'ee_admin_bar_menu_espresso-toolbar-events-edit', $post->ID)
+			) {
+				//Events Edit Current Event
+				$admin_bar->add_menu(array(
+					'id'     => 'espresso-toolbar-events-edit',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => __('Edit Event', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'edit', 'post' => $post->ID),
+						$events_admin_url),
+					'meta'   => array(
+						'title'  => __('Edit Event', 'event_espresso'),
+						'target' => '',
+						'class'  => $menu_class,
+					),
+				));
+			}
+		}
+		//Events View
+		if ($this->registry->CAP->current_user_can('ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-view')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-view',
+				'parent' => 'espresso-toolbar-events',
+				'title'  => __('View', 'event_espresso'),
+				'href'   => $events_admin_url,
+				'meta'   => array(
+					'title'  => __('View', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events-all')) {
+			//Events View All
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-all',
+				'parent' => 'espresso-toolbar-events-view',
+				'title'  => __('All', 'event_espresso'),
+				'href'   => $events_admin_url,
+				'meta'   => array(
+					'title'  => __('All', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if ($this->registry->CAP->current_user_can('ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-today')
+		) {
+			//Events View Today
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-today',
+				'parent' => 'espresso-toolbar-events-view',
+				'title'  => __('Today', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
+					$events_admin_url),
+				'meta'   => array(
+					'title'  => __('Today', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if ($this->registry->CAP->current_user_can('ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-month')
+		) {
+			//Events View This Month
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-month',
+				'parent' => 'espresso-toolbar-events-view',
+				'title'  => __('This Month', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
+					$events_admin_url),
+				'meta'   => array(
+					'title'  => __('This Month', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations',
+				'parent' => 'espresso-toolbar',
+				'title'  => __('Registrations', 'event_espresso'),
+				'href'   => $reg_admin_url,
+				'meta'   => array(
+					'title'  => __('Registrations', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today',
+				'parent' => 'espresso-toolbar-registrations',
+				'title'  => __('Today', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
+					$reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Today', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today Completed
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today-approved',
+				'parent' => 'espresso-toolbar-registrations-today',
+				'title'  => __('Approved', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'today',
+					'_reg_status' => EEM_Registration::status_id_approved,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Approved', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today Pending\
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today-pending',
+				'parent' => 'espresso-toolbar-registrations-today',
+				'title'  => __('Pending', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'     => 'default',
+					'status'     => 'today',
+					'reg_status' => EEM_Registration::status_id_pending_payment,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Pending Payment', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today Incomplete
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today-not-approved',
+				'parent' => 'espresso-toolbar-registrations-today',
+				'title'  => __('Not Approved', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'today',
+					'_reg_status' => EEM_Registration::status_id_not_approved,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Not Approved', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today Incomplete
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today-cancelled',
+				'parent' => 'espresso-toolbar-registrations-today',
+				'title'  => __('Cancelled', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'today',
+					'_reg_status' => EEM_Registration::status_id_cancelled,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Cancelled', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month',
+				'parent' => 'espresso-toolbar-registrations',
+				'title'  => __('This Month', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
+					$reg_admin_url),
+				'meta'   => array(
+					'title'  => __('This Month', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month Approved
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month-approved',
+				'parent' => 'espresso-toolbar-registrations-month',
+				'title'  => __('Approved', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'month',
+					'_reg_status' => EEM_Registration::status_id_approved,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Approved', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month Pending
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month-pending',
+				'parent' => 'espresso-toolbar-registrations-month',
+				'title'  => __('Pending', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'month',
+					'_reg_status' => EEM_Registration::status_id_pending_payment,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Pending', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month Not Approved
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month-not-approved',
+				'parent' => 'espresso-toolbar-registrations-month',
+				'title'  => __('Not Approved', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'month',
+					'_reg_status' => EEM_Registration::status_id_not_approved,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Not Approved', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month Cancelled
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month-cancelled',
+				'parent' => 'espresso-toolbar-registrations-month',
+				'title'  => __('Cancelled', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'month',
+					'_reg_status' => EEM_Registration::status_id_cancelled,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Cancelled', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Extensions & Services
+		if ($this->registry->CAP->current_user_can('ee_read_ee',
+			'ee_admin_bar_menu_espresso-toolbar-extensions-and-services')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-extensions-and-services',
+				'parent' => 'espresso-toolbar',
+				'title'  => __('Extensions & Services', 'event_espresso'),
+				'href'   => $extensions_admin_url,
+				'meta'   => array(
+					'title'  => __('Extensions & Services', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+	}
+
+
+
+	/**
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
+	 * never returned with the function.
+	 *
+	 * @param  array $exclude_array any existing pages being excluded are in this array.
+	 * @return array
+	 */
+	public function remove_pages_from_wp_list_pages($exclude_array)
+	{
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
+	}
+
+
+
+
+
+
+	/***********************************************        WP_ENQUEUE_SCRIPTS HOOK         ***********************************************/
+	/**
+	 *    wp_enqueue_scripts
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp_enqueue_scripts()
+	{
+		// unlike other systems, EE_System_scripts loading is turned ON by default, but prior to the init hook, can be turned off via: add_filter( 'FHEE_load_EE_System_scripts', '__return_false' );
+		if (apply_filters('FHEE_load_EE_System_scripts', true)) {
+			// jquery_validate loading is turned OFF by default, but prior to the wp_enqueue_scripts hook, can be turned back on again via:  add_filter( 'FHEE_load_jquery_validate', '__return_true' );
+			if (apply_filters('FHEE_load_jquery_validate', false)) {
+				// 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);
+			}
+		}
+	}
 
 
 

Spacing +10 added lines, -10 removed lines

@@ -182,7 +182,7 @@ 
     {
         // set autoloaders for all of the classes implementing EEI_Plugin_API
         // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'plugin_api');
         //load and setup EE_Capabilities
         $this->registry->load_core('Capabilities');
         //caps need to be initialized on every request so that capability maps are set.
@@ -205,7 +205,7 @@ 
                 && $_GET['activate'] === 'true'
             )
         ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
+            include_once EE_THIRD_PARTY.'wp-api-basic-auth'.DS.'basic-auth.php';
         }
         do_action('AHEE__EE_System__load_espresso_addons__complete');
     }
@@ -687,7 +687,7 @@ 
     private function _parse_model_names()
     {
         //get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
+        $models = glob(EE_MODELS.'*.model.php');
         $model_names = array();
         $non_abstract_db_models = array();
         foreach ($models as $model) {
@@ -715,8 +715,8 @@ 
      */
     private function _maybe_brew_regular()
     {
-        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
+        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH.'brewing_regular.php')) {
+            require_once EE_CAFF_PATH.'brewing_regular.php';
         }
     }
 
@@ -757,8 +757,8 @@ 
                 'event_espresso');
             $msg .= '<ul>';
             foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
-                        $class_name) . '</b></li>';
+                $msg .= '<li><b>Event Espresso - '.str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
+                        $class_name).'</b></li>';
             }
             $msg .= '</ul>';
             $msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
@@ -1053,7 +1053,7 @@ 
             'href'  => $events_admin_url,
             'meta'  => array(
                 'title' => __('Event Espresso', 'event_espresso'),
-                'class' => $menu_class . 'first',
+                'class' => $menu_class.'first',
             ),
         ));
         //Events
@@ -1430,10 +1430,10 @@ 
             // jquery_validate loading is turned OFF by default, but prior to the wp_enqueue_scripts hook, can be turned back on again via:  add_filter( 'FHEE_load_jquery_validate', '__return_true' );
             if (apply_filters('FHEE_load_jquery_validate', false)) {
                 // register jQuery Validate and additional methods
-                wp_register_script('jquery-validate', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
+                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',
+                    EE_GLOBAL_ASSETS_URL.'scripts/jquery.validate.additional-methods.min.js',
                     array('jquery', 'jquery-validate'), '1.15.0', true);
             }
         }

core/EE_Registry.core.php

Indentation +1336 added lines, -1336 removed lines

@@ -16,1372 +16,1372 @@
 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',
-            )
-        );
-        // 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()
-    {
-        $this->AssetsRegistry = new Registry();
-        // 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 = $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
-    ) {
-        // 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 = new 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
-     */
-    final function __destruct()
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     * @param $b
-     */
-    final function __call($a, $b)
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     */
-    final function __get($a)
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     * @param $b
-     */
-    final function __set($a, $b)
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     */
-    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',
+			)
+		);
+		// 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()
+	{
+		$this->AssetsRegistry = new Registry();
+		// 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 = $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
+	) {
+		// 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 = new 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
+	 */
+	final function __destruct()
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 * @param $b
+	 */
+	final function __call($a, $b)
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 */
+	final function __get($a)
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 * @param $b
+	 */
+	final function __set($a, $b)
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 */
+	final function __isset($a)
+	{
+	}
 
 
 
-    /**
-     * @param $a
-     */
-    final function __unset($a)
-    {
-    }
+	/**
+	 * @param $a
+	 */
+	final function __unset($a)
+	{
+	}
 
 
 
-    /**
-     * @return array
-     */
-    final function __sleep()
-    {
-        return array();
-    }
+	/**
+	 * @return array
+	 */
+	final function __sleep()
+	{
+		return array();
+	}
 
 
 
-    final function __wakeup()
-    {
-    }
+	final function __wakeup()
+	{
+	}
 
 
 
-    /**
-     * @return string
-     */
-    final function __toString()
-    {
-        return '';
-    }
+	/**
+	 * @return string
+	 */
+	final function __toString()
+	{
+		return '';
+	}
 
 
 
-    final function __invoke()
-    {
-    }
+	final function __invoke()
+	{
+	}
 
 
 
-    final function __set_state()
-    {
-    }
+	final function __set_state()
+	{
+	}
 
 
 
-    final function __clone()
-    {
-    }
+	final function __clone()
+	{
+	}
 
 
 
-    /**
-     * @param $a
-     * @param $b
-     */
-    final static function __callStatic($a, $b)
-    {
-    }
+	/**
+	 * @param $a
+	 * @param $b
+	 */
+	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/db_models/fields/EE_Foreign_Key_String_Field.php

Spacing +1 added lines, -1 removed lines

@@ -1,5 +1,5 @@
 <?php
-require_once(EE_MODELS . 'fields/EE_Foreign_Key_Field_Base.php');
+require_once(EE_MODELS.'fields/EE_Foreign_Key_Field_Base.php');
 
 class EE_Foreign_Key_String_Field extends EE_Foreign_Key_Field_Base
 {

Indentation +13 added lines, -13 removed lines

@@ -4,17 +4,17 @@
 class EE_Foreign_Key_String_Field extends EE_Foreign_Key_Field_Base
 {
 
-    /**
-     * removes all tags when setting
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        return strtoupper(wp_strip_all_tags($value_inputted_for_field_on_model_object));
-    }
+	/**
+	 * removes all tags when setting
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		return strtoupper(wp_strip_all_tags($value_inputted_for_field_on_model_object));
+	}
 }
\ No newline at end of file

core/db_models/fields/EE_Any_Foreign_Model_Name_Field.php

Spacing +1 added lines, -1 removed lines

@@ -1,5 +1,5 @@
 <?php
-require_once(EE_MODELS . 'fields/EE_DB_Only_Field_Base.php');
+require_once(EE_MODELS.'fields/EE_DB_Only_Field_Base.php');
 
 /**
  * Used by EE_Belongs_To_Any_Relations and EE_Has_Many_Any_Relations to identify the model the foreign key points to.

core/db_models/fields/EE_DB_Only_Text_Field.php

Spacing +1 added lines, -1 removed lines

@@ -1,5 +1,5 @@
 <?php
-require_once(EE_MODELS . 'fields/EE_DB_Only_Field_Base.php');
+require_once(EE_MODELS.'fields/EE_DB_Only_Field_Base.php');
 
 class EE_DB_Only_Text_Field extends EE_DB_Only_Field_Base
 {

core/db_models/relations/EE_Has_Many_Relation.php

Indentation +81 added lines, -81 removed lines

@@ -13,93 +13,93 @@
 class EE_Has_Many_Relation extends EE_Model_Relation_Base
 {
 
-    /**
-     * Object representing the relationship between two models. Has_Many_Relations are where the OTHER model has the
-     * foreign key this model. IE, there can be many other model objects related to one of this model's objects (but
-     * NOT through a JOIN table, which is the case for EE_HABTM_Relations). This knows how to join the models, get
-     * related models across the relation, and add-and-remove the relationships.
-     *
-     * @param boolean $block_deletes                 For this type of r elation, we block by default. If there are
-     *                                               related models across this relation, block (prevent and add an
-     *                                               error) the deletion of this model
-     * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
-     *                                               default
-     */
-    public function __construct($block_deletes = true, $blocking_delete_error_message = null)
-    {
-        parent::__construct($block_deletes, $blocking_delete_error_message);
-    }
+	/**
+	 * Object representing the relationship between two models. Has_Many_Relations are where the OTHER model has the
+	 * foreign key this model. IE, there can be many other model objects related to one of this model's objects (but
+	 * NOT through a JOIN table, which is the case for EE_HABTM_Relations). This knows how to join the models, get
+	 * related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param boolean $block_deletes                 For this type of r elation, we block by default. If there are
+	 *                                               related models across this relation, block (prevent and add an
+	 *                                               error) the deletion of this model
+	 * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
+	 *                                               default
+	 */
+	public function __construct($block_deletes = true, $blocking_delete_error_message = null)
+	{
+		parent::__construct($block_deletes, $blocking_delete_error_message);
+	}
 
 
-    /**
-     * Gets the SQL string for performing the join between this model and the other model.
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
-     *                other_model_primary_table.fk" etc
-     * @throws \EE_Error
-     */
-    public function get_join_statement($model_relation_chain)
-    {
-        //create the sql string like
-        // LEFT JOIN other_table AS table_alias ON this_table_alias.pk = other_table_alias.fk extra_join_conditions
-        $this_table_pk_field  = $this->get_this_model()->get_primary_key_field();
-        $other_table_fk_field = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $pk_table_alias       = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
-                $this->get_this_model()->get_this_model_name()) . $this_table_pk_field->get_table_alias();
-        $fk_table_alias       = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
-                $this->get_other_model()->get_this_model_name()) . $other_table_fk_field->get_table_alias();
-        $fk_table             = $this->get_other_model()->get_table_for_alias($fk_table_alias);
+	/**
+	 * Gets the SQL string for performing the join between this model and the other model.
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
+	 *                other_model_primary_table.fk" etc
+	 * @throws \EE_Error
+	 */
+	public function get_join_statement($model_relation_chain)
+	{
+		//create the sql string like
+		// LEFT JOIN other_table AS table_alias ON this_table_alias.pk = other_table_alias.fk extra_join_conditions
+		$this_table_pk_field  = $this->get_this_model()->get_primary_key_field();
+		$other_table_fk_field = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$pk_table_alias       = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
+				$this->get_this_model()->get_this_model_name()) . $this_table_pk_field->get_table_alias();
+		$fk_table_alias       = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
+				$this->get_other_model()->get_this_model_name()) . $other_table_fk_field->get_table_alias();
+		$fk_table             = $this->get_other_model()->get_table_for_alias($fk_table_alias);
 
-        return $this->_left_join($fk_table, $fk_table_alias, $other_table_fk_field->get_table_column(), $pk_table_alias,
-                $this_table_pk_field->get_table_column()) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
-    }
+		return $this->_left_join($fk_table, $fk_table_alias, $other_table_fk_field->get_table_column(), $pk_table_alias,
+				$this_table_pk_field->get_table_column()) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
+	}
 
 
-    /**
-     * Sets the other model object's foreign key to this model object's primary key. Feel free to do this manually if
-     * you like.
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $extra_join_model_fields_n_values
-     * @return \EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array())
-    {
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+	/**
+	 * Sets the other model object's foreign key to this model object's primary key. Feel free to do this manually if
+	 * you like.
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $extra_join_model_fields_n_values
+	 * @return \EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array())
+	{
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
 
-        //find the field on the other model which is a foreign key to this model
-        $fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        if ($other_model_obj->get($fk_field_on_other_model->get_name()) != $this_model_obj->ID()) {
-            //set that field on the other model to this model's ID
-            $other_model_obj->set($fk_field_on_other_model->get_name(), $this_model_obj->ID());
-            $other_model_obj->save();
-        }
-        return $other_model_obj;
-    }
+		//find the field on the other model which is a foreign key to this model
+		$fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		if ($other_model_obj->get($fk_field_on_other_model->get_name()) != $this_model_obj->ID()) {
+			//set that field on the other model to this model's ID
+			$other_model_obj->set($fk_field_on_other_model->get_name(), $this_model_obj->ID());
+			$other_model_obj->save();
+		}
+		return $other_model_obj;
+	}
 
 
-    /**
-     * Sets the other model object's foreign key to its default, instead of pointing to this model object.
-     * If $other_obj_or_id doesn't have any other relations, this function is essentially orphaning it
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $where_query
-     * @return \EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array())
-    {
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
-        //find the field on the other model which is a foreign key to this model
-        $fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        //set that field on the other model to this model's ID
-        $other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
-        $other_model_obj->save();
-        return $other_model_obj;
-    }
+	/**
+	 * Sets the other model object's foreign key to its default, instead of pointing to this model object.
+	 * If $other_obj_or_id doesn't have any other relations, this function is essentially orphaning it
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $where_query
+	 * @return \EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array())
+	{
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+		//find the field on the other model which is a foreign key to this model
+		$fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		//set that field on the other model to this model's ID
+		$other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
+		$other_model_obj->save();
+		return $other_model_obj;
+	}
 }

core/interfaces/EEI_Interfaces.php

Indentation +23 added lines, -23 removed lines

@@ -190,7 +190,7 @@ 
 interface EEI_Attendee {
 	public function fname();
 	public function lname();
-    public function full_name();
+	public function full_name();
 	public function email();
 	public function phone();
 	public function address();
@@ -311,23 +311,23 @@ 
 	 * @param float $amount
 	 * @param string $name
 	 * @param string $description
-         * @param string $code
-         * @param boolean $add_to_existing_line_item if true and a duplicate line item with
-         *  the same code is found, $amount will be added onto it; otherwise will simply
-         *  set the taxes to match $amount
+	 * @param string $code
+	 * @param boolean $add_to_existing_line_item if true and a duplicate line item with
+	 *  the same code is found, $amount will be added onto it; otherwise will simply
+	 *  set the taxes to match $amount
 	 * @return EE_Line_Item the new tax created
 	 */
 	public function set_total_tax_to( EE_Line_Item $total_line_item, $amount, $name  = NULL, $description = NULL, $code = NULL, $add_to_existing_line_item = false );
 
-         /**
-         * Makes all the line items which are children of $line_item taxable (or not).
-         * Does NOT save the line items
-         * @param EE_Line_Item $line_item
-         * @param boolean $taxable
-         * @param string $code_substring_for_whitelist if this string is part of the line item's code
-         *  it will be whitelisted (ie, except from becoming taxable)
-         */
-        public static function set_line_items_taxable( EE_Line_Item $line_item, $taxable = true, $code_substring_for_whitelist = null );
+		 /**
+		  * Makes all the line items which are children of $line_item taxable (or not).
+		  * Does NOT save the line items
+		  * @param EE_Line_Item $line_item
+		  * @param boolean $taxable
+		  * @param string $code_substring_for_whitelist if this string is part of the line item's code
+		  *  it will be whitelisted (ie, except from becoming taxable)
+		  */
+		public static function set_line_items_taxable( EE_Line_Item $line_item, $taxable = true, $code_substring_for_whitelist = null );
 
 	/**
 	 * Adds a simple item ( unrelated to any other model object) to the total line item,
@@ -357,15 +357,15 @@ 
  */
 interface EEHI_Money{
 		/**
-	 * For comparing floats. Default operator is '=', but see the $operator below for all options.
-	 * This should be used to compare floats instead of normal '==' because floats
-	 * are inherently imprecise, and so you can sometimes have two floats that appear to be identical
-	 * but actually differ by 0.00000001.
-	 * @param float $float1
-	 * @param float $float2
-	 * @param string $operator  The operator. Valid options are =, <=, <, >=, >, <>, eq, lt, lte, gt, gte, ne
-	 * @return boolean whether the equation is true or false
-	 */
+		 * For comparing floats. Default operator is '=', but see the $operator below for all options.
+		 * This should be used to compare floats instead of normal '==' because floats
+		 * are inherently imprecise, and so you can sometimes have two floats that appear to be identical
+		 * but actually differ by 0.00000001.
+		 * @param float $float1
+		 * @param float $float2
+		 * @param string $operator  The operator. Valid options are =, <=, <, >=, >, <>, eq, lt, lte, gt, gte, ne
+		 * @return boolean whether the equation is true or false
+		 */
 	public function compare_floats( $float1, $float2, $operator='=' );
 }
 

caffeinated/payment_methods/Paypal_Pro/EEG_Paypal_Pro.gateway.php

Indentation +31 added lines, -31 removed lines

@@ -90,19 +90,19 @@ 
 	 */
 	public function do_direct_payment($payment,$billing_info = null){
 		$transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
-            throw new EE_Error(esc_html__('No transaction for payment while paying with PayPal Pro.', 'event_espresso'));
-        }
-        $primary_registrant = $transaction->primary_registration();
-        if (! $primary_registrant instanceof EEI_Registration) {
-            throw new EE_Error(esc_html__('No primary registration on transaction while paying with PayPal Pro.',
-                'event_espresso'));
-        }
-        $attendee = $primary_registrant->attendee();
-        if (! $attendee instanceof EEI_Attendee) {
-            throw new EE_Error(esc_html__('No attendee on primary registration while paying with PayPal Pro.',
-                'event_espresso'));
-        }
+		if (! $transaction instanceof EEI_Transaction) {
+			throw new EE_Error(esc_html__('No transaction for payment while paying with PayPal Pro.', 'event_espresso'));
+		}
+		$primary_registrant = $transaction->primary_registration();
+		if (! $primary_registrant instanceof EEI_Registration) {
+			throw new EE_Error(esc_html__('No primary registration on transaction while paying with PayPal Pro.',
+				'event_espresso'));
+		}
+		$attendee = $primary_registrant->attendee();
+		if (! $attendee instanceof EEI_Attendee) {
+			throw new EE_Error(esc_html__('No attendee on primary registration while paying with PayPal Pro.',
+				'event_espresso'));
+		}
 		$order_description  = $this->_format_order_description( $payment );
 		//charge for the full amount. Show itemized list
 		if( $this->_can_easily_itemize_transaction_for( $payment ) ){
@@ -232,23 +232,23 @@ 
 			'zip' => $billing_info['zip'],
 		);
 
-        //check if the registration info contains the needed fields for paypal pro (see https://developer.paypal.com/docs/classic/api/merchant/DoDirectPayment_API_Operation_NVP/)
-        if($attendee->address() && $attendee->city() && $attendee->country_ID()){
-            $use_registration_address_info = true;
-        } else {
-            $use_registration_address_info = false;
-        }
-        //so if the attendee has enough data to fill out PayPal Pro's shipping info, use it. If not, use the billing info again
-        $ShippingAddress = array(
-            'shiptoname' => substr($use_registration_address_info ? $attendee->full_name() : $billing_info['first_name'] . ' ' . $billing_info['last_name'], 0, 32),
-            'shiptostreet' => substr($use_registration_address_info ? $attendee->address() : $billing_info['address'], 0, 100),
-            'shiptostreet2' => substr($use_registration_address_info ? $attendee->address2() : $billing_info['address2'],0,100),
-            'shiptocity' => substr($use_registration_address_info ? $attendee->city() : $billing_info['city'],0,40),
-            'state' => substr($use_registration_address_info ? $attendee->state_name() : $billing_info['state'],0,40),
-            'shiptocountry' => $use_registration_address_info ? $attendee->country_ID() : $billing_info['country'],
-            'shiptozip' => substr($use_registration_address_info ? $attendee->zip() : $billing_info['zip'],0,20),
-            'shiptophonenum' => substr($use_registration_address_info ? $attendee->phone() : $billing_info['phone'],0,20),
-        );
+		//check if the registration info contains the needed fields for paypal pro (see https://developer.paypal.com/docs/classic/api/merchant/DoDirectPayment_API_Operation_NVP/)
+		if($attendee->address() && $attendee->city() && $attendee->country_ID()){
+			$use_registration_address_info = true;
+		} else {
+			$use_registration_address_info = false;
+		}
+		//so if the attendee has enough data to fill out PayPal Pro's shipping info, use it. If not, use the billing info again
+		$ShippingAddress = array(
+			'shiptoname' => substr($use_registration_address_info ? $attendee->full_name() : $billing_info['first_name'] . ' ' . $billing_info['last_name'], 0, 32),
+			'shiptostreet' => substr($use_registration_address_info ? $attendee->address() : $billing_info['address'], 0, 100),
+			'shiptostreet2' => substr($use_registration_address_info ? $attendee->address2() : $billing_info['address2'],0,100),
+			'shiptocity' => substr($use_registration_address_info ? $attendee->city() : $billing_info['city'],0,40),
+			'state' => substr($use_registration_address_info ? $attendee->state_name() : $billing_info['state'],0,40),
+			'shiptocountry' => $use_registration_address_info ? $attendee->country_ID() : $billing_info['country'],
+			'shiptozip' => substr($use_registration_address_info ? $attendee->zip() : $billing_info['zip'],0,20),
+			'shiptophonenum' => substr($use_registration_address_info ? $attendee->phone() : $billing_info['phone'],0,20),
+		);
 
 		$PaymentDetails = array(
 			// Required.  Total amount of order, including shipping, handling, and tax.
@@ -280,7 +280,7 @@ 
 				'PayerInfo' => $PayerInfo,
 				'PayerName' => $PayerName,
 				'BillingAddress' => $BillingAddress,
-                'ShippingAddress' => $ShippingAddress,
+				'ShippingAddress' => $ShippingAddress,
 				'PaymentDetails' => $PaymentDetails,
 				'OrderItems' => $order_items,
 		);

Spacing +61 added lines, -61 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION'))
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('No direct script access allowed');
 
 /**
@@ -25,7 +25,7 @@ 
  *
  * ------------------------------------------------------------------------
  */
-class EEG_Paypal_Pro extends EE_Onsite_Gateway{
+class EEG_Paypal_Pro extends EE_Onsite_Gateway {
 	/**
 	 *
 	 * @var $_paypal_api_username string
@@ -88,42 +88,42 @@ 
 	 * } @see parent::do_direct_payment for more info
 	 * @return \EE_Payment|\EEI_Payment
 	 */
-	public function do_direct_payment($payment,$billing_info = null){
+	public function do_direct_payment($payment, $billing_info = null) {
 		$transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
+        if ( ! $transaction instanceof EEI_Transaction) {
             throw new EE_Error(esc_html__('No transaction for payment while paying with PayPal Pro.', 'event_espresso'));
         }
         $primary_registrant = $transaction->primary_registration();
-        if (! $primary_registrant instanceof EEI_Registration) {
+        if ( ! $primary_registrant instanceof EEI_Registration) {
             throw new EE_Error(esc_html__('No primary registration on transaction while paying with PayPal Pro.',
                 'event_espresso'));
         }
         $attendee = $primary_registrant->attendee();
-        if (! $attendee instanceof EEI_Attendee) {
+        if ( ! $attendee instanceof EEI_Attendee) {
             throw new EE_Error(esc_html__('No attendee on primary registration while paying with PayPal Pro.',
                 'event_espresso'));
         }
-		$order_description  = $this->_format_order_description( $payment );
+		$order_description = $this->_format_order_description($payment);
 		//charge for the full amount. Show itemized list
-		if( $this->_can_easily_itemize_transaction_for( $payment ) ){
+		if ($this->_can_easily_itemize_transaction_for($payment)) {
 			$item_num = 1;
 			$total_line_item = $transaction->total_line_item();
 			$order_items = array();
 			foreach ($total_line_item->get_items() as $line_item) {
 				//ignore line items with a quantity of 0
-				if( $line_item->quantity() == 0 ) {
+				if ($line_item->quantity() == 0) {
 					continue;
 				}
 				$item = array(
 						// Item Name.  127 char max.
 						'l_name' => substr(
-							$this->_format_line_item_name( $line_item, $payment ),
+							$this->_format_line_item_name($line_item, $payment),
 							0,
 							127
 						),
 						// Item description.  127 char max.
 						'l_desc' => substr( 
-							$this->_format_line_item_desc( $line_item, $payment ),
+							$this->_format_line_item_desc($line_item, $payment),
 							0,
 							127
 						),
@@ -147,20 +147,20 @@ 
 			}
 			$item_amount = $total_line_item->get_items_total();
 			$tax_amount = $total_line_item->get_total_tax();
-		}else{
+		} else {
 			$order_items = array();
 			$item_amount = $payment->amount();
 			$tax_amount = 0;
-			array_push($order_items,array(
+			array_push($order_items, array(
 				// Item Name.  127 char max.
 				'l_name' => substr(
-					$this->_format_partial_payment_line_item_name( $payment ),
+					$this->_format_partial_payment_line_item_name($payment),
 					0,
 					127
 				),
 				// Item description.  127 char max.
 				'l_desc' => substr( 
-					$this->_format_partial_payment_line_item_desc( $payment ),
+					$this->_format_partial_payment_line_item_desc($payment),
 					0,
 					127
 				),
@@ -208,11 +208,11 @@ 
 			// Payer's salutation.  20 char max.
 			'salutation' => '',
 			// Payer's first name.  25 char max.
-			'firstname' => substr($billing_info['first_name'],0,25),
+			'firstname' => substr($billing_info['first_name'], 0, 25),
 			// Payer's middle name.  25 char max.
 			'middlename' => '',
 			// Payer's last name.  25 char max.
-			'lastname' => substr($billing_info['last_name'],0,25),
+			'lastname' => substr($billing_info['last_name'], 0, 25),
 			// Payer's suffix.  12 char max.
 			'suffix' => ''
 		);
@@ -225,7 +225,7 @@ 
 			// Required.  Name of City.
 			'city' => $billing_info['city'],
 			// Required. Name of State or Province.
-			'state' => substr( $billing_info['state'], 0, 40 ),
+			'state' => substr($billing_info['state'], 0, 40),
 			// Required.  Country code.
 			'countrycode' => $billing_info['country'],
 			// Required.  Postal code of payer.
@@ -233,21 +233,21 @@ 
 		);
 
         //check if the registration info contains the needed fields for paypal pro (see https://developer.paypal.com/docs/classic/api/merchant/DoDirectPayment_API_Operation_NVP/)
-        if($attendee->address() && $attendee->city() && $attendee->country_ID()){
+        if ($attendee->address() && $attendee->city() && $attendee->country_ID()) {
             $use_registration_address_info = true;
         } else {
             $use_registration_address_info = false;
         }
         //so if the attendee has enough data to fill out PayPal Pro's shipping info, use it. If not, use the billing info again
         $ShippingAddress = array(
-            'shiptoname' => substr($use_registration_address_info ? $attendee->full_name() : $billing_info['first_name'] . ' ' . $billing_info['last_name'], 0, 32),
+            'shiptoname' => substr($use_registration_address_info ? $attendee->full_name() : $billing_info['first_name'].' '.$billing_info['last_name'], 0, 32),
             'shiptostreet' => substr($use_registration_address_info ? $attendee->address() : $billing_info['address'], 0, 100),
-            'shiptostreet2' => substr($use_registration_address_info ? $attendee->address2() : $billing_info['address2'],0,100),
-            'shiptocity' => substr($use_registration_address_info ? $attendee->city() : $billing_info['city'],0,40),
-            'state' => substr($use_registration_address_info ? $attendee->state_name() : $billing_info['state'],0,40),
+            'shiptostreet2' => substr($use_registration_address_info ? $attendee->address2() : $billing_info['address2'], 0, 100),
+            'shiptocity' => substr($use_registration_address_info ? $attendee->city() : $billing_info['city'], 0, 40),
+            'state' => substr($use_registration_address_info ? $attendee->state_name() : $billing_info['state'], 0, 40),
             'shiptocountry' => $use_registration_address_info ? $attendee->country_ID() : $billing_info['country'],
-            'shiptozip' => substr($use_registration_address_info ? $attendee->zip() : $billing_info['zip'],0,20),
-            'shiptophonenum' => substr($use_registration_address_info ? $attendee->phone() : $billing_info['phone'],0,20),
+            'shiptozip' => substr($use_registration_address_info ? $attendee->zip() : $billing_info['zip'], 0, 20),
+            'shiptophonenum' => substr($use_registration_address_info ? $attendee->phone() : $billing_info['phone'], 0, 20),
         );
 
 		$PaymentDetails = array(
@@ -256,7 +256,7 @@ 
 			// Required.  Three-letter currency code.  Default is USD.
 			'currencycode' => $payment->currency_code(),
 			// Required if you include itemized cart details. (L_AMTn, etc.)  Subtotal of items not including S&H, or tax.
-			'itemamt' => $this->format_currency($item_amount),//
+			'itemamt' => $this->format_currency($item_amount), //
 			// Total shipping costs for the order.  If you specify shippingamt, you must also specify itemamt.
 			'shippingamt' => '',
 			// Total handling costs for the order.  If you specify handlingamt, you must also specify itemamt.
@@ -268,10 +268,10 @@ 
 			// Free-form field for your own use.  256 char max.
 			'custom' => $primary_registrant ? $primary_registrant->ID() : '',
 			// Your own invoice or tracking number
-			'invnum' => wp_generate_password(12,false),//$transaction->ID(),
+			'invnum' => wp_generate_password(12, false), //$transaction->ID(),
 			// URL for receiving Instant Payment Notifications.  This overrides what your profile is set to use.
 			'notifyurl' => '',
-			'buttonsource' => 'EventEspresso_SP',//EE will blow up if you change this
+			'buttonsource' => 'EventEspresso_SP', //EE will blow up if you change this
 		);
 		// Wrap all data arrays into a single, "master" array which will be passed into the class function.
 		$PayPalRequestData = array(
@@ -285,32 +285,32 @@ 
 				'OrderItems' => $order_items,
 		);
 		$this->_log_clean_request($PayPalRequestData, $payment);
-		try{
+		try {
 			$PayPalResult = $this->prep_and_curl_request($PayPalRequestData);
 			//remove PCI-sensitive data so it doesn't get stored
-			$PayPalResult = $this->_log_clean_response($PayPalResult,$payment);
+			$PayPalResult = $this->_log_clean_response($PayPalResult, $payment);
 
 			$message = isset($PayPalResult['L_LONGMESSAGE0']) ? $PayPalResult['L_LONGMESSAGE0'] : $PayPalResult['ACK'];
-			if( empty($PayPalResult[ 'RAWRESPONSE' ] ) ) {
-				$payment->set_status( $this->_pay_model->failed_status() ) ;
-				$payment->set_gateway_response( __( 'No response received from Paypal Pro', 'event_espresso' ) );
+			if (empty($PayPalResult['RAWRESPONSE'])) {
+				$payment->set_status($this->_pay_model->failed_status());
+				$payment->set_gateway_response(__('No response received from Paypal Pro', 'event_espresso'));
 				$payment->set_details($PayPalResult);
-			}else{
-				if($this->_APICallSuccessful($PayPalResult)){
+			} else {
+				if ($this->_APICallSuccessful($PayPalResult)) {
 					$payment->set_status($this->_pay_model->approved_status());
-				}else{
+				} else {
 					$payment->set_status($this->_pay_model->declined_status());
 				}
 				//make sure we interpret the AMT as a float, not an international string (where periods are thousand separators)
-				$payment->set_amount(isset($PayPalResult['AMT']) ? floatval( $PayPalResult['AMT'] ) : 0);
+				$payment->set_amount(isset($PayPalResult['AMT']) ? floatval($PayPalResult['AMT']) : 0);
 				$payment->set_gateway_response($message);
-				$payment->set_txn_id_chq_nmbr(isset( $PayPalResult['TRANSACTIONID'] )? $PayPalResult['TRANSACTIONID'] : null);
+				$payment->set_txn_id_chq_nmbr(isset($PayPalResult['TRANSACTIONID']) ? $PayPalResult['TRANSACTIONID'] : null);
 
 				$primary_registration_code = $primary_registrant instanceof EE_Registration ? $primary_registrant->reg_code() : '';
 				$payment->set_extra_accntng($primary_registration_code);
 				$payment->set_details($PayPalResult);
 			}
-		}catch(Exception $e){
+		} catch (Exception $e) {
 			$payment->set_status($this->_pay_model->failed_status());
 			$payment->set_gateway_response($e->getMessage());
 		}
@@ -327,7 +327,7 @@ 
 	 * @param EEI_Payment $payment
 	 * @return array
 	 */
-	private function _log_clean_request($request,$payment){
+	private function _log_clean_request($request, $payment) {
 		$cleaned_request_data = $request;
 		unset($cleaned_request_data['CCDetails']['acct']);
 		unset($cleaned_request_data['CCDetails']['cvv2']);
@@ -343,13 +343,13 @@ 
 	 * @param EEI_Payment $payment
 	 * @return array cleaned
 	 */
-	private function _log_clean_response($response,$payment){
+	private function _log_clean_response($response, $payment) {
 		unset($response['REQUESTDATA']['CREDITCARDTYPE']);
 		unset($response['REQUESTDATA']['ACCT']);
 		unset($response['REQUESTDATA']['EXPDATE']);
 		unset($response['REQUESTDATA']['CVV2']);
 		unset($response['RAWREQUEST']);
-		$this->log(array('Paypal Response'=>$response),$payment);
+		$this->log(array('Paypal Response'=>$response), $payment);
 		return $response;
 	}
 
@@ -374,32 +374,32 @@ 
 		// DP Fields
 		$DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array();
 		foreach ($DPFields as $DPFieldsVar => $DPFieldsVal)
-			$DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal);
+			$DPFieldsNVP .= '&'.strtoupper($DPFieldsVar).'='.urlencode($DPFieldsVal);
 
 		// CC Details Fields
 		$CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array();
 		foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal)
-			$CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal);
+			$CCDetailsNVP .= '&'.strtoupper($CCDetailsVar).'='.urlencode($CCDetailsVal);
 
 		// PayerInfo Type Fields
 		$PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array();
 		foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal)
-			$PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal);
+			$PayerInfoNVP .= '&'.strtoupper($PayerInfoVar).'='.urlencode($PayerInfoVal);
 
 		// Payer Name Fields
 		$PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array();
 		foreach ($PayerName as $PayerNameVar => $PayerNameVal)
-			$PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal);
+			$PayerNameNVP .= '&'.strtoupper($PayerNameVar).'='.urlencode($PayerNameVal);
 
 		// Address Fields (Billing)
 		$BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array();
 		foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal)
-			$BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal);
+			$BillingAddressNVP .= '&'.strtoupper($BillingAddressVar).'='.urlencode($BillingAddressVal);
 
 		// Payment Details Type Fields
 		$PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array();
 		foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal)
-			$PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal);
+			$PaymentDetailsNVP .= '&'.strtoupper($PaymentDetailsVar).'='.urlencode($PaymentDetailsVal);
 
 		// Payment Details Item Type Fields
 		$OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array();
@@ -407,22 +407,22 @@ 
 		foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) {
 			$CurrentItem = $OrderItems[$OrderItemsVar];
 			foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal)
-				$OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal);
+				$OrderItemsNVP .= '&'.strtoupper($CurrentItemVar).$n.'='.urlencode($CurrentItemVal);
 			$n++;
 		}
 
 		// Ship To Address Fields
 		$ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array();
 		foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal)
-			$ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal);
+			$ShippingAddressNVP .= '&'.strtoupper($ShippingAddressVar).'='.urlencode($ShippingAddressVal);
 
 		// 3D Secure Fields
 		$Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array();
 		foreach ($Secure3D as $Secure3DVar => $Secure3DVal)
-			$Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal);
+			$Secure3DNVP .= '&'.strtoupper($Secure3DVar).'='.urlencode($Secure3DVal);
 
 		// Now that we have each chunk we need to go ahead and append them all together for our entire NVP string
-		$NVPRequest = 'USER=' . $this->_username . '&PWD=' . $this->_password . '&VERSION=64.0' . '&SIGNATURE=' . $this->_signature . $DPFieldsNVP . $CCDetailsNVP . $PayerInfoNVP . $PayerNameNVP . $BillingAddressNVP . $PaymentDetailsNVP . $OrderItemsNVP . $ShippingAddressNVP . $Secure3DNVP;
+		$NVPRequest = 'USER='.$this->_username.'&PWD='.$this->_password.'&VERSION=64.0'.'&SIGNATURE='.$this->_signature.$DPFieldsNVP.$CCDetailsNVP.$PayerInfoNVP.$PayerNameNVP.$BillingAddressNVP.$PaymentDetailsNVP.$OrderItemsNVP.$ShippingAddressNVP.$Secure3DNVP;
 		$NVPResponse = $this->_CURLRequest($NVPRequest);
 		$NVPRequestArray = $this->_NVPToArray($NVPRequest);
 		$NVPResponseArray = $this->_NVPToArray($NVPResponse);
@@ -446,7 +446,7 @@ 
 	private function _CURLRequest($Request) {
 		$EndPointURL = $this->_debug_mode ? 'https://api-3t.sandbox.paypal.com/nvp' : 'https://api-3t.paypal.com/nvp';
 		$curl = curl_init();
-		curl_setopt($curl, CURLOPT_VERBOSE, apply_filters('FHEE__EEG_Paypal_Pro__CurlRequest__CURLOPT_VERBOSE', TRUE ) );
+		curl_setopt($curl, CURLOPT_VERBOSE, apply_filters('FHEE__EEG_Paypal_Pro__CurlRequest__CURLOPT_VERBOSE', TRUE));
 		curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, FALSE);
 		curl_setopt($curl, CURLOPT_TIMEOUT, 60);
 		curl_setopt($curl, CURLOPT_URL, $EndPointURL);
@@ -496,9 +496,9 @@ 
 	private function _APICallSuccessful($PayPalResult) {
 		$approved = false;
 		// check main response message from PayPal
-		if (isset($PayPalResult['ACK']) && !empty($PayPalResult['ACK'])) {
+		if (isset($PayPalResult['ACK']) && ! empty($PayPalResult['ACK'])) {
 			$ack = strtoupper($PayPalResult['ACK']);
-			$approved = ( $ack == 'SUCCESS' || $ack == 'SUCCESSWITHWARNING' || $ack == 'PARTIALSUCCESS' ) ? true : false;
+			$approved = ($ack == 'SUCCESS' || $ack == 'SUCCESSWITHWARNING' || $ack == 'PARTIALSUCCESS') ? true : false;
 		}
 
 		return $approved;
@@ -514,11 +514,11 @@ 
 
 		$Errors = array();
 		$n = 0;
-		while (isset($DataArray['L_ERRORCODE' . $n . ''])) {
-			$LErrorCode = isset($DataArray['L_ERRORCODE' . $n . '']) ? $DataArray['L_ERRORCODE' . $n . ''] : '';
-			$LShortMessage = isset($DataArray['L_SHORTMESSAGE' . $n . '']) ? $DataArray['L_SHORTMESSAGE' . $n . ''] : '';
-			$LLongMessage = isset($DataArray['L_LONGMESSAGE' . $n . '']) ? $DataArray['L_LONGMESSAGE' . $n . ''] : '';
-			$LSeverityCode = isset($DataArray['L_SEVERITYCODE' . $n . '']) ? $DataArray['L_SEVERITYCODE' . $n . ''] : '';
+		while (isset($DataArray['L_ERRORCODE'.$n.''])) {
+			$LErrorCode = isset($DataArray['L_ERRORCODE'.$n.'']) ? $DataArray['L_ERRORCODE'.$n.''] : '';
+			$LShortMessage = isset($DataArray['L_SHORTMESSAGE'.$n.'']) ? $DataArray['L_SHORTMESSAGE'.$n.''] : '';
+			$LLongMessage = isset($DataArray['L_LONGMESSAGE'.$n.'']) ? $DataArray['L_LONGMESSAGE'.$n.''] : '';
+			$LSeverityCode = isset($DataArray['L_SEVERITYCODE'.$n.'']) ? $DataArray['L_SEVERITYCODE'.$n.''] : '';
 
 			$CurrentItem = array(
 					'L_ERRORCODE' => $LErrorCode,
@@ -558,7 +558,7 @@ 
 				elseif ($CurrentErrorVar == 'L_SEVERITYCODE')
 					$CurrentVarName = 'Severity Code';
 
-				$error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal;
+				$error .= '<br />'.$CurrentVarName.': '.$CurrentErrorVal;
 			}
 		}
 		return $error;

Braces +42 added lines, -31 removed lines

@@ -1,7 +1,8 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION'))
+if (!defined('EVENT_ESPRESSO_VERSION')) {
 	exit('No direct script access allowed');
+}
 
 /**
  * Event Espresso
@@ -147,7 +148,7 @@ 
 			}
 			$item_amount = $total_line_item->get_items_total();
 			$tax_amount = $total_line_item->get_total_tax();
-		}else{
+		} else{
 			$order_items = array();
 			$item_amount = $payment->amount();
 			$tax_amount = 0;
@@ -295,10 +296,10 @@ 
 				$payment->set_status( $this->_pay_model->failed_status() ) ;
 				$payment->set_gateway_response( __( 'No response received from Paypal Pro', 'event_espresso' ) );
 				$payment->set_details($PayPalResult);
-			}else{
+			} else{
 				if($this->_APICallSuccessful($PayPalResult)){
 					$payment->set_status($this->_pay_model->approved_status());
-				}else{
+				} else{
 					$payment->set_status($this->_pay_model->declined_status());
 				}
 				//make sure we interpret the AMT as a float, not an international string (where periods are thousand separators)
@@ -310,7 +311,7 @@ 
 				$payment->set_extra_accntng($primary_registration_code);
 				$payment->set_details($PayPalResult);
 			}
-		}catch(Exception $e){
+		} catch(Exception $e){
 			$payment->set_status($this->_pay_model->failed_status());
 			$payment->set_gateway_response($e->getMessage());
 		}
@@ -373,53 +374,62 @@ 
 
 		// DP Fields
 		$DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array();
-		foreach ($DPFields as $DPFieldsVar => $DPFieldsVal)
-			$DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal);
+		foreach ($DPFields as $DPFieldsVar => $DPFieldsVal) {
+					$DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal);
+		}
 
 		// CC Details Fields
 		$CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array();
-		foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal)
-			$CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal);
+		foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal) {
+					$CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal);
+		}
 
 		// PayerInfo Type Fields
 		$PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array();
-		foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal)
-			$PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal);
+		foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal) {
+					$PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal);
+		}
 
 		// Payer Name Fields
 		$PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array();
-		foreach ($PayerName as $PayerNameVar => $PayerNameVal)
-			$PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal);
+		foreach ($PayerName as $PayerNameVar => $PayerNameVal) {
+					$PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal);
+		}
 
 		// Address Fields (Billing)
 		$BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array();
-		foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal)
-			$BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal);
+		foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal) {
+					$BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal);
+		}
 
 		// Payment Details Type Fields
 		$PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array();
-		foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal)
-			$PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal);
+		foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal) {
+					$PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal);
+		}
 
 		// Payment Details Item Type Fields
 		$OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array();
 		$n = 0;
 		foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) {
 			$CurrentItem = $OrderItems[$OrderItemsVar];
-			foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal)
-				$OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal);
+			foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal) {
+							$OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal);
+			}
 			$n++;
 		}
 
 		// Ship To Address Fields
 		$ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array();
-		foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal)
-			$ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal);
+		foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal) {
+					$ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal);
+		}
 
 		// 3D Secure Fields
 		$Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array();
-		foreach ($Secure3D as $Secure3DVar => $Secure3DVal)
-			$Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal);
+		foreach ($Secure3D as $Secure3DVar => $Secure3DVal) {
+					$Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal);
+		}
 
 		// Now that we have each chunk we need to go ahead and append them all together for our entire NVP string
 		$NVPRequest = 'USER=' . $this->_username . '&PWD=' . $this->_password . '&VERSION=64.0' . '&SIGNATURE=' . $this->_signature . $DPFieldsNVP . $CCDetailsNVP . $PayerInfoNVP . $PayerNameNVP . $BillingAddressNVP . $PaymentDetailsNVP . $OrderItemsNVP . $ShippingAddressNVP . $Secure3DNVP;
@@ -549,14 +559,15 @@ 
 			$CurrentError = $Errors[$ErrorVar];
 			foreach ($CurrentError as $CurrentErrorVar => $CurrentErrorVal) {
 				$CurrentVarName = '';
-				if ($CurrentErrorVar == 'L_ERRORCODE')
-					$CurrentVarName = 'Error Code';
-				elseif ($CurrentErrorVar == 'L_SHORTMESSAGE')
-					$CurrentVarName = 'Short Message';
-				elseif ($CurrentErrorVar == 'L_LONGMESSAGE')
-					$CurrentVarName = 'Long Message';
-				elseif ($CurrentErrorVar == 'L_SEVERITYCODE')
-					$CurrentVarName = 'Severity Code';
+				if ($CurrentErrorVar == 'L_ERRORCODE') {
+									$CurrentVarName = 'Error Code';
+				} elseif ($CurrentErrorVar == 'L_SHORTMESSAGE') {
+									$CurrentVarName = 'Short Message';
+				} elseif ($CurrentErrorVar == 'L_LONGMESSAGE') {
+									$CurrentVarName = 'Long Message';
+				} elseif ($CurrentErrorVar == 'L_SEVERITYCODE') {
+									$CurrentVarName = 'Severity Code';
+				}
 
 				$error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal;
 			}