eventespresso / event-espresso-core

core/helpers/EEH_Activation.helper.php

Doc Comments +3 added lines, -3 removed lines

@@ -613,7 +613,7 @@ 
      *
      * @since  4.6.0
      * @global WPDB $wpdb
-     * @return mixed null|int WP_user ID or NULL
+     * @return integer|null null|int WP_user ID or NULL
      */
     public static function get_default_creator_id()
     {
@@ -774,7 +774,7 @@ 
      * @static
      * @deprecated instead use TableManager::dropTable()
      * @param string $table_name
-     * @return bool | int
+     * @return integer | int
      */
     public static function delete_unused_db_table($table_name)
     {
@@ -791,7 +791,7 @@ 
      * @deprecated instead use TableManager::dropIndex()
      * @param string $table_name
      * @param string $index_name
-     * @return bool | int
+     * @return integer | int
      */
     public static function drop_index($table_name, $index_name)
     {

Indentation +1694 added lines, -1694 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -14,231 +14,231 @@ 
 class EEH_Activation
 {
 
-    /**
-     * constant used to indicate a cron task is no longer in use
-     */
-    const cron_task_no_longer_in_use = 'no_longer_in_use';
-
-    /**
-     * option name that will indicate whether or not we still
-     * need to create EE's folders in the uploads directory
-     * (because if EE was installed without file system access,
-     * we need to request credentials before we can create them)
-     */
-    const upload_directories_incomplete_option_name = 'ee_upload_directories_incomplete';
-
-    /**
-     * WP_User->ID
-     *
-     * @var int
-     */
-    private static $_default_creator_id;
-
-    /**
-     * indicates whether or not we've already verified core's default data during this request,
-     * because after migrations are done, any addons activated while in maintenance mode
-     * will want to setup their own default data, and they might hook into core's default data
-     * and trigger core to setup its default data. In which case they might all ask for core to init its default data.
-     * This prevents doing that for EVERY single addon.
-     *
-     * @var boolean
-     */
-    protected static $_initialized_db_content_already_in_this_request = false;
-
-    /**
-     * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
-     */
-    private static $table_analysis;
-
-    /**
-     * @var \EventEspresso\core\services\database\TableManager $table_manager
-     */
-    private static $table_manager;
-
-
-    /**
-     * @return \EventEspresso\core\services\database\TableAnalysis
-     */
-    public static function getTableAnalysis()
-    {
-        if (! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
-            self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
-        }
-        return self::$table_analysis;
-    }
-
-
-    /**
-     * @return \EventEspresso\core\services\database\TableManager
-     */
-    public static function getTableManager()
-    {
-        if (! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
-            self::$table_manager = EE_Registry::instance()->create('TableManager', array(), true);
-        }
-        return self::$table_manager;
-    }
-
-
-    /**
-     *    _ensure_table_name_has_prefix
-     *
-     * @deprecated instead use TableAnalysis::ensureTableNameHasPrefix()
-     * @access     public
-     * @static
-     * @param $table_name
-     * @return string
-     */
-    public static function ensure_table_name_has_prefix($table_name)
-    {
-        return \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-    }
-
-
-    /**
-     *    system_initialization
-     *    ensures the EE configuration settings are loaded with at least default options set
-     *    and that all critical EE pages have been generated with the appropriate shortcodes in place
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function system_initialization()
-    {
-        EEH_Activation::reset_and_update_config();
-        //which is fired BEFORE activation of plugin anyways
-        EEH_Activation::verify_default_pages_exist();
-    }
-
-
-    /**
-     * Sets the database schema and creates folders. This should
-     * be called on plugin activation and reactivation
-     *
-     * @return boolean success, whether the database and folders are setup properly
-     * @throws \EE_Error
-     */
-    public static function initialize_db_and_folders()
-    {
-        $good_filesystem = EEH_Activation::create_upload_directories();
-        $good_db         = EEH_Activation::create_database_tables();
-        return $good_filesystem && $good_db;
-    }
-
-
-    /**
-     * assuming we have an up-to-date database schema, this will populate it
-     * with default and initial data. This should be called
-     * upon activation of a new plugin, reactivation, and at the end
-     * of running migration scripts
-     *
-     * @throws \EE_Error
-     */
-    public static function initialize_db_content()
-    {
-        //let's avoid doing all this logic repeatedly, especially when addons are requesting it
-        if (EEH_Activation::$_initialized_db_content_already_in_this_request) {
-            return;
-        }
-        EEH_Activation::$_initialized_db_content_already_in_this_request = true;
-
-        EEH_Activation::initialize_system_questions();
-        EEH_Activation::insert_default_status_codes();
-        EEH_Activation::generate_default_message_templates();
-        EEH_Activation::create_no_ticket_prices_array();
-        EE_Registry::instance()->CAP->init_caps();
-
-        EEH_Activation::validate_messages_system();
-        EEH_Activation::insert_default_payment_methods();
-        //in case we've
-        EEH_Activation::remove_cron_tasks();
-        EEH_Activation::create_cron_tasks();
-        // remove all TXN locks since that is being done via extra meta now
-        delete_option('ee_locked_transactions');
-        //also, check for CAF default db content
-        do_action('AHEE__EEH_Activation__initialize_db_content');
-        //also: EEM_Gateways::load_all_gateways() outputs a lot of success messages
-        //which users really won't care about on initial activation
-        EE_Error::overwrite_success();
-    }
-
-
-    /**
-     * Returns an array of cron tasks. Array values are the actions fired by the cron tasks (the "hooks"),
-     * values are the frequency (the "recurrence"). See http://codex.wordpress.org/Function_Reference/wp_schedule_event
-     * If the cron task should NO longer be used, it should have a value of EEH_Activation::cron_task_no_longer_in_use
-     * (null)
-     *
-     * @param string $which_to_include can be 'current' (ones that are currently in use),
-     *                                 'old' (only returns ones that should no longer be used),or 'all',
-     * @return array
-     * @throws \EE_Error
-     */
-    public static function get_cron_tasks($which_to_include)
-    {
-        $cron_tasks = apply_filters(
-            'FHEE__EEH_Activation__get_cron_tasks',
-            array(
-                'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'      => 'hourly',
+	/**
+	 * constant used to indicate a cron task is no longer in use
+	 */
+	const cron_task_no_longer_in_use = 'no_longer_in_use';
+
+	/**
+	 * option name that will indicate whether or not we still
+	 * need to create EE's folders in the uploads directory
+	 * (because if EE was installed without file system access,
+	 * we need to request credentials before we can create them)
+	 */
+	const upload_directories_incomplete_option_name = 'ee_upload_directories_incomplete';
+
+	/**
+	 * WP_User->ID
+	 *
+	 * @var int
+	 */
+	private static $_default_creator_id;
+
+	/**
+	 * indicates whether or not we've already verified core's default data during this request,
+	 * because after migrations are done, any addons activated while in maintenance mode
+	 * will want to setup their own default data, and they might hook into core's default data
+	 * and trigger core to setup its default data. In which case they might all ask for core to init its default data.
+	 * This prevents doing that for EVERY single addon.
+	 *
+	 * @var boolean
+	 */
+	protected static $_initialized_db_content_already_in_this_request = false;
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
+	 */
+	private static $table_analysis;
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableManager $table_manager
+	 */
+	private static $table_manager;
+
+
+	/**
+	 * @return \EventEspresso\core\services\database\TableAnalysis
+	 */
+	public static function getTableAnalysis()
+	{
+		if (! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
+			self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
+		}
+		return self::$table_analysis;
+	}
+
+
+	/**
+	 * @return \EventEspresso\core\services\database\TableManager
+	 */
+	public static function getTableManager()
+	{
+		if (! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
+			self::$table_manager = EE_Registry::instance()->create('TableManager', array(), true);
+		}
+		return self::$table_manager;
+	}
+
+
+	/**
+	 *    _ensure_table_name_has_prefix
+	 *
+	 * @deprecated instead use TableAnalysis::ensureTableNameHasPrefix()
+	 * @access     public
+	 * @static
+	 * @param $table_name
+	 * @return string
+	 */
+	public static function ensure_table_name_has_prefix($table_name)
+	{
+		return \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+	}
+
+
+	/**
+	 *    system_initialization
+	 *    ensures the EE configuration settings are loaded with at least default options set
+	 *    and that all critical EE pages have been generated with the appropriate shortcodes in place
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function system_initialization()
+	{
+		EEH_Activation::reset_and_update_config();
+		//which is fired BEFORE activation of plugin anyways
+		EEH_Activation::verify_default_pages_exist();
+	}
+
+
+	/**
+	 * Sets the database schema and creates folders. This should
+	 * be called on plugin activation and reactivation
+	 *
+	 * @return boolean success, whether the database and folders are setup properly
+	 * @throws \EE_Error
+	 */
+	public static function initialize_db_and_folders()
+	{
+		$good_filesystem = EEH_Activation::create_upload_directories();
+		$good_db         = EEH_Activation::create_database_tables();
+		return $good_filesystem && $good_db;
+	}
+
+
+	/**
+	 * assuming we have an up-to-date database schema, this will populate it
+	 * with default and initial data. This should be called
+	 * upon activation of a new plugin, reactivation, and at the end
+	 * of running migration scripts
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function initialize_db_content()
+	{
+		//let's avoid doing all this logic repeatedly, especially when addons are requesting it
+		if (EEH_Activation::$_initialized_db_content_already_in_this_request) {
+			return;
+		}
+		EEH_Activation::$_initialized_db_content_already_in_this_request = true;
+
+		EEH_Activation::initialize_system_questions();
+		EEH_Activation::insert_default_status_codes();
+		EEH_Activation::generate_default_message_templates();
+		EEH_Activation::create_no_ticket_prices_array();
+		EE_Registry::instance()->CAP->init_caps();
+
+		EEH_Activation::validate_messages_system();
+		EEH_Activation::insert_default_payment_methods();
+		//in case we've
+		EEH_Activation::remove_cron_tasks();
+		EEH_Activation::create_cron_tasks();
+		// remove all TXN locks since that is being done via extra meta now
+		delete_option('ee_locked_transactions');
+		//also, check for CAF default db content
+		do_action('AHEE__EEH_Activation__initialize_db_content');
+		//also: EEM_Gateways::load_all_gateways() outputs a lot of success messages
+		//which users really won't care about on initial activation
+		EE_Error::overwrite_success();
+	}
+
+
+	/**
+	 * Returns an array of cron tasks. Array values are the actions fired by the cron tasks (the "hooks"),
+	 * values are the frequency (the "recurrence"). See http://codex.wordpress.org/Function_Reference/wp_schedule_event
+	 * If the cron task should NO longer be used, it should have a value of EEH_Activation::cron_task_no_longer_in_use
+	 * (null)
+	 *
+	 * @param string $which_to_include can be 'current' (ones that are currently in use),
+	 *                                 'old' (only returns ones that should no longer be used),or 'all',
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public static function get_cron_tasks($which_to_include)
+	{
+		$cron_tasks = apply_filters(
+			'FHEE__EEH_Activation__get_cron_tasks',
+			array(
+				'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'      => 'hourly',
 //				'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions' => EEH_Activation::cron_task_no_longer_in_use, actually this is still in use
-                'AHEE__EE_Cron_Tasks__update_transaction_with_payment' => EEH_Activation::cron_task_no_longer_in_use,
-                //there may have been a bug which prevented from these cron tasks from getting unscheduled, so we might want to remove these for a few updates
-            )
-        );
-        if ($which_to_include === 'old') {
-            $cron_tasks = array_filter(
-                $cron_tasks,
-                function ($value) {
-                    return $value === EEH_Activation::cron_task_no_longer_in_use;
-                }
-            );
-        } elseif ($which_to_include === 'current') {
-            $cron_tasks = array_filter($cron_tasks);
-        } elseif (WP_DEBUG && $which_to_include !== 'all') {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Invalid argument of "%1$s" passed to EEH_Activation::get_cron_tasks. Valid values are "all", "old" and "current".',
-                        'event_espresso'
-                    ),
-                    $which_to_include
-                )
-            );
-        }
-        return $cron_tasks;
-    }
-
-
-    /**
-     * Ensure cron tasks are setup (the removal of crons should be done by remove_crons())
-     *
-     * @throws \EE_Error
-     */
-    public static function create_cron_tasks()
-    {
-
-        foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
-            if (! wp_next_scheduled($hook_name)) {
-                wp_schedule_event(time(), $frequency, $hook_name);
-            }
-        }
-
-    }
-
-
-    /**
-     * Remove the currently-existing and now-removed cron tasks.
-     *
-     * @param boolean $remove_all whether to only remove the old ones, or remove absolutely ALL the EE ones
-     * @throws \EE_Error
-     */
-    public static function remove_cron_tasks($remove_all = true)
-    {
-        $cron_tasks_to_remove = $remove_all ? 'all' : 'old';
-        $crons                = _get_cron_array();
-        $crons                = is_array($crons) ? $crons : array();
-        /* reminder of what $crons look like:
+				'AHEE__EE_Cron_Tasks__update_transaction_with_payment' => EEH_Activation::cron_task_no_longer_in_use,
+				//there may have been a bug which prevented from these cron tasks from getting unscheduled, so we might want to remove these for a few updates
+			)
+		);
+		if ($which_to_include === 'old') {
+			$cron_tasks = array_filter(
+				$cron_tasks,
+				function ($value) {
+					return $value === EEH_Activation::cron_task_no_longer_in_use;
+				}
+			);
+		} elseif ($which_to_include === 'current') {
+			$cron_tasks = array_filter($cron_tasks);
+		} elseif (WP_DEBUG && $which_to_include !== 'all') {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Invalid argument of "%1$s" passed to EEH_Activation::get_cron_tasks. Valid values are "all", "old" and "current".',
+						'event_espresso'
+					),
+					$which_to_include
+				)
+			);
+		}
+		return $cron_tasks;
+	}
+
+
+	/**
+	 * Ensure cron tasks are setup (the removal of crons should be done by remove_crons())
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function create_cron_tasks()
+	{
+
+		foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
+			if (! wp_next_scheduled($hook_name)) {
+				wp_schedule_event(time(), $frequency, $hook_name);
+			}
+		}
+
+	}
+
+
+	/**
+	 * Remove the currently-existing and now-removed cron tasks.
+	 *
+	 * @param boolean $remove_all whether to only remove the old ones, or remove absolutely ALL the EE ones
+	 * @throws \EE_Error
+	 */
+	public static function remove_cron_tasks($remove_all = true)
+	{
+		$cron_tasks_to_remove = $remove_all ? 'all' : 'old';
+		$crons                = _get_cron_array();
+		$crons                = is_array($crons) ? $crons : array();
+		/* reminder of what $crons look like:
          * Top-level keys are timestamps, and their values are arrays.
          * The 2nd level arrays have keys with each of the cron task hook names to run at that time
          * and their values are arrays.
@@ -255,966 +255,966 @@ 
          *					...
          *      ...
          */
-        $ee_cron_tasks_to_remove = EEH_Activation::get_cron_tasks($cron_tasks_to_remove);
-        foreach ($crons as $timestamp => $hooks_to_fire_at_time) {
-            if (is_array($hooks_to_fire_at_time)) {
-                foreach ($hooks_to_fire_at_time as $hook_name => $hook_actions) {
-                    if (isset($ee_cron_tasks_to_remove[$hook_name])
-                        && is_array($ee_cron_tasks_to_remove[$hook_name])
-                    ) {
-                        unset($crons[$timestamp][$hook_name]);
-                    }
-                }
-                //also take care of any empty cron timestamps.
-                if (empty($hooks_to_fire_at_time)) {
-                    unset($crons[$timestamp]);
-                }
-            }
-        }
-        _set_cron_array($crons);
-    }
-
-
-    /**
-     *    CPT_initialization
-     *    registers all EE CPTs ( Custom Post Types ) then flushes rewrite rules so that all endpoints exist
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function CPT_initialization()
-    {
-        // register Custom Post Types
-        EE_Registry::instance()->load_core('Register_CPTs');
-        flush_rewrite_rules();
-    }
-
-
-
-    /**
-     *    reset_and_update_config
-     * The following code was moved over from EE_Config so that it will no longer run on every request.
-     * If there is old calendar config data saved, then it will get converted on activation.
-     * This was basically a DMS before we had DMS's, and will get removed after a few more versions.
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function reset_and_update_config()
-    {
-        do_action('AHEE__EE_Config___load_core_config__start', array('EEH_Activation', 'load_calendar_config'));
-        add_filter(
-            'FHEE__EE_Config___load_core_config__config_settings',
-            array('EEH_Activation', 'migrate_old_config_data'),
-            10,
-            3
-        );
-        //EE_Config::reset();
-        if (! EE_Config::logging_enabled()) {
-            delete_option(EE_Config::LOG_NAME);
-        }
-    }
-
-
-    /**
-     *    load_calendar_config
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function load_calendar_config()
-    {
-        // grab array of all plugin folders and loop thru it
-        $plugins = glob(WP_PLUGIN_DIR . DS . '*', GLOB_ONLYDIR);
-        if (empty($plugins)) {
-            return;
-        }
-        foreach ($plugins as $plugin_path) {
-            // grab plugin folder name from path
-            $plugin = basename($plugin_path);
-            // drill down to Espresso plugins
-            // then to calendar related plugins
-            if (
-                strpos($plugin, 'espresso') !== false
-                || strpos($plugin, 'Espresso') !== false
-                || strpos($plugin, 'ee4') !== false
-                || strpos($plugin, 'EE4') !== false
-                || strpos($plugin, 'calendar') !== false
-            ) {
-                // this is what we are looking for
-                $calendar_config = $plugin_path . DS . 'EE_Calendar_Config.php';
-                // does it exist in this folder ?
-                if (is_readable($calendar_config)) {
-                    // YEAH! let's load it
-                    require_once($calendar_config);
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    _migrate_old_config_data
-     *
-     * @access    public
-     * @param array|stdClass $settings
-     * @param string         $config
-     * @param \EE_Config     $EE_Config
-     * @return \stdClass
-     */
-    public static function migrate_old_config_data($settings = array(), $config = '', EE_Config $EE_Config)
-    {
-        $convert_from_array = array('addons');
-        // in case old settings were saved as an array
-        if (is_array($settings) && in_array($config, $convert_from_array)) {
-            // convert existing settings to an object
-            $config_array = $settings;
-            $settings = new stdClass();
-            foreach ($config_array as $key => $value) {
-                if ($key === 'calendar' && class_exists('EE_Calendar_Config')) {
-                    $EE_Config->set_config('addons', 'EE_Calendar', 'EE_Calendar_Config', $value);
-                } else {
-                    $settings->{$key} = $value;
-                }
-            }
-            add_filter('FHEE__EE_Config___load_core_config__update_espresso_config', '__return_true');
-        }
-        return $settings;
-    }
-
-
-    /**
-     * deactivate_event_espresso
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function deactivate_event_espresso()
-    {
-        // check permissions
-        if (current_user_can('activate_plugins')) {
-            deactivate_plugins(EE_PLUGIN_BASENAME, true);
-        }
-    }
-
-
-
-
-
-    /**
-     * verify_default_pages_exist
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function verify_default_pages_exist()
-    {
-        $critical_page_problem = false;
-        $critical_pages = array(
-            array(
-                'id'   => 'reg_page_id',
-                'name' => __('Registration Checkout', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_CHECKOUT',
-            ),
-            array(
-                'id'   => 'txn_page_id',
-                'name' => __('Transactions', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_TXN_PAGE',
-            ),
-            array(
-                'id'   => 'thank_you_page_id',
-                'name' => __('Thank You', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_THANK_YOU',
-            ),
-            array(
-                'id'   => 'cancel_page_id',
-                'name' => __('Registration Cancelled', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_CANCELLED',
-            ),
-        );
-        $EE_Core_Config = EE_Registry::instance()->CFG->core;
-        foreach ($critical_pages as $critical_page) {
-            // is critical page ID set in config ?
-            if ($EE_Core_Config->{$critical_page['id']} !== false) {
-                // attempt to find post by ID
-                $critical_page['post'] = get_post($EE_Core_Config->{$critical_page['id']});
-            }
-            // no dice?
-            if ($critical_page['post'] === null) {
-                // attempt to find post by title
-                $critical_page['post'] = self::get_page_by_ee_shortcode($critical_page['code']);
-                // still nothing?
-                if ($critical_page['post'] === null) {
-                    $critical_page = EEH_Activation::create_critical_page($critical_page);
-                    // REALLY? Still nothing ??!?!?
-                    if ($critical_page['post'] === null) {
-                        $msg = __(
-                            'The Event Espresso critical page configuration settings could not be updated.',
-                            'event_espresso'
-                        );
-                        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                        break;
-                    }
-                }
-            }
-            // track post_shortcodes
-            if ($critical_page['post']) {
-                EEH_Activation::_track_critical_page_post_shortcodes($critical_page);
-            }
-            // check that Post ID matches critical page ID in config
-            if (
-                isset($critical_page['post']->ID)
-                && $critical_page['post']->ID !== $EE_Core_Config->{$critical_page['id']}
-            ) {
-                //update Config with post ID
-                $EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
-                if (! EE_Config::instance()->update_espresso_config(false, false)) {
-                    $msg = __(
-                        'The Event Espresso critical page configuration settings could not be updated.',
-                        'event_espresso'
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            $critical_page_problem =
-                ! isset($critical_page['post']->post_status)
-                || $critical_page['post']->post_status !== 'publish'
-                || strpos($critical_page['post']->post_content, $critical_page['code']) === false
-                    ? true
-                    : $critical_page_problem;
-        }
-        if ($critical_page_problem) {
-            $msg = sprintf(
-                __(
-                    'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
-                    'event_espresso'
-                ),
-                '<a href="'
-                . admin_url('admin.php?page=espresso_general_settings&action=critical_pages')
-                . '">'
-                . __('Event Espresso Critical Pages Settings', 'event_espresso')
-                . '</a>'
-            );
-            EE_Error::add_persistent_admin_notice('critical_page_problem', $msg);
-        }
-        if (EE_Error::has_notices()) {
-            EE_Error::get_notices(false, true, true);
-        }
-    }
-
-
-
-    /**
-     * Returns the first post which uses the specified shortcode
-     *
-     * @param string $ee_shortcode usually one of the critical pages shortcodes, eg
-     *                             ESPRESSO_THANK_YOU. So we will search fora post with the content
-     *                             "[ESPRESSO_THANK_YOU"
-     *                             (we don't search for the closing shortcode bracket because they might have added
-     *                             parameter to the shortcode
-     * @return WP_Post or NULl
-     */
-    public static function get_page_by_ee_shortcode($ee_shortcode)
-    {
-        global $wpdb;
-        $shortcode_and_opening_bracket = '[' . $ee_shortcode;
-        $post_id = $wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
-        if ($post_id) {
-            return get_post($post_id);
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     *    This function generates a post for critical espresso pages
-     *
-     * @access public
-     * @static
-     * @param array $critical_page
-     * @return array
-     */
-    public static function create_critical_page($critical_page)
-    {
-
-        $post_args = array(
-            'post_title'     => $critical_page['name'],
-            'post_status'    => 'publish',
-            'post_type'      => 'page',
-            'comment_status' => 'closed',
-            'post_content'   => '[' . $critical_page['code'] . ']',
-        );
-
-        $post_id = wp_insert_post($post_args);
-        if (! $post_id) {
-            $msg = sprintf(
-                __('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
-                $critical_page['name']
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return $critical_page;
-        }
-        // get newly created post's details
-        if (! $critical_page['post'] = get_post($post_id)) {
-            $msg = sprintf(
-                __('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
-                $critical_page['name']
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-
-        return $critical_page;
-
-    }
-
-
-
-
-
-    /**
-     *    This function adds a critical page's shortcode to the post_shortcodes array
-     *
-     * @access private
-     * @static
-     * @param array $critical_page
-     * @return void
-     */
-    private static function _track_critical_page_post_shortcodes($critical_page = array())
-    {
-        // check the goods
-        if ( ! $critical_page['post'] instanceof WP_Post) {
-            $msg = sprintf(
-                __(
-                    'The Event Espresso critical page shortcode for the page %s can not be tracked because it is not a WP_Post object.',
-                    'event_espresso'
-                ),
-                $critical_page['name']
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return;
-        }
-        $EE_Core_Config = EE_Registry::instance()->CFG->core;
-        // map shortcode to post
-        $EE_Core_Config->post_shortcodes[$critical_page['post']->post_name][$critical_page['code']] = $critical_page['post']->ID;
-        // and make sure it's NOT added to the WP "Posts Page"
-        // name of the WP Posts Page
-        $posts_page = EE_Config::get_page_for_posts();
-        if (isset($EE_Core_Config->post_shortcodes[$posts_page])) {
-            unset($EE_Core_Config->post_shortcodes[$posts_page][$critical_page['code']]);
-        }
-        if ($posts_page !== 'posts' && isset($EE_Core_Config->post_shortcodes['posts'])) {
-            unset($EE_Core_Config->post_shortcodes['posts'][$critical_page['code']]);
-        }
-        // update post_shortcode CFG
-        if ( ! EE_Config::instance()->update_espresso_config(false, false)) {
-            $msg = sprintf(
-                __(
-                    'The Event Espresso critical page shortcode for the %s page could not be configured properly.',
-                    'event_espresso'
-                ),
-                $critical_page['name']
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-
-    /**
-     * Tries to find the oldest admin for this site.  If there are no admins for this site then return NULL.
-     * The role being used to check is filterable.
-     *
-     * @since  4.6.0
-     * @global WPDB $wpdb
-     * @return mixed null|int WP_user ID or NULL
-     */
-    public static function get_default_creator_id()
-    {
-        global $wpdb;
-        if ( ! empty(self::$_default_creator_id)) {
-            return self::$_default_creator_id;
-        }/**/
-        $role_to_check = apply_filters('FHEE__EEH_Activation__get_default_creator_id__role_to_check', 'administrator');
-        //let's allow pre_filtering for early exits by alternative methods for getting id.  We check for truthy result and if so then exit early.
-        $pre_filtered_id = apply_filters(
-            'FHEE__EEH_Activation__get_default_creator_id__pre_filtered_id',
-            false,
-            $role_to_check
-        );
-        if ($pre_filtered_id !== false) {
-            return (int)$pre_filtered_id;
-        }
-        $capabilities_key = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
-        $query = $wpdb->prepare(
-            "SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
-            '%' . $role_to_check . '%'
-        );
-        $user_id = $wpdb->get_var($query);
-        $user_id = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
-        if ($user_id && (int)$user_id) {
-            self::$_default_creator_id = (int)$user_id;
-            return self::$_default_creator_id;
-        } else {
-            return null;
-        }
-    }
-
-
-
-    /**
-     * used by EE and EE addons during plugin activation to create tables.
-     * Its a wrapper for EventEspresso\core\services\database\TableManager::createTable,
-     * but includes extra logic regarding activations.
-     *
-     * @access public
-     * @static
-     * @param string  $table_name              without the $wpdb->prefix
-     * @param string  $sql                     SQL for creating the table (contents between brackets in an SQL create
-     *                                         table query)
-     * @param string  $engine                  like 'ENGINE=MyISAM' or 'ENGINE=InnoDB'
-     * @param boolean $drop_pre_existing_table set to TRUE when you want to make SURE the table is completely empty
-     *                                         and new once this function is done (ie, you really do want to CREATE a
-     *                                         table, and expect it to be empty once you're done) leave as FALSE when
-     *                                         you just want to verify the table exists and matches this definition
-     *                                         (and if it HAS data in it you want to leave it be)
-     * @return void
-     * @throws EE_Error if there are database errors
-     */
-    public static function create_table($table_name, $sql, $engine = 'ENGINE=MyISAM ', $drop_pre_existing_table = false)
-    {
-        if (apply_filters('FHEE__EEH_Activation__create_table__short_circuit', false, $table_name, $sql)) {
-            return;
-        }
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if ( ! function_exists('dbDelta')) {
-            require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
-        }
-        $tableAnalysis = \EEH_Activation::getTableAnalysis();
-        $wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
-        // do we need to first delete an existing version of this table ?
-        if ($drop_pre_existing_table && $tableAnalysis->tableExists($wp_table_name)) {
-            // ok, delete the table... but ONLY if it's empty
-            $deleted_safely = EEH_Activation::delete_db_table_if_empty($wp_table_name);
-            // table is NOT empty, are you SURE you want to delete this table ???
-            if ( ! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
-                \EEH_Activation::getTableManager()->dropTable($wp_table_name);
-            } else if ( ! $deleted_safely) {
-                // so we should be more cautious rather than just dropping tables so easily
-                error_log(
-                    sprintf(
-                        __(
-                            'It appears that database table "%1$s" exists when it shouldn\'t, and therefore may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend: %2$s 1. create a new COMPLETE backup of your database, %2$s 2. delete ALL tables from your database, %2$s 3. restore to your previous backup. %2$s If, however, you have not restored to a backup, then somehow your "%3$s" WordPress option could not be read. You can probably ignore this message, but should investigate why that option is being removed.',
-                            'event_espresso'
-                        ),
-                        $wp_table_name,
-                        '<br/>',
-                        'espresso_db_update'
-                    )
-                );
-            }
-        }
-        $engine = str_replace('ENGINE=', '', $engine);
-        \EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
-    }
-
-
-
-    /**
-     *    add_column_if_it_doesn't_exist
-     *    Checks if this column already exists on the specified table. Handy for addons which want to add a column
-     *
-     * @access     public
-     * @static
-     * @deprecated instead use TableManager::addColumn()
-     * @param string $table_name  (without "wp_", eg "esp_attendee"
-     * @param string $column_name
-     * @param string $column_info if your SQL were 'ALTER TABLE table_name ADD price VARCHAR(10)', this would be
-     *                            'VARCHAR(10)'
-     * @return bool|int
-     */
-    public static function add_column_if_it_doesnt_exist(
-        $table_name,
-        $column_name,
-        $column_info = 'INT UNSIGNED NOT NULL'
-    ) {
-        return \EEH_Activation::getTableManager()->addColumn($table_name, $column_name, $column_info);
-    }
-
-
-    /**
-     * get_fields_on_table
-     * Gets all the fields on the database table.
-     *
-     * @access     public
-     * @deprecated instead use TableManager::getTableColumns()
-     * @static
-     * @param string $table_name , without prefixed $wpdb->prefix
-     * @return array of database column names
-     */
-    public static function get_fields_on_table($table_name = null)
-    {
-        return \EEH_Activation::getTableManager()->getTableColumns($table_name);
-    }
-
-
-    /**
-     * db_table_is_empty
-     *
-     * @access     public\
-     * @deprecated instead use TableAnalysis::tableIsEmpty()
-     * @static
-     * @param string $table_name
-     * @return bool
-     */
-    public static function db_table_is_empty($table_name)
-    {
-        return \EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name);
-    }
-
-
-    /**
-     * delete_db_table_if_empty
-     *
-     * @access public
-     * @static
-     * @param string $table_name
-     * @return bool | int
-     */
-    public static function delete_db_table_if_empty($table_name)
-    {
-        if (\EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name)) {
-            return \EEH_Activation::getTableManager()->dropTable($table_name);
-        }
-        return false;
-    }
-
-
-    /**
-     * delete_unused_db_table
-     *
-     * @access     public
-     * @static
-     * @deprecated instead use TableManager::dropTable()
-     * @param string $table_name
-     * @return bool | int
-     */
-    public static function delete_unused_db_table($table_name)
-    {
-        return \EEH_Activation::getTableManager()->dropTable($table_name);
-    }
-
-
-    /**
-     * drop_index
-     *
-     * @access     public
-     * @static
-     * @deprecated instead use TableManager::dropIndex()
-     * @param string $table_name
-     * @param string $index_name
-     * @return bool | int
-     */
-    public static function drop_index($table_name, $index_name)
-    {
-        return \EEH_Activation::getTableManager()->dropIndex($table_name, $index_name);
-    }
-
-
-
-    /**
-     * create_database_tables
-     *
-     * @access public
-     * @static
-     * @throws EE_Error
-     * @return boolean success (whether database is setup properly or not)
-     */
-    public static function create_database_tables()
-    {
-        EE_Registry::instance()->load_core('Data_Migration_Manager');
-        //find the migration script that sets the database to be compatible with the code
-        $dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms();
-        if ($dms_name) {
-            $current_data_migration_script = EE_Registry::instance()->load_dms($dms_name);
-            $current_data_migration_script->set_migrating(false);
-            $current_data_migration_script->schema_changes_before_migration();
-            $current_data_migration_script->schema_changes_after_migration();
-            if ($current_data_migration_script->get_errors()) {
-                if (WP_DEBUG) {
-                    foreach ($current_data_migration_script->get_errors() as $error) {
-                        EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-                    }
-                } else {
-                    EE_Error::add_error(
-                        __(
-                            'There were errors creating the Event Espresso database tables and Event Espresso has been 
+		$ee_cron_tasks_to_remove = EEH_Activation::get_cron_tasks($cron_tasks_to_remove);
+		foreach ($crons as $timestamp => $hooks_to_fire_at_time) {
+			if (is_array($hooks_to_fire_at_time)) {
+				foreach ($hooks_to_fire_at_time as $hook_name => $hook_actions) {
+					if (isset($ee_cron_tasks_to_remove[$hook_name])
+						&& is_array($ee_cron_tasks_to_remove[$hook_name])
+					) {
+						unset($crons[$timestamp][$hook_name]);
+					}
+				}
+				//also take care of any empty cron timestamps.
+				if (empty($hooks_to_fire_at_time)) {
+					unset($crons[$timestamp]);
+				}
+			}
+		}
+		_set_cron_array($crons);
+	}
+
+
+	/**
+	 *    CPT_initialization
+	 *    registers all EE CPTs ( Custom Post Types ) then flushes rewrite rules so that all endpoints exist
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function CPT_initialization()
+	{
+		// register Custom Post Types
+		EE_Registry::instance()->load_core('Register_CPTs');
+		flush_rewrite_rules();
+	}
+
+
+
+	/**
+	 *    reset_and_update_config
+	 * The following code was moved over from EE_Config so that it will no longer run on every request.
+	 * If there is old calendar config data saved, then it will get converted on activation.
+	 * This was basically a DMS before we had DMS's, and will get removed after a few more versions.
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function reset_and_update_config()
+	{
+		do_action('AHEE__EE_Config___load_core_config__start', array('EEH_Activation', 'load_calendar_config'));
+		add_filter(
+			'FHEE__EE_Config___load_core_config__config_settings',
+			array('EEH_Activation', 'migrate_old_config_data'),
+			10,
+			3
+		);
+		//EE_Config::reset();
+		if (! EE_Config::logging_enabled()) {
+			delete_option(EE_Config::LOG_NAME);
+		}
+	}
+
+
+	/**
+	 *    load_calendar_config
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function load_calendar_config()
+	{
+		// grab array of all plugin folders and loop thru it
+		$plugins = glob(WP_PLUGIN_DIR . DS . '*', GLOB_ONLYDIR);
+		if (empty($plugins)) {
+			return;
+		}
+		foreach ($plugins as $plugin_path) {
+			// grab plugin folder name from path
+			$plugin = basename($plugin_path);
+			// drill down to Espresso plugins
+			// then to calendar related plugins
+			if (
+				strpos($plugin, 'espresso') !== false
+				|| strpos($plugin, 'Espresso') !== false
+				|| strpos($plugin, 'ee4') !== false
+				|| strpos($plugin, 'EE4') !== false
+				|| strpos($plugin, 'calendar') !== false
+			) {
+				// this is what we are looking for
+				$calendar_config = $plugin_path . DS . 'EE_Calendar_Config.php';
+				// does it exist in this folder ?
+				if (is_readable($calendar_config)) {
+					// YEAH! let's load it
+					require_once($calendar_config);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    _migrate_old_config_data
+	 *
+	 * @access    public
+	 * @param array|stdClass $settings
+	 * @param string         $config
+	 * @param \EE_Config     $EE_Config
+	 * @return \stdClass
+	 */
+	public static function migrate_old_config_data($settings = array(), $config = '', EE_Config $EE_Config)
+	{
+		$convert_from_array = array('addons');
+		// in case old settings were saved as an array
+		if (is_array($settings) && in_array($config, $convert_from_array)) {
+			// convert existing settings to an object
+			$config_array = $settings;
+			$settings = new stdClass();
+			foreach ($config_array as $key => $value) {
+				if ($key === 'calendar' && class_exists('EE_Calendar_Config')) {
+					$EE_Config->set_config('addons', 'EE_Calendar', 'EE_Calendar_Config', $value);
+				} else {
+					$settings->{$key} = $value;
+				}
+			}
+			add_filter('FHEE__EE_Config___load_core_config__update_espresso_config', '__return_true');
+		}
+		return $settings;
+	}
+
+
+	/**
+	 * deactivate_event_espresso
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function deactivate_event_espresso()
+	{
+		// check permissions
+		if (current_user_can('activate_plugins')) {
+			deactivate_plugins(EE_PLUGIN_BASENAME, true);
+		}
+	}
+
+
+
+
+
+	/**
+	 * verify_default_pages_exist
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function verify_default_pages_exist()
+	{
+		$critical_page_problem = false;
+		$critical_pages = array(
+			array(
+				'id'   => 'reg_page_id',
+				'name' => __('Registration Checkout', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_CHECKOUT',
+			),
+			array(
+				'id'   => 'txn_page_id',
+				'name' => __('Transactions', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_TXN_PAGE',
+			),
+			array(
+				'id'   => 'thank_you_page_id',
+				'name' => __('Thank You', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_THANK_YOU',
+			),
+			array(
+				'id'   => 'cancel_page_id',
+				'name' => __('Registration Cancelled', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_CANCELLED',
+			),
+		);
+		$EE_Core_Config = EE_Registry::instance()->CFG->core;
+		foreach ($critical_pages as $critical_page) {
+			// is critical page ID set in config ?
+			if ($EE_Core_Config->{$critical_page['id']} !== false) {
+				// attempt to find post by ID
+				$critical_page['post'] = get_post($EE_Core_Config->{$critical_page['id']});
+			}
+			// no dice?
+			if ($critical_page['post'] === null) {
+				// attempt to find post by title
+				$critical_page['post'] = self::get_page_by_ee_shortcode($critical_page['code']);
+				// still nothing?
+				if ($critical_page['post'] === null) {
+					$critical_page = EEH_Activation::create_critical_page($critical_page);
+					// REALLY? Still nothing ??!?!?
+					if ($critical_page['post'] === null) {
+						$msg = __(
+							'The Event Espresso critical page configuration settings could not be updated.',
+							'event_espresso'
+						);
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+						break;
+					}
+				}
+			}
+			// track post_shortcodes
+			if ($critical_page['post']) {
+				EEH_Activation::_track_critical_page_post_shortcodes($critical_page);
+			}
+			// check that Post ID matches critical page ID in config
+			if (
+				isset($critical_page['post']->ID)
+				&& $critical_page['post']->ID !== $EE_Core_Config->{$critical_page['id']}
+			) {
+				//update Config with post ID
+				$EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
+				if (! EE_Config::instance()->update_espresso_config(false, false)) {
+					$msg = __(
+						'The Event Espresso critical page configuration settings could not be updated.',
+						'event_espresso'
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			$critical_page_problem =
+				! isset($critical_page['post']->post_status)
+				|| $critical_page['post']->post_status !== 'publish'
+				|| strpos($critical_page['post']->post_content, $critical_page['code']) === false
+					? true
+					: $critical_page_problem;
+		}
+		if ($critical_page_problem) {
+			$msg = sprintf(
+				__(
+					'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
+					'event_espresso'
+				),
+				'<a href="'
+				. admin_url('admin.php?page=espresso_general_settings&action=critical_pages')
+				. '">'
+				. __('Event Espresso Critical Pages Settings', 'event_espresso')
+				. '</a>'
+			);
+			EE_Error::add_persistent_admin_notice('critical_page_problem', $msg);
+		}
+		if (EE_Error::has_notices()) {
+			EE_Error::get_notices(false, true, true);
+		}
+	}
+
+
+
+	/**
+	 * Returns the first post which uses the specified shortcode
+	 *
+	 * @param string $ee_shortcode usually one of the critical pages shortcodes, eg
+	 *                             ESPRESSO_THANK_YOU. So we will search fora post with the content
+	 *                             "[ESPRESSO_THANK_YOU"
+	 *                             (we don't search for the closing shortcode bracket because they might have added
+	 *                             parameter to the shortcode
+	 * @return WP_Post or NULl
+	 */
+	public static function get_page_by_ee_shortcode($ee_shortcode)
+	{
+		global $wpdb;
+		$shortcode_and_opening_bracket = '[' . $ee_shortcode;
+		$post_id = $wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
+		if ($post_id) {
+			return get_post($post_id);
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 *    This function generates a post for critical espresso pages
+	 *
+	 * @access public
+	 * @static
+	 * @param array $critical_page
+	 * @return array
+	 */
+	public static function create_critical_page($critical_page)
+	{
+
+		$post_args = array(
+			'post_title'     => $critical_page['name'],
+			'post_status'    => 'publish',
+			'post_type'      => 'page',
+			'comment_status' => 'closed',
+			'post_content'   => '[' . $critical_page['code'] . ']',
+		);
+
+		$post_id = wp_insert_post($post_args);
+		if (! $post_id) {
+			$msg = sprintf(
+				__('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
+				$critical_page['name']
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return $critical_page;
+		}
+		// get newly created post's details
+		if (! $critical_page['post'] = get_post($post_id)) {
+			$msg = sprintf(
+				__('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
+				$critical_page['name']
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+
+		return $critical_page;
+
+	}
+
+
+
+
+
+	/**
+	 *    This function adds a critical page's shortcode to the post_shortcodes array
+	 *
+	 * @access private
+	 * @static
+	 * @param array $critical_page
+	 * @return void
+	 */
+	private static function _track_critical_page_post_shortcodes($critical_page = array())
+	{
+		// check the goods
+		if ( ! $critical_page['post'] instanceof WP_Post) {
+			$msg = sprintf(
+				__(
+					'The Event Espresso critical page shortcode for the page %s can not be tracked because it is not a WP_Post object.',
+					'event_espresso'
+				),
+				$critical_page['name']
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return;
+		}
+		$EE_Core_Config = EE_Registry::instance()->CFG->core;
+		// map shortcode to post
+		$EE_Core_Config->post_shortcodes[$critical_page['post']->post_name][$critical_page['code']] = $critical_page['post']->ID;
+		// and make sure it's NOT added to the WP "Posts Page"
+		// name of the WP Posts Page
+		$posts_page = EE_Config::get_page_for_posts();
+		if (isset($EE_Core_Config->post_shortcodes[$posts_page])) {
+			unset($EE_Core_Config->post_shortcodes[$posts_page][$critical_page['code']]);
+		}
+		if ($posts_page !== 'posts' && isset($EE_Core_Config->post_shortcodes['posts'])) {
+			unset($EE_Core_Config->post_shortcodes['posts'][$critical_page['code']]);
+		}
+		// update post_shortcode CFG
+		if ( ! EE_Config::instance()->update_espresso_config(false, false)) {
+			$msg = sprintf(
+				__(
+					'The Event Espresso critical page shortcode for the %s page could not be configured properly.',
+					'event_espresso'
+				),
+				$critical_page['name']
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+
+	/**
+	 * Tries to find the oldest admin for this site.  If there are no admins for this site then return NULL.
+	 * The role being used to check is filterable.
+	 *
+	 * @since  4.6.0
+	 * @global WPDB $wpdb
+	 * @return mixed null|int WP_user ID or NULL
+	 */
+	public static function get_default_creator_id()
+	{
+		global $wpdb;
+		if ( ! empty(self::$_default_creator_id)) {
+			return self::$_default_creator_id;
+		}/**/
+		$role_to_check = apply_filters('FHEE__EEH_Activation__get_default_creator_id__role_to_check', 'administrator');
+		//let's allow pre_filtering for early exits by alternative methods for getting id.  We check for truthy result and if so then exit early.
+		$pre_filtered_id = apply_filters(
+			'FHEE__EEH_Activation__get_default_creator_id__pre_filtered_id',
+			false,
+			$role_to_check
+		);
+		if ($pre_filtered_id !== false) {
+			return (int)$pre_filtered_id;
+		}
+		$capabilities_key = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
+		$query = $wpdb->prepare(
+			"SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
+			'%' . $role_to_check . '%'
+		);
+		$user_id = $wpdb->get_var($query);
+		$user_id = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
+		if ($user_id && (int)$user_id) {
+			self::$_default_creator_id = (int)$user_id;
+			return self::$_default_creator_id;
+		} else {
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * used by EE and EE addons during plugin activation to create tables.
+	 * Its a wrapper for EventEspresso\core\services\database\TableManager::createTable,
+	 * but includes extra logic regarding activations.
+	 *
+	 * @access public
+	 * @static
+	 * @param string  $table_name              without the $wpdb->prefix
+	 * @param string  $sql                     SQL for creating the table (contents between brackets in an SQL create
+	 *                                         table query)
+	 * @param string  $engine                  like 'ENGINE=MyISAM' or 'ENGINE=InnoDB'
+	 * @param boolean $drop_pre_existing_table set to TRUE when you want to make SURE the table is completely empty
+	 *                                         and new once this function is done (ie, you really do want to CREATE a
+	 *                                         table, and expect it to be empty once you're done) leave as FALSE when
+	 *                                         you just want to verify the table exists and matches this definition
+	 *                                         (and if it HAS data in it you want to leave it be)
+	 * @return void
+	 * @throws EE_Error if there are database errors
+	 */
+	public static function create_table($table_name, $sql, $engine = 'ENGINE=MyISAM ', $drop_pre_existing_table = false)
+	{
+		if (apply_filters('FHEE__EEH_Activation__create_table__short_circuit', false, $table_name, $sql)) {
+			return;
+		}
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if ( ! function_exists('dbDelta')) {
+			require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
+		}
+		$tableAnalysis = \EEH_Activation::getTableAnalysis();
+		$wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
+		// do we need to first delete an existing version of this table ?
+		if ($drop_pre_existing_table && $tableAnalysis->tableExists($wp_table_name)) {
+			// ok, delete the table... but ONLY if it's empty
+			$deleted_safely = EEH_Activation::delete_db_table_if_empty($wp_table_name);
+			// table is NOT empty, are you SURE you want to delete this table ???
+			if ( ! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
+				\EEH_Activation::getTableManager()->dropTable($wp_table_name);
+			} else if ( ! $deleted_safely) {
+				// so we should be more cautious rather than just dropping tables so easily
+				error_log(
+					sprintf(
+						__(
+							'It appears that database table "%1$s" exists when it shouldn\'t, and therefore may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend: %2$s 1. create a new COMPLETE backup of your database, %2$s 2. delete ALL tables from your database, %2$s 3. restore to your previous backup. %2$s If, however, you have not restored to a backup, then somehow your "%3$s" WordPress option could not be read. You can probably ignore this message, but should investigate why that option is being removed.',
+							'event_espresso'
+						),
+						$wp_table_name,
+						'<br/>',
+						'espresso_db_update'
+					)
+				);
+			}
+		}
+		$engine = str_replace('ENGINE=', '', $engine);
+		\EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
+	}
+
+
+
+	/**
+	 *    add_column_if_it_doesn't_exist
+	 *    Checks if this column already exists on the specified table. Handy for addons which want to add a column
+	 *
+	 * @access     public
+	 * @static
+	 * @deprecated instead use TableManager::addColumn()
+	 * @param string $table_name  (without "wp_", eg "esp_attendee"
+	 * @param string $column_name
+	 * @param string $column_info if your SQL were 'ALTER TABLE table_name ADD price VARCHAR(10)', this would be
+	 *                            'VARCHAR(10)'
+	 * @return bool|int
+	 */
+	public static function add_column_if_it_doesnt_exist(
+		$table_name,
+		$column_name,
+		$column_info = 'INT UNSIGNED NOT NULL'
+	) {
+		return \EEH_Activation::getTableManager()->addColumn($table_name, $column_name, $column_info);
+	}
+
+
+	/**
+	 * get_fields_on_table
+	 * Gets all the fields on the database table.
+	 *
+	 * @access     public
+	 * @deprecated instead use TableManager::getTableColumns()
+	 * @static
+	 * @param string $table_name , without prefixed $wpdb->prefix
+	 * @return array of database column names
+	 */
+	public static function get_fields_on_table($table_name = null)
+	{
+		return \EEH_Activation::getTableManager()->getTableColumns($table_name);
+	}
+
+
+	/**
+	 * db_table_is_empty
+	 *
+	 * @access     public\
+	 * @deprecated instead use TableAnalysis::tableIsEmpty()
+	 * @static
+	 * @param string $table_name
+	 * @return bool
+	 */
+	public static function db_table_is_empty($table_name)
+	{
+		return \EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name);
+	}
+
+
+	/**
+	 * delete_db_table_if_empty
+	 *
+	 * @access public
+	 * @static
+	 * @param string $table_name
+	 * @return bool | int
+	 */
+	public static function delete_db_table_if_empty($table_name)
+	{
+		if (\EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name)) {
+			return \EEH_Activation::getTableManager()->dropTable($table_name);
+		}
+		return false;
+	}
+
+
+	/**
+	 * delete_unused_db_table
+	 *
+	 * @access     public
+	 * @static
+	 * @deprecated instead use TableManager::dropTable()
+	 * @param string $table_name
+	 * @return bool | int
+	 */
+	public static function delete_unused_db_table($table_name)
+	{
+		return \EEH_Activation::getTableManager()->dropTable($table_name);
+	}
+
+
+	/**
+	 * drop_index
+	 *
+	 * @access     public
+	 * @static
+	 * @deprecated instead use TableManager::dropIndex()
+	 * @param string $table_name
+	 * @param string $index_name
+	 * @return bool | int
+	 */
+	public static function drop_index($table_name, $index_name)
+	{
+		return \EEH_Activation::getTableManager()->dropIndex($table_name, $index_name);
+	}
+
+
+
+	/**
+	 * create_database_tables
+	 *
+	 * @access public
+	 * @static
+	 * @throws EE_Error
+	 * @return boolean success (whether database is setup properly or not)
+	 */
+	public static function create_database_tables()
+	{
+		EE_Registry::instance()->load_core('Data_Migration_Manager');
+		//find the migration script that sets the database to be compatible with the code
+		$dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms();
+		if ($dms_name) {
+			$current_data_migration_script = EE_Registry::instance()->load_dms($dms_name);
+			$current_data_migration_script->set_migrating(false);
+			$current_data_migration_script->schema_changes_before_migration();
+			$current_data_migration_script->schema_changes_after_migration();
+			if ($current_data_migration_script->get_errors()) {
+				if (WP_DEBUG) {
+					foreach ($current_data_migration_script->get_errors() as $error) {
+						EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+					}
+				} else {
+					EE_Error::add_error(
+						__(
+							'There were errors creating the Event Espresso database tables and Event Espresso has been 
                             deactivated. To view the errors, please enable WP_DEBUG in your wp-config.php file.',
-                            'event_espresso'
-                        )
-                    );
-                }
-                return false;
-            }
-            EE_Data_Migration_Manager::instance()->update_current_database_state_to();
-        } else {
-            EE_Error::add_error(
-                __(
-                    'Could not determine most up-to-date data migration script from which to pull database schema
+							'event_espresso'
+						)
+					);
+				}
+				return false;
+			}
+			EE_Data_Migration_Manager::instance()->update_current_database_state_to();
+		} else {
+			EE_Error::add_error(
+				__(
+					'Could not determine most up-to-date data migration script from which to pull database schema
                      structure. So database is probably not setup properly',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * initialize_system_questions
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function initialize_system_questions()
-    {
-        // QUESTION GROUPS
-        global $wpdb;
-        $table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group');
-        $SQL = "SELECT QSG_system FROM $table_name WHERE QSG_system != 0";
-        // what we have
-        $question_groups = $wpdb->get_col($SQL);
-        // check the response
-        $question_groups = is_array($question_groups) ? $question_groups : array();
-        // what we should have
-        $QSG_systems = array(1, 2);
-        // loop thru what we should have and compare to what we have
-        foreach ($QSG_systems as $QSG_system) {
-            // reset values array
-            $QSG_values = array();
-            // if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
-            if (! in_array("$QSG_system", $question_groups)) {
-                // add it
-                switch ($QSG_system) {
-                    case 1:
-                        $QSG_values = array(
-                            'QSG_name'            => __('Personal Information', 'event_espresso'),
-                            'QSG_identifier'      => 'personal-information-' . time(),
-                            'QSG_desc'            => '',
-                            'QSG_order'           => 1,
-                            'QSG_show_group_name' => 1,
-                            'QSG_show_group_desc' => 1,
-                            'QSG_system'          => EEM_Question_Group::system_personal,
-                            'QSG_deleted'         => 0,
-                        );
-                        break;
-                    case 2:
-                        $QSG_values = array(
-                            'QSG_name'            => __('Address Information', 'event_espresso'),
-                            'QSG_identifier'      => 'address-information-' . time(),
-                            'QSG_desc'            => '',
-                            'QSG_order'           => 2,
-                            'QSG_show_group_name' => 1,
-                            'QSG_show_group_desc' => 1,
-                            'QSG_system'          => EEM_Question_Group::system_address,
-                            'QSG_deleted'         => 0,
-                        );
-                        break;
-                }
-                // make sure we have some values before inserting them
-                if (! empty($QSG_values)) {
-                    // insert system question
-                    $wpdb->insert(
-                        $table_name,
-                        $QSG_values,
-                        array('%s', '%s', '%s', '%d', '%d', '%d', '%d', '%d')
-                    );
-                    $QSG_IDs[$QSG_system] = $wpdb->insert_id;
-                }
-            }
-        }
-        // QUESTIONS
-        global $wpdb;
-        $table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question');
-        $SQL = "SELECT QST_system FROM $table_name WHERE QST_system != ''";
-        // what we have
-        $questions = $wpdb->get_col($SQL);
-        // what we should have
-        $QST_systems = array(
-            'fname',
-            'lname',
-            'email',
-            'address',
-            'address2',
-            'city',
-            'country',
-            'state',
-            'zip',
-            'phone',
-        );
-        $order_for_group_1 = 1;
-        $order_for_group_2 = 1;
-        // loop thru what we should have and compare to what we have
-        foreach ($QST_systems as $QST_system) {
-            // reset values array
-            $QST_values = array();
-            // if we don't have what we should have
-            if (! in_array($QST_system, $questions)) {
-                // add it
-                switch ($QST_system) {
-                    case 'fname':
-                        $QST_values = array(
-                            'QST_display_text'  => __('First Name', 'event_espresso'),
-                            'QST_admin_label'   => __('First Name - System Question', 'event_espresso'),
-                            'QST_system'        => 'fname',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 1,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'lname':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Last Name', 'event_espresso'),
-                            'QST_admin_label'   => __('Last Name - System Question', 'event_espresso'),
-                            'QST_system'        => 'lname',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 2,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'email':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Email Address', 'event_espresso'),
-                            'QST_admin_label'   => __('Email Address - System Question', 'event_espresso'),
-                            'QST_system'        => 'email',
-                            'QST_type'          => 'EMAIL',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 3,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'address':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Address', 'event_espresso'),
-                            'QST_admin_label'   => __('Address - System Question', 'event_espresso'),
-                            'QST_system'        => 'address',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 4,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'address2':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Address2', 'event_espresso'),
-                            'QST_admin_label'   => __('Address2 - System Question', 'event_espresso'),
-                            'QST_system'        => 'address2',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 5,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'city':
-                        $QST_values = array(
-                            'QST_display_text'  => __('City', 'event_espresso'),
-                            'QST_admin_label'   => __('City - System Question', 'event_espresso'),
-                            'QST_system'        => 'city',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 6,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'country':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Country', 'event_espresso'),
-                            'QST_admin_label'   => __('Country - System Question', 'event_espresso'),
-                            'QST_system'        => 'country',
-                            'QST_type'          => 'COUNTRY',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 7,
-                            'QST_admin_only'    => 0,
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'state':
-                        $QST_values = array(
-                            'QST_display_text'  => __('State/Province', 'event_espresso'),
-                            'QST_admin_label'   => __('State/Province - System Question', 'event_espresso'),
-                            'QST_system'        => 'state',
-                            'QST_type'          => 'STATE',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 8,
-                            'QST_admin_only'    => 0,
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'zip':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Zip/Postal Code', 'event_espresso'),
-                            'QST_admin_label'   => __('Zip/Postal Code - System Question', 'event_espresso'),
-                            'QST_system'        => 'zip',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 9,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'phone':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Phone Number', 'event_espresso'),
-                            'QST_admin_label'   => __('Phone Number - System Question', 'event_espresso'),
-                            'QST_system'        => 'phone',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 10,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                }
-                if (! empty($QST_values)) {
-                    // insert system question
-                    $wpdb->insert(
-                        $table_name,
-                        $QST_values,
-                        array('%s', '%s', '%s', '%s', '%d', '%s', '%d', '%d', '%d', '%d')
-                    );
-                    $QST_ID = $wpdb->insert_id;
-                    // QUESTION GROUP QUESTIONS
-                    if (in_array($QST_system, array('fname', 'lname', 'email'))) {
-                        $system_question_we_want = EEM_Question_Group::system_personal;
-                    } else {
-                        $system_question_we_want = EEM_Question_Group::system_address;
-                    }
-                    if (isset($QSG_IDs[$system_question_we_want])) {
-                        $QSG_ID = $QSG_IDs[$system_question_we_want];
-                    } else {
-                        $id_col = EEM_Question_Group::instance()
-                                                    ->get_col(array(array('QSG_system' => $system_question_we_want)));
-                        if (is_array($id_col)) {
-                            $QSG_ID = reset($id_col);
-                        } else {
-                            //ok so we didn't find it in the db either?? that's weird because we should have inserted it at the start of this method
-                            EE_Log::instance()->log(
-                                __FILE__,
-                                __FUNCTION__,
-                                sprintf(
-                                    __(
-                                        'Could not associate question %1$s to a question group because no system question
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * initialize_system_questions
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function initialize_system_questions()
+	{
+		// QUESTION GROUPS
+		global $wpdb;
+		$table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group');
+		$SQL = "SELECT QSG_system FROM $table_name WHERE QSG_system != 0";
+		// what we have
+		$question_groups = $wpdb->get_col($SQL);
+		// check the response
+		$question_groups = is_array($question_groups) ? $question_groups : array();
+		// what we should have
+		$QSG_systems = array(1, 2);
+		// loop thru what we should have and compare to what we have
+		foreach ($QSG_systems as $QSG_system) {
+			// reset values array
+			$QSG_values = array();
+			// if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
+			if (! in_array("$QSG_system", $question_groups)) {
+				// add it
+				switch ($QSG_system) {
+					case 1:
+						$QSG_values = array(
+							'QSG_name'            => __('Personal Information', 'event_espresso'),
+							'QSG_identifier'      => 'personal-information-' . time(),
+							'QSG_desc'            => '',
+							'QSG_order'           => 1,
+							'QSG_show_group_name' => 1,
+							'QSG_show_group_desc' => 1,
+							'QSG_system'          => EEM_Question_Group::system_personal,
+							'QSG_deleted'         => 0,
+						);
+						break;
+					case 2:
+						$QSG_values = array(
+							'QSG_name'            => __('Address Information', 'event_espresso'),
+							'QSG_identifier'      => 'address-information-' . time(),
+							'QSG_desc'            => '',
+							'QSG_order'           => 2,
+							'QSG_show_group_name' => 1,
+							'QSG_show_group_desc' => 1,
+							'QSG_system'          => EEM_Question_Group::system_address,
+							'QSG_deleted'         => 0,
+						);
+						break;
+				}
+				// make sure we have some values before inserting them
+				if (! empty($QSG_values)) {
+					// insert system question
+					$wpdb->insert(
+						$table_name,
+						$QSG_values,
+						array('%s', '%s', '%s', '%d', '%d', '%d', '%d', '%d')
+					);
+					$QSG_IDs[$QSG_system] = $wpdb->insert_id;
+				}
+			}
+		}
+		// QUESTIONS
+		global $wpdb;
+		$table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question');
+		$SQL = "SELECT QST_system FROM $table_name WHERE QST_system != ''";
+		// what we have
+		$questions = $wpdb->get_col($SQL);
+		// what we should have
+		$QST_systems = array(
+			'fname',
+			'lname',
+			'email',
+			'address',
+			'address2',
+			'city',
+			'country',
+			'state',
+			'zip',
+			'phone',
+		);
+		$order_for_group_1 = 1;
+		$order_for_group_2 = 1;
+		// loop thru what we should have and compare to what we have
+		foreach ($QST_systems as $QST_system) {
+			// reset values array
+			$QST_values = array();
+			// if we don't have what we should have
+			if (! in_array($QST_system, $questions)) {
+				// add it
+				switch ($QST_system) {
+					case 'fname':
+						$QST_values = array(
+							'QST_display_text'  => __('First Name', 'event_espresso'),
+							'QST_admin_label'   => __('First Name - System Question', 'event_espresso'),
+							'QST_system'        => 'fname',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 1,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 1,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'lname':
+						$QST_values = array(
+							'QST_display_text'  => __('Last Name', 'event_espresso'),
+							'QST_admin_label'   => __('Last Name - System Question', 'event_espresso'),
+							'QST_system'        => 'lname',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 1,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 2,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'email':
+						$QST_values = array(
+							'QST_display_text'  => __('Email Address', 'event_espresso'),
+							'QST_admin_label'   => __('Email Address - System Question', 'event_espresso'),
+							'QST_system'        => 'email',
+							'QST_type'          => 'EMAIL',
+							'QST_required'      => 1,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 3,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'address':
+						$QST_values = array(
+							'QST_display_text'  => __('Address', 'event_espresso'),
+							'QST_admin_label'   => __('Address - System Question', 'event_espresso'),
+							'QST_system'        => 'address',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 4,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'address2':
+						$QST_values = array(
+							'QST_display_text'  => __('Address2', 'event_espresso'),
+							'QST_admin_label'   => __('Address2 - System Question', 'event_espresso'),
+							'QST_system'        => 'address2',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 5,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'city':
+						$QST_values = array(
+							'QST_display_text'  => __('City', 'event_espresso'),
+							'QST_admin_label'   => __('City - System Question', 'event_espresso'),
+							'QST_system'        => 'city',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 6,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'country':
+						$QST_values = array(
+							'QST_display_text'  => __('Country', 'event_espresso'),
+							'QST_admin_label'   => __('Country - System Question', 'event_espresso'),
+							'QST_system'        => 'country',
+							'QST_type'          => 'COUNTRY',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 7,
+							'QST_admin_only'    => 0,
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'state':
+						$QST_values = array(
+							'QST_display_text'  => __('State/Province', 'event_espresso'),
+							'QST_admin_label'   => __('State/Province - System Question', 'event_espresso'),
+							'QST_system'        => 'state',
+							'QST_type'          => 'STATE',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 8,
+							'QST_admin_only'    => 0,
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'zip':
+						$QST_values = array(
+							'QST_display_text'  => __('Zip/Postal Code', 'event_espresso'),
+							'QST_admin_label'   => __('Zip/Postal Code - System Question', 'event_espresso'),
+							'QST_system'        => 'zip',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 9,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'phone':
+						$QST_values = array(
+							'QST_display_text'  => __('Phone Number', 'event_espresso'),
+							'QST_admin_label'   => __('Phone Number - System Question', 'event_espresso'),
+							'QST_system'        => 'phone',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 10,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+				}
+				if (! empty($QST_values)) {
+					// insert system question
+					$wpdb->insert(
+						$table_name,
+						$QST_values,
+						array('%s', '%s', '%s', '%s', '%d', '%s', '%d', '%d', '%d', '%d')
+					);
+					$QST_ID = $wpdb->insert_id;
+					// QUESTION GROUP QUESTIONS
+					if (in_array($QST_system, array('fname', 'lname', 'email'))) {
+						$system_question_we_want = EEM_Question_Group::system_personal;
+					} else {
+						$system_question_we_want = EEM_Question_Group::system_address;
+					}
+					if (isset($QSG_IDs[$system_question_we_want])) {
+						$QSG_ID = $QSG_IDs[$system_question_we_want];
+					} else {
+						$id_col = EEM_Question_Group::instance()
+													->get_col(array(array('QSG_system' => $system_question_we_want)));
+						if (is_array($id_col)) {
+							$QSG_ID = reset($id_col);
+						} else {
+							//ok so we didn't find it in the db either?? that's weird because we should have inserted it at the start of this method
+							EE_Log::instance()->log(
+								__FILE__,
+								__FUNCTION__,
+								sprintf(
+									__(
+										'Could not associate question %1$s to a question group because no system question
                                          group existed',
-                                        'event_espresso'
-                                    ),
-                                    $QST_ID),
-                                'error');
-                            continue;
-                        }
-                    }
-                    // add system questions to groups
-                    $wpdb->insert(
-                        \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group_question'),
-                        array(
-                            'QSG_ID'    => $QSG_ID,
-                            'QST_ID'    => $QST_ID,
-                            'QGQ_order' => ($QSG_ID === 1) ? $order_for_group_1++ : $order_for_group_2++,
-                        ),
-                        array('%d', '%d', '%d')
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Makes sure the default payment method (Invoice) is active.
-     * This used to be done automatically as part of constructing the old gateways config
-     *
-     * @throws \EE_Error
-     */
-    public static function insert_default_payment_methods()
-    {
-        if (! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
-        } else {
-            EEM_Payment_Method::instance()->verify_button_urls();
-        }
-    }
-
-    /**
-     * insert_default_status_codes
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function insert_default_status_codes()
-    {
-
-        global $wpdb;
-
-        if (\EEH_Activation::getTableAnalysis()->tableExists(EEM_Status::instance()->table())) {
-
-            $table_name = EEM_Status::instance()->table();
-
-            $SQL = "DELETE FROM $table_name WHERE STS_ID IN ( 'ACT', 'NAC', 'NOP', 'OPN', 'CLS', 'PND', 'ONG', 'SEC', 'DRF', 'DEL', 'DEN', 'EXP', 'RPP', 'RCN', 'RDC', 'RAP', 'RNA', 'RWL', 'TAB', 'TIN', 'TFL', 'TCM', 'TOP', 'PAP', 'PCN', 'PFL', 'PDC', 'EDR', 'ESN', 'PPN', 'RIC', 'MSN', 'MFL', 'MID', 'MRS', 'MIC', 'MDO', 'MEX' );";
-            $wpdb->query($SQL);
-
-            $SQL = "INSERT INTO $table_name
+										'event_espresso'
+									),
+									$QST_ID),
+								'error');
+							continue;
+						}
+					}
+					// add system questions to groups
+					$wpdb->insert(
+						\EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group_question'),
+						array(
+							'QSG_ID'    => $QSG_ID,
+							'QST_ID'    => $QST_ID,
+							'QGQ_order' => ($QSG_ID === 1) ? $order_for_group_1++ : $order_for_group_2++,
+						),
+						array('%d', '%d', '%d')
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Makes sure the default payment method (Invoice) is active.
+	 * This used to be done automatically as part of constructing the old gateways config
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function insert_default_payment_methods()
+	{
+		if (! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
+		} else {
+			EEM_Payment_Method::instance()->verify_button_urls();
+		}
+	}
+
+	/**
+	 * insert_default_status_codes
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function insert_default_status_codes()
+	{
+
+		global $wpdb;
+
+		if (\EEH_Activation::getTableAnalysis()->tableExists(EEM_Status::instance()->table())) {
+
+			$table_name = EEM_Status::instance()->table();
+
+			$SQL = "DELETE FROM $table_name WHERE STS_ID IN ( 'ACT', 'NAC', 'NOP', 'OPN', 'CLS', 'PND', 'ONG', 'SEC', 'DRF', 'DEL', 'DEN', 'EXP', 'RPP', 'RCN', 'RDC', 'RAP', 'RNA', 'RWL', 'TAB', 'TIN', 'TFL', 'TCM', 'TOP', 'PAP', 'PCN', 'PFL', 'PDC', 'EDR', 'ESN', 'PPN', 'RIC', 'MSN', 'MFL', 'MID', 'MRS', 'MIC', 'MDO', 'MEX' );";
+			$wpdb->query($SQL);
+
+			$SQL = "INSERT INTO $table_name
 					(STS_ID, STS_code, STS_type, STS_can_edit, STS_desc, STS_open) VALUES
 					('ACT', 'ACTIVE', 'event', 0, NULL, 1),
 					('NAC', 'NOT_ACTIVE', 'event', 0, NULL, 0),
@@ -1254,521 +1254,521 @@ 
 					('MID', 'IDLE', 'message', 0, NULL, 1),
 					('MRS', 'RESEND', 'message', 0, NULL, 1),
 					('MIC', 'INCOMPLETE', 'message', 0, NULL, 0);";
-            $wpdb->query($SQL);
-
-        }
-
-    }
-
-
-    /**
-     * create_upload_directories
-     * Creates folders in the uploads directory to facilitate addons and templates
-     *
-     * @access public
-     * @static
-     * @return boolean success of verifying upload directories exist
-     */
-    public static function create_upload_directories()
-    {
-        // Create the required folders
-        $folders = array(
-            EVENT_ESPRESSO_TEMPLATE_DIR,
-            EVENT_ESPRESSO_GATEWAY_DIR,
-            EVENT_ESPRESSO_UPLOAD_DIR . 'logs/',
-            EVENT_ESPRESSO_UPLOAD_DIR . 'css/',
-            EVENT_ESPRESSO_UPLOAD_DIR . 'tickets/',
-        );
-        foreach ($folders as $folder) {
-            try {
-                EEH_File::ensure_folder_exists_and_is_writable($folder);
-                @ chmod($folder, 0755);
-            } catch (EE_Error $e) {
-                EE_Error::add_error(
-                    sprintf(
-                        __('Could not create the folder at "%1$s" because: %2$s', 'event_espresso'),
-                        $folder,
-                        '<br />' . $e->getMessage()
-                    ),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                //indicate we'll need to fix this later
-                update_option(EEH_Activation::upload_directories_incomplete_option_name, true);
-                return false;
-            }
-        }
-        //just add the .htaccess file to the logs directory to begin with. Even if logging
-        //is disabled, there might be activation errors recorded in there
-        EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs/');
-        //remember EE's folders are all good
-        delete_option(EEH_Activation::upload_directories_incomplete_option_name);
-        return true;
-    }
-
-    /**
-     * Whether the upload directories need to be fixed or not.
-     * If EE is installed but filesystem access isn't initially available,
-     * we need to get the user's filesystem credentials and THEN create them,
-     * so there might be period of time when EE is installed but its
-     * upload directories aren't available. This indicates such a state
-     *
-     * @return boolean
-     */
-    public static function upload_directories_incomplete()
-    {
-        return get_option(EEH_Activation::upload_directories_incomplete_option_name, false);
-    }
-
-
-    /**
-     * generate_default_message_templates
-     *
-     * @static
-     * @throws EE_Error
-     * @return bool     true means new templates were created.
-     *                  false means no templates were created.
-     *                  This is NOT an error flag. To check for errors you will want
-     *                  to use either EE_Error or a try catch for an EE_Error exception.
-     */
-    public static function generate_default_message_templates()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        /*
+			$wpdb->query($SQL);
+
+		}
+
+	}
+
+
+	/**
+	 * create_upload_directories
+	 * Creates folders in the uploads directory to facilitate addons and templates
+	 *
+	 * @access public
+	 * @static
+	 * @return boolean success of verifying upload directories exist
+	 */
+	public static function create_upload_directories()
+	{
+		// Create the required folders
+		$folders = array(
+			EVENT_ESPRESSO_TEMPLATE_DIR,
+			EVENT_ESPRESSO_GATEWAY_DIR,
+			EVENT_ESPRESSO_UPLOAD_DIR . 'logs/',
+			EVENT_ESPRESSO_UPLOAD_DIR . 'css/',
+			EVENT_ESPRESSO_UPLOAD_DIR . 'tickets/',
+		);
+		foreach ($folders as $folder) {
+			try {
+				EEH_File::ensure_folder_exists_and_is_writable($folder);
+				@ chmod($folder, 0755);
+			} catch (EE_Error $e) {
+				EE_Error::add_error(
+					sprintf(
+						__('Could not create the folder at "%1$s" because: %2$s', 'event_espresso'),
+						$folder,
+						'<br />' . $e->getMessage()
+					),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				//indicate we'll need to fix this later
+				update_option(EEH_Activation::upload_directories_incomplete_option_name, true);
+				return false;
+			}
+		}
+		//just add the .htaccess file to the logs directory to begin with. Even if logging
+		//is disabled, there might be activation errors recorded in there
+		EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs/');
+		//remember EE's folders are all good
+		delete_option(EEH_Activation::upload_directories_incomplete_option_name);
+		return true;
+	}
+
+	/**
+	 * Whether the upload directories need to be fixed or not.
+	 * If EE is installed but filesystem access isn't initially available,
+	 * we need to get the user's filesystem credentials and THEN create them,
+	 * so there might be period of time when EE is installed but its
+	 * upload directories aren't available. This indicates such a state
+	 *
+	 * @return boolean
+	 */
+	public static function upload_directories_incomplete()
+	{
+		return get_option(EEH_Activation::upload_directories_incomplete_option_name, false);
+	}
+
+
+	/**
+	 * generate_default_message_templates
+	 *
+	 * @static
+	 * @throws EE_Error
+	 * @return bool     true means new templates were created.
+	 *                  false means no templates were created.
+	 *                  This is NOT an error flag. To check for errors you will want
+	 *                  to use either EE_Error or a try catch for an EE_Error exception.
+	 */
+	public static function generate_default_message_templates()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		/*
          * This first method is taking care of ensuring any default messengers
          * that should be made active and have templates generated are done.
          */
-        $new_templates_created_for_messenger = self::_activate_and_generate_default_messengers_and_message_templates(
-            $message_resource_manager
-        );
-        /**
-         * This method is verifying there are no NEW default message types
-         * for ACTIVE messengers that need activated (and corresponding templates setup).
-         */
-        $new_templates_created_for_message_type = self::_activate_new_message_types_for_active_messengers_and_generate_default_templates(
-            $message_resource_manager
-        );
-        //after all is done, let's persist these changes to the db.
-        $message_resource_manager->update_has_activated_messengers_option();
-        $message_resource_manager->update_active_messengers_option();
-        // will return true if either of these are true.  Otherwise will return false.
-        return $new_templates_created_for_message_type || $new_templates_created_for_messenger;
-    }
-
-
-
-    /**
-     * @param \EE_Message_Resource_Manager $message_resource_manager
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    protected static function _activate_new_message_types_for_active_messengers_and_generate_default_templates(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        /** @type EE_messenger[] $active_messengers */
-        $active_messengers = $message_resource_manager->active_messengers();
-        $installed_message_types = $message_resource_manager->installed_message_types();
-        $templates_created = false;
-        foreach ($active_messengers as $active_messenger) {
-            $default_message_type_names_for_messenger = $active_messenger->get_default_message_types();
-            $default_message_type_names_to_activate = array();
-            // looping through each default message type reported by the messenger
-            // and setup the actual message types to activate.
-            foreach ($default_message_type_names_for_messenger as $default_message_type_name_for_messenger) {
-                // if already active or has already been activated before we skip
-                // (otherwise we might reactivate something user's intentionally deactivated.)
-                // we also skip if the message type is not installed.
-                if (
-                    $message_resource_manager->has_message_type_been_activated_for_messenger(
-                        $default_message_type_name_for_messenger,
-                        $active_messenger->name
-                    )
-                    || $message_resource_manager->is_message_type_active_for_messenger(
-                        $active_messenger->name,
-                        $default_message_type_name_for_messenger
-                    )
-                    || ! isset($installed_message_types[$default_message_type_name_for_messenger])
-                ) {
-                    continue;
-                }
-                $default_message_type_names_to_activate[] = $default_message_type_name_for_messenger;
-            }
-            //let's activate!
-            $message_resource_manager->ensure_message_types_are_active(
-                $default_message_type_names_to_activate,
-                $active_messenger->name,
-                false
-            );
-            //activate the templates for these message types
-            if ( ! empty($default_message_type_names_to_activate)) {
-                $templates_created = EEH_MSG_Template::generate_new_templates(
-                    $active_messenger->name,
-                    $default_message_type_names_for_messenger,
-                    '',
-                    true
-                );
-            }
-        }
-        return $templates_created;
-    }
-
-
-
-    /**
-     * This will activate and generate default messengers and default message types for those messengers.
-     *
-     * @param EE_message_Resource_Manager $message_resource_manager
-     * @return array|bool  True means there were default messengers and message type templates generated.
-     *                     False means that there were no templates generated
-     *                     (which could simply mean there are no default message types for a messenger).
-     * @throws EE_Error
-     */
-    protected static function _activate_and_generate_default_messengers_and_message_templates(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        /** @type EE_messenger[] $messengers_to_generate */
-        $messengers_to_generate = self::_get_default_messengers_to_generate_on_activation($message_resource_manager);
-        $installed_message_types = $message_resource_manager->installed_message_types();
-        $templates_generated = false;
-        foreach ($messengers_to_generate as $messenger_to_generate) {
-            $default_message_type_names_for_messenger = $messenger_to_generate->get_default_message_types();
-            //verify the default message types match an installed message type.
-            foreach ($default_message_type_names_for_messenger as $key => $name) {
-                if (
-                    ! isset($installed_message_types[$name])
-                    || $message_resource_manager->has_message_type_been_activated_for_messenger(
-                        $name,
-                        $messenger_to_generate->name
-                    )
-                ) {
-                    unset($default_message_type_names_for_messenger[$key]);
-                }
-            }
-            // in previous iterations, the active_messengers option in the db
-            // needed updated before calling create templates. however with the changes this may not be necessary.
-            // This comment is left here just in case we discover that we _do_ need to update before
-            // passing off to create templates (after the refactor is done).
-            // @todo remove this comment when determined not necessary.
-            $message_resource_manager->activate_messenger(
-                $messenger_to_generate->name,
-                $default_message_type_names_for_messenger,
-                false
-            );
-            //create any templates needing created (or will reactivate templates already generated as necessary).
-            if ( ! empty($default_message_type_names_for_messenger)) {
-                $templates_generated = EEH_MSG_Template::generate_new_templates(
-                    $messenger_to_generate->name,
-                    $default_message_type_names_for_messenger,
-                    '',
-                    true
-                );
-            }
-        }
-        return $templates_generated;
-    }
-
-
-    /**
-     * This returns the default messengers to generate templates for on activation of EE.
-     * It considers:
-     * - whether a messenger is already active in the db.
-     * - whether a messenger has been made active at any time in the past.
-     *
-     * @static
-     * @param  EE_Message_Resource_Manager $message_resource_manager
-     * @return EE_messenger[]
-     */
-    protected static function _get_default_messengers_to_generate_on_activation(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        $active_messengers    = $message_resource_manager->active_messengers();
-        $installed_messengers = $message_resource_manager->installed_messengers();
-        $has_activated        = $message_resource_manager->get_has_activated_messengers_option();
-
-        $messengers_to_generate = array();
-        foreach ($installed_messengers as $installed_messenger) {
-            //if installed messenger is a messenger that should be activated on install
-            //and is not already active
-            //and has never been activated
-            if (
-                ! $installed_messenger->activate_on_install
-                || isset($active_messengers[$installed_messenger->name])
-                || isset($has_activated[$installed_messenger->name])
-            ) {
-                continue;
-            }
-            $messengers_to_generate[$installed_messenger->name] = $installed_messenger;
-        }
-        return $messengers_to_generate;
-    }
-
-
-    /**
-     * This simply validates active message types to ensure they actually match installed
-     * message types.  If there's a mismatch then we deactivate the message type and ensure all related db
-     * rows are set inactive.
-     * Note: Messengers are no longer validated here as of 4.9.0 because they get validated automatically whenever
-     * EE_Messenger_Resource_Manager is constructed.  Message Types are a bit more resource heavy for validation so they
-     * are still handled in here.
-     *
-     * @since 4.3.1
-     * @return void
-     */
-    public static function validate_messages_system()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $message_resource_manager->validate_active_message_types_are_installed();
-        do_action('AHEE__EEH_Activation__validate_messages_system');
-    }
-
-
-    /**
-     * create_no_ticket_prices_array
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function create_no_ticket_prices_array()
-    {
-        // this creates an array for tracking events that have no active ticket prices created
-        // this allows us to warn admins of the situation so that it can be corrected
-        $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', false);
-        if (! $espresso_no_ticket_prices) {
-            add_option('ee_no_ticket_prices', array(), '', false);
-        }
-    }
-
-
-    /**
-     * plugin_deactivation
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function plugin_deactivation()
-    {
-    }
-
-
-    /**
-     * Finds all our EE4 custom post types, and deletes them and their associated data
-     * (like post meta or term relations)
-     *
-     * @global wpdb $wpdb
-     * @throws \EE_Error
-     */
-    public static function delete_all_espresso_cpt_data()
-    {
-        global $wpdb;
-        //get all the CPT post_types
-        $ee_post_types = array();
-        foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
-            if (method_exists($model_name, 'instance')) {
-                $model_obj = call_user_func(array($model_name, 'instance'));
-                if ($model_obj instanceof EEM_CPT_Base) {
-                    $ee_post_types[] = $wpdb->prepare("%s", $model_obj->post_type());
-                }
-            }
-        }
-        //get all our CPTs
-        $query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (" . implode(",", $ee_post_types) . ")";
-        $cpt_ids = $wpdb->get_col($query);
-        //delete each post meta and term relations too
-        foreach ($cpt_ids as $post_id) {
-            wp_delete_post($post_id, true);
-        }
-    }
-
-    /**
-     * Deletes all EE custom tables
-     *
-     * @return array
-     */
-    public static function drop_espresso_tables()
-    {
-        $tables = array();
-        // load registry
-        foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
-            if (method_exists($model_name, 'instance')) {
-                $model_obj = call_user_func(array($model_name, 'instance'));
-                if ($model_obj instanceof EEM_Base) {
-                    foreach ($model_obj->get_tables() as $table) {
-                        if (strpos($table->get_table_name(), 'esp_')
-                            &&
-                            (
-                                is_main_site()//main site? nuke them all
-                                || ! $table->is_global()//not main site,but not global either. nuke it
-                            )
-                        ) {
-                            $tables[] = $table->get_table_name();
-                        }
-                    }
-                }
-            }
-        }
-
-        //there are some tables whose models were removed.
-        //they should be removed when removing all EE core's data
-        $tables_without_models = array(
-            'esp_promotion',
-            'esp_promotion_applied',
-            'esp_promotion_object',
-            'esp_promotion_rule',
-            'esp_rule',
-        );
-        foreach ($tables_without_models as $table) {
-            $tables[] = $table;
-        }
-        return \EEH_Activation::getTableManager()->dropTables($tables);
-    }
-
-
-
-    /**
-     * Drops all the tables mentioned in a single MYSQL query. Double-checks
-     * each table name provided has a wpdb prefix attached, and that it exists.
-     * Returns the list actually deleted
-     *
-     * @deprecated in 4.9.13. Instead use TableManager::dropTables()
-     * @global WPDB $wpdb
-     * @param array $table_names
-     * @return array of table names which we deleted
-     */
-    public static function drop_tables($table_names)
-    {
-        return \EEH_Activation::getTableManager()->dropTables($table_names);
-    }
-
-
-
-    /**
-     * plugin_uninstall
-     *
-     * @access public
-     * @static
-     * @param bool $remove_all
-     * @return void
-     */
-    public static function delete_all_espresso_tables_and_data($remove_all = true)
-    {
-        global $wpdb;
-        self::drop_espresso_tables();
-        $wp_options_to_delete = array(
-            'ee_no_ticket_prices'                => true,
-            'ee_active_messengers'               => true,
-            'ee_has_activated_messenger'         => true,
-            'ee_flush_rewrite_rules'             => true,
-            'ee_config'                          => false,
-            'ee_data_migration_current_db_state' => true,
-            'ee_data_migration_mapping_'         => false,
-            'ee_data_migration_script_'          => false,
-            'ee_data_migrations'                 => true,
-            'ee_dms_map'                         => false,
-            'ee_notices'                         => true,
-            'lang_file_check_'                   => false,
-            'ee_maintenance_mode'                => true,
-            'ee_ueip_optin'                      => true,
-            'ee_ueip_has_notified'               => true,
-            'ee_plugin_activation_errors'        => true,
-            'ee_id_mapping_from'                 => false,
-            'espresso_persistent_admin_notices'  => true,
-            'ee_encryption_key'                  => true,
-            'pue_force_upgrade_'                 => false,
-            'pue_json_error_'                    => false,
-            'pue_install_key_'                   => false,
-            'pue_verification_error_'            => false,
-            'pu_dismissed_upgrade_'              => false,
-            'external_updates-'                  => false,
-            'ee_extra_data'                      => true,
-            'ee_ssn_'                            => false,
-            'ee_rss_'                            => false,
-            'ee_rte_n_tx_'                       => false,
-            'ee_pers_admin_notices'              => true,
-            'ee_job_parameters_'                 => false,
-            'ee_upload_directories_incomplete'   => true,
-            'ee_verified_db_collations'          => true,
-        );
-        if (is_main_site()) {
-            $wp_options_to_delete['ee_network_config'] = true;
-        }
-        $undeleted_options = array();
-        foreach ($wp_options_to_delete as $option_name => $no_wildcard) {
-            if ($no_wildcard) {
-                if ( ! delete_option($option_name)) {
-                    $undeleted_options[] = $option_name;
-                }
-            } else {
-                $option_names_to_delete_from_wildcard = $wpdb->get_col("SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%$option_name%'");
-                foreach ($option_names_to_delete_from_wildcard as $option_name_from_wildcard) {
-                    if ( ! delete_option($option_name_from_wildcard)) {
-                        $undeleted_options[] = $option_name_from_wildcard;
-                    }
-                }
-            }
-        }
-        //also, let's make sure the "ee_config_option_names" wp option stays out by removing the action that adds it
-        remove_action('shutdown', array(EE_Config::instance(), 'shutdown'), 10);
-        if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
-            $db_update_sans_ee4 = array();
-            foreach ($espresso_db_update as $version => $times_activated) {
-                if ((string)$version[0] === '3') {//if its NON EE4
-                    $db_update_sans_ee4[$version] = $times_activated;
-                }
-            }
-            update_option('espresso_db_update', $db_update_sans_ee4);
-        }
-        $errors = '';
-        if ( ! empty($undeleted_options)) {
-            $errors .= sprintf(
-                __('The following wp-options could not be deleted: %s%s', 'event_espresso'),
-                '<br/>',
-                implode(',<br/>', $undeleted_options)
-            );
-        }
-        if ( ! empty($errors)) {
-            EE_Error::add_attention($errors, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-    /**
-     * Gets the mysql error code from the last used query by wpdb
-     *
-     * @return int mysql error code, see https://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html
-     */
-    public static function last_wpdb_error_code()
-    {
-        global $wpdb;
-        if ($wpdb->use_mysqli) {
-            return mysqli_errno($wpdb->dbh);
-        } else {
-            return mysql_errno($wpdb->dbh);
-        }
-    }
-
-    /**
-     * Checks that the database table exists. Also works on temporary tables (for unit tests mostly).
-     *
-     * @global wpdb  $wpdb
-     * @deprecated instead use TableAnalysis::tableExists()
-     * @param string $table_name with or without $wpdb->prefix
-     * @return boolean
-     */
-    public static function table_exists($table_name)
-    {
-        return \EEH_Activation::getTableAnalysis()->tableExists($table_name);
-    }
-
-    /**
-     * Resets the cache on EEH_Activation
-     */
-    public static function reset()
-    {
-        self::$_default_creator_id                             = null;
-        self::$_initialized_db_content_already_in_this_request = false;
-    }
+		$new_templates_created_for_messenger = self::_activate_and_generate_default_messengers_and_message_templates(
+			$message_resource_manager
+		);
+		/**
+		 * This method is verifying there are no NEW default message types
+		 * for ACTIVE messengers that need activated (and corresponding templates setup).
+		 */
+		$new_templates_created_for_message_type = self::_activate_new_message_types_for_active_messengers_and_generate_default_templates(
+			$message_resource_manager
+		);
+		//after all is done, let's persist these changes to the db.
+		$message_resource_manager->update_has_activated_messengers_option();
+		$message_resource_manager->update_active_messengers_option();
+		// will return true if either of these are true.  Otherwise will return false.
+		return $new_templates_created_for_message_type || $new_templates_created_for_messenger;
+	}
+
+
+
+	/**
+	 * @param \EE_Message_Resource_Manager $message_resource_manager
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	protected static function _activate_new_message_types_for_active_messengers_and_generate_default_templates(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		/** @type EE_messenger[] $active_messengers */
+		$active_messengers = $message_resource_manager->active_messengers();
+		$installed_message_types = $message_resource_manager->installed_message_types();
+		$templates_created = false;
+		foreach ($active_messengers as $active_messenger) {
+			$default_message_type_names_for_messenger = $active_messenger->get_default_message_types();
+			$default_message_type_names_to_activate = array();
+			// looping through each default message type reported by the messenger
+			// and setup the actual message types to activate.
+			foreach ($default_message_type_names_for_messenger as $default_message_type_name_for_messenger) {
+				// if already active or has already been activated before we skip
+				// (otherwise we might reactivate something user's intentionally deactivated.)
+				// we also skip if the message type is not installed.
+				if (
+					$message_resource_manager->has_message_type_been_activated_for_messenger(
+						$default_message_type_name_for_messenger,
+						$active_messenger->name
+					)
+					|| $message_resource_manager->is_message_type_active_for_messenger(
+						$active_messenger->name,
+						$default_message_type_name_for_messenger
+					)
+					|| ! isset($installed_message_types[$default_message_type_name_for_messenger])
+				) {
+					continue;
+				}
+				$default_message_type_names_to_activate[] = $default_message_type_name_for_messenger;
+			}
+			//let's activate!
+			$message_resource_manager->ensure_message_types_are_active(
+				$default_message_type_names_to_activate,
+				$active_messenger->name,
+				false
+			);
+			//activate the templates for these message types
+			if ( ! empty($default_message_type_names_to_activate)) {
+				$templates_created = EEH_MSG_Template::generate_new_templates(
+					$active_messenger->name,
+					$default_message_type_names_for_messenger,
+					'',
+					true
+				);
+			}
+		}
+		return $templates_created;
+	}
+
+
+
+	/**
+	 * This will activate and generate default messengers and default message types for those messengers.
+	 *
+	 * @param EE_message_Resource_Manager $message_resource_manager
+	 * @return array|bool  True means there were default messengers and message type templates generated.
+	 *                     False means that there were no templates generated
+	 *                     (which could simply mean there are no default message types for a messenger).
+	 * @throws EE_Error
+	 */
+	protected static function _activate_and_generate_default_messengers_and_message_templates(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		/** @type EE_messenger[] $messengers_to_generate */
+		$messengers_to_generate = self::_get_default_messengers_to_generate_on_activation($message_resource_manager);
+		$installed_message_types = $message_resource_manager->installed_message_types();
+		$templates_generated = false;
+		foreach ($messengers_to_generate as $messenger_to_generate) {
+			$default_message_type_names_for_messenger = $messenger_to_generate->get_default_message_types();
+			//verify the default message types match an installed message type.
+			foreach ($default_message_type_names_for_messenger as $key => $name) {
+				if (
+					! isset($installed_message_types[$name])
+					|| $message_resource_manager->has_message_type_been_activated_for_messenger(
+						$name,
+						$messenger_to_generate->name
+					)
+				) {
+					unset($default_message_type_names_for_messenger[$key]);
+				}
+			}
+			// in previous iterations, the active_messengers option in the db
+			// needed updated before calling create templates. however with the changes this may not be necessary.
+			// This comment is left here just in case we discover that we _do_ need to update before
+			// passing off to create templates (after the refactor is done).
+			// @todo remove this comment when determined not necessary.
+			$message_resource_manager->activate_messenger(
+				$messenger_to_generate->name,
+				$default_message_type_names_for_messenger,
+				false
+			);
+			//create any templates needing created (or will reactivate templates already generated as necessary).
+			if ( ! empty($default_message_type_names_for_messenger)) {
+				$templates_generated = EEH_MSG_Template::generate_new_templates(
+					$messenger_to_generate->name,
+					$default_message_type_names_for_messenger,
+					'',
+					true
+				);
+			}
+		}
+		return $templates_generated;
+	}
+
+
+	/**
+	 * This returns the default messengers to generate templates for on activation of EE.
+	 * It considers:
+	 * - whether a messenger is already active in the db.
+	 * - whether a messenger has been made active at any time in the past.
+	 *
+	 * @static
+	 * @param  EE_Message_Resource_Manager $message_resource_manager
+	 * @return EE_messenger[]
+	 */
+	protected static function _get_default_messengers_to_generate_on_activation(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		$active_messengers    = $message_resource_manager->active_messengers();
+		$installed_messengers = $message_resource_manager->installed_messengers();
+		$has_activated        = $message_resource_manager->get_has_activated_messengers_option();
+
+		$messengers_to_generate = array();
+		foreach ($installed_messengers as $installed_messenger) {
+			//if installed messenger is a messenger that should be activated on install
+			//and is not already active
+			//and has never been activated
+			if (
+				! $installed_messenger->activate_on_install
+				|| isset($active_messengers[$installed_messenger->name])
+				|| isset($has_activated[$installed_messenger->name])
+			) {
+				continue;
+			}
+			$messengers_to_generate[$installed_messenger->name] = $installed_messenger;
+		}
+		return $messengers_to_generate;
+	}
+
+
+	/**
+	 * This simply validates active message types to ensure they actually match installed
+	 * message types.  If there's a mismatch then we deactivate the message type and ensure all related db
+	 * rows are set inactive.
+	 * Note: Messengers are no longer validated here as of 4.9.0 because they get validated automatically whenever
+	 * EE_Messenger_Resource_Manager is constructed.  Message Types are a bit more resource heavy for validation so they
+	 * are still handled in here.
+	 *
+	 * @since 4.3.1
+	 * @return void
+	 */
+	public static function validate_messages_system()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$message_resource_manager->validate_active_message_types_are_installed();
+		do_action('AHEE__EEH_Activation__validate_messages_system');
+	}
+
+
+	/**
+	 * create_no_ticket_prices_array
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function create_no_ticket_prices_array()
+	{
+		// this creates an array for tracking events that have no active ticket prices created
+		// this allows us to warn admins of the situation so that it can be corrected
+		$espresso_no_ticket_prices = get_option('ee_no_ticket_prices', false);
+		if (! $espresso_no_ticket_prices) {
+			add_option('ee_no_ticket_prices', array(), '', false);
+		}
+	}
+
+
+	/**
+	 * plugin_deactivation
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function plugin_deactivation()
+	{
+	}
+
+
+	/**
+	 * Finds all our EE4 custom post types, and deletes them and their associated data
+	 * (like post meta or term relations)
+	 *
+	 * @global wpdb $wpdb
+	 * @throws \EE_Error
+	 */
+	public static function delete_all_espresso_cpt_data()
+	{
+		global $wpdb;
+		//get all the CPT post_types
+		$ee_post_types = array();
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
+			if (method_exists($model_name, 'instance')) {
+				$model_obj = call_user_func(array($model_name, 'instance'));
+				if ($model_obj instanceof EEM_CPT_Base) {
+					$ee_post_types[] = $wpdb->prepare("%s", $model_obj->post_type());
+				}
+			}
+		}
+		//get all our CPTs
+		$query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (" . implode(",", $ee_post_types) . ")";
+		$cpt_ids = $wpdb->get_col($query);
+		//delete each post meta and term relations too
+		foreach ($cpt_ids as $post_id) {
+			wp_delete_post($post_id, true);
+		}
+	}
+
+	/**
+	 * Deletes all EE custom tables
+	 *
+	 * @return array
+	 */
+	public static function drop_espresso_tables()
+	{
+		$tables = array();
+		// load registry
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
+			if (method_exists($model_name, 'instance')) {
+				$model_obj = call_user_func(array($model_name, 'instance'));
+				if ($model_obj instanceof EEM_Base) {
+					foreach ($model_obj->get_tables() as $table) {
+						if (strpos($table->get_table_name(), 'esp_')
+							&&
+							(
+								is_main_site()//main site? nuke them all
+								|| ! $table->is_global()//not main site,but not global either. nuke it
+							)
+						) {
+							$tables[] = $table->get_table_name();
+						}
+					}
+				}
+			}
+		}
+
+		//there are some tables whose models were removed.
+		//they should be removed when removing all EE core's data
+		$tables_without_models = array(
+			'esp_promotion',
+			'esp_promotion_applied',
+			'esp_promotion_object',
+			'esp_promotion_rule',
+			'esp_rule',
+		);
+		foreach ($tables_without_models as $table) {
+			$tables[] = $table;
+		}
+		return \EEH_Activation::getTableManager()->dropTables($tables);
+	}
+
+
+
+	/**
+	 * Drops all the tables mentioned in a single MYSQL query. Double-checks
+	 * each table name provided has a wpdb prefix attached, and that it exists.
+	 * Returns the list actually deleted
+	 *
+	 * @deprecated in 4.9.13. Instead use TableManager::dropTables()
+	 * @global WPDB $wpdb
+	 * @param array $table_names
+	 * @return array of table names which we deleted
+	 */
+	public static function drop_tables($table_names)
+	{
+		return \EEH_Activation::getTableManager()->dropTables($table_names);
+	}
+
+
+
+	/**
+	 * plugin_uninstall
+	 *
+	 * @access public
+	 * @static
+	 * @param bool $remove_all
+	 * @return void
+	 */
+	public static function delete_all_espresso_tables_and_data($remove_all = true)
+	{
+		global $wpdb;
+		self::drop_espresso_tables();
+		$wp_options_to_delete = array(
+			'ee_no_ticket_prices'                => true,
+			'ee_active_messengers'               => true,
+			'ee_has_activated_messenger'         => true,
+			'ee_flush_rewrite_rules'             => true,
+			'ee_config'                          => false,
+			'ee_data_migration_current_db_state' => true,
+			'ee_data_migration_mapping_'         => false,
+			'ee_data_migration_script_'          => false,
+			'ee_data_migrations'                 => true,
+			'ee_dms_map'                         => false,
+			'ee_notices'                         => true,
+			'lang_file_check_'                   => false,
+			'ee_maintenance_mode'                => true,
+			'ee_ueip_optin'                      => true,
+			'ee_ueip_has_notified'               => true,
+			'ee_plugin_activation_errors'        => true,
+			'ee_id_mapping_from'                 => false,
+			'espresso_persistent_admin_notices'  => true,
+			'ee_encryption_key'                  => true,
+			'pue_force_upgrade_'                 => false,
+			'pue_json_error_'                    => false,
+			'pue_install_key_'                   => false,
+			'pue_verification_error_'            => false,
+			'pu_dismissed_upgrade_'              => false,
+			'external_updates-'                  => false,
+			'ee_extra_data'                      => true,
+			'ee_ssn_'                            => false,
+			'ee_rss_'                            => false,
+			'ee_rte_n_tx_'                       => false,
+			'ee_pers_admin_notices'              => true,
+			'ee_job_parameters_'                 => false,
+			'ee_upload_directories_incomplete'   => true,
+			'ee_verified_db_collations'          => true,
+		);
+		if (is_main_site()) {
+			$wp_options_to_delete['ee_network_config'] = true;
+		}
+		$undeleted_options = array();
+		foreach ($wp_options_to_delete as $option_name => $no_wildcard) {
+			if ($no_wildcard) {
+				if ( ! delete_option($option_name)) {
+					$undeleted_options[] = $option_name;
+				}
+			} else {
+				$option_names_to_delete_from_wildcard = $wpdb->get_col("SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%$option_name%'");
+				foreach ($option_names_to_delete_from_wildcard as $option_name_from_wildcard) {
+					if ( ! delete_option($option_name_from_wildcard)) {
+						$undeleted_options[] = $option_name_from_wildcard;
+					}
+				}
+			}
+		}
+		//also, let's make sure the "ee_config_option_names" wp option stays out by removing the action that adds it
+		remove_action('shutdown', array(EE_Config::instance(), 'shutdown'), 10);
+		if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
+			$db_update_sans_ee4 = array();
+			foreach ($espresso_db_update as $version => $times_activated) {
+				if ((string)$version[0] === '3') {//if its NON EE4
+					$db_update_sans_ee4[$version] = $times_activated;
+				}
+			}
+			update_option('espresso_db_update', $db_update_sans_ee4);
+		}
+		$errors = '';
+		if ( ! empty($undeleted_options)) {
+			$errors .= sprintf(
+				__('The following wp-options could not be deleted: %s%s', 'event_espresso'),
+				'<br/>',
+				implode(',<br/>', $undeleted_options)
+			);
+		}
+		if ( ! empty($errors)) {
+			EE_Error::add_attention($errors, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+	/**
+	 * Gets the mysql error code from the last used query by wpdb
+	 *
+	 * @return int mysql error code, see https://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html
+	 */
+	public static function last_wpdb_error_code()
+	{
+		global $wpdb;
+		if ($wpdb->use_mysqli) {
+			return mysqli_errno($wpdb->dbh);
+		} else {
+			return mysql_errno($wpdb->dbh);
+		}
+	}
+
+	/**
+	 * Checks that the database table exists. Also works on temporary tables (for unit tests mostly).
+	 *
+	 * @global wpdb  $wpdb
+	 * @deprecated instead use TableAnalysis::tableExists()
+	 * @param string $table_name with or without $wpdb->prefix
+	 * @return boolean
+	 */
+	public static function table_exists($table_name)
+	{
+		return \EEH_Activation::getTableAnalysis()->tableExists($table_name);
+	}
+
+	/**
+	 * Resets the cache on EEH_Activation
+	 */
+	public static function reset()
+	{
+		self::$_default_creator_id                             = null;
+		self::$_initialized_db_content_already_in_this_request = false;
+	}
 }
 // End of file EEH_Activation.helper.php
 // Location: /helpers/EEH_Activation.core.php

Spacing +32 added lines, -32 removed lines

@@ -61,7 +61,7 @@ 
      */
     public static function getTableAnalysis()
     {
-        if (! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
+        if ( ! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
             self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
         }
         return self::$table_analysis;
@@ -73,7 +73,7 @@ 
      */
     public static function getTableManager()
     {
-        if (! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
+        if ( ! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
             self::$table_manager = EE_Registry::instance()->create('TableManager', array(), true);
         }
         return self::$table_manager;
@@ -189,7 +189,7 @@ 
         if ($which_to_include === 'old') {
             $cron_tasks = array_filter(
                 $cron_tasks,
-                function ($value) {
+                function($value) {
                     return $value === EEH_Activation::cron_task_no_longer_in_use;
                 }
             );
@@ -219,7 +219,7 @@ 
     {
 
         foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
-            if (! wp_next_scheduled($hook_name)) {
+            if ( ! wp_next_scheduled($hook_name)) {
                 wp_schedule_event(time(), $frequency, $hook_name);
             }
         }
@@ -312,7 +312,7 @@ 
             3
         );
         //EE_Config::reset();
-        if (! EE_Config::logging_enabled()) {
+        if ( ! EE_Config::logging_enabled()) {
             delete_option(EE_Config::LOG_NAME);
         }
     }
@@ -327,7 +327,7 @@ 
     public static function load_calendar_config()
     {
         // grab array of all plugin folders and loop thru it
-        $plugins = glob(WP_PLUGIN_DIR . DS . '*', GLOB_ONLYDIR);
+        $plugins = glob(WP_PLUGIN_DIR.DS.'*', GLOB_ONLYDIR);
         if (empty($plugins)) {
             return;
         }
@@ -344,7 +344,7 @@ 
                 || strpos($plugin, 'calendar') !== false
             ) {
                 // this is what we are looking for
-                $calendar_config = $plugin_path . DS . 'EE_Calendar_Config.php';
+                $calendar_config = $plugin_path.DS.'EE_Calendar_Config.php';
                 // does it exist in this folder ?
                 if (is_readable($calendar_config)) {
                     // YEAH! let's load it
@@ -477,7 +477,7 @@ 
             ) {
                 //update Config with post ID
                 $EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
-                if (! EE_Config::instance()->update_espresso_config(false, false)) {
+                if ( ! EE_Config::instance()->update_espresso_config(false, false)) {
                     $msg = __(
                         'The Event Espresso critical page configuration settings could not be updated.',
                         'event_espresso'
@@ -526,7 +526,7 @@ 
     public static function get_page_by_ee_shortcode($ee_shortcode)
     {
         global $wpdb;
-        $shortcode_and_opening_bracket = '[' . $ee_shortcode;
+        $shortcode_and_opening_bracket = '['.$ee_shortcode;
         $post_id = $wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
         if ($post_id) {
             return get_post($post_id);
@@ -552,11 +552,11 @@ 
             'post_status'    => 'publish',
             'post_type'      => 'page',
             'comment_status' => 'closed',
-            'post_content'   => '[' . $critical_page['code'] . ']',
+            'post_content'   => '['.$critical_page['code'].']',
         );
 
         $post_id = wp_insert_post($post_args);
-        if (! $post_id) {
+        if ( ! $post_id) {
             $msg = sprintf(
                 __('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
                 $critical_page['name']
@@ -565,7 +565,7 @@ 
             return $critical_page;
         }
         // get newly created post's details
-        if (! $critical_page['post'] = get_post($post_id)) {
+        if ( ! $critical_page['post'] = get_post($post_id)) {
             $msg = sprintf(
                 __('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
                 $critical_page['name']
@@ -652,17 +652,17 @@ 
             $role_to_check
         );
         if ($pre_filtered_id !== false) {
-            return (int)$pre_filtered_id;
+            return (int) $pre_filtered_id;
         }
         $capabilities_key = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
         $query = $wpdb->prepare(
             "SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
-            '%' . $role_to_check . '%'
+            '%'.$role_to_check.'%'
         );
         $user_id = $wpdb->get_var($query);
         $user_id = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
-        if ($user_id && (int)$user_id) {
-            self::$_default_creator_id = (int)$user_id;
+        if ($user_id && (int) $user_id) {
+            self::$_default_creator_id = (int) $user_id;
             return self::$_default_creator_id;
         } else {
             return null;
@@ -697,7 +697,7 @@ 
         }
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
         if ( ! function_exists('dbDelta')) {
-            require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
+            require_once(ABSPATH.'wp-admin/includes/upgrade.php');
         }
         $tableAnalysis = \EEH_Activation::getTableAnalysis();
         $wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
@@ -908,13 +908,13 @@ 
             // reset values array
             $QSG_values = array();
             // if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
-            if (! in_array("$QSG_system", $question_groups)) {
+            if ( ! in_array("$QSG_system", $question_groups)) {
                 // add it
                 switch ($QSG_system) {
                     case 1:
                         $QSG_values = array(
                             'QSG_name'            => __('Personal Information', 'event_espresso'),
-                            'QSG_identifier'      => 'personal-information-' . time(),
+                            'QSG_identifier'      => 'personal-information-'.time(),
                             'QSG_desc'            => '',
                             'QSG_order'           => 1,
                             'QSG_show_group_name' => 1,
@@ -926,7 +926,7 @@ 
                     case 2:
                         $QSG_values = array(
                             'QSG_name'            => __('Address Information', 'event_espresso'),
-                            'QSG_identifier'      => 'address-information-' . time(),
+                            'QSG_identifier'      => 'address-information-'.time(),
                             'QSG_desc'            => '',
                             'QSG_order'           => 2,
                             'QSG_show_group_name' => 1,
@@ -937,7 +937,7 @@ 
                         break;
                 }
                 // make sure we have some values before inserting them
-                if (! empty($QSG_values)) {
+                if ( ! empty($QSG_values)) {
                     // insert system question
                     $wpdb->insert(
                         $table_name,
@@ -974,7 +974,7 @@ 
             // reset values array
             $QST_values = array();
             // if we don't have what we should have
-            if (! in_array($QST_system, $questions)) {
+            if ( ! in_array($QST_system, $questions)) {
                 // add it
                 switch ($QST_system) {
                     case 'fname':
@@ -1126,7 +1126,7 @@ 
                         );
                         break;
                 }
-                if (! empty($QST_values)) {
+                if ( ! empty($QST_values)) {
                     // insert system question
                     $wpdb->insert(
                         $table_name,
@@ -1187,7 +1187,7 @@ 
      */
     public static function insert_default_payment_methods()
     {
-        if (! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
+        if ( ! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
             EE_Registry::instance()->load_lib('Payment_Method_Manager');
             EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
         } else {
@@ -1275,9 +1275,9 @@ 
         $folders = array(
             EVENT_ESPRESSO_TEMPLATE_DIR,
             EVENT_ESPRESSO_GATEWAY_DIR,
-            EVENT_ESPRESSO_UPLOAD_DIR . 'logs/',
-            EVENT_ESPRESSO_UPLOAD_DIR . 'css/',
-            EVENT_ESPRESSO_UPLOAD_DIR . 'tickets/',
+            EVENT_ESPRESSO_UPLOAD_DIR.'logs/',
+            EVENT_ESPRESSO_UPLOAD_DIR.'css/',
+            EVENT_ESPRESSO_UPLOAD_DIR.'tickets/',
         );
         foreach ($folders as $folder) {
             try {
@@ -1288,7 +1288,7 @@ 
                     sprintf(
                         __('Could not create the folder at "%1$s" because: %2$s', 'event_espresso'),
                         $folder,
-                        '<br />' . $e->getMessage()
+                        '<br />'.$e->getMessage()
                     ),
                     __FILE__, __FUNCTION__, __LINE__
                 );
@@ -1299,7 +1299,7 @@ 
         }
         //just add the .htaccess file to the logs directory to begin with. Even if logging
         //is disabled, there might be activation errors recorded in there
-        EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs/');
+        EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR.'logs/');
         //remember EE's folders are all good
         delete_option(EEH_Activation::upload_directories_incomplete_option_name);
         return true;
@@ -1535,7 +1535,7 @@ 
         // this creates an array for tracking events that have no active ticket prices created
         // this allows us to warn admins of the situation so that it can be corrected
         $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', false);
-        if (! $espresso_no_ticket_prices) {
+        if ( ! $espresso_no_ticket_prices) {
             add_option('ee_no_ticket_prices', array(), '', false);
         }
     }
@@ -1574,7 +1574,7 @@ 
             }
         }
         //get all our CPTs
-        $query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (" . implode(",", $ee_post_types) . ")";
+        $query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (".implode(",", $ee_post_types).")";
         $cpt_ids = $wpdb->get_col($query);
         //delete each post meta and term relations too
         foreach ($cpt_ids as $post_id) {
@@ -1714,7 +1714,7 @@ 
         if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
             $db_update_sans_ee4 = array();
             foreach ($espresso_db_update as $version => $times_activated) {
-                if ((string)$version[0] === '3') {//if its NON EE4
+                if ((string) $version[0] === '3') {//if its NON EE4
                     $db_update_sans_ee4[$version] = $times_activated;
                 }
             }

admin_pages/messages/EE_Message_List_Table.class.php

Indentation +427 added lines, -427 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -15,430 +15,430 @@ 
 {
 
 
-    /**
-     * @return Messages_Admin_Page
-     */
-    public function get_admin_page()
-    {
-        return $this->_admin_page;
-    }
-
-
-    protected function _setup_data()
-    {
-        $this->_data           = $this->_get_messages($this->_per_page, $this->_view);
-        $this->_all_data_count = $this->_get_messages($this->_per_page, $this->_view, true);
-    }
-
-
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => __('Message', 'event_espresso'),
-            'plural'   => __('Messages', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->get_admin_page()->get_current_screen()->id,
-        );
-
-        $this->_columns = array(
-            'cb'           => '<input type="checkbox" />',
-            'to'           => __('To', 'event_espresso'),
-            'from'         => __('From', 'event_espresso'),
-            'messenger'    => __('Messenger', 'event_espresso'),
-            'message_type' => __('Message Type', 'event_espresso'),
-            'context'      => __('Context', 'event_espresso'),
-            'modified'     => __('Modified', 'event_espresso'),
-            'action'       => __('Actions', 'event_espresso'),
-            'msg_id'       => __('ID', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            'modified'     => array('MSG_modified' => true),
-            'message_type' => array('MSG_message_type' => false),
-            'messenger'    => array('MSG_messenger' => false),
-            'to'           => array('MSG_to' => false),
-            'from'         => array('MSG_from' => false),
-            'context'      => array('MSG_context' => false),
-            'msg_id'       => array('MSG_ID', false),
-        );
-
-        $this->_primary_column = 'to';
-
-        $this->_hidden_columns = array(
-            'msg_id',
-        );
-    }
-
-
-    /**
-     * This simply sets up the row class for the table rows.
-     * Allows for easier overriding of child methods for setting up sorting.
-     *
-     * @param  object $item the current item
-     * @return string
-     */
-    protected function _get_row_class($item)
-    {
-        $class = parent::_get_row_class($item);
-        //add status class
-        $class .= ' ee-status-strip msg-status-' . $item->STS_ID();
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-    /**
-     * _get_table_filters
-     * We use this to assemble and return any filters that are associated with this table that help further refine what
-     * get's shown in the table.
-     *
-     * @abstract
-     * @access protected
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _get_table_filters()
-    {
-        $filters = array();
-
-        //get select_inputs
-        $select_inputs = array(
-            $this->_get_messengers_dropdown_filter(),
-            $this->_get_message_types_dropdown_filter(),
-            $this->_get_contexts_for_message_types_dropdown_filter(),
-        );
-
-        //set filters to select inputs if they aren't empty
-        foreach ($select_inputs as $select_input) {
-            if ($select_input) {
-                $filters[] = $select_input;
-            }
-        }
-        return $filters;
-    }
-
-
-    protected function _add_view_counts()
-    {
-        foreach ($this->_views as $view => $args) {
-            $this->_views[$view]['count'] = $this->_get_messages($this->_per_page, $view, true, true);
-        }
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string   checkbox
-     * @throws \EE_Error
-     */
-    public function column_cb($message)
-    {
-        return sprintf('<input type="checkbox" name="MSG_ID[%s]" value="1" />', $message->ID());
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_msg_id(EE_Message $message)
-    {
-        return $message->ID();
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string    The recipient of the message
-     * @throws \EE_Error
-     */
-    public function column_to(EE_Message $message)
-    {
-        EE_Registry::instance()->load_helper('URL');
-        $actions           = array();
-        $actions['delete'] = '<a href="'
-                             . EEH_URL::add_query_args_and_nonce(
-                array(
-                    'page'   => 'espresso_messages',
-                    'action' => 'delete_ee_message',
-                    'MSG_ID' => $message->ID(),
-                ),
-                admin_url('admin.php')
-            )
-                             . '">' . __('Delete', 'event_espresso') . '</a>';
-        return esc_html($message->to()) . $this->row_actions($actions);
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string   The sender of the message
-     */
-    public function column_from(EE_Message $message)
-    {
-        return esc_html($message->from());
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string  The messenger used to send the message.
-     */
-    public function column_messenger(EE_Message $message)
-    {
-        return ucwords($message->messenger_label());
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string  The message type used to generate the message.
-     */
-    public function column_message_type(EE_Message $message)
-    {
-        return ucwords($message->message_type_label());
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string  The context the message was generated for.
-     */
-    public function column_context(EE_Message $message)
-    {
-        return $message->context_label();
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string    The timestamp when this message was last modified.
-     */
-    public function column_modified(EE_Message $message)
-    {
-        return $message->modified();
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string   Actions that can be done on the current message.
-     */
-    public function column_action(EE_Message $message)
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        $action_links = array(
-            'view'                => EEH_MSG_Template::get_message_action_link('view', $message),
-            'error'               => EEH_MSG_Template::get_message_action_link('error', $message),
-            'generate_now'        => EEH_MSG_Template::get_message_action_link('generate_now', $message),
-            'send_now'            => EEH_MSG_Template::get_message_action_link('send_now', $message),
-            'queue_for_resending' => EEH_MSG_Template::get_message_action_link('queue_for_resending', $message),
-            'view_transaction'    => EEH_MSG_Template::get_message_action_link('view_transaction', $message),
-        );
-        $content      = '';
-        switch ($message->STS_ID()) {
-            case EEM_Message::status_sent :
-                $content = $action_links['view'] . $action_links['queue_for_resending'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_resend :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_retry :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['error'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_failed :
-            case EEM_Message::status_debug_only :
-                $content = $action_links['error'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_idle :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_incomplete;
-                $content = $action_links['generate_now'] . $action_links['view_transaction'];
-                break;
-        }
-        return $content;
-    }
-
-
-    /**
-     * Retrieve the EE_Message objects for the list table.
-     *
-     * @param int    $perpage The number of items per page
-     * @param string $view    The view items are being retrieved for
-     * @param bool   $count   Whether to just return a count or not.
-     * @param bool   $all     Disregard any paging info (no limit on data returned).
-     * @return int|EE_Message[]
-     * @throws \EE_Error
-     */
-    protected function _get_messages($perpage = 10, $view = 'all', $count = false, $all = false)
-    {
-
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
-            ? $this->_req_data['paged']
-            : 1;
-
-        $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
-            ? $this->_req_data['perpage']
-            : $perpage;
-
-        $offset       = ($current_page - 1) * $per_page;
-        $limit        = $all || $count ? null : array($offset, $per_page);
-        $query_params = array(
-            'order_by' => empty($this->_req_data['orderby']) ? 'MSG_modified' : $this->_req_data['orderby'],
-            'order'    => empty($this->_req_data['order']) ? 'DESC' : $this->_req_data['order'],
-            'limit'    => $limit,
-        );
-
-        /**
-         * Any filters coming in from other routes?
-         */
-        if (isset($this->_req_data['filterby'])) {
-            $query_params = array_merge($query_params, EEM_Message::instance()->filter_by_query_params());
-            if ( ! $count) {
-                $query_params['group_by'] = 'MSG_ID';
-            }
-        }
-
-        //view conditionals
-        if ($view !== 'all' && $count && $all) {
-            $query_params[0]['AND*view_conditional'] = array(
-                'STS_ID' => strtoupper($view),
-            );
-        }
-
-        if (! $all && ! empty($this->_req_data['status']) && $this->_req_data['status'] !== 'all') {
-            $query_params[0]['AND*view_conditional'] = $this->_req_data === EEM_Message::status_failed
-                ? array(
-                    'STS_ID' => array(
-                        'IN',
-                        array(EEM_Message::status_failed, EEM_Message::status_messenger_executing)
-                    )
-                )
-                : array( 'STS_ID' => strtoupper($this->_req_data['status']) );
-        }
-
-        if (! $all && ! empty($this->_req_data['s'])) {
-            $search_string         = '%' . $this->_req_data['s'] . '%';
-            $query_params[0]['OR'] = array(
-                'MSG_to'      => array('LIKE', $search_string),
-                'MSG_from'    => array('LIKE', $search_string),
-                'MSG_subject' => array('LIKE', $search_string),
-                'MSG_content' => array('LIKE', $search_string),
-            );
-        }
-
-        //account for debug only status.  We don't show Messages with the EEM_Message::status_debug_only to clients when
-        //the messages system is in debug mode.
-        //Note: for backward compat with previous iterations, this is necessary because there may be EEM_Message::status_debug_only
-        //messages in the database.
-        if (! EEM_Message::debug()) {
-            $query_params[0]['AND*debug_only_conditional'] = array(
-                'STS_ID' => array('!=', EEM_Message::status_debug_only),
-            );
-        }
-
-        //account for filters
-        if (! $all
-            && isset($this->_req_data['ee_messenger_filter_by'])
-            && $this->_req_data['ee_messenger_filter_by'] !== 'none_selected'
-        ) {
-            $query_params[0]['AND*messenger_filter'] = array(
-                'MSG_messenger' => $this->_req_data['ee_messenger_filter_by'],
-            );
-        }
-        if (! $all
-            && ! empty($this->_req_data['ee_message_type_filter_by'])
-            && $this->_req_data['ee_message_type_filter_by'] !== 'none_selected'
-        ) {
-            $query_params[0]['AND*message_type_filter'] = array(
-                'MSG_message_type' => $this->_req_data['ee_message_type_filter_by'],
-            );
-        }
-
-        if (! $all
-            && ! empty($this->_req_data['ee_context_filter_by'])
-            && $this->_req_data['ee_context_filter_by'] !== 'none_selected'
-        ) {
-            $query_params[0]['AND*context_filter'] = array(
-                'MSG_context' => array('IN', explode(',', $this->_req_data['ee_context_filter_by'])),
-            );
-        }
-
-        return $count
-            /** @type int */
-            ? EEM_Message::instance()->count($query_params, null, true)
-            /** @type EE_Message[] */
-            : EEM_Message::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * Generate dropdown filter select input for messengers.
-     *
-     * @return string
-     */
-    protected function _get_messengers_dropdown_filter()
-    {
-        $messenger_options                    = array();
-        $active_messages_grouped_by_messenger = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
-
-        //setup array of messenger options
-        foreach ($active_messages_grouped_by_messenger as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $messenger_options[$active_message->messenger()] = ucwords($active_message->messenger_label());
-            }
-        }
-        return $this->get_admin_page()->get_messengers_select_input($messenger_options);
-    }
-
-
-    /**
-     * Generate dropdown filter select input for message types
-     *
-     * @return string
-     */
-    protected function _get_message_types_dropdown_filter()
-    {
-        $message_type_options                    = array();
-        $active_messages_grouped_by_message_type = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type'));
-
-        //setup array of message type options
-        foreach ($active_messages_grouped_by_message_type as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $message_type_options[$active_message->message_type()] = ucwords($active_message->message_type_label());
-            }
-        }
-        return $this->get_admin_page()->get_message_types_select_input($message_type_options);
-    }
-
-
-    /**
-     * Generate dropdown filter select input for message type contexts
-     *
-     * @return string
-     */
-    protected function _get_contexts_for_message_types_dropdown_filter()
-    {
-        $context_options                    = array();
-        $active_messages_grouped_by_context = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
-
-        //setup array of context options
-        foreach ($active_messages_grouped_by_context as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $message_type = $active_message->message_type_object();
-                if ($message_type instanceof EE_message_type) {
-                    foreach ($message_type->get_contexts() as $context => $context_details) {
-                        if (isset($context_details['label'])) {
-                            $context_options[$context] = $context_details['label'];
-                        }
-                    }
-                }
-            }
-        }
-        return $this->get_admin_page()->get_contexts_for_message_types_select_input($context_options);
-    }
+	/**
+	 * @return Messages_Admin_Page
+	 */
+	public function get_admin_page()
+	{
+		return $this->_admin_page;
+	}
+
+
+	protected function _setup_data()
+	{
+		$this->_data           = $this->_get_messages($this->_per_page, $this->_view);
+		$this->_all_data_count = $this->_get_messages($this->_per_page, $this->_view, true);
+	}
+
+
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => __('Message', 'event_espresso'),
+			'plural'   => __('Messages', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->get_admin_page()->get_current_screen()->id,
+		);
+
+		$this->_columns = array(
+			'cb'           => '<input type="checkbox" />',
+			'to'           => __('To', 'event_espresso'),
+			'from'         => __('From', 'event_espresso'),
+			'messenger'    => __('Messenger', 'event_espresso'),
+			'message_type' => __('Message Type', 'event_espresso'),
+			'context'      => __('Context', 'event_espresso'),
+			'modified'     => __('Modified', 'event_espresso'),
+			'action'       => __('Actions', 'event_espresso'),
+			'msg_id'       => __('ID', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			'modified'     => array('MSG_modified' => true),
+			'message_type' => array('MSG_message_type' => false),
+			'messenger'    => array('MSG_messenger' => false),
+			'to'           => array('MSG_to' => false),
+			'from'         => array('MSG_from' => false),
+			'context'      => array('MSG_context' => false),
+			'msg_id'       => array('MSG_ID', false),
+		);
+
+		$this->_primary_column = 'to';
+
+		$this->_hidden_columns = array(
+			'msg_id',
+		);
+	}
+
+
+	/**
+	 * This simply sets up the row class for the table rows.
+	 * Allows for easier overriding of child methods for setting up sorting.
+	 *
+	 * @param  object $item the current item
+	 * @return string
+	 */
+	protected function _get_row_class($item)
+	{
+		$class = parent::_get_row_class($item);
+		//add status class
+		$class .= ' ee-status-strip msg-status-' . $item->STS_ID();
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+	/**
+	 * _get_table_filters
+	 * We use this to assemble and return any filters that are associated with this table that help further refine what
+	 * get's shown in the table.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _get_table_filters()
+	{
+		$filters = array();
+
+		//get select_inputs
+		$select_inputs = array(
+			$this->_get_messengers_dropdown_filter(),
+			$this->_get_message_types_dropdown_filter(),
+			$this->_get_contexts_for_message_types_dropdown_filter(),
+		);
+
+		//set filters to select inputs if they aren't empty
+		foreach ($select_inputs as $select_input) {
+			if ($select_input) {
+				$filters[] = $select_input;
+			}
+		}
+		return $filters;
+	}
+
+
+	protected function _add_view_counts()
+	{
+		foreach ($this->_views as $view => $args) {
+			$this->_views[$view]['count'] = $this->_get_messages($this->_per_page, $view, true, true);
+		}
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string   checkbox
+	 * @throws \EE_Error
+	 */
+	public function column_cb($message)
+	{
+		return sprintf('<input type="checkbox" name="MSG_ID[%s]" value="1" />', $message->ID());
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_msg_id(EE_Message $message)
+	{
+		return $message->ID();
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string    The recipient of the message
+	 * @throws \EE_Error
+	 */
+	public function column_to(EE_Message $message)
+	{
+		EE_Registry::instance()->load_helper('URL');
+		$actions           = array();
+		$actions['delete'] = '<a href="'
+							 . EEH_URL::add_query_args_and_nonce(
+				array(
+					'page'   => 'espresso_messages',
+					'action' => 'delete_ee_message',
+					'MSG_ID' => $message->ID(),
+				),
+				admin_url('admin.php')
+			)
+							 . '">' . __('Delete', 'event_espresso') . '</a>';
+		return esc_html($message->to()) . $this->row_actions($actions);
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string   The sender of the message
+	 */
+	public function column_from(EE_Message $message)
+	{
+		return esc_html($message->from());
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string  The messenger used to send the message.
+	 */
+	public function column_messenger(EE_Message $message)
+	{
+		return ucwords($message->messenger_label());
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string  The message type used to generate the message.
+	 */
+	public function column_message_type(EE_Message $message)
+	{
+		return ucwords($message->message_type_label());
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string  The context the message was generated for.
+	 */
+	public function column_context(EE_Message $message)
+	{
+		return $message->context_label();
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string    The timestamp when this message was last modified.
+	 */
+	public function column_modified(EE_Message $message)
+	{
+		return $message->modified();
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string   Actions that can be done on the current message.
+	 */
+	public function column_action(EE_Message $message)
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		$action_links = array(
+			'view'                => EEH_MSG_Template::get_message_action_link('view', $message),
+			'error'               => EEH_MSG_Template::get_message_action_link('error', $message),
+			'generate_now'        => EEH_MSG_Template::get_message_action_link('generate_now', $message),
+			'send_now'            => EEH_MSG_Template::get_message_action_link('send_now', $message),
+			'queue_for_resending' => EEH_MSG_Template::get_message_action_link('queue_for_resending', $message),
+			'view_transaction'    => EEH_MSG_Template::get_message_action_link('view_transaction', $message),
+		);
+		$content      = '';
+		switch ($message->STS_ID()) {
+			case EEM_Message::status_sent :
+				$content = $action_links['view'] . $action_links['queue_for_resending'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_resend :
+				$content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_retry :
+				$content = $action_links['view'] . $action_links['send_now'] . $action_links['error'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_failed :
+			case EEM_Message::status_debug_only :
+				$content = $action_links['error'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_idle :
+				$content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_incomplete;
+				$content = $action_links['generate_now'] . $action_links['view_transaction'];
+				break;
+		}
+		return $content;
+	}
+
+
+	/**
+	 * Retrieve the EE_Message objects for the list table.
+	 *
+	 * @param int    $perpage The number of items per page
+	 * @param string $view    The view items are being retrieved for
+	 * @param bool   $count   Whether to just return a count or not.
+	 * @param bool   $all     Disregard any paging info (no limit on data returned).
+	 * @return int|EE_Message[]
+	 * @throws \EE_Error
+	 */
+	protected function _get_messages($perpage = 10, $view = 'all', $count = false, $all = false)
+	{
+
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
+			? $this->_req_data['paged']
+			: 1;
+
+		$per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
+			? $this->_req_data['perpage']
+			: $perpage;
+
+		$offset       = ($current_page - 1) * $per_page;
+		$limit        = $all || $count ? null : array($offset, $per_page);
+		$query_params = array(
+			'order_by' => empty($this->_req_data['orderby']) ? 'MSG_modified' : $this->_req_data['orderby'],
+			'order'    => empty($this->_req_data['order']) ? 'DESC' : $this->_req_data['order'],
+			'limit'    => $limit,
+		);
+
+		/**
+		 * Any filters coming in from other routes?
+		 */
+		if (isset($this->_req_data['filterby'])) {
+			$query_params = array_merge($query_params, EEM_Message::instance()->filter_by_query_params());
+			if ( ! $count) {
+				$query_params['group_by'] = 'MSG_ID';
+			}
+		}
+
+		//view conditionals
+		if ($view !== 'all' && $count && $all) {
+			$query_params[0]['AND*view_conditional'] = array(
+				'STS_ID' => strtoupper($view),
+			);
+		}
+
+		if (! $all && ! empty($this->_req_data['status']) && $this->_req_data['status'] !== 'all') {
+			$query_params[0]['AND*view_conditional'] = $this->_req_data === EEM_Message::status_failed
+				? array(
+					'STS_ID' => array(
+						'IN',
+						array(EEM_Message::status_failed, EEM_Message::status_messenger_executing)
+					)
+				)
+				: array( 'STS_ID' => strtoupper($this->_req_data['status']) );
+		}
+
+		if (! $all && ! empty($this->_req_data['s'])) {
+			$search_string         = '%' . $this->_req_data['s'] . '%';
+			$query_params[0]['OR'] = array(
+				'MSG_to'      => array('LIKE', $search_string),
+				'MSG_from'    => array('LIKE', $search_string),
+				'MSG_subject' => array('LIKE', $search_string),
+				'MSG_content' => array('LIKE', $search_string),
+			);
+		}
+
+		//account for debug only status.  We don't show Messages with the EEM_Message::status_debug_only to clients when
+		//the messages system is in debug mode.
+		//Note: for backward compat with previous iterations, this is necessary because there may be EEM_Message::status_debug_only
+		//messages in the database.
+		if (! EEM_Message::debug()) {
+			$query_params[0]['AND*debug_only_conditional'] = array(
+				'STS_ID' => array('!=', EEM_Message::status_debug_only),
+			);
+		}
+
+		//account for filters
+		if (! $all
+			&& isset($this->_req_data['ee_messenger_filter_by'])
+			&& $this->_req_data['ee_messenger_filter_by'] !== 'none_selected'
+		) {
+			$query_params[0]['AND*messenger_filter'] = array(
+				'MSG_messenger' => $this->_req_data['ee_messenger_filter_by'],
+			);
+		}
+		if (! $all
+			&& ! empty($this->_req_data['ee_message_type_filter_by'])
+			&& $this->_req_data['ee_message_type_filter_by'] !== 'none_selected'
+		) {
+			$query_params[0]['AND*message_type_filter'] = array(
+				'MSG_message_type' => $this->_req_data['ee_message_type_filter_by'],
+			);
+		}
+
+		if (! $all
+			&& ! empty($this->_req_data['ee_context_filter_by'])
+			&& $this->_req_data['ee_context_filter_by'] !== 'none_selected'
+		) {
+			$query_params[0]['AND*context_filter'] = array(
+				'MSG_context' => array('IN', explode(',', $this->_req_data['ee_context_filter_by'])),
+			);
+		}
+
+		return $count
+			/** @type int */
+			? EEM_Message::instance()->count($query_params, null, true)
+			/** @type EE_Message[] */
+			: EEM_Message::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * Generate dropdown filter select input for messengers.
+	 *
+	 * @return string
+	 */
+	protected function _get_messengers_dropdown_filter()
+	{
+		$messenger_options                    = array();
+		$active_messages_grouped_by_messenger = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
+
+		//setup array of messenger options
+		foreach ($active_messages_grouped_by_messenger as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$messenger_options[$active_message->messenger()] = ucwords($active_message->messenger_label());
+			}
+		}
+		return $this->get_admin_page()->get_messengers_select_input($messenger_options);
+	}
+
+
+	/**
+	 * Generate dropdown filter select input for message types
+	 *
+	 * @return string
+	 */
+	protected function _get_message_types_dropdown_filter()
+	{
+		$message_type_options                    = array();
+		$active_messages_grouped_by_message_type = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type'));
+
+		//setup array of message type options
+		foreach ($active_messages_grouped_by_message_type as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$message_type_options[$active_message->message_type()] = ucwords($active_message->message_type_label());
+			}
+		}
+		return $this->get_admin_page()->get_message_types_select_input($message_type_options);
+	}
+
+
+	/**
+	 * Generate dropdown filter select input for message type contexts
+	 *
+	 * @return string
+	 */
+	protected function _get_contexts_for_message_types_dropdown_filter()
+	{
+		$context_options                    = array();
+		$active_messages_grouped_by_context = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
+
+		//setup array of context options
+		foreach ($active_messages_grouped_by_context as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$message_type = $active_message->message_type_object();
+				if ($message_type instanceof EE_message_type) {
+					foreach ($message_type->get_contexts() as $context => $context_details) {
+						if (isset($context_details['label'])) {
+							$context_options[$context] = $context_details['label'];
+						}
+					}
+				}
+			}
+		}
+		return $this->get_admin_page()->get_contexts_for_message_types_select_input($context_options);
+	}
 } //end EE_Message_List_Table class
\ No newline at end of file

Spacing +19 added lines, -19 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -81,7 +81,7 @@ 
     {
         $class = parent::_get_row_class($item);
         //add status class
-        $class .= ' ee-status-strip msg-status-' . $item->STS_ID();
+        $class .= ' ee-status-strip msg-status-'.$item->STS_ID();
         if ($this->_has_checkbox_column) {
             $class .= ' has-checkbox-column';
         }
@@ -168,8 +168,8 @@ 
                 ),
                 admin_url('admin.php')
             )
-                             . '">' . __('Delete', 'event_espresso') . '</a>';
-        return esc_html($message->to()) . $this->row_actions($actions);
+                             . '">'.__('Delete', 'event_espresso').'</a>';
+        return esc_html($message->to()).$this->row_actions($actions);
     }
 
 
@@ -238,26 +238,26 @@ 
             'queue_for_resending' => EEH_MSG_Template::get_message_action_link('queue_for_resending', $message),
             'view_transaction'    => EEH_MSG_Template::get_message_action_link('view_transaction', $message),
         );
-        $content      = '';
+        $content = '';
         switch ($message->STS_ID()) {
             case EEM_Message::status_sent :
-                $content = $action_links['view'] . $action_links['queue_for_resending'] . $action_links['view_transaction'];
+                $content = $action_links['view'].$action_links['queue_for_resending'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_resend :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
+                $content = $action_links['view'].$action_links['send_now'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_retry :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['error'] . $action_links['view_transaction'];
+                $content = $action_links['view'].$action_links['send_now'].$action_links['error'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_failed :
             case EEM_Message::status_debug_only :
-                $content = $action_links['error'] . $action_links['view_transaction'];
+                $content = $action_links['error'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_idle :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
+                $content = $action_links['view'].$action_links['send_now'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_incomplete;
-                $content = $action_links['generate_now'] . $action_links['view_transaction'];
+                $content = $action_links['generate_now'].$action_links['view_transaction'];
                 break;
         }
         return $content;
@@ -310,7 +310,7 @@ 
             );
         }
 
-        if (! $all && ! empty($this->_req_data['status']) && $this->_req_data['status'] !== 'all') {
+        if ( ! $all && ! empty($this->_req_data['status']) && $this->_req_data['status'] !== 'all') {
             $query_params[0]['AND*view_conditional'] = $this->_req_data === EEM_Message::status_failed
                 ? array(
                     'STS_ID' => array(
@@ -318,11 +318,11 @@ 
                         array(EEM_Message::status_failed, EEM_Message::status_messenger_executing)
                     )
                 )
-                : array( 'STS_ID' => strtoupper($this->_req_data['status']) );
+                : array('STS_ID' => strtoupper($this->_req_data['status']));
         }
 
-        if (! $all && ! empty($this->_req_data['s'])) {
-            $search_string         = '%' . $this->_req_data['s'] . '%';
+        if ( ! $all && ! empty($this->_req_data['s'])) {
+            $search_string         = '%'.$this->_req_data['s'].'%';
             $query_params[0]['OR'] = array(
                 'MSG_to'      => array('LIKE', $search_string),
                 'MSG_from'    => array('LIKE', $search_string),
@@ -335,14 +335,14 @@ 
         //the messages system is in debug mode.
         //Note: for backward compat with previous iterations, this is necessary because there may be EEM_Message::status_debug_only
         //messages in the database.
-        if (! EEM_Message::debug()) {
+        if ( ! EEM_Message::debug()) {
             $query_params[0]['AND*debug_only_conditional'] = array(
                 'STS_ID' => array('!=', EEM_Message::status_debug_only),
             );
         }
 
         //account for filters
-        if (! $all
+        if ( ! $all
             && isset($this->_req_data['ee_messenger_filter_by'])
             && $this->_req_data['ee_messenger_filter_by'] !== 'none_selected'
         ) {
@@ -350,7 +350,7 @@ 
                 'MSG_messenger' => $this->_req_data['ee_messenger_filter_by'],
             );
         }
-        if (! $all
+        if ( ! $all
             && ! empty($this->_req_data['ee_message_type_filter_by'])
             && $this->_req_data['ee_message_type_filter_by'] !== 'none_selected'
         ) {
@@ -359,7 +359,7 @@ 
             );
         }
 
-        if (! $all
+        if ( ! $all
             && ! empty($this->_req_data['ee_context_filter_by'])
             && $this->_req_data['ee_context_filter_by'] !== 'none_selected'
         ) {

core/db_models/EEM_Message.model.php

Indentation +472 added lines, -472 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -12,481 +12,481 @@ 
 class EEM_Message extends EEM_Base implements EEI_Query_Filter
 {
 
-    // private instance of the Message object
-    protected static $_instance = null;
+	// private instance of the Message object
+	protected static $_instance = null;
 
 
-    /**
-     * This priority indicates a message should be generated and sent ASAP
-     *
-     * @type int
-     */
-    const priority_high = 10;
+	/**
+	 * This priority indicates a message should be generated and sent ASAP
+	 *
+	 * @type int
+	 */
+	const priority_high = 10;
 
 
-    /**
-     * This priority indicates a message should be generated ASAP and queued for sending.
-     *
-     * @type
-     */
-    const priority_medium = 20;
-
-
-    /**
-     * This priority indicates a message should be queued for generating.
-     *
-     * @type int
-     */
-    const priority_low = 30;
-
-
-    /**
-     * indicates this message was sent at the time modified
-     */
-    const status_sent = 'MSN';
-
-
-    /**
-     * indicates this message is waiting to be sent
-     */
-    const status_idle = 'MID';
-
-
-    /**
-     * indicates an attempt was a made to send this message
-     * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
-     * appear to the end user.
-     */
-    const status_failed = 'MFL';
-
-
-    /**
-     * indicates the message has been flagged for resending (at the time modified).
-     */
-    const status_resend = 'MRS';
-
-
-    /**
-     * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
-     * this status when added to the queue.
-     */
-    const status_incomplete = 'MIC';
-
-
-    /**
-     * Indicates everything was generated fine for the message, however, the messenger was unable to send.
-     * This status means that its possible to retry sending the message.
-     */
-    const status_retry = 'MRT';
-
-
-    /**
-     * This is used for more informational messages that may not indicate anything is broken but still cannot be
-     * generated or sent correctly. An example of a message that would get flagged this way would be when a not
-     * approved message was queued for generation, but at time of generation, the attached registration(s) are
-     * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
-     * in the db and be viewable in the message activity list table when the messages system is in debug mode.
-     *
-     * @see EEM_Message::debug()
-     */
-    const status_debug_only = 'MDO';
-
-
-    /**
-     * This status is given to messages it is processed by the messenger send method.
-     * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
-     * indicative of a PHP timeout or memory limit issue.
-     */
-    const status_messenger_executing = 'MEX';
-
-
-    /**
-     *    Private constructor to prevent direct creation.
-     *
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and
-     *                         any incoming timezone data that gets saved).  Note this just sends the timezone info to
-     *                         the date time model field objects.  Default is null (and will be assumed using the set
-     *                         timezone in the 'timezone_string' wp option)
-     * @return EEM_Message
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Message', 'event_espresso');
-        $this->plural_item   = __('Messages', 'event_espresso');
-
-        //used for token generator
-        EE_Registry::instance()->load_helper('URL');
-
-        $this->_tables = array(
-            'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
-        );
-
-        $allowed_priority = array(
-            self::priority_high   => __('high', 'event_espresso'),
-            self::priority_medium => __('medium', 'event_espresso'),
-            self::priority_low    => __('low', 'event_espresso'),
-        );
-
-        $this->_fields          = array(
-            'Message' => array(
-                'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', __('Message ID', 'event_espresso')),
-                'MSG_token'          => new EE_Plain_Text_Field('MSG_token',
-                    __('Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
-                        'event_espresso'), false, EEH_URL::generate_unique_token()),
-                'GRP_ID'             => new EE_Foreign_Key_Int_Field('GRP_ID',
-                    __('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'), true, 0,
-                    'Message_Template_Group'),
-                'TXN_ID'             => new EE_Foreign_Key_Int_Field('TXN_ID',
-                    __('Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
-                        'event_espresso'), true, 0, 'Transaction'),
-                'MSG_messenger'      => new EE_Plain_Text_Field('MSG_messenger',
-                    __('Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
-                        'event_espresso'), false, 'email'),
-                'MSG_message_type'   => new EE_Plain_Text_Field('MSG_message_type',
-                    __('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
-                    false, 'receipt'),
-                'MSG_context'        => new EE_Plain_Text_Field('MSG_context', __('Context', 'event_espresso'), false),
-                'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field('MSG_recipient_ID',
-                    __('Recipient ID', 'event_espresso'), true, null, array('Registration', 'Attendee', 'WP_User')),
-                'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field('MSG_recipient_type',
-                    __('Recipient Type', 'event_espresso'), true, null, array('Registration', 'Attendee', 'WP_User')),
-                'MSG_content'        => new EE_Maybe_Serialized_Text_Field('MSG_content',
-                    __('Content', 'event_espresso'), true, ''),
-                'MSG_to'             => new EE_Maybe_Serialized_Text_Field('MSG_to', __('Address To', 'event_espresso'),
-                    true),
-                'MSG_from'           => new EE_Maybe_Serialized_Text_Field('MSG_from',
-                    __('Address From', 'event_espresso'), true),
-                'MSG_subject'        => new EE_Maybe_Serialized_Text_Field('MSG_subject',
-                    __('Subject', 'event_espresso'), true, ''),
-                'MSG_priority'       => new EE_Enum_Integer_Field('MSG_priority', __('Priority', 'event_espresso'),
-                    false, self::priority_low, $allowed_priority),
-                'STS_ID'             => new EE_Foreign_Key_String_Field('STS_ID', __('Status', 'event_espresso'), false,
-                    self::status_incomplete, 'Status'),
-                'MSG_created'        => new EE_Datetime_Field('MSG_created', __('Created', 'event_espresso'), false,
-                    EE_Datetime_Field::now),
-                'MSG_modified'       => new EE_Datetime_Field('MSG_modified', __('Modified', 'event_espresso'), true,
-                    EE_Datetime_Field::now),
-            ),
-        );
-        $this->_model_relations = array(
-            'Attendee'               => new EE_Belongs_To_Any_Relation(),
-            'Registration'           => new EE_Belongs_To_Any_Relation(),
-            'WP_User'                => new EE_Belongs_To_Any_Relation(),
-            'Message_Template_Group' => new EE_Belongs_To_Relation(),
-            'Transaction'            => new EE_Belongs_To_Relation(),
-        );
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return \EE_Message
-     */
-    public function create_default_object()
-    {
-        /** @type EE_Message $message */
-        $message = parent::create_default_object();
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * @param mixed $cols_n_values
-     * @return \EE_Message
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values)
-    {
-        /** @type EE_Message $message */
-        $message = parent::instantiate_class_from_array_or_object($cols_n_values);
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given attendee.
-     *
-     * @param EE_Attendee|int $attendee
-     * @param string          $message_type the message type slug
-     * @return boolean
-     */
-    public function message_sent_for_attendee($attendee, $message_type)
-    {
-        $attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
-        return $this->exists(array(
-            array(
-                'Attendee.ATT_ID'  => $attendee_ID,
-                'MSG_message_type' => $message_type,
-                'STS_ID'           => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given registration
-     *
-     * @param EE_Registration|int $registration
-     * @param string              $message_type the message type slug
-     * @return boolean
-     */
-    public function message_sent_for_registration($registration, $message_type)
-    {
-        $registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
-        return $this->exists(array(
-            array(
-                'Registration.REG_ID' => $registrationID,
-                'MSG_message_type'    => $message_type,
-                'STS_ID'              => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * This retrieves an EE_Message object from the db matching the given token string.
-     *
-     * @param string $token
-     * @return EE_Message
-     */
-    public function get_one_by_token($token)
-    {
-        return $this->get_one(array(
-            array(
-                'MSG_token' => $token,
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns stati that indicate the message HAS been sent
-     *
-     * @return array of strings for possible stati
-     */
-    public function stati_indicating_sent()
-    {
-        return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
-    }
-
-
-    /**
-     * Returns stati that indicate the message is waiting to be sent.
-     *
-     * @return array of strings for possible stati.
-     */
-    public function stati_indicating_to_send()
-    {
-        return apply_filters('FHEE__EEM_Message__stati_indicating_to_send',
-            array(self::status_idle, self::status_resend));
-    }
-
-
-    /**
-     * Returns stati that indicate the message has failed sending
-     *
-     * @return array  array of strings for possible stati.
-     */
-    public function stati_indicating_failed_sending()
-    {
-        $failed_stati = array(
-            self::status_failed,
-            self::status_retry,
-            self::status_messenger_executing,
-        );
-        //if WP_DEBUG is set, then let's include debug_only fails
-        if (WP_DEBUG) {
-            $failed_stati[] = self::status_debug_only;
-        }
-        return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
-    }
-
-
-    /**
-     * Returns filterable array of all EEM_Message statuses.
-     *
-     * @return array
-     */
-    public function all_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__all_statuses',
-            array(
-                EEM_Message::status_sent,
-                EEM_Message::status_incomplete,
-                EEM_Message::status_idle,
-                EEM_Message::status_resend,
-                EEM_Message::status_retry,
-                EEM_Message::status_failed,
-                EEM_Message::status_messenger_executing,
-                EEM_Message::status_debug_only,
-            )
-        );
-    }
-
-    /**
-     * Detects any specific query variables in the request and uses those to setup appropriate
-     * filter for any queries.
-     *
-     * @return array
-     */
-    public function filter_by_query_params()
-    {
-        // expected possible query_vars, the key in this array matches an expected key in the request,
-        // the value, matches the corresponding EEM_Base child reference.
-        $expected_vars   = $this->_expected_vars_for_query_inject();
-        $query_params[0] = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $request_value = EE_Registry::instance()->REQ->get($request_key);
-            if ($request_value) {
-                //special case
-                switch ($request_key) {
-                    case '_REG_ID' :
-                        $query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
-                            'Transaction.Registration.REG_ID' => $request_value,
-                        );
-                        break;
-                    case 'EVT_ID' :
-                        $query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
-                            'Transaction.Registration.EVT_ID' => $request_value,
-                        );
-                        break;
-                    default :
-                        $query_params[0]['AND**filter_by']['OR**filter_by_' . $request_key][$model_name . '.' . $request_key] = $request_value;
-                        break;
-                }
-            }
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function get_pretty_label_for_results()
-    {
-        $expected_vars = $this->_expected_vars_for_query_inject();
-        $pretty_label  = '';
-        $label_parts   = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $model = EE_Registry::instance()->load_model($model_name);
-            if ($model_field_value = EE_Registry::instance()->REQ->get($request_key)) {
-                switch ($request_key) {
-                    case '_REG_ID' :
-                        $label_parts[] = sprintf(
-                            esc_html__('Registration with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'ATT_ID' :
-                        /** @var EE_Attendee $attendee */
-                        $attendee      = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $attendee instanceof EE_Attendee
-                            ? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
-                            : sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'ID' :
-                        /** @var EE_WP_User $wpUser */
-                        $wpUser        = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $wpUser instanceof EE_WP_User
-                            ? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
-                            : sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'TXN_ID' :
-                        $label_parts[] = sprintf(
-                            esc_html__('Transaction with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'EVT_ID' :
-                        /** @var EE_Event $Event */
-                        $Event         = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $Event instanceof EE_Event
-                            ? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
-                            : sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                }
-            }
-        }
-
-        if ($label_parts) {
-
-            //prepend to the last element of $label_parts an "and".
-            if (count($label_parts) > 1) {
-                $label_parts_index_to_prepend               = count($label_parts) - 1;
-                $label_parts[$label_parts_index_to_prepend] = 'and' . $label_parts[$label_parts_index_to_prepend];
-            }
-
-            $pretty_label .= sprintf(
-                esc_html_x(
-                    'Showing messages for %s',
-                    'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
-                    'event_espresso'
-                ),
-                implode(', ', $label_parts)
-            );
-        }
-        return $pretty_label;
-    }
-
-
-    /**
-     * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
-     * The array is in the format:
-     * array(
-     *  {$field_name} => {$model_name}
-     * );
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    protected function _expected_vars_for_query_inject()
-    {
-        return array(
-            '_REG_ID' => 'Registration',
-            'ATT_ID'  => 'Attendee',
-            'ID'      => 'WP_User',
-            'TXN_ID'  => 'Transaction',
-            'EVT_ID'  => 'Event',
-        );
-    }
-
-
-    /**
-     * This returns whether EEM_Message is in debug mode or not.
-     * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
-     * generating/sending messages. Debug mode can be set by either:
-     * 1. Sending in a value for the $set_debug argument
-     * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
-     * 3. Overriding the above via the provided filter.
-     *
-     * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
-     *                                  provided boolean. When no argument is provided (default null) then the debug
-     *                                  mode will be returned.
-     * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
-     */
-    public static function debug($set_debug = null)
-    {
-        static $is_debugging = null;
-
-        //initialize (use constant if set).
-        if (is_null($set_debug) && is_null($is_debugging)) {
-            $is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
-        }
-
-        if ( ! is_null($set_debug)) {
-            $is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
-        }
-
-        //return filtered value
-        return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
-    }
+	/**
+	 * This priority indicates a message should be generated ASAP and queued for sending.
+	 *
+	 * @type
+	 */
+	const priority_medium = 20;
+
+
+	/**
+	 * This priority indicates a message should be queued for generating.
+	 *
+	 * @type int
+	 */
+	const priority_low = 30;
+
+
+	/**
+	 * indicates this message was sent at the time modified
+	 */
+	const status_sent = 'MSN';
+
+
+	/**
+	 * indicates this message is waiting to be sent
+	 */
+	const status_idle = 'MID';
+
+
+	/**
+	 * indicates an attempt was a made to send this message
+	 * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
+	 * appear to the end user.
+	 */
+	const status_failed = 'MFL';
+
+
+	/**
+	 * indicates the message has been flagged for resending (at the time modified).
+	 */
+	const status_resend = 'MRS';
+
+
+	/**
+	 * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
+	 * this status when added to the queue.
+	 */
+	const status_incomplete = 'MIC';
+
+
+	/**
+	 * Indicates everything was generated fine for the message, however, the messenger was unable to send.
+	 * This status means that its possible to retry sending the message.
+	 */
+	const status_retry = 'MRT';
+
+
+	/**
+	 * This is used for more informational messages that may not indicate anything is broken but still cannot be
+	 * generated or sent correctly. An example of a message that would get flagged this way would be when a not
+	 * approved message was queued for generation, but at time of generation, the attached registration(s) are
+	 * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
+	 * in the db and be viewable in the message activity list table when the messages system is in debug mode.
+	 *
+	 * @see EEM_Message::debug()
+	 */
+	const status_debug_only = 'MDO';
+
+
+	/**
+	 * This status is given to messages it is processed by the messenger send method.
+	 * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
+	 * indicative of a PHP timeout or memory limit issue.
+	 */
+	const status_messenger_executing = 'MEX';
+
+
+	/**
+	 *    Private constructor to prevent direct creation.
+	 *
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and
+	 *                         any incoming timezone data that gets saved).  Note this just sends the timezone info to
+	 *                         the date time model field objects.  Default is null (and will be assumed using the set
+	 *                         timezone in the 'timezone_string' wp option)
+	 * @return EEM_Message
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Message', 'event_espresso');
+		$this->plural_item   = __('Messages', 'event_espresso');
+
+		//used for token generator
+		EE_Registry::instance()->load_helper('URL');
+
+		$this->_tables = array(
+			'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
+		);
+
+		$allowed_priority = array(
+			self::priority_high   => __('high', 'event_espresso'),
+			self::priority_medium => __('medium', 'event_espresso'),
+			self::priority_low    => __('low', 'event_espresso'),
+		);
+
+		$this->_fields          = array(
+			'Message' => array(
+				'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', __('Message ID', 'event_espresso')),
+				'MSG_token'          => new EE_Plain_Text_Field('MSG_token',
+					__('Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
+						'event_espresso'), false, EEH_URL::generate_unique_token()),
+				'GRP_ID'             => new EE_Foreign_Key_Int_Field('GRP_ID',
+					__('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'), true, 0,
+					'Message_Template_Group'),
+				'TXN_ID'             => new EE_Foreign_Key_Int_Field('TXN_ID',
+					__('Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
+						'event_espresso'), true, 0, 'Transaction'),
+				'MSG_messenger'      => new EE_Plain_Text_Field('MSG_messenger',
+					__('Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
+						'event_espresso'), false, 'email'),
+				'MSG_message_type'   => new EE_Plain_Text_Field('MSG_message_type',
+					__('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
+					false, 'receipt'),
+				'MSG_context'        => new EE_Plain_Text_Field('MSG_context', __('Context', 'event_espresso'), false),
+				'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field('MSG_recipient_ID',
+					__('Recipient ID', 'event_espresso'), true, null, array('Registration', 'Attendee', 'WP_User')),
+				'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field('MSG_recipient_type',
+					__('Recipient Type', 'event_espresso'), true, null, array('Registration', 'Attendee', 'WP_User')),
+				'MSG_content'        => new EE_Maybe_Serialized_Text_Field('MSG_content',
+					__('Content', 'event_espresso'), true, ''),
+				'MSG_to'             => new EE_Maybe_Serialized_Text_Field('MSG_to', __('Address To', 'event_espresso'),
+					true),
+				'MSG_from'           => new EE_Maybe_Serialized_Text_Field('MSG_from',
+					__('Address From', 'event_espresso'), true),
+				'MSG_subject'        => new EE_Maybe_Serialized_Text_Field('MSG_subject',
+					__('Subject', 'event_espresso'), true, ''),
+				'MSG_priority'       => new EE_Enum_Integer_Field('MSG_priority', __('Priority', 'event_espresso'),
+					false, self::priority_low, $allowed_priority),
+				'STS_ID'             => new EE_Foreign_Key_String_Field('STS_ID', __('Status', 'event_espresso'), false,
+					self::status_incomplete, 'Status'),
+				'MSG_created'        => new EE_Datetime_Field('MSG_created', __('Created', 'event_espresso'), false,
+					EE_Datetime_Field::now),
+				'MSG_modified'       => new EE_Datetime_Field('MSG_modified', __('Modified', 'event_espresso'), true,
+					EE_Datetime_Field::now),
+			),
+		);
+		$this->_model_relations = array(
+			'Attendee'               => new EE_Belongs_To_Any_Relation(),
+			'Registration'           => new EE_Belongs_To_Any_Relation(),
+			'WP_User'                => new EE_Belongs_To_Any_Relation(),
+			'Message_Template_Group' => new EE_Belongs_To_Relation(),
+			'Transaction'            => new EE_Belongs_To_Relation(),
+		);
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return \EE_Message
+	 */
+	public function create_default_object()
+	{
+		/** @type EE_Message $message */
+		$message = parent::create_default_object();
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values
+	 * @return \EE_Message
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values)
+	{
+		/** @type EE_Message $message */
+		$message = parent::instantiate_class_from_array_or_object($cols_n_values);
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given attendee.
+	 *
+	 * @param EE_Attendee|int $attendee
+	 * @param string          $message_type the message type slug
+	 * @return boolean
+	 */
+	public function message_sent_for_attendee($attendee, $message_type)
+	{
+		$attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
+		return $this->exists(array(
+			array(
+				'Attendee.ATT_ID'  => $attendee_ID,
+				'MSG_message_type' => $message_type,
+				'STS_ID'           => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given registration
+	 *
+	 * @param EE_Registration|int $registration
+	 * @param string              $message_type the message type slug
+	 * @return boolean
+	 */
+	public function message_sent_for_registration($registration, $message_type)
+	{
+		$registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
+		return $this->exists(array(
+			array(
+				'Registration.REG_ID' => $registrationID,
+				'MSG_message_type'    => $message_type,
+				'STS_ID'              => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * This retrieves an EE_Message object from the db matching the given token string.
+	 *
+	 * @param string $token
+	 * @return EE_Message
+	 */
+	public function get_one_by_token($token)
+	{
+		return $this->get_one(array(
+			array(
+				'MSG_token' => $token,
+			),
+		));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message HAS been sent
+	 *
+	 * @return array of strings for possible stati
+	 */
+	public function stati_indicating_sent()
+	{
+		return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message is waiting to be sent.
+	 *
+	 * @return array of strings for possible stati.
+	 */
+	public function stati_indicating_to_send()
+	{
+		return apply_filters('FHEE__EEM_Message__stati_indicating_to_send',
+			array(self::status_idle, self::status_resend));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message has failed sending
+	 *
+	 * @return array  array of strings for possible stati.
+	 */
+	public function stati_indicating_failed_sending()
+	{
+		$failed_stati = array(
+			self::status_failed,
+			self::status_retry,
+			self::status_messenger_executing,
+		);
+		//if WP_DEBUG is set, then let's include debug_only fails
+		if (WP_DEBUG) {
+			$failed_stati[] = self::status_debug_only;
+		}
+		return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
+	}
+
+
+	/**
+	 * Returns filterable array of all EEM_Message statuses.
+	 *
+	 * @return array
+	 */
+	public function all_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__all_statuses',
+			array(
+				EEM_Message::status_sent,
+				EEM_Message::status_incomplete,
+				EEM_Message::status_idle,
+				EEM_Message::status_resend,
+				EEM_Message::status_retry,
+				EEM_Message::status_failed,
+				EEM_Message::status_messenger_executing,
+				EEM_Message::status_debug_only,
+			)
+		);
+	}
+
+	/**
+	 * Detects any specific query variables in the request and uses those to setup appropriate
+	 * filter for any queries.
+	 *
+	 * @return array
+	 */
+	public function filter_by_query_params()
+	{
+		// expected possible query_vars, the key in this array matches an expected key in the request,
+		// the value, matches the corresponding EEM_Base child reference.
+		$expected_vars   = $this->_expected_vars_for_query_inject();
+		$query_params[0] = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$request_value = EE_Registry::instance()->REQ->get($request_key);
+			if ($request_value) {
+				//special case
+				switch ($request_key) {
+					case '_REG_ID' :
+						$query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
+							'Transaction.Registration.REG_ID' => $request_value,
+						);
+						break;
+					case 'EVT_ID' :
+						$query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
+							'Transaction.Registration.EVT_ID' => $request_value,
+						);
+						break;
+					default :
+						$query_params[0]['AND**filter_by']['OR**filter_by_' . $request_key][$model_name . '.' . $request_key] = $request_value;
+						break;
+				}
+			}
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function get_pretty_label_for_results()
+	{
+		$expected_vars = $this->_expected_vars_for_query_inject();
+		$pretty_label  = '';
+		$label_parts   = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$model = EE_Registry::instance()->load_model($model_name);
+			if ($model_field_value = EE_Registry::instance()->REQ->get($request_key)) {
+				switch ($request_key) {
+					case '_REG_ID' :
+						$label_parts[] = sprintf(
+							esc_html__('Registration with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'ATT_ID' :
+						/** @var EE_Attendee $attendee */
+						$attendee      = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $attendee instanceof EE_Attendee
+							? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
+							: sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'ID' :
+						/** @var EE_WP_User $wpUser */
+						$wpUser        = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $wpUser instanceof EE_WP_User
+							? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
+							: sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'TXN_ID' :
+						$label_parts[] = sprintf(
+							esc_html__('Transaction with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'EVT_ID' :
+						/** @var EE_Event $Event */
+						$Event         = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $Event instanceof EE_Event
+							? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
+							: sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
+						break;
+				}
+			}
+		}
+
+		if ($label_parts) {
+
+			//prepend to the last element of $label_parts an "and".
+			if (count($label_parts) > 1) {
+				$label_parts_index_to_prepend               = count($label_parts) - 1;
+				$label_parts[$label_parts_index_to_prepend] = 'and' . $label_parts[$label_parts_index_to_prepend];
+			}
+
+			$pretty_label .= sprintf(
+				esc_html_x(
+					'Showing messages for %s',
+					'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
+					'event_espresso'
+				),
+				implode(', ', $label_parts)
+			);
+		}
+		return $pretty_label;
+	}
+
+
+	/**
+	 * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
+	 * The array is in the format:
+	 * array(
+	 *  {$field_name} => {$model_name}
+	 * );
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	protected function _expected_vars_for_query_inject()
+	{
+		return array(
+			'_REG_ID' => 'Registration',
+			'ATT_ID'  => 'Attendee',
+			'ID'      => 'WP_User',
+			'TXN_ID'  => 'Transaction',
+			'EVT_ID'  => 'Event',
+		);
+	}
+
+
+	/**
+	 * This returns whether EEM_Message is in debug mode or not.
+	 * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
+	 * generating/sending messages. Debug mode can be set by either:
+	 * 1. Sending in a value for the $set_debug argument
+	 * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
+	 * 3. Overriding the above via the provided filter.
+	 *
+	 * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
+	 *                                  provided boolean. When no argument is provided (default null) then the debug
+	 *                                  mode will be returned.
+	 * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
+	 */
+	public static function debug($set_debug = null)
+	{
+		static $is_debugging = null;
+
+		//initialize (use constant if set).
+		if (is_null($set_debug) && is_null($is_debugging)) {
+			$is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
+		}
+
+		if ( ! is_null($set_debug)) {
+			$is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
+		}
+
+		//return filtered value
+		return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
+	}
 
 
 }

core/db_models/EEM_Status.model.php

Indentation +275 added lines, -275 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -25,291 +25,291 @@ 
 class EEM_Status extends EEM_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    /**
-     * @return EEM_Status
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item    = __('Status', 'event_espresso');
-        $this->plural_item      = __('Stati', 'event_espresso');
-        $this->_tables          = array(
-            'StatusTable' => new EE_Primary_Table('esp_status', 'STS_ID'),
-        );
-        $this->_fields          = array(
-            'StatusTable' => array(
-                'STS_ID'       => new EE_Primary_Key_String_Field('STS_ID', __('Status ID', 'event_espresso')),
-                'STS_code'     => new EE_Plain_Text_Field('STS_code', __('Status Code', 'event_espresso'), false, ''),
-                'STS_type'     => new EE_Enum_Text_Field(
-                    'STS_type',
-                    __("Type", "event_espresso"),
-                    false,
-                    'event',
-                    array(
-                        'event'        => __("Event", "event_espresso"),//deprecated
-                        'registration' => __("Registration", "event_espresso"),
-                        'transaction'  => __("Transaction", "event_espresso"),
-                        'payment'      => __("Payment", "event_espresso"),
-                        'email'        => __("Email", "event_espresso"),
-                        'message'      => __("Message", "event_espresso"),
-                    )),
-                'STS_can_edit' => new EE_Boolean_Field('STS_can_edit', __('Editable?', 'event_espresso'), false),
-                'STS_desc'     => new EE_Simple_HTML_Field('STS_desc', __("Description", "event_espresso"), false, ''),
-                'STS_open'     => new EE_Boolean_Field('STS_open', __("Open?", "event_espresso"), false, false),
-            ),
-        );
-        $this->_model_relations = array(
-            'Registration' => new EE_Has_Many_Relation(),
-            'Transaction'  => new EE_Has_Many_Relation(),
-            'Payment'      => new EE_Has_Many_Relation(),
-        );
-        //this model is generally available for reading
-        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
+	/**
+	 * @return EEM_Status
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item    = __('Status', 'event_espresso');
+		$this->plural_item      = __('Stati', 'event_espresso');
+		$this->_tables          = array(
+			'StatusTable' => new EE_Primary_Table('esp_status', 'STS_ID'),
+		);
+		$this->_fields          = array(
+			'StatusTable' => array(
+				'STS_ID'       => new EE_Primary_Key_String_Field('STS_ID', __('Status ID', 'event_espresso')),
+				'STS_code'     => new EE_Plain_Text_Field('STS_code', __('Status Code', 'event_espresso'), false, ''),
+				'STS_type'     => new EE_Enum_Text_Field(
+					'STS_type',
+					__("Type", "event_espresso"),
+					false,
+					'event',
+					array(
+						'event'        => __("Event", "event_espresso"),//deprecated
+						'registration' => __("Registration", "event_espresso"),
+						'transaction'  => __("Transaction", "event_espresso"),
+						'payment'      => __("Payment", "event_espresso"),
+						'email'        => __("Email", "event_espresso"),
+						'message'      => __("Message", "event_espresso"),
+					)),
+				'STS_can_edit' => new EE_Boolean_Field('STS_can_edit', __('Editable?', 'event_espresso'), false),
+				'STS_desc'     => new EE_Simple_HTML_Field('STS_desc', __("Description", "event_espresso"), false, ''),
+				'STS_open'     => new EE_Boolean_Field('STS_open', __("Open?", "event_espresso"), false, false),
+			),
+		);
+		$this->_model_relations = array(
+			'Registration' => new EE_Has_Many_Relation(),
+			'Transaction'  => new EE_Has_Many_Relation(),
+			'Payment'      => new EE_Has_Many_Relation(),
+		);
+		//this model is generally available for reading
+		$this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * This method provides the localized singular or plural string for a given status id
-     *
-     * @param  array   $statuses This should be an array of statuses in the format array( $status_id, $status_code ).
-     *                           That way if there isn't a translation in the index we'll return the default code.
-     * @param  boolean $plural   Whether to return plural string or not. Note, nearly all of the plural strings are the
-     *                           same as the singular (in English), however, this may NOT be the case with other
-     *                           languages
-     * @param  string  $schema   This can be either 'upper', 'lower', or 'sentence'.  Basically indicates how we want
-     *                           the status string returned ( UPPER, lower, Sentence)
-     * @throws EE_Error
-     * @return array             an array of translated strings for the incoming status id.
-     */
-    public function localized_status($statuses, $plural = false, $schema = 'upper')
-    {
-        //note these are all in lower case because ucwords() on upper case will NOT convert.
-        $translation_array = array(
-            EEM_Registration::status_id_pending_payment => array(
-                __('pending payment', 'event_espresso'), //singular
-                __('pending payments', 'event_espresso') //plural
-            ),
-            EEM_Registration::status_id_approved        => array(
-                __('approved', 'event_espresso'), //singular
-                __('approved', 'event_espresso') //plural
-            ),
-            EEM_Registration::status_id_not_approved    => array(
-                __('not approved', 'event_espresso'),
-                __('not approved', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_cancelled       => array(
-                __('cancelled', 'event_espresso'),
-                __('cancelled', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_incomplete      => array(
-                __('incomplete', 'event_espresso'),
-                __('incomplete', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_declined        => array(
-                __('declined', 'event_espresso'),
-                __('declined', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_wait_list       => array(
-                __('wait list', 'event_espresso'),
-                __('wait list', 'event_espresso'),
-            ),
-            EEM_Transaction::overpaid_status_code       => array(
-                __('overpaid', 'event_espresso'),
-                __('overpaid', 'event_espresso'),
-            ),
-            EEM_Transaction::complete_status_code       => array(
-                __('complete', 'event_espresso'),
-                __('complete', 'event_espresso'),
-            ),
-            EEM_Transaction::incomplete_status_code     => array(
-                __('incomplete', 'event_espresso'),
-                __('incomplete', 'event_espresso'),
-            ),
-            EEM_Transaction::failed_status_code         => array(
-                __('failed', 'event_espresso'),
-                __('failed', 'event_espresso'),
-            ),
-            EEM_Transaction::abandoned_status_code      => array(
-                __('abandoned', 'event_espresso'),
-                __('abandoned', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_approved             => array(
-                __('accepted', 'event_espresso'),
-                __('accepted', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_pending              => array(
-                __('pending', 'event_espresso'),
-                __('pending', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_cancelled            => array(
-                __('cancelled', 'event_espresso'),
-                __('cancelled', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_declined             => array(
-                __('declined', 'event_espresso'),
-                __('declined', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_failed               => array(
-                __('failed', 'event_espresso'),
-                __('failed', 'event_espresso'),
-            ),
-            //following statuses are NOT part of the EEM_Status but to keep things centralized we include in here.
-            EEM_Event::sold_out                         => array(
-                __('sold out', 'event_espresso'),
-                __('sold out', 'event_espresso'),
-            ),
-            EEM_Event::postponed                        => array(
-                __('postponed', 'event_espresso'),
-                __('Postponed', 'event_espresso'),
-            ),
-            EEM_Event::cancelled                        => array(
-                __('cancelled', 'event_espresso'),
-                __('cancelled', 'event_espresso'),
-            ),
-            EE_Ticket::archived                         => array(
-                __('archived', 'event_espresso'),
-                __('archived', 'event_espresso'),
-            ),
-            EE_Ticket::expired                          => array(
-                __('expired', 'event_espresso'),
-                __('expired', 'event_espresso'),
-            ),
-            EE_Ticket::sold_out                         => array(
-                __('sold out', 'event_espresso'),
-                __('sold out', 'event_espresso'),
-            ),
-            EE_Ticket::pending                          => array(
-                __('upcoming', 'event_espresso'),
-                __('upcoming', 'event_espresso'),
-            ),
-            EE_Ticket::onsale                           => array(
-                __('on sale', 'event_espresso'),
-                __('on sale', 'event_espresso'),
-            ),
-            EE_Datetime::cancelled                      => array(
-                __('cancelled', 'event_espresso'),
-                __('cancelled', 'event_espresso'),
-            ),
-            EE_Datetime::sold_out                       => array(
-                __('sold out', 'event_espresso'),
-                __('sold out', 'event_espresso'),
-            ),
-            EE_Datetime::expired                        => array(
-                __('expired', 'event_espresso'),
-                __('expired', 'event_espresso'),
-            ),
-            EE_Datetime::inactive                       => array(
-                __('inactive', 'event_espresso'),
-                __('inactive', 'event_espresso'),
-            ),
-            EE_Datetime::upcoming                       => array(
-                __('upcoming', 'event_espresso'),
-                __('upcoming', 'event_espresso'),
-            ),
-            EE_Datetime::active                         => array(
-                __('active', 'event_espresso'),
-                __('active', 'event_espresso'),
-            ),
-            EE_Datetime::postponed                      => array(
-                __('postponed', 'event_espresso'),
-                __('postponed', 'event_espresso'),
-            ),
-            //messages related
-            EEM_Message::status_sent                    => array(
-                __('sent', 'event_espresso'),
-                __('sent', 'event_espresso'),
-            ),
-            EEM_Message::status_idle                    => array(
-                __('queued for sending', 'event_espresso'),
-                __('queued for sending', 'event_espresso'),
-            ),
-            EEM_Message::status_failed                  => array(
-                __('failed', 'event_espresso'),
-                __('failed', 'event_espresso'),
-            ),
-            EEM_Message::status_debug_only              => array(
-                __('debug only', 'event_espresso'),
-                __('debug only', 'event_espresso'),
-            ),
-            EEM_Message::status_messenger_executing     => array(
-                __('messenger is executing', 'event_espresso'),
-                __('messenger is executing', 'event_espresso'),
-            ),
-            EEM_Message::status_resend                  => array(
-                __('queued for resending', 'event_espresso'),
-                __('queued for resending', 'event_espresso'),
-            ),
-            EEM_Message::status_incomplete              => array(
-                __('queued for generating', 'event_espresso'),
-                __('queued for generating', 'event_espresso'),
-            ),
-            EEM_Message::status_retry                   => array(
-                __('failed sending, can be retried', 'event_espresso'),
-                __('failed sending, can be retried', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_publish           => array(
-                __('published', 'event_espresso'),
-                __('published', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_future            => array(
-                __('scheduled', 'event_espresso'),
-                __('scheduled', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_draft             => array(
-                __('draft', 'event_espresso'),
-                __('draft', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_pending           => array(
-                __('pending', 'event_espresso'),
-                __('pending', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_private           => array(
-                __('private', 'event_espresso'),
-                __('private', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_trashed           => array(
-                __('trashed', 'event_espresso'),
-                __('trashed', 'event_espresso'),
-            ),
-        );
+	/**
+	 * This method provides the localized singular or plural string for a given status id
+	 *
+	 * @param  array   $statuses This should be an array of statuses in the format array( $status_id, $status_code ).
+	 *                           That way if there isn't a translation in the index we'll return the default code.
+	 * @param  boolean $plural   Whether to return plural string or not. Note, nearly all of the plural strings are the
+	 *                           same as the singular (in English), however, this may NOT be the case with other
+	 *                           languages
+	 * @param  string  $schema   This can be either 'upper', 'lower', or 'sentence'.  Basically indicates how we want
+	 *                           the status string returned ( UPPER, lower, Sentence)
+	 * @throws EE_Error
+	 * @return array             an array of translated strings for the incoming status id.
+	 */
+	public function localized_status($statuses, $plural = false, $schema = 'upper')
+	{
+		//note these are all in lower case because ucwords() on upper case will NOT convert.
+		$translation_array = array(
+			EEM_Registration::status_id_pending_payment => array(
+				__('pending payment', 'event_espresso'), //singular
+				__('pending payments', 'event_espresso') //plural
+			),
+			EEM_Registration::status_id_approved        => array(
+				__('approved', 'event_espresso'), //singular
+				__('approved', 'event_espresso') //plural
+			),
+			EEM_Registration::status_id_not_approved    => array(
+				__('not approved', 'event_espresso'),
+				__('not approved', 'event_espresso'),
+			),
+			EEM_Registration::status_id_cancelled       => array(
+				__('cancelled', 'event_espresso'),
+				__('cancelled', 'event_espresso'),
+			),
+			EEM_Registration::status_id_incomplete      => array(
+				__('incomplete', 'event_espresso'),
+				__('incomplete', 'event_espresso'),
+			),
+			EEM_Registration::status_id_declined        => array(
+				__('declined', 'event_espresso'),
+				__('declined', 'event_espresso'),
+			),
+			EEM_Registration::status_id_wait_list       => array(
+				__('wait list', 'event_espresso'),
+				__('wait list', 'event_espresso'),
+			),
+			EEM_Transaction::overpaid_status_code       => array(
+				__('overpaid', 'event_espresso'),
+				__('overpaid', 'event_espresso'),
+			),
+			EEM_Transaction::complete_status_code       => array(
+				__('complete', 'event_espresso'),
+				__('complete', 'event_espresso'),
+			),
+			EEM_Transaction::incomplete_status_code     => array(
+				__('incomplete', 'event_espresso'),
+				__('incomplete', 'event_espresso'),
+			),
+			EEM_Transaction::failed_status_code         => array(
+				__('failed', 'event_espresso'),
+				__('failed', 'event_espresso'),
+			),
+			EEM_Transaction::abandoned_status_code      => array(
+				__('abandoned', 'event_espresso'),
+				__('abandoned', 'event_espresso'),
+			),
+			EEM_Payment::status_id_approved             => array(
+				__('accepted', 'event_espresso'),
+				__('accepted', 'event_espresso'),
+			),
+			EEM_Payment::status_id_pending              => array(
+				__('pending', 'event_espresso'),
+				__('pending', 'event_espresso'),
+			),
+			EEM_Payment::status_id_cancelled            => array(
+				__('cancelled', 'event_espresso'),
+				__('cancelled', 'event_espresso'),
+			),
+			EEM_Payment::status_id_declined             => array(
+				__('declined', 'event_espresso'),
+				__('declined', 'event_espresso'),
+			),
+			EEM_Payment::status_id_failed               => array(
+				__('failed', 'event_espresso'),
+				__('failed', 'event_espresso'),
+			),
+			//following statuses are NOT part of the EEM_Status but to keep things centralized we include in here.
+			EEM_Event::sold_out                         => array(
+				__('sold out', 'event_espresso'),
+				__('sold out', 'event_espresso'),
+			),
+			EEM_Event::postponed                        => array(
+				__('postponed', 'event_espresso'),
+				__('Postponed', 'event_espresso'),
+			),
+			EEM_Event::cancelled                        => array(
+				__('cancelled', 'event_espresso'),
+				__('cancelled', 'event_espresso'),
+			),
+			EE_Ticket::archived                         => array(
+				__('archived', 'event_espresso'),
+				__('archived', 'event_espresso'),
+			),
+			EE_Ticket::expired                          => array(
+				__('expired', 'event_espresso'),
+				__('expired', 'event_espresso'),
+			),
+			EE_Ticket::sold_out                         => array(
+				__('sold out', 'event_espresso'),
+				__('sold out', 'event_espresso'),
+			),
+			EE_Ticket::pending                          => array(
+				__('upcoming', 'event_espresso'),
+				__('upcoming', 'event_espresso'),
+			),
+			EE_Ticket::onsale                           => array(
+				__('on sale', 'event_espresso'),
+				__('on sale', 'event_espresso'),
+			),
+			EE_Datetime::cancelled                      => array(
+				__('cancelled', 'event_espresso'),
+				__('cancelled', 'event_espresso'),
+			),
+			EE_Datetime::sold_out                       => array(
+				__('sold out', 'event_espresso'),
+				__('sold out', 'event_espresso'),
+			),
+			EE_Datetime::expired                        => array(
+				__('expired', 'event_espresso'),
+				__('expired', 'event_espresso'),
+			),
+			EE_Datetime::inactive                       => array(
+				__('inactive', 'event_espresso'),
+				__('inactive', 'event_espresso'),
+			),
+			EE_Datetime::upcoming                       => array(
+				__('upcoming', 'event_espresso'),
+				__('upcoming', 'event_espresso'),
+			),
+			EE_Datetime::active                         => array(
+				__('active', 'event_espresso'),
+				__('active', 'event_espresso'),
+			),
+			EE_Datetime::postponed                      => array(
+				__('postponed', 'event_espresso'),
+				__('postponed', 'event_espresso'),
+			),
+			//messages related
+			EEM_Message::status_sent                    => array(
+				__('sent', 'event_espresso'),
+				__('sent', 'event_espresso'),
+			),
+			EEM_Message::status_idle                    => array(
+				__('queued for sending', 'event_espresso'),
+				__('queued for sending', 'event_espresso'),
+			),
+			EEM_Message::status_failed                  => array(
+				__('failed', 'event_espresso'),
+				__('failed', 'event_espresso'),
+			),
+			EEM_Message::status_debug_only              => array(
+				__('debug only', 'event_espresso'),
+				__('debug only', 'event_espresso'),
+			),
+			EEM_Message::status_messenger_executing     => array(
+				__('messenger is executing', 'event_espresso'),
+				__('messenger is executing', 'event_espresso'),
+			),
+			EEM_Message::status_resend                  => array(
+				__('queued for resending', 'event_espresso'),
+				__('queued for resending', 'event_espresso'),
+			),
+			EEM_Message::status_incomplete              => array(
+				__('queued for generating', 'event_espresso'),
+				__('queued for generating', 'event_espresso'),
+			),
+			EEM_Message::status_retry                   => array(
+				__('failed sending, can be retried', 'event_espresso'),
+				__('failed sending, can be retried', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_publish           => array(
+				__('published', 'event_espresso'),
+				__('published', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_future            => array(
+				__('scheduled', 'event_espresso'),
+				__('scheduled', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_draft             => array(
+				__('draft', 'event_espresso'),
+				__('draft', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_pending           => array(
+				__('pending', 'event_espresso'),
+				__('pending', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_private           => array(
+				__('private', 'event_espresso'),
+				__('private', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_trashed           => array(
+				__('trashed', 'event_espresso'),
+				__('trashed', 'event_espresso'),
+			),
+		);
 
-        $translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
+		$translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
 
-        if ( ! is_array($statuses)) {
-            throw new EE_Error(__('The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
-                'event_espresso'));
-        }
+		if ( ! is_array($statuses)) {
+			throw new EE_Error(__('The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
+				'event_espresso'));
+		}
 
-        $translation = array();
+		$translation = array();
 
-        foreach ($statuses as $id => $code) {
-            if (isset($translation_array[$id])) {
-                $translation[$id] = $plural ? $translation_array[$id][1] : $translation_array[$id][0];
-            } else {
-                $translation[$id] = $code;
-            }
+		foreach ($statuses as $id => $code) {
+			if (isset($translation_array[$id])) {
+				$translation[$id] = $plural ? $translation_array[$id][1] : $translation_array[$id][0];
+			} else {
+				$translation[$id] = $code;
+			}
 
-            //schema
-            switch ($schema) {
-                case 'lower' :
-                    $translation[$id] = strtolower($translation[$id]); //even though these start in lower case, this will catch any statuses added via filter.
-                    break;
-                case 'sentence' :
-                    $translation[$id] = ucwords($translation[$id]);
-                    break;
-                case 'upper' :
-                    $translation[$id] = strtoupper($translation[$id]);
-                    break;
-            }
-        }
+			//schema
+			switch ($schema) {
+				case 'lower' :
+					$translation[$id] = strtolower($translation[$id]); //even though these start in lower case, this will catch any statuses added via filter.
+					break;
+				case 'sentence' :
+					$translation[$id] = ucwords($translation[$id]);
+					break;
+				case 'upper' :
+					$translation[$id] = strtoupper($translation[$id]);
+					break;
+			}
+		}
 
-        return $translation;
-    }
+		return $translation;
+	}
 
 
 }

core/libraries/messages/EE_Message_Repository.lib.php

Spacing +4 added lines, -4 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -38,7 +38,7 @@ 
     {
         $attached = parent::add($message);
         //ensure $info is an array if not already
-        $info = $info === null ? $info = array() : (array)$info;
+        $info = $info === null ? $info = array() : (array) $info;
         $data = $this->_init_data($info, $attached, $message);
         if ($attached) {
             $this->set_info($message, $data);
@@ -103,10 +103,10 @@ 
     {
         $save_tracking = array('updated' => 0, 'notupdated' => 0, 'errors' => array());
 
-        if (! $do_hooks_only) {
+        if ( ! $do_hooks_only) {
             $this->rewind();
             //exit early if there is nothing to save.
-            if (! $this->count() > 0) {
+            if ( ! $this->count() > 0) {
                 return $save_tracking;
             }
 

Indentation +251 added lines, -251 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -16,256 +16,256 @@ 
 {
 
 
-    /**
-     *    EE_Message_Repository constructor
-     */
-    public function __construct()
-    {
-        $this->interface = 'EE_Message';
-        parent::__construct();
-    }
-
-
-    /**
-     * Add the EE_Message to the repository.
-     * This also ensures that the MSG_token is saves as a part of the info for retrieval.
-     *
-     * @param EE_Message $message
-     * @param mixed      $info Any included data is saved in the attached object info array indexed by 'data'
-     * @return bool
-     */
-    public function add($message, $info = null)
-    {
-        $attached = parent::add($message);
-        //ensure $info is an array if not already
-        $info = $info === null ? $info = array() : (array)$info;
-        $data = $this->_init_data($info, $attached, $message);
-        if ($attached) {
-            $this->set_info($message, $data);
-        }
-        return $attached;
-    }
-
-
-    /**
-     * Initializes the data from the incoming info.
-     *
-     * @param array      $info     incoming data.
-     * @param bool       $attached Indicates whether the object was attached successfully.
-     * @param EE_Message $message
-     * @return array
-     */
-    protected function _init_data($info, $attached, $message)
-    {
-        $data = array(
-            'test_send'               => false,
-            'preview'                 => false,
-            'data_handler_class_name' => '',
-            'data'                    => array(
-                'MSG_generation_data' => array(),
-            ),
-        );
-        if (isset($info['preview'])) {
-            $data['preview'] = $info['preview'];
-            unset($info['preview']);
-        }
-        if (isset($info['test_send'])) {
-            $data['test_send'] = $info['test_send'];
-            unset($info['test_send']);
-        }
-        if (isset($info['data_handler_class_name'])) {
-            $data['data_handler_class_name'] = $info['data_handler_class_name'];
-            unset($info['data_handler_class_name']);
-        }
-        if ($attached && $message->STS_ID() === EEM_Message::status_incomplete) {
-            $generation_data = isset($info['MSG_generation_data']) ? $info['MSG_generation_data'] : array();
-            //if data isn't in $info...let's see if its available via the message object
-            $generation_data = ! $generation_data ? $message->get_generation_data() : $generation_data;
-            //still empty then let's just use info
-            $generation_data                     = ! $generation_data ? $info : $generation_data;
-            $data['data']['MSG_generation_data'] = $generation_data;
-        }
-        return $data;
-    }
-
-
-    /**
-     * Save all EE_Message objects to the db.
-     *
-     * @param bool $do_hooks_only  When true, only the hooks related to saving are fired.
-     * @return array array(
-     *                  'updated' => 0, //count of how many messages updated
-     *                  'notupdated' => 0, //count of how many messages not updated.
-     *                  'errors' => array( $token ), //array of message object tokens that had errors in saving
-     *                  )
-     */
-    public function saveAll($do_hooks_only = false)
-    {
-        $save_tracking = array('updated' => 0, 'notupdated' => 0, 'errors' => array());
-
-        if (! $do_hooks_only) {
-            $this->rewind();
-            //exit early if there is nothing to save.
-            if (! $this->count() > 0) {
-                return $save_tracking;
-            }
-
-            while ($this->valid()) {
-                $saved = $this->current()->save();
-                if ($saved === false) {
-                    $save_tracking['errors'][] = $this->current()->MSG_token();
-                } elseif ($saved) {
-                    $save_tracking['updated']++;
-                } else {
-                    $save_tracking['notupdated']++;
-                }
-                //maybe persist generation data if this is an incomplete EE_Message.
-                $this->_maybe_persist_attached_data();
-
-                $this->next();
-            }
-        }
-        do_action('AHEE__EE_Message_Repository__saveAll__after', $save_tracking, $this, $do_hooks_only);
-        return $save_tracking;
-    }
-
-
-    /**
-     * Retrieves a EE_Message from the repository that matches the given token.
-     *
-     * @param string $token Token.
-     * @return EE_Message | null
-     */
-    public function getMessageByToken($token)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current()->MSG_token() === $token) {
-                $message = $this->current();
-                $this->rewind();
-                return $message;
-            }
-            $this->next();
-        }
-        return null;
-    }
-
-
-    /**
-     * This retrieves any data required for generation that may be saved with the current EE_Message in storage.
-     *
-     * @return array();
-     */
-    public function get_generation_data()
-    {
-        //first verify we're at a valid iterator point.
-        if ( ! $this->valid()) {
-            return array();
-        }
-        $info = $this->getInfo();
-        return isset($info['data']) && isset($info['data']['MSG_generation_data']) ? $info['data']['MSG_generation_data'] : array();
-    }
-
-
-    /**
-     * Retrieves the data_handler_class_name or reference associated with the current EE_Message object in the iterator.
-     *
-     * @return string
-     */
-    public function get_data_handler()
-    {
-        if ( ! $this->valid()) {
-            return '';
-        }
-        $info = $this->getInfo();
-        return isset($info['data_handler_class_name']) ? $info['data_handler_class_name'] : '';
-    }
-
-
-    /**
-     * Returns whether this EE_Message is for a preview or not.
-     *
-     * @return bool
-     */
-    public function is_preview()
-    {
-        if ( ! $this->valid()) {
-            return false;
-        }
-        $info = $this->getInfo();
-        return $info['preview'];
-    }
-
-
-    /**
-     * Returns whether the current message pointed to is for a test send.
-     *
-     * @return bool
-     */
-    public function is_test_send()
-    {
-        if ( ! $this->valid()) {
-            return false;
-        }
-        $info = $this->getInfo();
-        return $info['test_send'];
-    }
-
-
-    /**
-     *  This checks if the current EE_Message in the iterator is incomplete. If it is, then
-     *  data is attached for later retrieval (batch generation).
-     */
-    protected function _maybe_persist_attached_data()
-    {
-        if ( ! $this->valid()) {
-            return;
-        }
-
-        $info                    = $this->getInfo();
-        $data_handler_class_name = isset($info['data_handler_class_name']) ? $info['data_handler_class_name'] : '';
-        $data                    = isset($info['data']) && isset($info['data']['MSG_generation_data']) ? $info['data']['MSG_generation_data'] : array();
-        if ($data && $this->current()->STS_ID() === EEM_Message::status_incomplete) {
-            $this->current()->set_generation_data($data);
-            $this->current()->set_field_or_extra_meta('data_handler_class_name', $data_handler_class_name);
-        }
-    }
-
-
-    /**
-     * This method returns a count of messages in the repository that have a given priority.
-     *
-     * @param int   $priority the priority that is being filtered for the count.
-     * @param array $status   the optional status(es) that will also be filtered by when priority matches.
-     * @return int  count of messages in the queue matching the conditions.
-     */
-    public function count_by_priority_and_status($priority, $status = array())
-    {
-        if ( ! empty($status)) {
-            $status = is_array($status) ? $status : array($status);
-        }
-
-        $count = 0;
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current()->priority() === $priority && (($status && in_array($this->current()->STS_ID(),
-                            $status)) || ! $status)
-            ) {
-                $count++;
-            }
-            $this->next();
-        }
-        return $count;
-    }
-
-
-    /**
-     * @return EE_Message
-     */
-    public function current()
-    {
-        return parent::current();
-    }
+	/**
+	 *    EE_Message_Repository constructor
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EE_Message';
+		parent::__construct();
+	}
+
+
+	/**
+	 * Add the EE_Message to the repository.
+	 * This also ensures that the MSG_token is saves as a part of the info for retrieval.
+	 *
+	 * @param EE_Message $message
+	 * @param mixed      $info Any included data is saved in the attached object info array indexed by 'data'
+	 * @return bool
+	 */
+	public function add($message, $info = null)
+	{
+		$attached = parent::add($message);
+		//ensure $info is an array if not already
+		$info = $info === null ? $info = array() : (array)$info;
+		$data = $this->_init_data($info, $attached, $message);
+		if ($attached) {
+			$this->set_info($message, $data);
+		}
+		return $attached;
+	}
+
+
+	/**
+	 * Initializes the data from the incoming info.
+	 *
+	 * @param array      $info     incoming data.
+	 * @param bool       $attached Indicates whether the object was attached successfully.
+	 * @param EE_Message $message
+	 * @return array
+	 */
+	protected function _init_data($info, $attached, $message)
+	{
+		$data = array(
+			'test_send'               => false,
+			'preview'                 => false,
+			'data_handler_class_name' => '',
+			'data'                    => array(
+				'MSG_generation_data' => array(),
+			),
+		);
+		if (isset($info['preview'])) {
+			$data['preview'] = $info['preview'];
+			unset($info['preview']);
+		}
+		if (isset($info['test_send'])) {
+			$data['test_send'] = $info['test_send'];
+			unset($info['test_send']);
+		}
+		if (isset($info['data_handler_class_name'])) {
+			$data['data_handler_class_name'] = $info['data_handler_class_name'];
+			unset($info['data_handler_class_name']);
+		}
+		if ($attached && $message->STS_ID() === EEM_Message::status_incomplete) {
+			$generation_data = isset($info['MSG_generation_data']) ? $info['MSG_generation_data'] : array();
+			//if data isn't in $info...let's see if its available via the message object
+			$generation_data = ! $generation_data ? $message->get_generation_data() : $generation_data;
+			//still empty then let's just use info
+			$generation_data                     = ! $generation_data ? $info : $generation_data;
+			$data['data']['MSG_generation_data'] = $generation_data;
+		}
+		return $data;
+	}
+
+
+	/**
+	 * Save all EE_Message objects to the db.
+	 *
+	 * @param bool $do_hooks_only  When true, only the hooks related to saving are fired.
+	 * @return array array(
+	 *                  'updated' => 0, //count of how many messages updated
+	 *                  'notupdated' => 0, //count of how many messages not updated.
+	 *                  'errors' => array( $token ), //array of message object tokens that had errors in saving
+	 *                  )
+	 */
+	public function saveAll($do_hooks_only = false)
+	{
+		$save_tracking = array('updated' => 0, 'notupdated' => 0, 'errors' => array());
+
+		if (! $do_hooks_only) {
+			$this->rewind();
+			//exit early if there is nothing to save.
+			if (! $this->count() > 0) {
+				return $save_tracking;
+			}
+
+			while ($this->valid()) {
+				$saved = $this->current()->save();
+				if ($saved === false) {
+					$save_tracking['errors'][] = $this->current()->MSG_token();
+				} elseif ($saved) {
+					$save_tracking['updated']++;
+				} else {
+					$save_tracking['notupdated']++;
+				}
+				//maybe persist generation data if this is an incomplete EE_Message.
+				$this->_maybe_persist_attached_data();
+
+				$this->next();
+			}
+		}
+		do_action('AHEE__EE_Message_Repository__saveAll__after', $save_tracking, $this, $do_hooks_only);
+		return $save_tracking;
+	}
+
+
+	/**
+	 * Retrieves a EE_Message from the repository that matches the given token.
+	 *
+	 * @param string $token Token.
+	 * @return EE_Message | null
+	 */
+	public function getMessageByToken($token)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current()->MSG_token() === $token) {
+				$message = $this->current();
+				$this->rewind();
+				return $message;
+			}
+			$this->next();
+		}
+		return null;
+	}
+
+
+	/**
+	 * This retrieves any data required for generation that may be saved with the current EE_Message in storage.
+	 *
+	 * @return array();
+	 */
+	public function get_generation_data()
+	{
+		//first verify we're at a valid iterator point.
+		if ( ! $this->valid()) {
+			return array();
+		}
+		$info = $this->getInfo();
+		return isset($info['data']) && isset($info['data']['MSG_generation_data']) ? $info['data']['MSG_generation_data'] : array();
+	}
+
+
+	/**
+	 * Retrieves the data_handler_class_name or reference associated with the current EE_Message object in the iterator.
+	 *
+	 * @return string
+	 */
+	public function get_data_handler()
+	{
+		if ( ! $this->valid()) {
+			return '';
+		}
+		$info = $this->getInfo();
+		return isset($info['data_handler_class_name']) ? $info['data_handler_class_name'] : '';
+	}
+
+
+	/**
+	 * Returns whether this EE_Message is for a preview or not.
+	 *
+	 * @return bool
+	 */
+	public function is_preview()
+	{
+		if ( ! $this->valid()) {
+			return false;
+		}
+		$info = $this->getInfo();
+		return $info['preview'];
+	}
+
+
+	/**
+	 * Returns whether the current message pointed to is for a test send.
+	 *
+	 * @return bool
+	 */
+	public function is_test_send()
+	{
+		if ( ! $this->valid()) {
+			return false;
+		}
+		$info = $this->getInfo();
+		return $info['test_send'];
+	}
+
+
+	/**
+	 *  This checks if the current EE_Message in the iterator is incomplete. If it is, then
+	 *  data is attached for later retrieval (batch generation).
+	 */
+	protected function _maybe_persist_attached_data()
+	{
+		if ( ! $this->valid()) {
+			return;
+		}
+
+		$info                    = $this->getInfo();
+		$data_handler_class_name = isset($info['data_handler_class_name']) ? $info['data_handler_class_name'] : '';
+		$data                    = isset($info['data']) && isset($info['data']['MSG_generation_data']) ? $info['data']['MSG_generation_data'] : array();
+		if ($data && $this->current()->STS_ID() === EEM_Message::status_incomplete) {
+			$this->current()->set_generation_data($data);
+			$this->current()->set_field_or_extra_meta('data_handler_class_name', $data_handler_class_name);
+		}
+	}
+
+
+	/**
+	 * This method returns a count of messages in the repository that have a given priority.
+	 *
+	 * @param int   $priority the priority that is being filtered for the count.
+	 * @param array $status   the optional status(es) that will also be filtered by when priority matches.
+	 * @return int  count of messages in the queue matching the conditions.
+	 */
+	public function count_by_priority_and_status($priority, $status = array())
+	{
+		if ( ! empty($status)) {
+			$status = is_array($status) ? $status : array($status);
+		}
+
+		$count = 0;
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current()->priority() === $priority && (($status && in_array($this->current()->STS_ID(),
+							$status)) || ! $status)
+			) {
+				$count++;
+			}
+			$this->next();
+		}
+		return $count;
+	}
+
+
+	/**
+	 * @return EE_Message
+	 */
+	public function current()
+	{
+		return parent::current();
+	}
 
 
 }
\ No newline at end of file

core/libraries/messages/EE_Messages_Queue.lib.php

Indentation +677 added lines, -677 removed lines

@@ -2,7 +2,7 @@ 
 use \EventEspresso\core\exceptions\SendMessageException;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -18,681 +18,681 @@ 
 {
 
 
-    /**
-     * @type    string  reference for sending action
-     */
-    const action_sending = 'sending';
-
-    /**
-     * @type    string  reference for generation action
-     */
-    const action_generating = 'generation';
-
-
-    /**
-     * @type EE_Message_Repository $_message_repository
-     */
-    protected $_message_repository;
-
-    /**
-     * Sets the limit of how many messages are generated per process.
-     *
-     * @type int
-     */
-    protected $_batch_count;
-
-    /**
-     * Sets the limit of how many messages can be sent per hour.
-     *
-     * @type int
-     */
-    protected $_rate_limit;
-
-    /**
-     * This is an array of cached queue items being stored in this object.
-     * The array keys will be the ID of the EE_Message in the db if saved.  If the EE_Message
-     * is not saved to the db then its key will be an increment of "UNS" (i.e. UNS1, UNS2 etc.)
-     *
-     * @type EE_Message[]
-     */
-    protected $_cached_queue_items;
-
-    /**
-     * Tracks the number of unsaved queue items.
-     *
-     * @type int
-     */
-    protected $_unsaved_count = 0;
-
-    /**
-     * used to record if a do_messenger_hooks has already been called for a message type.  This prevents multiple
-     * hooks getting fired if users have setup their action/filter hooks to prevent duplicate calls.
-     *
-     * @type array
-     */
-    protected $_did_hook = array();
-
-
-    /**
-     * Constructor.
-     * Setup all the initial properties and load a EE_Message_Repository.
-     *
-     * @param \EE_Message_Repository $message_repository
-     */
-    public function __construct(EE_Message_Repository $message_repository)
-    {
-        $this->_batch_count        = apply_filters('FHEE__EE_Messages_Queue___batch_count', 50);
-        $this->_rate_limit         = $this->get_rate_limit();
-        $this->_message_repository = $message_repository;
-    }
-
-
-    /**
-     * Add a EE_Message object to the queue
-     *
-     * @param EE_Message $message
-     * @param array      $data         This will be an array of data to attach to the object in the repository.  If the
-     *                                 object is persisted, this data will be saved on an extra_meta object related to
-     *                                 EE_Message.
-     * @param  bool      $preview      Whether this EE_Message represents a preview or not.
-     * @param  bool      $test_send    This indicates whether to do a test send instead of actual send. A test send will
-     *                                 use the messenger send method but typically is based on preview data.
-     * @return bool          Whether the message was successfully added to the repository or not.
-     */
-    public function add(EE_Message $message, $data = array(), $preview = false, $test_send = false)
-    {
-        $data['preview']   = $preview;
-        $data['test_send'] = $test_send;
-        return $this->_message_repository->add($message, $data);
-    }
-
-
-    /**
-     * Removes EE_Message from _queue that matches the given EE_Message if the pointer is on a matching EE_Message
-     *
-     * @param EE_Message $message The message to detach from the queue
-     * @param bool       $persist This flag indicates whether to attempt to delete the object from the db as well.
-     * @return bool
-     */
-    public function remove(EE_Message $message, $persist = false)
-    {
-        if ($persist && $this->_message_repository->current() !== $message) {
-            //get pointer on right message
-            if ($this->_message_repository->has($message)) {
-                $this->_message_repository->rewind();
-                while ($this->_message_repository->valid()) {
-                    if ($this->_message_repository->current() === $message) {
-                        break;
-                    }
-                    $this->_message_repository->next();
-                }
-            } else {
-                return false;
-            }
-        }
-        return $persist ? $this->_message_repository->delete() : $this->_message_repository->remove($message);
-    }
-
-
-    /**
-     * Persists all queued EE_Message objects to the db.
-     *
-     * @param bool $do_hooks_only       @see EE_Message_Repository::saveAll
-     * @return array @see EE_Messages_Repository::saveAll() for return values.
-     */
-    public function save($do_hooks_only = false)
-    {
-        return $this->_message_repository->saveAll($do_hooks_only);
-    }
-
-
-    /**
-     * @return EE_Message_Repository
-     */
-    public function get_message_repository()
-    {
-        return $this->_message_repository;
-    }
-
-
-    /**
-     * This does the following things:
-     * 1. Checks if there is a lock on generation (prevents race conditions).  If there is a lock then exits (return
-     * false).
-     * 2. If no lock, sets lock, then retrieves a batch of non-generated EE_Message objects and adds to queue
-     * 3. Returns bool.  True = batch ready.  False = no batch ready (or nothing available for generation).
-     * Note: Callers should make sure they release the lock otherwise batch generation will be prevented from
-     * continuing. The lock is on a transient that is set to expire after one hour as a fallback in case locks are not
-     * removed.
-     *
-     * @return bool  true if successfully retrieved batch, false no batch ready.
-     */
-    public function get_batch_to_generate()
-    {
-        if ($this->is_locked(EE_Messages_Queue::action_generating)) {
-            return false;
-        }
-
-        //lock batch generation to prevent race conditions.
-        $this->lock_queue(EE_Messages_Queue::action_generating);
-
-        $query_args = array(
-            // key 0 = where conditions
-            0          => array('STS_ID' => EEM_Message::status_incomplete),
-            'order_by' => $this->_get_priority_orderby(),
-            'limit'    => $this->_batch_count,
-        );
-        $messages   = EEM_Message::instance()->get_all($query_args);
-
-        if ( ! $messages) {
-            return false; //nothing to generate
-        }
-
-        foreach ($messages as $message) {
-            if ($message instanceof EE_Message) {
-                $data = $message->all_extra_meta_array();
-                $this->add($message, $data);
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This does the following things:
-     * 1. Checks if there is a lock on sending (prevents race conditions).  If there is a lock then exits (return
-     * false).
-     * 2. Grabs the allowed number of messages to send for the rate_limit.  If cannot send any more messages, then
-     * return false.
-     * 2. If no lock, sets lock, then retrieves a batch of EE_Message objects, adds to queue and triggers execution.
-     * 3. On success or unsuccessful send, sets status appropriately.
-     * 4. Saves messages via the queue
-     * 5. Releases lock.
-     *
-     * @return bool  true on success, false if something preventing sending (i.e. lock set).  Note: true does not
-     *               necessarily mean that all messages were successfully sent.  It just means that this method
-     *               successfully completed. On true, client may want to call $this->count_STS_in_queue(
-     *               EEM_Message::status_failed ) to see if any failed EE_Message objects.  Each failed message object
-     *               will also have a saved error message on it to assist with notifying user.
-     */
-    public function get_to_send_batch_and_send()
-    {
-        if ($this->is_locked(EE_Messages_Queue::action_sending) || $this->_rate_limit < 1) {
-            return false;
-        }
-
-        $this->lock_queue(EE_Messages_Queue::action_sending);
-
-        $batch = $this->_batch_count < $this->_rate_limit ? $this->_batch_count : $this->_rate_limit;
-
-        $query_args = array(
-            // key 0 = where conditions
-            0          => array('STS_ID' => array('IN', EEM_Message::instance()->stati_indicating_to_send())),
-            'order_by' => $this->_get_priority_orderby(),
-            'limit'    => $batch,
-        );
-
-        $messages_to_send = EEM_Message::instance()->get_all($query_args);
-
-
-        //any to send?
-        if ( ! $messages_to_send) {
-            $this->unlock_queue(EE_Messages_Queue::action_sending);
-            return false;
-        }
-
-        //add to queue.
-        foreach ($messages_to_send as $message) {
-            if ($message instanceof EE_Message) {
-                $this->add($message);
-            }
-        }
-
-        //send messages  (this also updates the rate limit)
-        $this->execute();
-
-        //release lock
-        $this->unlock_queue(EE_Messages_Queue::action_sending);
-        return true;
-    }
-
-
-    /**
-     * Locks the queue so that no other queues can call the "batch" methods.
-     *
-     * @param   string $type The type of queue being locked.
-     */
-    public function lock_queue($type = EE_Messages_Queue::action_generating)
-    {
-        set_transient($this->_get_lock_key($type), 1, $this->_get_lock_expiry($type));
-    }
-
-
-    /**
-     * Unlocks the queue so that batch methods can be used.
-     *
-     * @param   string $type The type of queue being unlocked.
-     */
-    public function unlock_queue($type = EE_Messages_Queue::action_generating)
-    {
-        delete_transient($this->_get_lock_key($type));
-    }
-
-
-    /**
-     * Retrieve the key used for the lock transient.
-     *
-     * @param string $type The type of lock.
-     * @return string
-     */
-    protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
-    {
-        return '_ee_lock_' . $type;
-    }
-
-
-    /**
-     * Retrieve the expiry time for the lock transient.
-     *
-     * @param string $type The type of lock
-     * @return int   time to expiry in seconds.
-     */
-    protected function _get_lock_expiry($type = EE_Messages_Queue::action_generating)
-    {
-        return (int)apply_filters('FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type);
-    }
-
-
-    /**
-     * Returns the key used for rate limit transient.
-     *
-     * @return string
-     */
-    protected function _get_rate_limit_key()
-    {
-        return '_ee_rate_limit';
-    }
-
-
-    /**
-     * Returns the rate limit expiry time.
-     *
-     * @return int
-     */
-    protected function _get_rate_limit_expiry()
-    {
-        return (int)apply_filters('FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS);
-    }
-
-
-    /**
-     * Returns the default rate limit for sending messages.
-     *
-     * @return int
-     */
-    protected function _default_rate_limit()
-    {
-        return (int)apply_filters('FHEE__EE_Messages_Queue___rate_limit', 200);
-    }
-
-
-    /**
-     * Return the orderby array for priority.
-     *
-     * @return array
-     */
-    protected function _get_priority_orderby()
-    {
-        return array(
-            'MSG_priority' => 'ASC',
-            'MSG_modified' => 'DESC',
-        );
-    }
-
-
-    /**
-     * Returns whether batch methods are "locked" or not.
-     *
-     * @param  string $type The type of lock being checked for.
-     * @return bool
-     */
-    public function is_locked($type = EE_Messages_Queue::action_generating)
-    {
-        /**
-         * This filters the default is_locked behaviour.
-         */
-        $is_locked = filter_var(
-            apply_filters(
-                'FHEE__EE_Messages_Queue__is_locked',
-                get_transient($this->_get_lock_key($type)),
-                $this
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-
-        /**
-         * @see usage of this filter in EE_Messages_Queue::initiate_request_by_priority() method.
-         *            Also implemented here because messages processed on the same request should not have any locks applied.
-         */
-        if (
-            apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            $is_locked = false;
-        }
-
-
-        return $is_locked;
-    }
-
-
-    /**
-     * Retrieves the rate limit that may be cached as a transient.
-     * If the rate limit is not set, then this sets the default rate limit and expiry and returns it.
-     *
-     * @return int
-     */
-    public function get_rate_limit()
-    {
-        if ( ! $rate_limit = get_transient($this->_get_rate_limit_key())) {
-            $rate_limit = $this->_default_rate_limit();
-            set_transient($this->_get_rate_limit_key(), $rate_limit, $this->_get_rate_limit_key());
-        }
-        return $rate_limit;
-    }
-
-
-    /**
-     * This updates existing rate limit with the new limit which is the old minus the batch.
-     *
-     * @param int $batch_completed This sets the new rate limit based on the given batch that was completed.
-     */
-    public function set_rate_limit($batch_completed)
-    {
-        //first get the most up to date rate limit (in case its expired and reset)
-        $rate_limit = $this->get_rate_limit();
-        $new_limit  = $rate_limit - $batch_completed;
-        //updating the transient option directly to avoid resetting the expiry.
-        update_option('_transient_' . $this->_get_rate_limit_key(), $new_limit);
-    }
-
-
-    /**
-     * This method checks the queue for ANY EE_Message objects with a priority matching the given priority passed in.
-     * If that exists, then we immediately initiate a non-blocking request to do the requested action type.
-     * Note: Keep in mind that there is the possibility that the request will not execute if there is already another
-     * request running on a queue for the given task.
-     *
-     * @param string $task     This indicates what type of request is going to be initiated.
-     * @param int    $priority This indicates the priority that triggers initiating the request.
-     */
-    public function initiate_request_by_priority($task = 'generate', $priority = EEM_Message::priority_high)
-    {
-        //determine what status is matched with the priority as part of the trigger conditions.
-        $status = $task == 'generate'
-            ? EEM_Message::status_incomplete
-            : EEM_Message::instance()->stati_indicating_to_send();
-        // always make sure we save because either this will get executed immediately on a separate request
-        // or remains in the queue for the regularly scheduled queue batch.
-        $this->save();
-        /**
-         * This filter/option allows users to override processing of messages on separate requests and instead have everything
-         * happen on the same request.  If this is utilized remember:
-         * - message priorities don't matter
-         * - existing unprocessed messages in the queue will not get processed unless manually triggered.
-         * - things will be perceived to take longer to happen for end users (i.e. registrations) because of the additional
-         *   processing happening on the same request.
-         * - any race condition protection (locks) are removed because they don't apply when things are processed on
-         *   the same request.
-         */
-        if (
-            apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            $messages_processor = EE_Registry::instance()->load_lib('Messages_Processor');
-            if ($messages_processor instanceof EE_Messages_Processor) {
-                return $messages_processor->process_immediately_from_queue($this);
-            }
-            //if we get here then that means the messages processor couldn't be loaded so messages will just remain
-            //queued for manual triggering by end user.
-        }
-
-        if ($this->_message_repository->count_by_priority_and_status($priority, $status)) {
-            EE_Messages_Scheduler::initiate_scheduled_non_blocking_request($task);
-        }
-    }
-
-
-    /**
-     *  Loops through the EE_Message objects in the _queue and calls the messenger send methods for each message.
-     *
-     * @param   bool     $save                    Used to indicate whether to save the message queue after sending
-     *                                            (default will save).
-     * @param   mixed    $sending_messenger       (optional) When the sending messenger is different than
-     *                                            what is on the EE_Message object in the queue.
-     *                                            For instance, showing the browser view of an email message,
-     *                                            or giving a pdf generated view of an html document.
-     *                                            This should be an instance of EE_messenger but if you call this
-     *                                            method
-     *                                            intending it to be a sending messenger but a valid one could not be
-     *                                            retrieved then send in an instance of EE_Error that contains the
-     *                                            related error message.
-     * @param   bool|int $by_priority             When set, this indicates that only messages
-     *                                            matching the given priority should be executed.
-     * @return int        Number of messages sent.  Note, 0 does not mean that no messages were processed.
-     *                                            Also, if the messenger is an request type messenger (or a preview),
-     *                                            its entirely possible that the messenger will exit before
-     */
-    public function execute($save = true, $sending_messenger = null, $by_priority = false)
-    {
-        $messages_sent   = 0;
-        $this->_did_hook = array();
-        $this->_message_repository->rewind();
-
-        while ($this->_message_repository->valid()) {
-            $error_messages = array();
-            /** @type EE_Message $message */
-            $message = $this->_message_repository->current();
-            //only process things that are queued for sending
-            if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
-                $this->_message_repository->next();
-                continue;
-            }
-            //if $by_priority is set and does not match then continue;
-            if ($by_priority && $by_priority != $message->priority()) {
-                $this->_message_repository->next();
-                continue;
-            }
-            //error checking
-            if (! $message->valid_messenger()) {
-                $error_messages[] = sprintf(
-                    __('The %s messenger is not active at time of sending.', 'event_espresso'),
-                    $message->messenger()
-                );
-            }
-            if (! $message->valid_message_type()) {
-                $error_messages[] = sprintf(
-                    __('The %s message type is not active at the time of sending.', 'event_espresso'),
-                    $message->message_type()
-                );
-            }
-            // if there was supposed to be a sending messenger for this message, but it was invalid/inactive,
-            // then it will instead be an EE_Error object, so let's check for that
-            if ($sending_messenger instanceof EE_Error) {
-                $error_messages[] = $sending_messenger->getMessage();
-            }
-            // if there are no errors, then let's process the message
-            if (empty($error_messages)) {
-                if ($save) {
-                    $message->set_messenger_is_executing();
-                }
-                if ($this->_process_message($message, $sending_messenger)) {
-                    $messages_sent++;
-                }
-            }
-            $this->_set_error_message($message, $error_messages);
-            //add modified time
-            $message->set_modified(time());
-            //we save each message after its processed to make sure its status persists in case PHP times-out or runs
-            //out of memory. @see https://events.codebasehq.com/projects/event-espresso/tickets/10281
-            if ($save) {
-                $message->save();
-            }
-
-            $this->_message_repository->next();
-        }
-        if ($save) {
-            $this->save(true);
-        }
-        return $messages_sent;
-    }
-
-
-    /**
-     * _process_message
-     *
-     * @param EE_Message $message
-     * @param mixed      $sending_messenger (optional)
-     * @return bool
-     */
-    protected function _process_message(EE_Message $message, $sending_messenger = null)
-    {
-        // these *should* have been validated in the execute() method above
-        $messenger    = $message->messenger_object();
-        $message_type = $message->message_type_object();
-        //do actions for sending messenger if it differs from generating messenger and swap values.
-        if (
-            $sending_messenger instanceof EE_messenger
-            && $messenger instanceof EE_messenger
-            && $sending_messenger->name != $messenger->name
-        ) {
-            $messenger->do_secondary_messenger_hooks($sending_messenger->name);
-            $messenger = $sending_messenger;
-        }
-        // send using messenger, but double check objects
-        if ($messenger instanceof EE_messenger && $message_type instanceof EE_message_type) {
-            //set hook for message type (but only if not using another messenger to send).
-            if ( ! isset($this->_did_hook[$message_type->name])) {
-                $message_type->do_messenger_hooks($messenger);
-                $this->_did_hook[$message_type->name] = 1;
-            }
-            //if preview then use preview method
-            return $this->_message_repository->is_preview()
-                ? $this->_do_preview($message, $messenger, $message_type, $this->_message_repository->is_test_send())
-                : $this->_do_send($message, $messenger, $message_type);
-        }
-        return false;
-    }
-
-
-    /**
-     * The intention of this method is to count how many EE_Message objects
-     * are in the queue with a given status.
-     * Example usage:
-     * After a caller calls the "EE_Message_Queue::execute()" method, the caller can check if there were any failed
-     * sends by calling $queue->count_STS_in_queue( EEM_Message_Queue::status_failed ).
-     *
-     * @param array $status Stati to check for in queue
-     * @return int  Count of EE_Message's matching the given status.
-     */
-    public function count_STS_in_queue($status)
-    {
-        $count  = 0;
-        $status = is_array($status) ? $status : array($status);
-        $this->_message_repository->rewind();
-        foreach ($this->_message_repository as $message) {
-            if (in_array($message->STS_ID(), $status)) {
-                $count++;
-            }
-        }
-        return $count;
-    }
-
-
-    /**
-     * Executes the get_preview method on the provided messenger.
-     *
-     * @param EE_Message      $message
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @param                 $test_send
-     * @return bool   true means all went well, false means, not so much.
-     */
-    protected function _do_preview(
-        EE_Message $message,
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $test_send
-    ) {
-        if ($preview = $messenger->get_preview($message, $message_type, $test_send)) {
-            if ( ! $test_send) {
-                $message->set_content($preview);
-            }
-            $message->set_STS_ID(EEM_Message::status_sent);
-            return true;
-        } else {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            return false;
-        }
-    }
-
-
-    /**
-     * Executes the send method on the provided messenger
-     * EE_Messengers are expected to:
-     * - return true if the send was successful.
-     * - return false if the send was unsuccessful but can be tried again.
-     * - throw an Exception if the send was unsuccessful and cannot be tried again.
-     *
-     * @param EE_Message      $message
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @return bool true means all went well, false means, not so much.
-     */
-    protected function _do_send(EE_Message $message, EE_messenger $messenger, EE_message_type $message_type)
-    {
-        try {
-            if ($messenger->send_message($message, $message_type)) {
-                $message->set_STS_ID(EEM_Message::status_sent);
-                return true;
-            } else {
-                $message->set_STS_ID(EEM_Message::status_retry);
-                return false;
-            }
-        } catch (SendMessageException $e) {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            $message->set_error_message($e->getMessage());
-            return false;
-        }
-    }
-
-
-    /**
-     * This sets any necessary error messages on the message object and its status to failed.
-     *
-     * @param EE_Message $message
-     * @param array      $error_messages the response from the messenger.
-     */
-    protected function _set_error_message(EE_Message $message, $error_messages)
-    {
-        $error_messages = (array)$error_messages;
-        if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_failed_sending())) {
-            $notices          = EE_Error::has_notices();
-            $error_messages[] = __(
-                'Messenger and Message Type were valid and active, but the messenger send method failed.',
-                'event_espresso'
-            );
-            if ($notices === 1) {
-                $notices           = EE_Error::get_vanilla_notices();
-                $notices['errors'] = isset($notices['errors']) ? $notices['errors'] : array();
-                $error_messages[]  = implode("\n", $notices['errors']);
-            }
-        }
-        if (count($error_messages) > 0) {
-            $msg = __('Message was not executed successfully.', 'event_espresso');
-            $msg = $msg . "\n" . implode("\n", $error_messages);
-            $message->set_error_message($msg);
-        }
-    }
+	/**
+	 * @type    string  reference for sending action
+	 */
+	const action_sending = 'sending';
+
+	/**
+	 * @type    string  reference for generation action
+	 */
+	const action_generating = 'generation';
+
+
+	/**
+	 * @type EE_Message_Repository $_message_repository
+	 */
+	protected $_message_repository;
+
+	/**
+	 * Sets the limit of how many messages are generated per process.
+	 *
+	 * @type int
+	 */
+	protected $_batch_count;
+
+	/**
+	 * Sets the limit of how many messages can be sent per hour.
+	 *
+	 * @type int
+	 */
+	protected $_rate_limit;
+
+	/**
+	 * This is an array of cached queue items being stored in this object.
+	 * The array keys will be the ID of the EE_Message in the db if saved.  If the EE_Message
+	 * is not saved to the db then its key will be an increment of "UNS" (i.e. UNS1, UNS2 etc.)
+	 *
+	 * @type EE_Message[]
+	 */
+	protected $_cached_queue_items;
+
+	/**
+	 * Tracks the number of unsaved queue items.
+	 *
+	 * @type int
+	 */
+	protected $_unsaved_count = 0;
+
+	/**
+	 * used to record if a do_messenger_hooks has already been called for a message type.  This prevents multiple
+	 * hooks getting fired if users have setup their action/filter hooks to prevent duplicate calls.
+	 *
+	 * @type array
+	 */
+	protected $_did_hook = array();
+
+
+	/**
+	 * Constructor.
+	 * Setup all the initial properties and load a EE_Message_Repository.
+	 *
+	 * @param \EE_Message_Repository $message_repository
+	 */
+	public function __construct(EE_Message_Repository $message_repository)
+	{
+		$this->_batch_count        = apply_filters('FHEE__EE_Messages_Queue___batch_count', 50);
+		$this->_rate_limit         = $this->get_rate_limit();
+		$this->_message_repository = $message_repository;
+	}
+
+
+	/**
+	 * Add a EE_Message object to the queue
+	 *
+	 * @param EE_Message $message
+	 * @param array      $data         This will be an array of data to attach to the object in the repository.  If the
+	 *                                 object is persisted, this data will be saved on an extra_meta object related to
+	 *                                 EE_Message.
+	 * @param  bool      $preview      Whether this EE_Message represents a preview or not.
+	 * @param  bool      $test_send    This indicates whether to do a test send instead of actual send. A test send will
+	 *                                 use the messenger send method but typically is based on preview data.
+	 * @return bool          Whether the message was successfully added to the repository or not.
+	 */
+	public function add(EE_Message $message, $data = array(), $preview = false, $test_send = false)
+	{
+		$data['preview']   = $preview;
+		$data['test_send'] = $test_send;
+		return $this->_message_repository->add($message, $data);
+	}
+
+
+	/**
+	 * Removes EE_Message from _queue that matches the given EE_Message if the pointer is on a matching EE_Message
+	 *
+	 * @param EE_Message $message The message to detach from the queue
+	 * @param bool       $persist This flag indicates whether to attempt to delete the object from the db as well.
+	 * @return bool
+	 */
+	public function remove(EE_Message $message, $persist = false)
+	{
+		if ($persist && $this->_message_repository->current() !== $message) {
+			//get pointer on right message
+			if ($this->_message_repository->has($message)) {
+				$this->_message_repository->rewind();
+				while ($this->_message_repository->valid()) {
+					if ($this->_message_repository->current() === $message) {
+						break;
+					}
+					$this->_message_repository->next();
+				}
+			} else {
+				return false;
+			}
+		}
+		return $persist ? $this->_message_repository->delete() : $this->_message_repository->remove($message);
+	}
+
+
+	/**
+	 * Persists all queued EE_Message objects to the db.
+	 *
+	 * @param bool $do_hooks_only       @see EE_Message_Repository::saveAll
+	 * @return array @see EE_Messages_Repository::saveAll() for return values.
+	 */
+	public function save($do_hooks_only = false)
+	{
+		return $this->_message_repository->saveAll($do_hooks_only);
+	}
+
+
+	/**
+	 * @return EE_Message_Repository
+	 */
+	public function get_message_repository()
+	{
+		return $this->_message_repository;
+	}
+
+
+	/**
+	 * This does the following things:
+	 * 1. Checks if there is a lock on generation (prevents race conditions).  If there is a lock then exits (return
+	 * false).
+	 * 2. If no lock, sets lock, then retrieves a batch of non-generated EE_Message objects and adds to queue
+	 * 3. Returns bool.  True = batch ready.  False = no batch ready (or nothing available for generation).
+	 * Note: Callers should make sure they release the lock otherwise batch generation will be prevented from
+	 * continuing. The lock is on a transient that is set to expire after one hour as a fallback in case locks are not
+	 * removed.
+	 *
+	 * @return bool  true if successfully retrieved batch, false no batch ready.
+	 */
+	public function get_batch_to_generate()
+	{
+		if ($this->is_locked(EE_Messages_Queue::action_generating)) {
+			return false;
+		}
+
+		//lock batch generation to prevent race conditions.
+		$this->lock_queue(EE_Messages_Queue::action_generating);
+
+		$query_args = array(
+			// key 0 = where conditions
+			0          => array('STS_ID' => EEM_Message::status_incomplete),
+			'order_by' => $this->_get_priority_orderby(),
+			'limit'    => $this->_batch_count,
+		);
+		$messages   = EEM_Message::instance()->get_all($query_args);
+
+		if ( ! $messages) {
+			return false; //nothing to generate
+		}
+
+		foreach ($messages as $message) {
+			if ($message instanceof EE_Message) {
+				$data = $message->all_extra_meta_array();
+				$this->add($message, $data);
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This does the following things:
+	 * 1. Checks if there is a lock on sending (prevents race conditions).  If there is a lock then exits (return
+	 * false).
+	 * 2. Grabs the allowed number of messages to send for the rate_limit.  If cannot send any more messages, then
+	 * return false.
+	 * 2. If no lock, sets lock, then retrieves a batch of EE_Message objects, adds to queue and triggers execution.
+	 * 3. On success or unsuccessful send, sets status appropriately.
+	 * 4. Saves messages via the queue
+	 * 5. Releases lock.
+	 *
+	 * @return bool  true on success, false if something preventing sending (i.e. lock set).  Note: true does not
+	 *               necessarily mean that all messages were successfully sent.  It just means that this method
+	 *               successfully completed. On true, client may want to call $this->count_STS_in_queue(
+	 *               EEM_Message::status_failed ) to see if any failed EE_Message objects.  Each failed message object
+	 *               will also have a saved error message on it to assist with notifying user.
+	 */
+	public function get_to_send_batch_and_send()
+	{
+		if ($this->is_locked(EE_Messages_Queue::action_sending) || $this->_rate_limit < 1) {
+			return false;
+		}
+
+		$this->lock_queue(EE_Messages_Queue::action_sending);
+
+		$batch = $this->_batch_count < $this->_rate_limit ? $this->_batch_count : $this->_rate_limit;
+
+		$query_args = array(
+			// key 0 = where conditions
+			0          => array('STS_ID' => array('IN', EEM_Message::instance()->stati_indicating_to_send())),
+			'order_by' => $this->_get_priority_orderby(),
+			'limit'    => $batch,
+		);
+
+		$messages_to_send = EEM_Message::instance()->get_all($query_args);
+
+
+		//any to send?
+		if ( ! $messages_to_send) {
+			$this->unlock_queue(EE_Messages_Queue::action_sending);
+			return false;
+		}
+
+		//add to queue.
+		foreach ($messages_to_send as $message) {
+			if ($message instanceof EE_Message) {
+				$this->add($message);
+			}
+		}
+
+		//send messages  (this also updates the rate limit)
+		$this->execute();
+
+		//release lock
+		$this->unlock_queue(EE_Messages_Queue::action_sending);
+		return true;
+	}
+
+
+	/**
+	 * Locks the queue so that no other queues can call the "batch" methods.
+	 *
+	 * @param   string $type The type of queue being locked.
+	 */
+	public function lock_queue($type = EE_Messages_Queue::action_generating)
+	{
+		set_transient($this->_get_lock_key($type), 1, $this->_get_lock_expiry($type));
+	}
+
+
+	/**
+	 * Unlocks the queue so that batch methods can be used.
+	 *
+	 * @param   string $type The type of queue being unlocked.
+	 */
+	public function unlock_queue($type = EE_Messages_Queue::action_generating)
+	{
+		delete_transient($this->_get_lock_key($type));
+	}
+
+
+	/**
+	 * Retrieve the key used for the lock transient.
+	 *
+	 * @param string $type The type of lock.
+	 * @return string
+	 */
+	protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
+	{
+		return '_ee_lock_' . $type;
+	}
+
+
+	/**
+	 * Retrieve the expiry time for the lock transient.
+	 *
+	 * @param string $type The type of lock
+	 * @return int   time to expiry in seconds.
+	 */
+	protected function _get_lock_expiry($type = EE_Messages_Queue::action_generating)
+	{
+		return (int)apply_filters('FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type);
+	}
+
+
+	/**
+	 * Returns the key used for rate limit transient.
+	 *
+	 * @return string
+	 */
+	protected function _get_rate_limit_key()
+	{
+		return '_ee_rate_limit';
+	}
+
+
+	/**
+	 * Returns the rate limit expiry time.
+	 *
+	 * @return int
+	 */
+	protected function _get_rate_limit_expiry()
+	{
+		return (int)apply_filters('FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS);
+	}
+
+
+	/**
+	 * Returns the default rate limit for sending messages.
+	 *
+	 * @return int
+	 */
+	protected function _default_rate_limit()
+	{
+		return (int)apply_filters('FHEE__EE_Messages_Queue___rate_limit', 200);
+	}
+
+
+	/**
+	 * Return the orderby array for priority.
+	 *
+	 * @return array
+	 */
+	protected function _get_priority_orderby()
+	{
+		return array(
+			'MSG_priority' => 'ASC',
+			'MSG_modified' => 'DESC',
+		);
+	}
+
+
+	/**
+	 * Returns whether batch methods are "locked" or not.
+	 *
+	 * @param  string $type The type of lock being checked for.
+	 * @return bool
+	 */
+	public function is_locked($type = EE_Messages_Queue::action_generating)
+	{
+		/**
+		 * This filters the default is_locked behaviour.
+		 */
+		$is_locked = filter_var(
+			apply_filters(
+				'FHEE__EE_Messages_Queue__is_locked',
+				get_transient($this->_get_lock_key($type)),
+				$this
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+
+		/**
+		 * @see usage of this filter in EE_Messages_Queue::initiate_request_by_priority() method.
+		 *            Also implemented here because messages processed on the same request should not have any locks applied.
+		 */
+		if (
+			apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			$is_locked = false;
+		}
+
+
+		return $is_locked;
+	}
+
+
+	/**
+	 * Retrieves the rate limit that may be cached as a transient.
+	 * If the rate limit is not set, then this sets the default rate limit and expiry and returns it.
+	 *
+	 * @return int
+	 */
+	public function get_rate_limit()
+	{
+		if ( ! $rate_limit = get_transient($this->_get_rate_limit_key())) {
+			$rate_limit = $this->_default_rate_limit();
+			set_transient($this->_get_rate_limit_key(), $rate_limit, $this->_get_rate_limit_key());
+		}
+		return $rate_limit;
+	}
+
+
+	/**
+	 * This updates existing rate limit with the new limit which is the old minus the batch.
+	 *
+	 * @param int $batch_completed This sets the new rate limit based on the given batch that was completed.
+	 */
+	public function set_rate_limit($batch_completed)
+	{
+		//first get the most up to date rate limit (in case its expired and reset)
+		$rate_limit = $this->get_rate_limit();
+		$new_limit  = $rate_limit - $batch_completed;
+		//updating the transient option directly to avoid resetting the expiry.
+		update_option('_transient_' . $this->_get_rate_limit_key(), $new_limit);
+	}
+
+
+	/**
+	 * This method checks the queue for ANY EE_Message objects with a priority matching the given priority passed in.
+	 * If that exists, then we immediately initiate a non-blocking request to do the requested action type.
+	 * Note: Keep in mind that there is the possibility that the request will not execute if there is already another
+	 * request running on a queue for the given task.
+	 *
+	 * @param string $task     This indicates what type of request is going to be initiated.
+	 * @param int    $priority This indicates the priority that triggers initiating the request.
+	 */
+	public function initiate_request_by_priority($task = 'generate', $priority = EEM_Message::priority_high)
+	{
+		//determine what status is matched with the priority as part of the trigger conditions.
+		$status = $task == 'generate'
+			? EEM_Message::status_incomplete
+			: EEM_Message::instance()->stati_indicating_to_send();
+		// always make sure we save because either this will get executed immediately on a separate request
+		// or remains in the queue for the regularly scheduled queue batch.
+		$this->save();
+		/**
+		 * This filter/option allows users to override processing of messages on separate requests and instead have everything
+		 * happen on the same request.  If this is utilized remember:
+		 * - message priorities don't matter
+		 * - existing unprocessed messages in the queue will not get processed unless manually triggered.
+		 * - things will be perceived to take longer to happen for end users (i.e. registrations) because of the additional
+		 *   processing happening on the same request.
+		 * - any race condition protection (locks) are removed because they don't apply when things are processed on
+		 *   the same request.
+		 */
+		if (
+			apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			$messages_processor = EE_Registry::instance()->load_lib('Messages_Processor');
+			if ($messages_processor instanceof EE_Messages_Processor) {
+				return $messages_processor->process_immediately_from_queue($this);
+			}
+			//if we get here then that means the messages processor couldn't be loaded so messages will just remain
+			//queued for manual triggering by end user.
+		}
+
+		if ($this->_message_repository->count_by_priority_and_status($priority, $status)) {
+			EE_Messages_Scheduler::initiate_scheduled_non_blocking_request($task);
+		}
+	}
+
+
+	/**
+	 *  Loops through the EE_Message objects in the _queue and calls the messenger send methods for each message.
+	 *
+	 * @param   bool     $save                    Used to indicate whether to save the message queue after sending
+	 *                                            (default will save).
+	 * @param   mixed    $sending_messenger       (optional) When the sending messenger is different than
+	 *                                            what is on the EE_Message object in the queue.
+	 *                                            For instance, showing the browser view of an email message,
+	 *                                            or giving a pdf generated view of an html document.
+	 *                                            This should be an instance of EE_messenger but if you call this
+	 *                                            method
+	 *                                            intending it to be a sending messenger but a valid one could not be
+	 *                                            retrieved then send in an instance of EE_Error that contains the
+	 *                                            related error message.
+	 * @param   bool|int $by_priority             When set, this indicates that only messages
+	 *                                            matching the given priority should be executed.
+	 * @return int        Number of messages sent.  Note, 0 does not mean that no messages were processed.
+	 *                                            Also, if the messenger is an request type messenger (or a preview),
+	 *                                            its entirely possible that the messenger will exit before
+	 */
+	public function execute($save = true, $sending_messenger = null, $by_priority = false)
+	{
+		$messages_sent   = 0;
+		$this->_did_hook = array();
+		$this->_message_repository->rewind();
+
+		while ($this->_message_repository->valid()) {
+			$error_messages = array();
+			/** @type EE_Message $message */
+			$message = $this->_message_repository->current();
+			//only process things that are queued for sending
+			if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
+				$this->_message_repository->next();
+				continue;
+			}
+			//if $by_priority is set and does not match then continue;
+			if ($by_priority && $by_priority != $message->priority()) {
+				$this->_message_repository->next();
+				continue;
+			}
+			//error checking
+			if (! $message->valid_messenger()) {
+				$error_messages[] = sprintf(
+					__('The %s messenger is not active at time of sending.', 'event_espresso'),
+					$message->messenger()
+				);
+			}
+			if (! $message->valid_message_type()) {
+				$error_messages[] = sprintf(
+					__('The %s message type is not active at the time of sending.', 'event_espresso'),
+					$message->message_type()
+				);
+			}
+			// if there was supposed to be a sending messenger for this message, but it was invalid/inactive,
+			// then it will instead be an EE_Error object, so let's check for that
+			if ($sending_messenger instanceof EE_Error) {
+				$error_messages[] = $sending_messenger->getMessage();
+			}
+			// if there are no errors, then let's process the message
+			if (empty($error_messages)) {
+				if ($save) {
+					$message->set_messenger_is_executing();
+				}
+				if ($this->_process_message($message, $sending_messenger)) {
+					$messages_sent++;
+				}
+			}
+			$this->_set_error_message($message, $error_messages);
+			//add modified time
+			$message->set_modified(time());
+			//we save each message after its processed to make sure its status persists in case PHP times-out or runs
+			//out of memory. @see https://events.codebasehq.com/projects/event-espresso/tickets/10281
+			if ($save) {
+				$message->save();
+			}
+
+			$this->_message_repository->next();
+		}
+		if ($save) {
+			$this->save(true);
+		}
+		return $messages_sent;
+	}
+
+
+	/**
+	 * _process_message
+	 *
+	 * @param EE_Message $message
+	 * @param mixed      $sending_messenger (optional)
+	 * @return bool
+	 */
+	protected function _process_message(EE_Message $message, $sending_messenger = null)
+	{
+		// these *should* have been validated in the execute() method above
+		$messenger    = $message->messenger_object();
+		$message_type = $message->message_type_object();
+		//do actions for sending messenger if it differs from generating messenger and swap values.
+		if (
+			$sending_messenger instanceof EE_messenger
+			&& $messenger instanceof EE_messenger
+			&& $sending_messenger->name != $messenger->name
+		) {
+			$messenger->do_secondary_messenger_hooks($sending_messenger->name);
+			$messenger = $sending_messenger;
+		}
+		// send using messenger, but double check objects
+		if ($messenger instanceof EE_messenger && $message_type instanceof EE_message_type) {
+			//set hook for message type (but only if not using another messenger to send).
+			if ( ! isset($this->_did_hook[$message_type->name])) {
+				$message_type->do_messenger_hooks($messenger);
+				$this->_did_hook[$message_type->name] = 1;
+			}
+			//if preview then use preview method
+			return $this->_message_repository->is_preview()
+				? $this->_do_preview($message, $messenger, $message_type, $this->_message_repository->is_test_send())
+				: $this->_do_send($message, $messenger, $message_type);
+		}
+		return false;
+	}
+
+
+	/**
+	 * The intention of this method is to count how many EE_Message objects
+	 * are in the queue with a given status.
+	 * Example usage:
+	 * After a caller calls the "EE_Message_Queue::execute()" method, the caller can check if there were any failed
+	 * sends by calling $queue->count_STS_in_queue( EEM_Message_Queue::status_failed ).
+	 *
+	 * @param array $status Stati to check for in queue
+	 * @return int  Count of EE_Message's matching the given status.
+	 */
+	public function count_STS_in_queue($status)
+	{
+		$count  = 0;
+		$status = is_array($status) ? $status : array($status);
+		$this->_message_repository->rewind();
+		foreach ($this->_message_repository as $message) {
+			if (in_array($message->STS_ID(), $status)) {
+				$count++;
+			}
+		}
+		return $count;
+	}
+
+
+	/**
+	 * Executes the get_preview method on the provided messenger.
+	 *
+	 * @param EE_Message      $message
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @param                 $test_send
+	 * @return bool   true means all went well, false means, not so much.
+	 */
+	protected function _do_preview(
+		EE_Message $message,
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$test_send
+	) {
+		if ($preview = $messenger->get_preview($message, $message_type, $test_send)) {
+			if ( ! $test_send) {
+				$message->set_content($preview);
+			}
+			$message->set_STS_ID(EEM_Message::status_sent);
+			return true;
+		} else {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			return false;
+		}
+	}
+
+
+	/**
+	 * Executes the send method on the provided messenger
+	 * EE_Messengers are expected to:
+	 * - return true if the send was successful.
+	 * - return false if the send was unsuccessful but can be tried again.
+	 * - throw an Exception if the send was unsuccessful and cannot be tried again.
+	 *
+	 * @param EE_Message      $message
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @return bool true means all went well, false means, not so much.
+	 */
+	protected function _do_send(EE_Message $message, EE_messenger $messenger, EE_message_type $message_type)
+	{
+		try {
+			if ($messenger->send_message($message, $message_type)) {
+				$message->set_STS_ID(EEM_Message::status_sent);
+				return true;
+			} else {
+				$message->set_STS_ID(EEM_Message::status_retry);
+				return false;
+			}
+		} catch (SendMessageException $e) {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			$message->set_error_message($e->getMessage());
+			return false;
+		}
+	}
+
+
+	/**
+	 * This sets any necessary error messages on the message object and its status to failed.
+	 *
+	 * @param EE_Message $message
+	 * @param array      $error_messages the response from the messenger.
+	 */
+	protected function _set_error_message(EE_Message $message, $error_messages)
+	{
+		$error_messages = (array)$error_messages;
+		if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_failed_sending())) {
+			$notices          = EE_Error::has_notices();
+			$error_messages[] = __(
+				'Messenger and Message Type were valid and active, but the messenger send method failed.',
+				'event_espresso'
+			);
+			if ($notices === 1) {
+				$notices           = EE_Error::get_vanilla_notices();
+				$notices['errors'] = isset($notices['errors']) ? $notices['errors'] : array();
+				$error_messages[]  = implode("\n", $notices['errors']);
+			}
+		}
+		if (count($error_messages) > 0) {
+			$msg = __('Message was not executed successfully.', 'event_espresso');
+			$msg = $msg . "\n" . implode("\n", $error_messages);
+			$message->set_error_message($msg);
+		}
+	}
 
 } //end EE_Messages_Queue class
\ No newline at end of file

Spacing +12 added lines, -12 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 use \EventEspresso\core\exceptions\SendMessageException;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -182,7 +182,7 @@ 
             'order_by' => $this->_get_priority_orderby(),
             'limit'    => $this->_batch_count,
         );
-        $messages   = EEM_Message::instance()->get_all($query_args);
+        $messages = EEM_Message::instance()->get_all($query_args);
 
         if ( ! $messages) {
             return false; //nothing to generate
@@ -287,7 +287,7 @@ 
      */
     protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
     {
-        return '_ee_lock_' . $type;
+        return '_ee_lock_'.$type;
     }
 
 
@@ -299,7 +299,7 @@ 
      */
     protected function _get_lock_expiry($type = EE_Messages_Queue::action_generating)
     {
-        return (int)apply_filters('FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type);
+        return (int) apply_filters('FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type);
     }
 
 
@@ -321,7 +321,7 @@ 
      */
     protected function _get_rate_limit_expiry()
     {
-        return (int)apply_filters('FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS);
+        return (int) apply_filters('FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS);
     }
 
 
@@ -332,7 +332,7 @@ 
      */
     protected function _default_rate_limit()
     {
-        return (int)apply_filters('FHEE__EE_Messages_Queue___rate_limit', 200);
+        return (int) apply_filters('FHEE__EE_Messages_Queue___rate_limit', 200);
     }
 
 
@@ -413,7 +413,7 @@ 
         $rate_limit = $this->get_rate_limit();
         $new_limit  = $rate_limit - $batch_completed;
         //updating the transient option directly to avoid resetting the expiry.
-        update_option('_transient_' . $this->_get_rate_limit_key(), $new_limit);
+        update_option('_transient_'.$this->_get_rate_limit_key(), $new_limit);
     }
 
 
@@ -494,7 +494,7 @@ 
             /** @type EE_Message $message */
             $message = $this->_message_repository->current();
             //only process things that are queued for sending
-            if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
+            if ( ! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
                 $this->_message_repository->next();
                 continue;
             }
@@ -504,13 +504,13 @@ 
                 continue;
             }
             //error checking
-            if (! $message->valid_messenger()) {
+            if ( ! $message->valid_messenger()) {
                 $error_messages[] = sprintf(
                     __('The %s messenger is not active at time of sending.', 'event_espresso'),
                     $message->messenger()
                 );
             }
-            if (! $message->valid_message_type()) {
+            if ( ! $message->valid_message_type()) {
                 $error_messages[] = sprintf(
                     __('The %s message type is not active at the time of sending.', 'event_espresso'),
                     $message->message_type()
@@ -675,7 +675,7 @@ 
      */
     protected function _set_error_message(EE_Message $message, $error_messages)
     {
-        $error_messages = (array)$error_messages;
+        $error_messages = (array) $error_messages;
         if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_failed_sending())) {
             $notices          = EE_Error::has_notices();
             $error_messages[] = __(
@@ -690,7 +690,7 @@ 
         }
         if (count($error_messages) > 0) {
             $msg = __('Message was not executed successfully.', 'event_espresso');
-            $msg = $msg . "\n" . implode("\n", $error_messages);
+            $msg = $msg."\n".implode("\n", $error_messages);
             $message->set_error_message($msg);
         }
     }

core/db_classes/EE_Message.class.php

Indentation +856 added lines, -856 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -12,865 +12,865 @@ 
 class EE_Message extends EE_Base_Class implements EEI_Admin_Links
 {
 
-    /**
-     * @deprecated 4.9.0  Added for backward compat with add-on's
-     * @type null
-     */
-    public $template_pack;
-
-    /**
-     * @deprecated 4.9.0 Added for backward compat with add-on's
-     * @type null
-     */
-    public $template_variation;
-
-    /**
-     * @deprecated 4.9.0 Added for backward compat with add-on's
-     * @type string
-     */
-    public $content = '';
-
-
-    /**
-     * @type EE_messenger $_messenger
-     */
-    protected $_messenger = null;
-
-    /**
-     * @type EE_message_type $_message_type
-     */
-    protected $_message_type = null;
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @param array  $date_formats incoming date formats in an array.  First value is the date_format, second is time
-     *                             format.
-     * @return EE_Message
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        //if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
-        if ( ! $has_object) {
-            EE_Registry::instance()->load_helper('URL');
-            $props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
-        }
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Gets MSG_token
-     *
-     * @return int
-     */
-    public function MSG_token()
-    {
-        return $this->get('MSG_token');
-    }
-
-
-    /**
-     * Sets MSG_token
-     *
-     * @param int $MSG_token
-     */
-    public function set_MSG_token($MSG_token)
-    {
-        $this->set('MSG_token', $MSG_token);
-    }
-
-
-    /**
-     * Gets GRP_ID
-     *
-     * @return int
-     */
-    public function GRP_ID()
-    {
-        return $this->get('GRP_ID');
-    }
-
-
-    /**
-     * Sets GRP_ID
-     *
-     * @param int $GRP_ID
-     */
-    public function set_GRP_ID($GRP_ID)
-    {
-        $this->set('GRP_ID', $GRP_ID);
-    }
-
-
-    /**
-     * Gets TXN_ID
-     *
-     * @return int
-     */
-    public function TXN_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * Sets TXN_ID
-     *
-     * @param int $TXN_ID
-     */
-    public function set_TXN_ID($TXN_ID)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     * Gets messenger
-     *
-     * @return string
-     */
-    public function messenger()
-    {
-        return $this->get('MSG_messenger');
-    }
-
-
-    /**
-     * Sets messenger
-     *
-     * @param string $messenger
-     */
-    public function set_messenger($messenger)
-    {
-        $this->set('MSG_messenger', $messenger);
-    }
-
-
-    /**
-     * Returns corresponding messenger object for the set messenger on this message
-     *
-     * @return EE_messenger | null
-     */
-    public function messenger_object()
-    {
-        return $this->_messenger;
-    }
-
-
-    /**
-     * Sets messenger
-     *
-     * @param EE_messenger $messenger
-     */
-    public function set_messenger_object(EE_messenger $messenger)
-    {
-        $this->_messenger = $messenger;
-    }
-
-
-    /**
-     * validates messenger
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function valid_messenger($throw_exceptions = false)
-    {
-        if ($this->_messenger instanceof EE_messenger) {
-            return true;
-        }
-        if ($throw_exceptions) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The "%1$s" messenger set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
-                        'event_espresso'
-                    ),
-                    $this->messenger()
-                )
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * This returns the set localized label for the messenger on this message.
-     * Note, if unable to retrieve the EE_messenger object then will just return the messenger slug saved
-     * with this message.
-     *
-     * @param   bool $plural whether to return the plural label or not.
-     * @return string
-     */
-    public function messenger_label($plural = false)
-    {
-        $label_type = $plural ? 'plural' : 'singular';
-        $messenger  = $this->messenger_object();
-        return $messenger instanceof EE_messenger ? $messenger->label[$label_type] : $this->messenger();
-    }
-
-
-    /**
-     * Gets message_type
-     *
-     * @return string
-     */
-    public function message_type()
-    {
-        return $this->get('MSG_message_type');
-    }
-
-
-    /**
-     * Sets message_type
-     *
-     * @param string $message_type
-     */
-    public function set_message_type($message_type)
-    {
-        $this->set('MSG_message_type', $message_type);
-    }
-
-
-    /**
-     * Returns the message type object for the set message type on this message
-     *
-     * @return EE_message_type | null
-     */
-    public function message_type_object()
-    {
-        return $this->_message_type;
-    }
-
-
-    /**
-     * Sets message_type
-     *
-     * @param EE_message_type $message_type
-     * @param bool            $set_priority   This indicates whether to set the priority to whatever the priority is on
-     *                                        the message type or not.
-     */
-    public function set_message_type_object(EE_message_type $message_type, $set_priority = false)
-    {
-        $this->_message_type = $message_type;
-        if ($set_priority) {
-            $this->set_priority($this->_message_type->get_priority());
-        }
-    }
-
-
-    /**
-     * validates message_type
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function valid_message_type($throw_exceptions = false)
-    {
-        if ($this->_message_type instanceof EE_message_type) {
-            return true;
-        }
-        if ($throw_exceptions) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The %1$s message type set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
-                        'event_espresso'
-                    ),
-                    $this->message_type()
-                )
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * validates messenger and message_type (that they are valid EE_messenger and EE_message_type objects).
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function is_valid($throw_exceptions = false)
-    {
-        if ($this->valid_messenger($throw_exceptions) && $this->valid_message_type($throw_exceptions)) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * This validates whether the internal messenger and message type objects are valid for sending.
-     * Three checks are done:
-     * 1. There is a valid messenger object.
-     * 2. There is a valid message type object.
-     * 3. The message type object is active for the messenger.
-     *
-     * @throws EE_Error  But only if $throw_exceptions is set to true.
-     * @param bool $throw_exceptions
-     * @return bool
-     */
-    public function is_valid_for_sending_or_generation($throw_exceptions = false)
-    {
-        $valid = false;
-        if ($this->is_valid($throw_exceptions)) {
-            /** @var EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            $valid                    = $message_resource_manager->is_message_type_active_for_messenger($this->messenger(),
-                $this->message_type());
-            if ( ! $valid && $throw_exceptions) {
-                throw new EE_Error(
-                    sprintf(
-                        __('The %1$s message type is not a valid message type for the %2$s messenger so it will not be sent.',
-                            'event_espresso'),
-                        $this->message_type(),
-                        $this->messenger()
-                    )
-                );
-            }
-        }
-        return $valid;
-    }
-
-
-    /**
-     * This returns the set localized label for the message type on this message.
-     * Note, if unable to retrieve the EE_message_type object then will just return the message type slug saved
-     * with this message.
-     *
-     * @param   bool $plural whether to return the plural label or not.
-     * @return string
-     */
-    public function message_type_label($plural = false)
-    {
-        $label_type   = $plural ? 'plural' : 'singular';
-        $message_type = $this->message_type_object();
-        return $message_type instanceof EE_message_type ? $message_type->label[$label_type] : $this->message_type();
-    }
-
-
-    /**
-     * Gets context
-     *
-     * @return string
-     */
-    public function context()
-    {
-        return $this->get('MSG_context');
-    }
-
-
-    /**
-     * This returns the corresponding localized label for the given context slug, if possible from installed message
-     * types. Otherwise, this will just return the set context slug on this object.
-     *
-     * @return string
-     */
-    public function context_label()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $contexts                 = $message_resource_manager->get_all_contexts();
-        return isset($contexts[$this->context()]) ? $contexts[$this->context()] : $this->context();
-    }
-
-
-    /**
-     * Sets context
-     *
-     * @param string $context
-     */
-    public function set_context($context)
-    {
-        $this->set('MSG_context', $context);
-    }
-
-
-    /**
-     * Gets recipient_ID
-     *
-     * @return int
-     */
-    public function recipient_ID()
-    {
-        return $this->get('MSG_recipient_ID');
-    }
-
-
-    /**
-     * Sets recipient_ID
-     *
-     * @param string $recipient_ID
-     */
-    public function set_recipient_ID($recipient_ID)
-    {
-        $this->set('MSG_recipient_ID', $recipient_ID);
-    }
-
-
-    /**
-     * Gets recipient_type
-     *
-     * @return string
-     */
-    public function recipient_type()
-    {
-        return $this->get('MSG_recipient_type');
-    }
-
-
-    /**
-     * Return the related object matching the recipient type and ID.
-     *
-     * @return EE_Base_Class | null
-     */
-    public function recipient_object()
-    {
-        if ( ! $this->recipient_type() || ! $this->recipient_ID()) {
-            return null;
-        }
-
-        return $this->get_first_related($this->recipient_type());
-    }
-
-
-    /**
-     * Sets recipient_type
-     *
-     * @param string $recipient_type
-     */
-    public function set_recipient_type($recipient_type)
-    {
-        $this->set('MSG_recipient_type', $recipient_type);
-    }
-
-
-    /**
-     * Gets content
-     *
-     * @return string
-     */
-    public function content()
-    {
-        return $this->get('MSG_content');
-    }
-
-
-    /**
-     * Sets content
-     *
-     * @param string $content
-     */
-    public function set_content($content)
-    {
-        $this->set('MSG_content', $content);
-    }
-
-
-    /**
-     * Gets subject
-     *
-     * @return string
-     */
-    public function subject()
-    {
-        return $this->get('MSG_subject');
-    }
-
-
-    /**
-     * Sets subject
-     *
-     * @param string $subject
-     */
-    public function set_subject($subject)
-    {
-        $this->set('MSG_subject', $subject);
-    }
-
-
-    /**
-     * Gets to
-     *
-     * @return string
-     */
-    public function to()
-    {
-        $to = $this->get('MSG_to');
-        return empty($to) ? __('No recipient', 'event_espresso') : $to;
-    }
-
-
-    /**
-     * Sets to
-     *
-     * @param string $to
-     */
-    public function set_to($to)
-    {
-        $this->set('MSG_to', $to);
-    }
-
-
-    /**
-     * Gets from
-     *
-     * @return string
-     */
-    public function from()
-    {
-        return $this->get('MSG_from');
-    }
-
-
-    /**
-     * Sets from
-     *
-     * @param string $from
-     */
-    public function set_from($from)
-    {
-        $this->set('MSG_from', $from);
-    }
-
-
-    /**
-     * Gets priority
-     *
-     * @return int
-     */
-    public function priority()
-    {
-        return $this->get('MSG_priority');
-    }
-
-
-    /**
-     * Sets priority
-     * Note.  Send Now Messengers always override any priority that may be set on a Message.  So
-     * this method calls the send_now method to verify that.
-     *
-     * @param int $priority
-     */
-    public function set_priority($priority)
-    {
-        $priority = $this->send_now() ? EEM_Message::priority_high : $priority;
-        parent::set('MSG_priority', $priority);
-    }
-
-
-    /**
-     * Overrides parent::set method so we can capture any sets for priority.
-     *
-     * @see parent::set() for phpdocs
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws EE_Error
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        if ($field_name === 'MSG_priority') {
-            $this->set_priority($field_value);
-        }
-        parent::set($field_name, $field_value, $use_default);
-    }
-
-
-    /**
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function send_now()
-    {
-        $send_now = $this->valid_messenger() && $this->messenger_object()->send_now() ? EEM_Message::priority_high : $this->priority();
-        return $send_now === EEM_Message::priority_high ? true : false;
-    }
-
-
-    /**
-     * Gets STS_ID
-     *
-     * @return string
-     */
-    public function STS_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * Sets STS_ID
-     *
-     * @param string $STS_ID
-     */
-    public function set_STS_ID($STS_ID)
-    {
-        $this->set('STS_ID', $STS_ID);
-    }
-
-
-    /**
-     * Gets created
-     *
-     * @return string
-     */
-    public function created()
-    {
-        return $this->get('MSG_created');
-    }
-
-
-    /**
-     * Sets created
-     *
-     * @param string $created
-     */
-    public function set_created($created)
-    {
-        $this->set('MSG_created', $created);
-    }
-
-
-    /**
-     * Gets modified
-     *
-     * @return string
-     */
-    public function modified()
-    {
-        return $this->get('MSG_modified');
-    }
-
-
-    /**
-     * Sets modified
-     *
-     * @param string $modified
-     */
-    public function set_modified($modified)
-    {
-        $this->set('MSG_modified', $modified);
-    }
-
-
-    /**
-     * Sets generation data for this message.
-     *
-     * @param mixed $data
-     */
-    public function set_generation_data($data)
-    {
-        $this->set_field_or_extra_meta('MSG_generation_data', $data);
-    }
-
-
-    /**
-     * Returns any set generation data for this message.
-     *
-     * @return mixed|null
-     */
-    public function get_generation_data()
-    {
-        return $this->get_field_or_extra_meta('MSG_generation_data');
-    }
-
-
-    /**
-     * Gets any error message.
-     *
-     * @return mixed|null
-     */
-    public function error_message()
-    {
-        return $this->get_field_or_extra_meta('MSG_error');
-    }
-
-
-    /**
-     * Sets an error message.
-     *
-     * @param $message
-     * @return bool|int
-     */
-    public function set_error_message($message)
-    {
-        return $this->set_field_or_extra_meta('MSG_error', $message);
-    }
-
-
-    /**
-     * This retrieves the associated template pack with this message.
-     *
-     * @return EE_Messages_Template_Pack | null
-     */
-    public function get_template_pack()
-    {
-        /**
-         * This is deprecated functionality that will be removed eventually but included here now for backward compat.
-         */
-        if ( ! empty($this->template_pack)) {
-            return $this->template_pack;
-        }
-        /** @type EE_Message_Template_Group $grp */
-        $grp = $this->get_first_related('Message_Template_Group');
-        //if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if ( ! $grp instanceof EE_Message_Template_Group) {
-            $grp = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $this->messenger(),
-                        'MTP_message_type' => $this->message_type(),
-                        'MTP_is_global'    => true,
-                    ),
-                )
-            );
-        }
-
-        return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack() : null;
-    }
-
-
-    /**
-     * Retrieves the variation used for generating this message.
-     *
-     * @return string
-     */
-    public function get_template_pack_variation()
-    {
-        /**
-         * This is deprecated functionality that will be removed eventually but included here now for backward compat.
-         */
-        if ( ! empty($this->template_variation)) {
-            return $this->template_variation;
-        }
-
-        /** @type EE_Message_Template_Group $grp */
-        $grp = $this->get_first_related('Message_Template_Group');
-
-        //if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if ( ! $grp instanceof EE_Message_Template_Group) {
-            $grp = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $this->messenger(),
-                        'MTP_message_type' => $this->message_type(),
-                        'MTP_is_global'    => true,
-                    ),
-                )
-            );
-        }
-
-        return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack_variation() : '';
-    }
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     */
-    public function get_admin_details_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        EE_Registry::instance()->load_helper('MSG_Template');
-        switch ($this->STS_ID()) {
-            case EEM_Message::status_failed :
-            case EEM_Message::status_debug_only :
-                return EEH_MSG_Template::generate_error_display_trigger($this);
-                break;
-
-            case EEM_Message::status_sent :
-                return EEH_MSG_Template::generate_browser_trigger($this);
-                break;
-
-            default :
-                return '';
-        }
-    }
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     */
-    public function get_admin_edit_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_messages',
-                'action' => 'settings',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_messages',
-                'action' => 'default',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * This sets the EEM_Message::status_messenger_executing class on the message and the appropriate error message for
-     * it.
-     * Note this also SAVES the current message object to the db because it adds an error message to accompany the status.
-     *
-     */
-    public function set_messenger_is_executing()
-    {
-        $this->set_STS_ID( EEM_Message::status_messenger_executing );
-        $this->set_error_message(
-            esc_html__(
-                'A message with this status indicates that there was a problem that occurred while the message was being
+	/**
+	 * @deprecated 4.9.0  Added for backward compat with add-on's
+	 * @type null
+	 */
+	public $template_pack;
+
+	/**
+	 * @deprecated 4.9.0 Added for backward compat with add-on's
+	 * @type null
+	 */
+	public $template_variation;
+
+	/**
+	 * @deprecated 4.9.0 Added for backward compat with add-on's
+	 * @type string
+	 */
+	public $content = '';
+
+
+	/**
+	 * @type EE_messenger $_messenger
+	 */
+	protected $_messenger = null;
+
+	/**
+	 * @type EE_message_type $_message_type
+	 */
+	protected $_message_type = null;
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @param array  $date_formats incoming date formats in an array.  First value is the date_format, second is time
+	 *                             format.
+	 * @return EE_Message
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		//if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
+		if ( ! $has_object) {
+			EE_Registry::instance()->load_helper('URL');
+			$props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
+		}
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Gets MSG_token
+	 *
+	 * @return int
+	 */
+	public function MSG_token()
+	{
+		return $this->get('MSG_token');
+	}
+
+
+	/**
+	 * Sets MSG_token
+	 *
+	 * @param int $MSG_token
+	 */
+	public function set_MSG_token($MSG_token)
+	{
+		$this->set('MSG_token', $MSG_token);
+	}
+
+
+	/**
+	 * Gets GRP_ID
+	 *
+	 * @return int
+	 */
+	public function GRP_ID()
+	{
+		return $this->get('GRP_ID');
+	}
+
+
+	/**
+	 * Sets GRP_ID
+	 *
+	 * @param int $GRP_ID
+	 */
+	public function set_GRP_ID($GRP_ID)
+	{
+		$this->set('GRP_ID', $GRP_ID);
+	}
+
+
+	/**
+	 * Gets TXN_ID
+	 *
+	 * @return int
+	 */
+	public function TXN_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * Sets TXN_ID
+	 *
+	 * @param int $TXN_ID
+	 */
+	public function set_TXN_ID($TXN_ID)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 * Gets messenger
+	 *
+	 * @return string
+	 */
+	public function messenger()
+	{
+		return $this->get('MSG_messenger');
+	}
+
+
+	/**
+	 * Sets messenger
+	 *
+	 * @param string $messenger
+	 */
+	public function set_messenger($messenger)
+	{
+		$this->set('MSG_messenger', $messenger);
+	}
+
+
+	/**
+	 * Returns corresponding messenger object for the set messenger on this message
+	 *
+	 * @return EE_messenger | null
+	 */
+	public function messenger_object()
+	{
+		return $this->_messenger;
+	}
+
+
+	/**
+	 * Sets messenger
+	 *
+	 * @param EE_messenger $messenger
+	 */
+	public function set_messenger_object(EE_messenger $messenger)
+	{
+		$this->_messenger = $messenger;
+	}
+
+
+	/**
+	 * validates messenger
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function valid_messenger($throw_exceptions = false)
+	{
+		if ($this->_messenger instanceof EE_messenger) {
+			return true;
+		}
+		if ($throw_exceptions) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The "%1$s" messenger set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
+						'event_espresso'
+					),
+					$this->messenger()
+				)
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * This returns the set localized label for the messenger on this message.
+	 * Note, if unable to retrieve the EE_messenger object then will just return the messenger slug saved
+	 * with this message.
+	 *
+	 * @param   bool $plural whether to return the plural label or not.
+	 * @return string
+	 */
+	public function messenger_label($plural = false)
+	{
+		$label_type = $plural ? 'plural' : 'singular';
+		$messenger  = $this->messenger_object();
+		return $messenger instanceof EE_messenger ? $messenger->label[$label_type] : $this->messenger();
+	}
+
+
+	/**
+	 * Gets message_type
+	 *
+	 * @return string
+	 */
+	public function message_type()
+	{
+		return $this->get('MSG_message_type');
+	}
+
+
+	/**
+	 * Sets message_type
+	 *
+	 * @param string $message_type
+	 */
+	public function set_message_type($message_type)
+	{
+		$this->set('MSG_message_type', $message_type);
+	}
+
+
+	/**
+	 * Returns the message type object for the set message type on this message
+	 *
+	 * @return EE_message_type | null
+	 */
+	public function message_type_object()
+	{
+		return $this->_message_type;
+	}
+
+
+	/**
+	 * Sets message_type
+	 *
+	 * @param EE_message_type $message_type
+	 * @param bool            $set_priority   This indicates whether to set the priority to whatever the priority is on
+	 *                                        the message type or not.
+	 */
+	public function set_message_type_object(EE_message_type $message_type, $set_priority = false)
+	{
+		$this->_message_type = $message_type;
+		if ($set_priority) {
+			$this->set_priority($this->_message_type->get_priority());
+		}
+	}
+
+
+	/**
+	 * validates message_type
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function valid_message_type($throw_exceptions = false)
+	{
+		if ($this->_message_type instanceof EE_message_type) {
+			return true;
+		}
+		if ($throw_exceptions) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The %1$s message type set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
+						'event_espresso'
+					),
+					$this->message_type()
+				)
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * validates messenger and message_type (that they are valid EE_messenger and EE_message_type objects).
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function is_valid($throw_exceptions = false)
+	{
+		if ($this->valid_messenger($throw_exceptions) && $this->valid_message_type($throw_exceptions)) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * This validates whether the internal messenger and message type objects are valid for sending.
+	 * Three checks are done:
+	 * 1. There is a valid messenger object.
+	 * 2. There is a valid message type object.
+	 * 3. The message type object is active for the messenger.
+	 *
+	 * @throws EE_Error  But only if $throw_exceptions is set to true.
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 */
+	public function is_valid_for_sending_or_generation($throw_exceptions = false)
+	{
+		$valid = false;
+		if ($this->is_valid($throw_exceptions)) {
+			/** @var EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			$valid                    = $message_resource_manager->is_message_type_active_for_messenger($this->messenger(),
+				$this->message_type());
+			if ( ! $valid && $throw_exceptions) {
+				throw new EE_Error(
+					sprintf(
+						__('The %1$s message type is not a valid message type for the %2$s messenger so it will not be sent.',
+							'event_espresso'),
+						$this->message_type(),
+						$this->messenger()
+					)
+				);
+			}
+		}
+		return $valid;
+	}
+
+
+	/**
+	 * This returns the set localized label for the message type on this message.
+	 * Note, if unable to retrieve the EE_message_type object then will just return the message type slug saved
+	 * with this message.
+	 *
+	 * @param   bool $plural whether to return the plural label or not.
+	 * @return string
+	 */
+	public function message_type_label($plural = false)
+	{
+		$label_type   = $plural ? 'plural' : 'singular';
+		$message_type = $this->message_type_object();
+		return $message_type instanceof EE_message_type ? $message_type->label[$label_type] : $this->message_type();
+	}
+
+
+	/**
+	 * Gets context
+	 *
+	 * @return string
+	 */
+	public function context()
+	{
+		return $this->get('MSG_context');
+	}
+
+
+	/**
+	 * This returns the corresponding localized label for the given context slug, if possible from installed message
+	 * types. Otherwise, this will just return the set context slug on this object.
+	 *
+	 * @return string
+	 */
+	public function context_label()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$contexts                 = $message_resource_manager->get_all_contexts();
+		return isset($contexts[$this->context()]) ? $contexts[$this->context()] : $this->context();
+	}
+
+
+	/**
+	 * Sets context
+	 *
+	 * @param string $context
+	 */
+	public function set_context($context)
+	{
+		$this->set('MSG_context', $context);
+	}
+
+
+	/**
+	 * Gets recipient_ID
+	 *
+	 * @return int
+	 */
+	public function recipient_ID()
+	{
+		return $this->get('MSG_recipient_ID');
+	}
+
+
+	/**
+	 * Sets recipient_ID
+	 *
+	 * @param string $recipient_ID
+	 */
+	public function set_recipient_ID($recipient_ID)
+	{
+		$this->set('MSG_recipient_ID', $recipient_ID);
+	}
+
+
+	/**
+	 * Gets recipient_type
+	 *
+	 * @return string
+	 */
+	public function recipient_type()
+	{
+		return $this->get('MSG_recipient_type');
+	}
+
+
+	/**
+	 * Return the related object matching the recipient type and ID.
+	 *
+	 * @return EE_Base_Class | null
+	 */
+	public function recipient_object()
+	{
+		if ( ! $this->recipient_type() || ! $this->recipient_ID()) {
+			return null;
+		}
+
+		return $this->get_first_related($this->recipient_type());
+	}
+
+
+	/**
+	 * Sets recipient_type
+	 *
+	 * @param string $recipient_type
+	 */
+	public function set_recipient_type($recipient_type)
+	{
+		$this->set('MSG_recipient_type', $recipient_type);
+	}
+
+
+	/**
+	 * Gets content
+	 *
+	 * @return string
+	 */
+	public function content()
+	{
+		return $this->get('MSG_content');
+	}
+
+
+	/**
+	 * Sets content
+	 *
+	 * @param string $content
+	 */
+	public function set_content($content)
+	{
+		$this->set('MSG_content', $content);
+	}
+
+
+	/**
+	 * Gets subject
+	 *
+	 * @return string
+	 */
+	public function subject()
+	{
+		return $this->get('MSG_subject');
+	}
+
+
+	/**
+	 * Sets subject
+	 *
+	 * @param string $subject
+	 */
+	public function set_subject($subject)
+	{
+		$this->set('MSG_subject', $subject);
+	}
+
+
+	/**
+	 * Gets to
+	 *
+	 * @return string
+	 */
+	public function to()
+	{
+		$to = $this->get('MSG_to');
+		return empty($to) ? __('No recipient', 'event_espresso') : $to;
+	}
+
+
+	/**
+	 * Sets to
+	 *
+	 * @param string $to
+	 */
+	public function set_to($to)
+	{
+		$this->set('MSG_to', $to);
+	}
+
+
+	/**
+	 * Gets from
+	 *
+	 * @return string
+	 */
+	public function from()
+	{
+		return $this->get('MSG_from');
+	}
+
+
+	/**
+	 * Sets from
+	 *
+	 * @param string $from
+	 */
+	public function set_from($from)
+	{
+		$this->set('MSG_from', $from);
+	}
+
+
+	/**
+	 * Gets priority
+	 *
+	 * @return int
+	 */
+	public function priority()
+	{
+		return $this->get('MSG_priority');
+	}
+
+
+	/**
+	 * Sets priority
+	 * Note.  Send Now Messengers always override any priority that may be set on a Message.  So
+	 * this method calls the send_now method to verify that.
+	 *
+	 * @param int $priority
+	 */
+	public function set_priority($priority)
+	{
+		$priority = $this->send_now() ? EEM_Message::priority_high : $priority;
+		parent::set('MSG_priority', $priority);
+	}
+
+
+	/**
+	 * Overrides parent::set method so we can capture any sets for priority.
+	 *
+	 * @see parent::set() for phpdocs
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws EE_Error
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		if ($field_name === 'MSG_priority') {
+			$this->set_priority($field_value);
+		}
+		parent::set($field_name, $field_value, $use_default);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function send_now()
+	{
+		$send_now = $this->valid_messenger() && $this->messenger_object()->send_now() ? EEM_Message::priority_high : $this->priority();
+		return $send_now === EEM_Message::priority_high ? true : false;
+	}
+
+
+	/**
+	 * Gets STS_ID
+	 *
+	 * @return string
+	 */
+	public function STS_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * Sets STS_ID
+	 *
+	 * @param string $STS_ID
+	 */
+	public function set_STS_ID($STS_ID)
+	{
+		$this->set('STS_ID', $STS_ID);
+	}
+
+
+	/**
+	 * Gets created
+	 *
+	 * @return string
+	 */
+	public function created()
+	{
+		return $this->get('MSG_created');
+	}
+
+
+	/**
+	 * Sets created
+	 *
+	 * @param string $created
+	 */
+	public function set_created($created)
+	{
+		$this->set('MSG_created', $created);
+	}
+
+
+	/**
+	 * Gets modified
+	 *
+	 * @return string
+	 */
+	public function modified()
+	{
+		return $this->get('MSG_modified');
+	}
+
+
+	/**
+	 * Sets modified
+	 *
+	 * @param string $modified
+	 */
+	public function set_modified($modified)
+	{
+		$this->set('MSG_modified', $modified);
+	}
+
+
+	/**
+	 * Sets generation data for this message.
+	 *
+	 * @param mixed $data
+	 */
+	public function set_generation_data($data)
+	{
+		$this->set_field_or_extra_meta('MSG_generation_data', $data);
+	}
+
+
+	/**
+	 * Returns any set generation data for this message.
+	 *
+	 * @return mixed|null
+	 */
+	public function get_generation_data()
+	{
+		return $this->get_field_or_extra_meta('MSG_generation_data');
+	}
+
+
+	/**
+	 * Gets any error message.
+	 *
+	 * @return mixed|null
+	 */
+	public function error_message()
+	{
+		return $this->get_field_or_extra_meta('MSG_error');
+	}
+
+
+	/**
+	 * Sets an error message.
+	 *
+	 * @param $message
+	 * @return bool|int
+	 */
+	public function set_error_message($message)
+	{
+		return $this->set_field_or_extra_meta('MSG_error', $message);
+	}
+
+
+	/**
+	 * This retrieves the associated template pack with this message.
+	 *
+	 * @return EE_Messages_Template_Pack | null
+	 */
+	public function get_template_pack()
+	{
+		/**
+		 * This is deprecated functionality that will be removed eventually but included here now for backward compat.
+		 */
+		if ( ! empty($this->template_pack)) {
+			return $this->template_pack;
+		}
+		/** @type EE_Message_Template_Group $grp */
+		$grp = $this->get_first_related('Message_Template_Group');
+		//if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
+		if ( ! $grp instanceof EE_Message_Template_Group) {
+			$grp = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $this->messenger(),
+						'MTP_message_type' => $this->message_type(),
+						'MTP_is_global'    => true,
+					),
+				)
+			);
+		}
+
+		return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack() : null;
+	}
+
+
+	/**
+	 * Retrieves the variation used for generating this message.
+	 *
+	 * @return string
+	 */
+	public function get_template_pack_variation()
+	{
+		/**
+		 * This is deprecated functionality that will be removed eventually but included here now for backward compat.
+		 */
+		if ( ! empty($this->template_variation)) {
+			return $this->template_variation;
+		}
+
+		/** @type EE_Message_Template_Group $grp */
+		$grp = $this->get_first_related('Message_Template_Group');
+
+		//if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
+		if ( ! $grp instanceof EE_Message_Template_Group) {
+			$grp = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $this->messenger(),
+						'MTP_message_type' => $this->message_type(),
+						'MTP_is_global'    => true,
+					),
+				)
+			);
+		}
+
+		return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack_variation() : '';
+	}
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_details_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		EE_Registry::instance()->load_helper('MSG_Template');
+		switch ($this->STS_ID()) {
+			case EEM_Message::status_failed :
+			case EEM_Message::status_debug_only :
+				return EEH_MSG_Template::generate_error_display_trigger($this);
+				break;
+
+			case EEM_Message::status_sent :
+				return EEH_MSG_Template::generate_browser_trigger($this);
+				break;
+
+			default :
+				return '';
+		}
+	}
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_messages',
+				'action' => 'settings',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_messages',
+				'action' => 'default',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * This sets the EEM_Message::status_messenger_executing class on the message and the appropriate error message for
+	 * it.
+	 * Note this also SAVES the current message object to the db because it adds an error message to accompany the status.
+	 *
+	 */
+	public function set_messenger_is_executing()
+	{
+		$this->set_STS_ID( EEM_Message::status_messenger_executing );
+		$this->set_error_message(
+			esc_html__(
+				'A message with this status indicates that there was a problem that occurred while the message was being
                 processed by the messenger.  It is still possible that the message was sent successfully, but at some
                 point during the processing there was a failure.  This usually is indicative of a timeout issue with PHP 
                 or memory limits being reached.  If you see this repeatedly you may want to consider upgrading the memory 
                 available to PHP on your server.',
-                'event_espresso'
-            )
-        );
-    }
+				'event_espresso'
+			)
+		);
+	}
 }
 /* End of file EE_Message.class.php */
 /* Location: /core/db_classes/EE_Message.class.php */
\ No newline at end of file

Spacing +2 added lines, -2 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -859,7 +859,7 @@ 
      */
     public function set_messenger_is_executing()
     {
-        $this->set_STS_ID( EEM_Message::status_messenger_executing );
+        $this->set_STS_ID(EEM_Message::status_messenger_executing);
         $this->set_error_message(
             esc_html__(
                 'A message with this status indicates that there was a problem that occurred while the message was being

espresso.php

Indentation +215 added lines, -215 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('ABSPATH')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /*
   Plugin Name:		Event Espresso
@@ -40,239 +40,239 @@ 
  * @since            4.0
  */
 if (function_exists('espresso_version')) {
-    /**
-     *    espresso_duplicate_plugin_error
-     *    displays if more than one version of EE is activated at the same time
-     */
-    function espresso_duplicate_plugin_error()
-    {
-        ?>
+	/**
+	 *    espresso_duplicate_plugin_error
+	 *    displays if more than one version of EE is activated at the same time
+	 */
+	function espresso_duplicate_plugin_error()
+	{
+		?>
         <div class="error">
             <p>
                 <?php echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                ); ?>
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+				); ?>
             </p>
         </div>
         <?php
-        espresso_deactivate_plugin(plugin_basename(__FILE__));
-    }
+		espresso_deactivate_plugin(plugin_basename(__FILE__));
+	}
 
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
-    if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
+	if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                            esc_html__(
-                                    'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                                    'event_espresso'
-                            ),
-                            EE_MIN_PHP_VER_REQUIRED,
-                            PHP_VERSION,
-                            '<br/>',
-                            '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+							esc_html__(
+									'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+									'event_espresso'
+							),
+							EE_MIN_PHP_VER_REQUIRED,
+							PHP_VERSION,
+							'<br/>',
+							'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.24.rc.017');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.24.rc.017');
+		}
 
-        // define versions
-        define('EVENT_ESPRESSO_VERSION', espresso_version());
-        define('EE_MIN_WP_VER_REQUIRED', '4.1');
-        define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
-        define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        //used to be DIRECTORY_SEPARATOR, but that caused issues on windows
-        if ( ! defined('DS')) {
-            define('DS', '/');
-        }
-        if ( ! defined('PS')) {
-            define('PS', PATH_SEPARATOR);
-        }
-        if ( ! defined('SP')) {
-            define('SP', ' ');
-        }
-        if ( ! defined('EENL')) {
-            define('EENL', "\n");
-        }
-        define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
-        // define the plugin directory and URL
-        define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
-        define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
-        define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
-        // main root folder paths
-        define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
-        define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
-        define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
-        define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
-        define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
-        define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
-        define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
-        define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
-        // core system paths
-        define('EE_ADMIN', EE_CORE . 'admin' . DS);
-        define('EE_CPTS', EE_CORE . 'CPTs' . DS);
-        define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
-        define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
-        define('EE_BUSINESS', EE_CORE . 'business' . DS);
-        define('EE_MODELS', EE_CORE . 'db_models' . DS);
-        define('EE_HELPERS', EE_CORE . 'helpers' . DS);
-        define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
-        define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
-        define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
-        define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
-        define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
-        // gateways
-        define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
-        define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
-        // asset URL paths
-        define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
-        define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
-        define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
-        define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
-        define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
-        define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
-        // define upload paths
-        $uploads = wp_upload_dir();
-        // define the uploads directory and URL
-        define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
-        define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
-        // define the templates directory and URL
-        define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
-        define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
-        // define the gateway directory and URL
-        define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
-        define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
-        // languages folder/path
-        define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
-        define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
-        //check for dompdf fonts in uploads
-        if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
-            define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
-        }
-        //ajax constants
-        define(
-                'EE_FRONT_AJAX',
-                isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
-        );
-        define(
-                'EE_ADMIN_AJAX',
-                isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
-        );
-        //just a handy constant occasionally needed for finding values representing infinity in the DB
-        //you're better to use this than its straight value (currently -1) in case you ever
-        //want to change its default value! or find when -1 means infinity
-        define('EE_INF_IN_DB', -1);
-        define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
-        define('EE_DEBUG', false);
-        /**
-         *    espresso_plugin_activation
-         *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		// define versions
+		define('EVENT_ESPRESSO_VERSION', espresso_version());
+		define('EE_MIN_WP_VER_REQUIRED', '4.1');
+		define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
+		define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		//used to be DIRECTORY_SEPARATOR, but that caused issues on windows
+		if ( ! defined('DS')) {
+			define('DS', '/');
+		}
+		if ( ! defined('PS')) {
+			define('PS', PATH_SEPARATOR);
+		}
+		if ( ! defined('SP')) {
+			define('SP', ' ');
+		}
+		if ( ! defined('EENL')) {
+			define('EENL', "\n");
+		}
+		define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
+		// define the plugin directory and URL
+		define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
+		define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
+		define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
+		// main root folder paths
+		define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
+		define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
+		define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
+		define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
+		define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
+		define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
+		define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
+		define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
+		// core system paths
+		define('EE_ADMIN', EE_CORE . 'admin' . DS);
+		define('EE_CPTS', EE_CORE . 'CPTs' . DS);
+		define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
+		define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
+		define('EE_BUSINESS', EE_CORE . 'business' . DS);
+		define('EE_MODELS', EE_CORE . 'db_models' . DS);
+		define('EE_HELPERS', EE_CORE . 'helpers' . DS);
+		define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
+		define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
+		define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
+		define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
+		define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
+		// gateways
+		define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
+		define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
+		// asset URL paths
+		define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
+		define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
+		define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
+		define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
+		define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
+		define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
+		// define upload paths
+		$uploads = wp_upload_dir();
+		// define the uploads directory and URL
+		define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
+		define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
+		// define the templates directory and URL
+		define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
+		define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
+		// define the gateway directory and URL
+		define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
+		define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
+		// languages folder/path
+		define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
+		define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
+		//check for dompdf fonts in uploads
+		if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
+			define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
+		}
+		//ajax constants
+		define(
+				'EE_FRONT_AJAX',
+				isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
+		);
+		define(
+				'EE_ADMIN_AJAX',
+				isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
+		);
+		//just a handy constant occasionally needed for finding values representing infinity in the DB
+		//you're better to use this than its straight value (currently -1) in case you ever
+		//want to change its default value! or find when -1 means infinity
+		define('EE_INF_IN_DB', -1);
+		define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
+		define('EE_DEBUG', false);
+		/**
+		 *    espresso_plugin_activation
+		 *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
-        /**
-         *    espresso_load_error_handling
-         *    this function loads EE's class for handling exceptions and errors
-         */
-        function espresso_load_error_handling()
-        {
-            // load debugging tools
-            if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
-                require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
-                EEH_Debug_Tools::instance();
-            }
-            // load error handling
-            if (is_readable(EE_CORE . 'EE_Error.core.php')) {
-                require_once(EE_CORE . 'EE_Error.core.php');
-            } else {
-                wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
-            }
-        }
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		/**
+		 *    espresso_load_error_handling
+		 *    this function loads EE's class for handling exceptions and errors
+		 */
+		function espresso_load_error_handling()
+		{
+			// load debugging tools
+			if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
+				require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
+				EEH_Debug_Tools::instance();
+			}
+			// load error handling
+			if (is_readable(EE_CORE . 'EE_Error.core.php')) {
+				require_once(EE_CORE . 'EE_Error.core.php');
+			} else {
+				wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
+			}
+		}
 
-        /**
-         *    espresso_load_required
-         *    given a class name and path, this function will load that file or throw an exception
-         *
-         * @param    string $classname
-         * @param    string $full_path_to_file
-         * @throws    EE_Error
-         */
-        function espresso_load_required($classname, $full_path_to_file)
-        {
-            static $error_handling_loaded = false;
-            if ( ! $error_handling_loaded) {
-                espresso_load_error_handling();
-                $error_handling_loaded = true;
-            }
-            if (is_readable($full_path_to_file)) {
-                require_once($full_path_to_file);
-            } else {
-                throw new EE_Error (
-                        sprintf(
-                                esc_html__(
-                                        'The %s class file could not be located or is not readable due to file permissions.',
-                                        'event_espresso'
-                                ),
-                                $classname
-                        )
-                );
-            }
-        }
+		/**
+		 *    espresso_load_required
+		 *    given a class name and path, this function will load that file or throw an exception
+		 *
+		 * @param    string $classname
+		 * @param    string $full_path_to_file
+		 * @throws    EE_Error
+		 */
+		function espresso_load_required($classname, $full_path_to_file)
+		{
+			static $error_handling_loaded = false;
+			if ( ! $error_handling_loaded) {
+				espresso_load_error_handling();
+				$error_handling_loaded = true;
+			}
+			if (is_readable($full_path_to_file)) {
+				require_once($full_path_to_file);
+			} else {
+				throw new EE_Error (
+						sprintf(
+								esc_html__(
+										'The %s class file could not be located or is not readable due to file permissions.',
+										'event_espresso'
+								),
+								$classname
+						)
+				);
+			}
+		}
 
-        espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
-        espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
-        espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
-        new EE_Bootstrap();
-    }
+		espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
+		espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
+		espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
+		new EE_Bootstrap();
+	}
 }
 if ( ! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if ( ! function_exists('deactivate_plugins')) {
-            require_once(ABSPATH . 'wp-admin/includes/plugin.php');
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if ( ! function_exists('deactivate_plugins')) {
+			require_once(ABSPATH . 'wp-admin/includes/plugin.php');
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }

core/admin/EE_Admin_Page.core.php

Indentation +3268 added lines, -3268 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -28,2119 +28,2119 @@ 
 {
 
 
-    //set in _init_page_props()
-    public $page_slug;
+	//set in _init_page_props()
+	public $page_slug;
 
-    public $page_label;
+	public $page_label;
 
-    public $page_folder;
+	public $page_folder;
 
-    //set in define_page_props()
-    protected $_admin_base_url;
+	//set in define_page_props()
+	protected $_admin_base_url;
 
-    protected $_admin_base_path;
+	protected $_admin_base_path;
 
-    protected $_admin_page_title;
+	protected $_admin_page_title;
 
-    protected $_labels;
+	protected $_labels;
 
 
-    //set early within EE_Admin_Init
-    protected $_wp_page_slug;
+	//set early within EE_Admin_Init
+	protected $_wp_page_slug;
 
-    //navtabs
-    protected $_nav_tabs;
+	//navtabs
+	protected $_nav_tabs;
 
-    protected $_default_nav_tab_name;
+	protected $_default_nav_tab_name;
 
-    //helptourstops
-    protected $_help_tour = array();
+	//helptourstops
+	protected $_help_tour = array();
 
 
-    //template variables (used by templates)
-    protected $_template_path;
+	//template variables (used by templates)
+	protected $_template_path;
 
-    protected $_column_template_path;
+	protected $_column_template_path;
 
-    /**
-     * @var array $_template_args
-     */
-    protected $_template_args = array();
+	/**
+	 * @var array $_template_args
+	 */
+	protected $_template_args = array();
 
-    /**
-     * this will hold the list table object for a given view.
-     *
-     * @var EE_Admin_List_Table $_list_table_object
-     */
-    protected $_list_table_object;
+	/**
+	 * this will hold the list table object for a given view.
+	 *
+	 * @var EE_Admin_List_Table $_list_table_object
+	 */
+	protected $_list_table_object;
 
-    //bools
-    protected $_is_UI_request = null; //this starts at null so we can have no header routes progress through two states.
+	//bools
+	protected $_is_UI_request = null; //this starts at null so we can have no header routes progress through two states.
 
-    protected $_routing;
+	protected $_routing;
 
-    //list table args
-    protected $_view;
+	//list table args
+	protected $_view;
 
-    protected $_views;
+	protected $_views;
 
 
-    //action => method pairs used for routing incoming requests
-    protected $_page_routes;
+	//action => method pairs used for routing incoming requests
+	protected $_page_routes;
 
-    protected $_page_config;
+	protected $_page_config;
 
-    //the current page route and route config
-    protected $_route;
+	//the current page route and route config
+	protected $_route;
 
-    protected $_route_config;
+	protected $_route_config;
 
-    /**
-     * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
-     * actions.
-     *
-     * @since 4.6.x
-     * @var array.
-     */
-    protected $_default_route_query_args;
+	/**
+	 * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
+	 * actions.
+	 *
+	 * @since 4.6.x
+	 * @var array.
+	 */
+	protected $_default_route_query_args;
 
-    //set via request page and action args.
-    protected $_current_page;
+	//set via request page and action args.
+	protected $_current_page;
 
-    protected $_current_view;
+	protected $_current_view;
 
-    protected $_current_page_view_url;
+	protected $_current_page_view_url;
 
-    //sanitized request action (and nonce)
-    /**
-     * @var string $_req_action
-     */
-    protected $_req_action;
+	//sanitized request action (and nonce)
+	/**
+	 * @var string $_req_action
+	 */
+	protected $_req_action;
 
-    /**
-     * @var string $_req_nonce
-     */
-    protected $_req_nonce;
+	/**
+	 * @var string $_req_nonce
+	 */
+	protected $_req_nonce;
 
-    //search related
-    protected $_search_btn_label;
+	//search related
+	protected $_search_btn_label;
 
-    protected $_search_box_callback;
+	protected $_search_box_callback;
 
-    /**
-     * WP Current Screen object
-     *
-     * @var WP_Screen
-     */
-    protected $_current_screen;
+	/**
+	 * WP Current Screen object
+	 *
+	 * @var WP_Screen
+	 */
+	protected $_current_screen;
 
-    //for holding EE_Admin_Hooks object when needed (set via set_hook_object())
-    protected $_hook_obj;
+	//for holding EE_Admin_Hooks object when needed (set via set_hook_object())
+	protected $_hook_obj;
 
-    //for holding incoming request data
-    protected $_req_data;
+	//for holding incoming request data
+	protected $_req_data;
 
-    // yes / no array for admin form fields
-    protected $_yes_no_values = array();
-
-    //some default things shared by all child classes
-    protected $_default_espresso_metaboxes;
-
-    /**
-     *    EE_Registry Object
-     *
-     * @var    EE_Registry
-     * @access    protected
-     */
-    protected $EE = null;
-
-
-
-    /**
-     * This is just a property that flags whether the given route is a caffeinated route or not.
-     *
-     * @var boolean
-     */
-    protected $_is_caf = false;
-
-
-
-    /**
-     * @Constructor
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @access public
-     */
-    public function __construct($routing = true)
-    {
-        if (strpos($this->_get_dir(), 'caffeinated') !== false) {
-            $this->_is_caf = true;
-        }
-        $this->_yes_no_values = array(
-                array('id' => true, 'text' => __('Yes', 'event_espresso')),
-                array('id' => false, 'text' => __('No', 'event_espresso')),
-        );
-        //set the _req_data property.
-        $this->_req_data = array_merge($_GET, $_POST);
-        //routing enabled?
-        $this->_routing = $routing;
-        //set initial page props (child method)
-        $this->_init_page_props();
-        //set global defaults
-        $this->_set_defaults();
-        //set early because incoming requests could be ajax related and we need to register those hooks.
-        $this->_global_ajax_hooks();
-        $this->_ajax_hooks();
-        //other_page_hooks have to be early too.
-        $this->_do_other_page_hooks();
-        //This just allows us to have extending clases do something specific before the parent constructor runs _page_setup.
-        if (method_exists($this, '_before_page_setup')) {
-            $this->_before_page_setup();
-        }
-        //set up page dependencies
-        $this->_page_setup();
-    }
-
-
-
-    /**
-     * _init_page_props
-     * Child classes use to set at least the following properties:
-     * $page_slug.
-     * $page_label.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _init_page_props();
-
-
-
-    /**
-     * _ajax_hooks
-     * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
-     * Note: within the ajax callback methods.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _ajax_hooks();
-
-
-
-    /**
-     * _define_page_props
-     * child classes define page properties in here.  Must include at least:
-     * $_admin_base_url = base_url for all admin pages
-     * $_admin_page_title = default admin_page_title for admin pages
-     * $_labels = array of default labels for various automatically generated elements:
-     *    array(
-     *        'buttons' => array(
-     *            'add' => __('label for add new button'),
-     *            'edit' => __('label for edit button'),
-     *            'delete' => __('label for delete button')
-     *            )
-     *        )
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _define_page_props();
-
-
-
-    /**
-     * _set_page_routes
-     * child classes use this to define the page routes for all subpages handled by the class.  Page routes are assigned to a action => method pairs in an array and to the $_page_routes property.  Each page route must also have a 'default'
-     * route. Here's the format
-     * $this->_page_routes = array(
-     *        'default' => array(
-     *            'func' => '_default_method_handling_route',
-     *            'args' => array('array','of','args'),
-     *            'noheader' => true, //add this in if this page route is processed before any headers are loaded (i.e. ajax request, backend processing)
-     *            'headers_sent_route'=>'headers_route_reference', //add this if noheader=>true, and you want to load a headers route after.  The string you enter here should match the defined route reference for a headers sent route.
-     *            'capability' => 'route_capability', //indicate a string for minimum capability required to access this route.
-     *            'obj_id' => 10 // if this route has an object id, then this can include it (used for capability checks).
-     *        ),
-     *        'insert_item' => '_method_for_handling_insert_item' //this can be used if all we need to have is a handling method.
-     *        )
-     * )
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_page_routes();
-
-
-
-    /**
-     * _set_page_config
-     * child classes use this to define the _page_config array for all subpages handled by the class. Each key in the array corresponds to the page_route for the loaded page.
-     * Format:
-     * $this->_page_config = array(
-     *        'default' => array(
-     *            'labels' => array(
-     *                'buttons' => array(
-     *                    'add' => __('label for adding item'),
-     *                    'edit' => __('label for editing item'),
-     *                    'delete' => __('label for deleting item')
-     *                ),
-     *                'publishbox' => __('Localized Title for Publish metabox', 'event_espresso')
-     *            ), //optional an array of custom labels for various automatically generated elements to use on the page. If this isn't present then the defaults will be used as set for the $this->_labels in _define_page_props() method
-     *            'nav' => array(
-     *                'label' => __('Label for Tab', 'event_espresso').
-     *                'url' => 'http://someurl', //automatically generated UNLESS you define
-     *                'css_class' => 'css-class', //automatically generated UNLESS you define
-     *                'order' => 10, //required to indicate tab position.
-     *                'persistent' => false //if you want the nav tab to ONLY display when the specific route is displayed then add this parameter.
-     *            'list_table' => 'name_of_list_table' //string for list table class to be loaded for this admin_page.
-     *            'metaboxes' => array('metabox1', 'metabox2'), //if present this key indicates we want to load metaboxes set for eventespresso admin pages.
-     *            'has_metaboxes' => true, //this boolean flag can simply be used to indicate if the route will have metaboxes.  Typically this is used if the 'metaboxes' index is not used because metaboxes are added later.  We just use
-     *            this flag to make sure the necessary js gets enqueued on page load.
-     *            'has_help_popups' => false //defaults(true) //this boolean flag can simply be used to indicate if the given route has help popups setup and if it does then we need to make sure thickbox is enqueued.
-     *            'columns' => array(4, 2), //this key triggers the setup of a page that uses columns (metaboxes).  The array indicates the max number of columns (4) and the default number of columns on page load (2).  There is an option
-     *            in the "screen_options" dropdown that is setup so users can pick what columns they want to display.
-     *            'help_tabs' => array( //this is used for adding help tabs to a page
-     *                'tab_id' => array(
-     *                    'title' => 'tab_title',
-     *                    'filename' => 'name_of_file_containing_content', //this is the primary method for setting help tab content.  The fallback if it isn't present is to try a the callback.  Filename should match a file in the admin
-     *                    folder's "help_tabs" dir (ie.. events/help_tabs/name_of_file_containing_content.help_tab.php)
-     *                    'callback' => 'callback_method_for_content', //if 'filename' isn't present then system will attempt to use the callback which should match the name of a method in the class
-     *                    ),
-     *                'tab2_id' => array(
-     *                    'title' => 'tab2 title',
-     *                    'filename' => 'file_name_2'
-     *                    'callback' => 'callback_method_for_content',
-     *                 ),
-     *            'help_sidebar' => 'callback_for_sidebar_content', //this is used for setting up the sidebar in the help tab area on an admin page. @link http://make.wordpress.org/core/2011/12/06/help-and-screen-api-changes-in-3-3/
-     *            'help_tour' => array(
-     *                'name_of_help_tour_class', //all help tours shoudl be a child class of EE_Help_Tour and located in a folder for this admin page named "help_tours", a file name matching the key given here
-     *                (name_of_help_tour_class.class.php), and class matching key given here (name_of_help_tour_class)
-     *            ),
-     *            'require_nonce' => TRUE //this is used if you want to set a route to NOT require a nonce (default is true if it isn't present).  To remove the requirement for a nonce check when this route is visited just set
-     *            'require_nonce' to FALSE
-     *            )
-     * )
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_page_config();
-
-
-
-
-
-    /** end sample help_tour methods **/
-    /**
-     * _add_screen_options
-     * Child classes can add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
-     * Note child classes can also define _add_screen_options_($this->_current_view) to limit screen options to a particular view.
-     *
-     * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
-     *         see also WP_Screen object documents...
-     * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _add_screen_options();
-
-
-
-    /**
-     * _add_feature_pointers
-     * Child classes should use this method for implementing any "feature pointers" (using built-in WP styling js).
-     * Note child classes can also define _add_feature_pointers_($this->_current_view) to limit screen options to a particular view.
-     * Note: this is just a placeholder for now.  Implementation will come down the road
-     * See: WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
-     *
-     * @link   http://eamann.com/tech/wordpress-portland/
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _add_feature_pointers();
-
-
-
-    /**
-     * load_scripts_styles
-     * child classes put their wp_enqueue_script and wp_enqueue_style hooks in here for anything they need loaded for their pages/subpages.  Note this is for all pages/subpages of the system.  You can also load only specific scripts/styles
-     * per view by putting them in a dynamic function in this format (load_scripts_styles_{$this->_current_view}) which matches your page route (action request arg)
-     *
-     * @abstract
-     * @access public
-     * @return void
-     */
-    abstract public function load_scripts_styles();
-
-
-
-    /**
-     * admin_init
-     * Anything that should be set/executed at 'admin_init' WP hook runtime should be put in here.  This will apply to all pages/views loaded by child class.
-     *
-     * @abstract
-     * @access public
-     * @return void
-     */
-    abstract public function admin_init();
-
-
-
-    /**
-     * admin_notices
-     * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply to all pages/views loaded by child class.
-     *
-     * @abstract
-     * @access public
-     * @return void
-     */
-    abstract public function admin_notices();
-
-
-
-    /**
-     * admin_footer_scripts
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method will apply to all pages/views loaded by child class.
-     *
-     * @access public
-     * @return void
-     */
-    abstract public function admin_footer_scripts();
-
-
-
-    /**
-     * admin_footer
-     * anything triggered by the 'admin_footer' WP action hook should be added to here. This particular method will apply to all pages/views loaded by child class.
-     *
-     * @access  public
-     * @return void
-     */
-    public function admin_footer()
-    {
-    }
-
-
-
-    /**
-     * _global_ajax_hooks
-     * all global add_action('wp_ajax_{name_of_hook}') hooks in here.
-     * Note: within the ajax callback methods.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    protected function _global_ajax_hooks()
-    {
-        //for lazy loading of metabox content
-        add_action('wp_ajax_espresso-ajax-content', array($this, 'ajax_metabox_content'), 10);
-    }
-
-
-
-    public function ajax_metabox_content()
-    {
-        $contentid = isset($this->_req_data['contentid']) ? $this->_req_data['contentid'] : '';
-        $url = isset($this->_req_data['contenturl']) ? $this->_req_data['contenturl'] : '';
-        self::cached_rss_display($contentid, $url);
-        wp_die();
-    }
-
-
-
-    /**
-     * _page_setup
-     * Makes sure any things that need to be loaded early get handled.  We also escape early here if the page requested doesn't match the object.
-     *
-     * @final
-     * @access protected
-     * @return void
-     */
-    final protected function _page_setup()
-    {
-        //requires?
-        //admin_init stuff - global - we're setting this REALLY early so if EE_Admin pages have to hook into other WP pages they can.  But keep in mind, not everything is available from the EE_Admin Page object at this point.
-        add_action('admin_init', array($this, 'admin_init_global'), 5);
-        //next verify if we need to load anything...
-        $this->_current_page = ! empty($_GET['page']) ? sanitize_key($_GET['page']) : '';
-        $this->page_folder = strtolower(str_replace('_Admin_Page', '', str_replace('Extend_', '', get_class($this))));
-        global $ee_menu_slugs;
-        $ee_menu_slugs = (array)$ee_menu_slugs;
-        if (( ! $this->_current_page || ! isset($ee_menu_slugs[$this->_current_page])) && ! defined('DOING_AJAX')) {
-            return false;
-        }
-        // becuz WP List tables have two duplicate select inputs for choosing bulk actions, we need to copy the action from the second to the first
-        if (isset($this->_req_data['action2']) && $this->_req_data['action'] == -1) {
-            $this->_req_data['action'] = ! empty($this->_req_data['action2']) && $this->_req_data['action2'] != -1 ? $this->_req_data['action2'] : $this->_req_data['action'];
-        }
-        // then set blank or -1 action values to 'default'
-        $this->_req_action = isset($this->_req_data['action']) && ! empty($this->_req_data['action']) && $this->_req_data['action'] != -1 ? sanitize_key($this->_req_data['action']) : 'default';
-        //if action is 'default' after the above BUT we have  'route' var set, then let's use the route as the action.  This covers cases where we're coming in from a list table that isn't on the default route.
-        $this->_req_action = $this->_req_action == 'default' && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
-        //however if we are doing_ajax and we've got a 'route' set then that's what the req_action will be
-        $this->_req_action = defined('DOING_AJAX') && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
-        $this->_current_view = $this->_req_action;
-        $this->_req_nonce = $this->_req_action . '_nonce';
-        $this->_define_page_props();
-        $this->_current_page_view_url = add_query_arg(array('page' => $this->_current_page, 'action' => $this->_current_view), $this->_admin_base_url);
-        //default things
-        $this->_default_espresso_metaboxes = array('_espresso_news_post_box', '_espresso_links_post_box', '_espresso_ratings_request', '_espresso_sponsors_post_box');
-        //set page configs
-        $this->_set_page_routes();
-        $this->_set_page_config();
-        //let's include any referrer data in our default_query_args for this route for "stickiness".
-        if (isset($this->_req_data['wp_referer'])) {
-            $this->_default_route_query_args['wp_referer'] = $this->_req_data['wp_referer'];
-        }
-        //for caffeinated and other extended functionality.  If there is a _extend_page_config method then let's run that to modify the all the various page configuration arrays
-        if (method_exists($this, '_extend_page_config')) {
-            $this->_extend_page_config();
-        }
-        //for CPT and other extended functionality. If there is an _extend_page_config_for_cpt then let's run that to modify all the various page configuration arrays.
-        if (method_exists($this, '_extend_page_config_for_cpt')) {
-            $this->_extend_page_config_for_cpt();
-        }
-        //filter routes and page_config so addons can add their stuff. Filtering done per class
-        $this->_page_routes = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_routes', $this->_page_routes, $this);
-        $this->_page_config = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_config', $this->_page_config, $this);
-        //if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
-        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
-            add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view), 10, 2);
-        }
-        //next route only if routing enabled
-        if ($this->_routing && ! defined('DOING_AJAX')) {
-            $this->_verify_routes();
-            //next let's just check user_access and kill if no access
-            $this->check_user_access();
-            if ($this->_is_UI_request) {
-                //admin_init stuff - global, all views for this page class, specific view
-                add_action('admin_init', array($this, 'admin_init'), 10);
-                if (method_exists($this, 'admin_init_' . $this->_current_view)) {
-                    add_action('admin_init', array($this, 'admin_init_' . $this->_current_view), 15);
-                }
-            } else {
-                //hijack regular WP loading and route admin request immediately
-                @ini_set('memory_limit', apply_filters('admin_memory_limit', WP_MAX_MEMORY_LIMIT));
-                $this->route_admin_request();
-            }
-        }
-    }
-
-
-
-    /**
-     * Provides a way for related child admin pages to load stuff on the loaded admin page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _do_other_page_hooks()
-    {
-        $registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, array());
-        foreach ($registered_pages as $page) {
-            //now let's setup the file name and class that should be present
-            $classname = str_replace('.class.php', '', $page);
-            //autoloaders should take care of loading file
-            if ( ! class_exists($classname)) {
-                $error_msg[] = sprintf(__('Something went wrong with loading the %s admin hooks page.', 'event_espresso'), $page);
-                $error_msg[] = $error_msg[0]
-                               . "\r\n"
-                               . sprintf(__('There is no class in place for the %s admin hooks page.%sMake sure you have <strong>%s</strong> defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
-                                'event_espresso'), $page, '<br />', $classname);
-                throw new EE_Error(implode('||', $error_msg));
-            }
-            $a = new ReflectionClass($classname);
-            //notice we are passing the instance of this class to the hook object.
-            $hookobj[] = $a->newInstance($this);
-        }
-    }
-
-
-
-    public function load_page_dependencies()
-    {
-        try {
-            $this->_load_page_dependencies();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-
-    /**
-     * load_page_dependencies
-     * loads things specific to this page class when its loaded.  Really helps with efficiency.
-     *
-     * @access public
-     * @return void
-     */
-    protected function _load_page_dependencies()
-    {
-        //let's set the current_screen and screen options to override what WP set
-        $this->_current_screen = get_current_screen();
-        //load admin_notices - global, page class, and view specific
-        add_action('admin_notices', array($this, 'admin_notices_global'), 5);
-        add_action('admin_notices', array($this, 'admin_notices'), 10);
-        if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
-            add_action('admin_notices', array($this, 'admin_notices_' . $this->_current_view), 15);
-        }
-        //load network admin_notices - global, page class, and view specific
-        add_action('network_admin_notices', array($this, 'network_admin_notices_global'), 5);
-        if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
-            add_action('network_admin_notices', array($this, 'network_admin_notices_' . $this->_current_view));
-        }
-        //this will save any per_page screen options if they are present
-        $this->_set_per_page_screen_options();
-        //setup list table properties
-        $this->_set_list_table();
-        // child classes can "register" a metabox to be automatically handled via the _page_config array property.  However in some cases the metaboxes will need to be added within a route handling callback.
-        $this->_add_registered_meta_boxes();
-        $this->_add_screen_columns();
-        //add screen options - global, page child class, and view specific
-        $this->_add_global_screen_options();
-        $this->_add_screen_options();
-        if (method_exists($this, '_add_screen_options_' . $this->_current_view)) {
-            call_user_func(array($this, '_add_screen_options_' . $this->_current_view));
-        }
-        //add help tab(s) and tours- set via page_config and qtips.
-        $this->_add_help_tour();
-        $this->_add_help_tabs();
-        $this->_add_qtips();
-        //add feature_pointers - global, page child class, and view specific
-        $this->_add_feature_pointers();
-        $this->_add_global_feature_pointers();
-        if (method_exists($this, '_add_feature_pointer_' . $this->_current_view)) {
-            call_user_func(array($this, '_add_feature_pointer_' . $this->_current_view));
-        }
-        //enqueue scripts/styles - global, page class, and view specific
-        add_action('admin_enqueue_scripts', array($this, 'load_global_scripts_styles'), 5);
-        add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles'), 10);
-        if (method_exists($this, 'load_scripts_styles_' . $this->_current_view)) {
-            add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles_' . $this->_current_view), 15);
-        }
-        add_action('admin_enqueue_scripts', array($this, 'admin_footer_scripts_eei18n_js_strings'), 100);
-        //admin_print_footer_scripts - global, page child class, and view specific.  NOTE, despite the name, whenever possible, scripts should NOT be loaded using this.  In most cases that's doing_it_wrong().  But adding hidden container elements etc. is a good use case. Notice the late priority we're giving these
-        add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_global'), 99);
-        add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts'), 100);
-        if (method_exists($this, 'admin_footer_scripts_' . $this->_current_view)) {
-            add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_' . $this->_current_view), 101);
-        }
-        //admin footer scripts
-        add_action('admin_footer', array($this, 'admin_footer_global'), 99);
-        add_action('admin_footer', array($this, 'admin_footer'), 100);
-        if (method_exists($this, 'admin_footer_' . $this->_current_view)) {
-            add_action('admin_footer', array($this, 'admin_footer_' . $this->_current_view), 101);
-        }
-        do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', $this->page_slug);
-        //targeted hook
-        do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load__' . $this->page_slug . '__' . $this->_req_action);
-    }
-
-
-
-    /**
-     * _set_defaults
-     * This sets some global defaults for class properties.
-     */
-    private function _set_defaults()
-    {
-        $this->_current_screen = $this->_admin_page_title = $this->_req_action = $this->_req_nonce = $this->_event = $this->_template_path = $this->_column_template_path = null;
-        $this->_nav_tabs = $this_views = $this->_page_routes = $this->_page_config = $this->_default_route_query_args = array();
-        $this->default_nav_tab_name = 'overview';
-        //init template args
-        $this->_template_args = array(
-                'admin_page_header'  => '',
-                'admin_page_content' => '',
-                'post_body_content'  => '',
-                'before_list_table'  => '',
-                'after_list_table'   => '',
-        );
-    }
-
-
-
-    /**
-     * route_admin_request
-     *
-     * @see    _route_admin_request()
-     * @access public
-     * @return void|exception error
-     */
-    public function route_admin_request()
-    {
-        try {
-            $this->_route_admin_request();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-
-    public function set_wp_page_slug($wp_page_slug)
-    {
-        $this->_wp_page_slug = $wp_page_slug;
-        //if in network admin then we need to append "-network" to the page slug. Why? Because that's how WP rolls...
-        if (is_network_admin()) {
-            $this->_wp_page_slug .= '-network';
-        }
-    }
-
-
-
-    /**
-     * _verify_routes
-     * All this method does is verify the incoming request and make sure that routes exist for it.  We do this early so we know if we need to drop out.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _verify_routes()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if ( ! $this->_current_page && ! defined('DOING_AJAX')) {
-            return false;
-        }
-        $this->_route = false;
-        $func = false;
-        $args = array();
-        // check that the page_routes array is not empty
-        if (empty($this->_page_routes)) {
-            // user error msg
-            $error_msg = sprintf(__('No page routes have been set for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
-            // developer error msg
-            $error_msg .= '||' . $error_msg . __(' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.', 'event_espresso');
-            throw new EE_Error($error_msg);
-        }
-        // and that the requested page route exists
-        if (array_key_exists($this->_req_action, $this->_page_routes)) {
-            $this->_route = $this->_page_routes[$this->_req_action];
-            $this->_route_config = isset($this->_page_config[$this->_req_action]) ? $this->_page_config[$this->_req_action] : array();
-        } else {
-            // user error msg
-            $error_msg = sprintf(__('The requested page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
-            // developer error msg
-            $error_msg .= '||' . $error_msg . sprintf(__(' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.', 'event_espresso'), $this->_req_action);
-            throw new EE_Error($error_msg);
-        }
-        // and that a default route exists
-        if ( ! array_key_exists('default', $this->_page_routes)) {
-            // user error msg
-            $error_msg = sprintf(__('A default page route has not been set for the % admin page.', 'event_espresso'), $this->_admin_page_title);
-            // developer error msg
-            $error_msg .= '||' . $error_msg . __(' Create a key in the "_page_routes" array named "default" and set its value to your default page method.', 'event_espresso');
-            throw new EE_Error($error_msg);
-        }
-        //first lets' catch if the UI request has EVER been set.
-        if ($this->_is_UI_request === null) {
-            //lets set if this is a UI request or not.
-            $this->_is_UI_request = ( ! isset($this->_req_data['noheader']) || $this->_req_data['noheader'] !== true) ? true : false;
-            //wait a minute... we might have a noheader in the route array
-            $this->_is_UI_request = is_array($this->_route) && isset($this->_route['noheader']) && $this->_route['noheader'] ? false : $this->_is_UI_request;
-        }
-        $this->_set_current_labels();
-    }
-
-
-
-    /**
-     * this method simply verifies a given route and makes sure its an actual route available for the loaded page
-     *
-     * @param  string $route the route name we're verifying
-     * @return mixed  (bool|Exception)      we'll throw an exception if this isn't a valid route.
-     */
-    protected function _verify_route($route)
-    {
-        if (array_key_exists($this->_req_action, $this->_page_routes)) {
-            return true;
-        } else {
-            // user error msg
-            $error_msg = sprintf(__('The given page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
-            // developer error msg
-            $error_msg .= '||' . $error_msg . sprintf(__(' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property', 'event_espresso'), $route);
-            throw new EE_Error($error_msg);
-        }
-    }
-
-
-
-    /**
-     * perform nonce verification
-     * This method has be encapsulated here so that any ajax requests that bypass normal routes can verify their nonces using this method (and save retyping!)
-     *
-     * @param  string $nonce     The nonce sent
-     * @param  string $nonce_ref The nonce reference string (name0)
-     * @return mixed (bool|die)
-     */
-    protected function _verify_nonce($nonce, $nonce_ref)
-    {
-        // verify nonce against expected value
-        if ( ! wp_verify_nonce($nonce, $nonce_ref)) {
-            // these are not the droids you are looking for !!!
-            $msg = sprintf(__('%sNonce Fail.%s', 'event_espresso'), '<a href="http://www.youtube.com/watch?v=56_S0WeTkzs">', '</a>');
-            if (WP_DEBUG) {
-                $msg .= "\n  " . sprintf(__('In order to dynamically generate nonces for your actions, use the %s::add_query_args_and_nonce() method. May the Nonce be with you!', 'event_espresso'), __CLASS__);
-            }
-            if ( ! defined('DOING_AJAX')) {
-                wp_die($msg);
-            } else {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                $this->_return_json();
-            }
-        }
-    }
-
-
-
-    /**
-     * _route_admin_request()
-     * Meat and potatoes of the class.  Basically, this dude checks out what's being requested and sees if theres are
-     * some doodads to work the magic and handle the flingjangy. Translation:  Checks if the requested action is listed
-     * in the page routes and then will try to load the corresponding method.
-     *
-     * @access protected
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _route_admin_request()
-    {
-        if ( ! $this->_is_UI_request) {
-            $this->_verify_routes();
-        }
-        $nonce_check = isset($this->_route_config['require_nonce'])
-            ? $this->_route_config['require_nonce']
-            : true;
-        if ($this->_req_action !== 'default' && $nonce_check) {
-            // set nonce from post data
-            $nonce = isset($this->_req_data[$this->_req_nonce])
-                ? sanitize_text_field($this->_req_data[$this->_req_nonce])
-                : '';
-            $this->_verify_nonce($nonce, $this->_req_nonce);
-        }
-        //set the nav_tabs array but ONLY if this is  UI_request
-        if ($this->_is_UI_request) {
-            $this->_set_nav_tabs();
-        }
-        // grab callback function
-        $func = is_array($this->_route) ? $this->_route['func'] : $this->_route;
-        // check if callback has args
-        $args = is_array($this->_route) && isset($this->_route['args']) ? $this->_route['args'] : array();
-        $error_msg = '';
-        // action right before calling route
-        // (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
-        if ( ! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
-            do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
-        }
-        // right before calling the route, let's remove _wp_http_referer from the
-        // $_SERVER[REQUEST_URI] global (its now in _req_data for route processing).
-        $_SERVER['REQUEST_URI'] = remove_query_arg('_wp_http_referer', wp_unslash($_SERVER['REQUEST_URI']));
-        if ( ! empty($func)) {
-            if (is_array($func)) {
-                list($class, $method) = $func;
-            } else if (strpos($func, '::') !== false) {
-                list($class, $method) = explode('::', $func);
-            } else {
-                $class = $this;
-                $method = $func;
-            }
-            if ( ! (is_object($class) && $class === $this)) {
-                // send along this admin page object for access by addons.
-                $args['admin_page_object'] = $this;
-            }
-
-            if (
-                //is it a method on a class that doesn't work?
-                (
-                    (
-                        method_exists($class, $method)
-                        && call_user_func_array(array($class, $method), $args) === false
-                    )
-                    && (
-                        //is it a standalone function that doesn't work?
-                        function_exists($method)
-                        && call_user_func_array($func, array_merge(array('admin_page_object' => $this), $args)) === false
-                    )
-                )
-                || (
-                    //is it neither a class method NOR a standalone function?
-                    ! method_exists($class, $method)
-                    && ! function_exists($method)
-                )
-            ) {
-                // user error msg
-                $error_msg = __('An error occurred. The  requested page route could not be found.', 'event_espresso');
-                // developer error msg
-                $error_msg .= '||';
-                $error_msg .= sprintf(
-                    __(
-                        'Page route "%s" could not be called. Check that the spelling for method names and actions in the "_page_routes" array are all correct.',
-                        'event_espresso'
-                    ),
-                    $method
-                );
-            }
-            if ( ! empty($error_msg)) {
-                throw new EE_Error($error_msg);
-            }
-        }
-        //if we've routed and this route has a no headers route AND a sent_headers_route, then we need to reset the routing properties to the new route.
-        //now if UI request is FALSE and noheader is true AND we have a headers_sent_route in the route array then let's set UI_request to true because the no header route has a second func after headers have been sent.
-        if ($this->_is_UI_request === false
-            && is_array($this->_route)
-            && ! empty($this->_route['headers_sent_route'])
-        ) {
-            $this->_reset_routing_properties($this->_route['headers_sent_route']);
-        }
-    }
-
-
-
-    /**
-     * This method just allows the resetting of page properties in the case where a no headers
-     * route redirects to a headers route in its route config.
-     *
-     * @since   4.3.0
-     * @param  string $new_route New (non header) route to redirect to.
-     * @return   void
-     */
-    protected function _reset_routing_properties($new_route)
-    {
-        $this->_is_UI_request = true;
-        //now we set the current route to whatever the headers_sent_route is set at
-        $this->_req_data['action'] = $new_route;
-        //rerun page setup
-        $this->_page_setup();
-    }
-
-
-
-    /**
-     * _add_query_arg
-     * adds nonce to array of arguments then calls WP add_query_arg function
-     *(internally just uses EEH_URL's function with the same name)
-     *
-     * @access public
-     * @param array  $args
-     * @param string $url
-     * @param bool   $sticky                  if true, then the existing Request params will be appended to the generated
-     *                                        url in an associative array indexed by the key 'wp_referer';
-     *                                        Example usage:
-     *                                        If the current page is:
-     *                                        http://mydomain.com/wp-admin/admin.php?page=espresso_registrations
-     *                                        &action=default&event_id=20&month_range=March%202015
-     *                                        &_wpnonce=5467821
-     *                                        and you call:
-     *                                        EE_Admin_Page::add_query_args_and_nonce(
-     *                                        array(
-     *                                        'action' => 'resend_something',
-     *                                        'page=>espresso_registrations'
-     *                                        ),
-     *                                        $some_url,
-     *                                        true
-     *                                        );
-     *                                        It will produce a url in this structure:
-     *                                        http://{$some_url}/?page=espresso_registrations&action=resend_something
-     *                                        &wp_referer[action]=default&wp_referer[event_id]=20&wpreferer[
-     *                                        month_range]=March%202015
-     * @param   bool $exclude_nonce           If true, the the nonce will be excluded from the generated nonce.
-     * @return string
-     */
-    public static function add_query_args_and_nonce($args = array(), $url = false, $sticky = false, $exclude_nonce = false)
-    {
-        //if there is a _wp_http_referer include the values from the request but only if sticky = true
-        if ($sticky) {
-            $request = $_REQUEST;
-            unset($request['_wp_http_referer']);
-            unset($request['wp_referer']);
-            foreach ($request as $key => $value) {
-                //do not add nonces
-                if (strpos($key, 'nonce') !== false) {
-                    continue;
-                }
-                $args['wp_referer[' . $key . ']'] = $value;
-            }
-        }
-        return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
-    }
-
-
-
-    /**
-     * This returns a generated link that will load the related help tab.
-     *
-     * @param  string $help_tab_id the id for the connected help tab
-     * @param  string $icon_style  (optional) include css class for the style you want to use for the help icon.
-     * @param  string $help_text   (optional) send help text you want to use for the link if default not to be used
-     * @uses EEH_Template::get_help_tab_link()
-     * @return string              generated link
-     */
-    protected function _get_help_tab_link($help_tab_id, $icon_style = false, $help_text = false)
-    {
-        return EEH_Template::get_help_tab_link($help_tab_id, $this->page_slug, $this->_req_action, $icon_style, $help_text);
-    }
-
-
-
-    /**
-     * _add_help_tabs
-     * Note child classes define their help tabs within the page_config array.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/add_help_tab
-     * @access protected
-     * @return void
-     */
-    protected function _add_help_tabs()
-    {
-        $tour_buttons = '';
-        if (isset($this->_page_config[$this->_req_action])) {
-            $config = $this->_page_config[$this->_req_action];
-            //is there a help tour for the current route?  if there is let's setup the tour buttons
-            if (isset($this->_help_tour[$this->_req_action])) {
-                $tb = array();
-                $tour_buttons = '<div class="ee-abs-container"><div class="ee-help-tour-restart-buttons">';
-                foreach ($this->_help_tour['tours'] as $tour) {
-                    //if this is the end tour then we don't need to setup a button
-                    if ($tour instanceof EE_Help_Tour_final_stop) {
-                        continue;
-                    }
-                    $tb[] = '<button id="trigger-tour-' . $tour->get_slug() . '" class="button-primary trigger-ee-help-tour">' . $tour->get_label() . '</button>';
-                }
-                $tour_buttons .= implode('<br />', $tb);
-                $tour_buttons .= '</div></div>';
-            }
-            // let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
-            if (is_array($config) && isset($config['help_sidebar'])) {
-                //check that the callback given is valid
-                if ( ! method_exists($this, $config['help_sidebar'])) {
-                    throw new EE_Error(sprintf(__('The _page_config array has a callback set for the "help_sidebar" option.  However the callback given (%s) is not a valid callback.  Doublecheck the spelling and make sure this method exists for the class %s',
-                            'event_espresso'), $config['help_sidebar'], get_class($this)));
-                }
-                $content = apply_filters('FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar', call_user_func(array($this, $config['help_sidebar'])));
-                $content .= $tour_buttons; //add help tour buttons.
-                //do we have any help tours setup?  Cause if we do we want to add the buttons
-                $this->_current_screen->set_help_sidebar($content);
-            }
-            //if we DON'T have config help sidebar and there ARE toure buttons then we'll just add the tour buttons to the sidebar.
-            if ( ! isset($config['help_sidebar']) && ! empty($tour_buttons)) {
-                $this->_current_screen->set_help_sidebar($tour_buttons);
-            }
-            //handle if no help_tabs are set so the sidebar will still show for the help tour buttons
-            if ( ! isset($config['help_tabs']) && ! empty($tour_buttons)) {
-                $_ht['id'] = $this->page_slug;
-                $_ht['title'] = __('Help Tours', 'event_espresso');
-                $_ht['content'] = '<p>' . __('The buttons to the right allow you to start/restart any help tours available for this page', 'event_espresso') . '</p>';
-                $this->_current_screen->add_help_tab($_ht);
-            }/**/
-            if ( ! isset($config['help_tabs'])) {
-                return;
-            } //no help tabs for this route
-            foreach ((array)$config['help_tabs'] as $tab_id => $cfg) {
-                //we're here so there ARE help tabs!
-                //make sure we've got what we need
-                if ( ! isset($cfg['title'])) {
-                    throw new EE_Error(__('The _page_config array is not set up properly for help tabs.  It is missing a title', 'event_espresso'));
-                }
-                if ( ! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
-                    throw new EE_Error(__('The _page_config array is not setup properly for help tabs. It is missing a either a filename reference, or a callback reference or a content reference so there is no way to know the content for the help tab',
-                            'event_espresso'));
-                }
-                //first priority goes to content.
-                if ( ! empty($cfg['content'])) {
-                    $content = ! empty($cfg['content']) ? $cfg['content'] : null;
-                    //second priority goes to filename
-                } else if ( ! empty($cfg['filename'])) {
-                    $file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
-                    //it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
-                    $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tabs/' . $cfg['filename'] . '.help_tab.php' : $file_path;
-                    //if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
-                    if ( ! is_readable($file_path) && ! isset($cfg['callback'])) {
-                        EE_Error::add_error(sprintf(__('The filename given for the help tab %s is not a valid file and there is no other configuration for the tab content.  Please check that the string you set for the help tab on this route (%s) is the correct spelling.  The file should be in %s',
-                                'event_espresso'), $tab_id, key($config), $file_path), __FILE__, __FUNCTION__, __LINE__);
-                        return;
-                    }
-                    $template_args['admin_page_obj'] = $this;
-                    $content = EEH_Template::display_template($file_path, $template_args, true);
-                } else {
-                    $content = '';
-                }
-                //check if callback is valid
-                if (empty($content) && ( ! isset($cfg['callback']) || ! method_exists($this, $cfg['callback']))) {
-                    EE_Error::add_error(sprintf(__('The callback given for a %s help tab on this page does not content OR a corresponding method for generating the content.  Check the spelling or make sure the method is present.',
-                            'event_espresso'), $cfg['title']), __FILE__, __FUNCTION__, __LINE__);
-                    return;
-                }
-                //setup config array for help tab method
-                $id = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
-                $_ht = array(
-                        'id'       => $id,
-                        'title'    => $cfg['title'],
-                        'callback' => isset($cfg['callback']) && empty($content) ? array($this, $cfg['callback']) : null,
-                        'content'  => $content,
-                );
-                $this->_current_screen->add_help_tab($_ht);
-            }
-        }
-    }
-
-
-
-    /**
-     * This basically checks loaded $_page_config property to see if there are any help_tours defined.  "help_tours" is an array with properties for setting up usage of the joyride plugin
-     *
-     * @link   http://zurb.com/playground/jquery-joyride-feature-tour-plugin
-     * @see    instructions regarding the format and construction of the "help_tour" array element is found in the _set_page_config() comments
-     * @access protected
-     * @return void
-     */
-    protected function _add_help_tour()
-    {
-        $tours = array();
-        $this->_help_tour = array();
-        //exit early if help tours are turned off globally
-        if ( ! EE_Registry::instance()->CFG->admin->help_tour_activation || (defined('EE_DISABLE_HELP_TOURS') && EE_DISABLE_HELP_TOURS)) {
-            return;
-        }
-        //loop through _page_config to find any help_tour defined
-        foreach ($this->_page_config as $route => $config) {
-            //we're only going to set things up for this route
-            if ($route !== $this->_req_action) {
-                continue;
-            }
-            if (isset($config['help_tour'])) {
-                foreach ($config['help_tour'] as $tour) {
-                    $file_path = $this->_get_dir() . '/help_tours/' . $tour . '.class.php';
-                    //let's see if we can get that file... if not its possible this is a decaf route not set in caffienated so lets try and get the caffeinated equivalent
-                    $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tours/' . $tour . '.class.php' : $file_path;
-                    //if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
-                    if ( ! is_readable($file_path)) {
-                        EE_Error::add_error(sprintf(__('The file path given for the help tour (%s) is not a valid path.  Please check that the string you set for the help tour on this route (%s) is the correct spelling', 'event_espresso'),
-                                $file_path, $tour), __FILE__, __FUNCTION__, __LINE__);
-                        return;
-                    }
-                    require_once $file_path;
-                    if ( ! class_exists($tour)) {
-                        $error_msg[] = sprintf(__('Something went wrong with loading the %s Help Tour Class.', 'event_espresso'), $tour);
-                        $error_msg[] = $error_msg[0] . "\r\n" . sprintf(__('There is no class in place for the %s help tour.%s Make sure you have <strong>%s</strong> defined in the "help_tour" array for the %s route of the % admin page.',
-                                        'event_espresso'), $tour, '<br />', $tour, $this->_req_action, get_class($this));
-                        throw new EE_Error(implode('||', $error_msg));
-                    }
-                    $a = new ReflectionClass($tour);
-                    $tour_obj = $a->newInstance($this->_is_caf);
-                    $tours[] = $tour_obj;
-                    $this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($tour_obj);
-                }
-                //let's inject the end tour stop element common to all pages... this will only get seen once per machine.
-                $end_stop_tour = new EE_Help_Tour_final_stop($this->_is_caf);
-                $tours[] = $end_stop_tour;
-                $this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($end_stop_tour);
-            }
-        }
-        if ( ! empty($tours)) {
-            $this->_help_tour['tours'] = $tours;
-        }
-        //thats it!  Now that the $_help_tours property is set (or not) the scripts and html should be taken care of automatically.
-    }
-
-
-
-    /**
-     * This simply sets up any qtips that have been defined in the page config
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _add_qtips()
-    {
-        if (isset($this->_route_config['qtips'])) {
-            $qtips = (array)$this->_route_config['qtips'];
-            //load qtip loader
-            $path = array(
-                    $this->_get_dir() . '/qtips/',
-                    EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
-            );
-            EEH_Qtip_Loader::instance()->register($qtips, $path);
-        }
-    }
-
-
-
-    /**
-     * _set_nav_tabs
-     * This sets up the nav tabs from the page_routes array.  This method can be overwritten by child classes if you wish to add additional tabs or modify accordingly.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_nav_tabs()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $i = 0;
-        foreach ($this->_page_config as $slug => $config) {
-            if ( ! is_array($config) || (is_array($config) && (isset($config['nav']) && ! $config['nav']) || ! isset($config['nav']))) {
-                continue;
-            } //no nav tab for this config
-            //check for persistent flag
-            if (isset($config['nav']['persistent']) && ! $config['nav']['persistent'] && $slug !== $this->_req_action) {
-                continue;
-            } //nav tab is only to appear when route requested.
-            if ( ! $this->check_user_access($slug, true)) {
-                continue;
-            } //no nav tab becasue current user does not have access.
-            $css_class = isset($config['css_class']) ? $config['css_class'] . ' ' : '';
-            $this->_nav_tabs[$slug] = array(
-                    'url'       => isset($config['nav']['url']) ? $config['nav']['url'] : self::add_query_args_and_nonce(array('action' => $slug), $this->_admin_base_url),
-                    'link_text' => isset($config['nav']['label']) ? $config['nav']['label'] : ucwords(str_replace('_', ' ', $slug)),
-                    'css_class' => $this->_req_action == $slug ? $css_class . 'nav-tab-active' : $css_class,
-                    'order'     => isset($config['nav']['order']) ? $config['nav']['order'] : $i,
-            );
-            $i++;
-        }
-        //if $this->_nav_tabs is empty then lets set the default
-        if (empty($this->_nav_tabs)) {
-            $this->_nav_tabs[$this->default_nav_tab_name] = array(
-                    'url'       => $this->admin_base_url,
-                    'link_text' => ucwords(str_replace('_', ' ', $this->default_nav_tab_name)),
-                    'css_class' => 'nav-tab-active',
-                    'order'     => 10,
-            );
-        }
-        //now let's sort the tabs according to order
-        usort($this->_nav_tabs, array($this, '_sort_nav_tabs'));
-    }
-
-
-
-    /**
-     * _set_current_labels
-     * This method modifies the _labels property with any optional specific labels indicated in the _page_routes property array
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_current_labels()
-    {
-        if (is_array($this->_route_config) && isset($this->_route_config['labels'])) {
-            foreach ($this->_route_config['labels'] as $label => $text) {
-                if (is_array($text)) {
-                    foreach ($text as $sublabel => $subtext) {
-                        $this->_labels[$label][$sublabel] = $subtext;
-                    }
-                } else {
-                    $this->_labels[$label] = $text;
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *        verifies user access for this admin page
-     *
-     * @param string $route_to_check if present then the capability for the route matching this string is checked.
-     * @param bool   $verify_only    Default is FALSE which means if user check fails then wp_die().  Otherwise just return false if verify fail.
-     * @return        BOOL|wp_die()
-     */
-    public function check_user_access($route_to_check = '', $verify_only = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $route_to_check = empty($route_to_check) ? $this->_req_action : $route_to_check;
-        $capability = ! empty($route_to_check) && isset($this->_page_routes[$route_to_check]) && is_array($this->_page_routes[$route_to_check]) && ! empty($this->_page_routes[$route_to_check]['capability'])
-                ? $this->_page_routes[$route_to_check]['capability'] : null;
-        if (empty($capability) && empty($route_to_check)) {
-            $capability = is_array($this->_route) && empty($this->_route['capability']) ? 'manage_options' : $this->_route['capability'];
-        } else {
-            $capability = empty($capability) ? 'manage_options' : $capability;
-        }
-        $id = is_array($this->_route) && ! empty($this->_route['obj_id']) ? $this->_route['obj_id'] : 0;
-        if (( ! function_exists('is_admin') || ! EE_Registry::instance()->CAP->current_user_can($capability, $this->page_slug . '_' . $route_to_check, $id)) && ! defined('DOING_AJAX')) {
-            if ($verify_only) {
-                return false;
-            } else {
-                if ( is_user_logged_in() ) {
-                    wp_die(__('You do not have access to this route.', 'event_espresso'));
-                } else {
-                    return false;
-                }
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * 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()
-    {
-    }
-
-
-
-    /**
-     * wp_loaded_global
-     * This runs all the code that we want executed within the WP wp_loaded hook.  This method is optional for an EE_Admin page and will execute on every EE Admin Page load
-     *
-     * @access public
-     * @return void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-
-    /**
-     * admin_notices
-     * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on ALL EE_Admin pages.
-     *
-     * @access public
-     * @return void
-     */
-    public function admin_notices_global()
-    {
-        $this->_display_no_javascript_warning();
-        $this->_display_espresso_notices();
-    }
-
-
-
-    public function network_admin_notices_global()
-    {
-        $this->_display_no_javascript_warning();
-        $this->_display_espresso_notices();
-    }
-
-
-
-    /**
-     * 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();
-        //if metaboxes are present we need to add the nonce field
-        if ((isset($this->_route_config['metaboxes']) || (isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes']) || isset($this->_route_config['list_table']))) {
-            wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
-            wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
-        }
-    }
-
-
-
-    /**
-     * admin_footer_global
-     * Anything triggered by the wp 'admin_footer' wp hook should be put in here. This particluar method will apply on ALL EE_Admin Pages.
-     *
-     * @access  public
-     * @return  void
-     */
-    public function admin_footer_global()
-    {
-        //dialog container for dialog helper
-        $d_cont = '<div class="ee-admin-dialog-container auto-hide hidden">' . "\n";
-        $d_cont .= '<div class="ee-notices"></div>';
-        $d_cont .= '<div class="ee-admin-dialog-container-inner-content"></div>';
-        $d_cont .= '</div>';
-        echo $d_cont;
-        //help tour stuff?
-        if (isset($this->_help_tour[$this->_req_action])) {
-            echo implode('<br />', $this->_help_tour[$this->_req_action]);
-        }
-        //current set timezone for timezone js
-        echo '<span id="current_timezone" class="hidden">' . EEH_DTT_Helper::get_timezone() . '</span>';
-    }
-
-
-
-    /**
-     * This function sees if there is a method for help popup content existing for the given route.  If there is then we'll use the retrieved array to output the content using the template.
-     * For child classes:
-     * If you want to have help popups then in your templates or your content you set "triggers" for the content using the "_set_help_trigger('help_trigger_id')" where "help_trigger_id" is what you will use later in your custom method for
-     * the help popup content on that page. Then in your Child_Admin_Page class you need to define a help popup method for the content in the format "_help_popup_content_{route_name}()"  So if you are setting help content for the
-     * 'edit_event' route you should have a method named "_help_popup_content_edit_route". In your defined "help_popup_content_..." method.  You must prepare and return an array in the following format array(
-     *    'help_trigger_id' => array(
-     *        'title' => __('localized title for popup', 'event_espresso'),
-     *        'content' => __('localized content for popup', 'event_espresso')
-     *    )
-     * );
-     * Then the EE_Admin_Parent will take care of making sure that is setup properly on the correct route.
-     *
-     * @access protected
-     * @return string content
-     */
-    protected function _set_help_popup_content($help_array = array(), $display = false)
-    {
-        $content = '';
-        $help_array = empty($help_array) ? $this->_get_help_content() : $help_array;
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php';
-        //loop through the array and setup content
-        foreach ($help_array as $trigger => $help) {
-            //make sure the array is setup properly
-            if ( ! isset($help['title']) || ! isset($help['content'])) {
-                throw new EE_Error(__('Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
-                        'event_espresso'));
-            }
-            //we're good so let'd setup the template vars and then assign parsed template content to our content.
-            $template_args = array(
-                    'help_popup_id'      => $trigger,
-                    'help_popup_title'   => $help['title'],
-                    'help_popup_content' => $help['content'],
-            );
-            $content .= EEH_Template::display_template($template_path, $template_args, true);
-        }
-        if ($display) {
-            echo $content;
-        } else {
-            return $content;
-        }
-    }
-
-
-
-    /**
-     * All this does is retrive the help content array if set by the EE_Admin_Page child
-     *
-     * @access private
-     * @return array properly formatted array for help popup content
-     */
-    private function _get_help_content()
-    {
-        //what is the method we're looking for?
-        $method_name = '_help_popup_content_' . $this->_req_action;
-        //if method doesn't exist let's get out.
-        if ( ! method_exists($this, $method_name)) {
-            return array();
-        }
-        //k we're good to go let's retrieve the help array
-        $help_array = call_user_func(array($this, $method_name));
-        //make sure we've got an array!
-        if ( ! is_array($help_array)) {
-            throw new EE_Error(__('Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.', 'event_espresso'));
-        }
-        return $help_array;
-    }
-
-
-
-    /**
-     * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
-     * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
-     * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
-     *
-     * @access protected
-     * @param string  $trigger_id reference for retrieving the trigger content for the popup
-     * @param boolean $display    if false then we return the trigger string
-     * @param array   $dimensions an array of dimensions for the box (array(h,w))
-     * @return string
-     */
-    protected function _set_help_trigger($trigger_id, $display = true, $dimensions = array('400', '640'))
-    {
-        if (defined('DOING_AJAX')) {
-            return;
-        }
-        //let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
-        $help_array = $this->_get_help_content();
-        $help_content = '';
-        if (empty($help_array) || ! isset($help_array[$trigger_id])) {
-            $help_array[$trigger_id] = array(
-                    'title'   => __('Missing Content', 'event_espresso'),
-                    'content' => __('A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
-                            'event_espresso'),
-            );
-            $help_content = $this->_set_help_popup_content($help_array, false);
-        }
-        //let's setup the trigger
-        $content = '<a class="ee-dialog" href="?height=' . $dimensions[0] . '&width=' . $dimensions[1] . '&inlineId=' . $trigger_id . '" target="_blank"><span class="question ee-help-popup-question"></span></a>';
-        $content = $content . $help_content;
-        if ($display) {
-            echo $content;
-        } else {
-            return $content;
-        }
-    }
-
-
-
-    /**
-     * _add_global_screen_options
-     * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
-     * This particular method will add_screen_options on ALL EE_Admin Pages
-     *
-     * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
-     *         see also WP_Screen object documents...
-     * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
-     * @abstract
-     * @access private
-     * @return void
-     */
-    private function _add_global_screen_options()
-    {
-    }
-
-
-
-    /**
-     * _add_global_feature_pointers
-     * This method is used for implementing any "feature pointers" (using built-in WP styling js).
-     * This particular method will implement feature pointers for ALL EE_Admin pages.
-     * Note: this is just a placeholder for now.  Implementation will come down the road
-     *
-     * @see    WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
-     * @link   http://eamann.com/tech/wordpress-portland/
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    private function _add_global_feature_pointers()
-    {
-    }
-
-
-
-    /**
-     * load_global_scripts_styles
-     * The scripts and styles enqueued in here will be loaded on every EE Admin page
-     *
-     * @return void
-     */
-    public function load_global_scripts_styles()
-    {
-        /** STYLES **/
-        // add debugging styles
-        if (WP_DEBUG) {
-            add_action('admin_head', array($this, 'add_xdebug_style'));
-        }
-        //register all styles
-        wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
-        wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', array(), EVENT_ESPRESSO_VERSION);
-        //helpers styles
-        wp_register_style('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css', array(), EVENT_ESPRESSO_VERSION);
-        //enqueue global styles
-        wp_enqueue_style('ee-admin-css');
-        /** SCRIPTS **/
-        //register all scripts
-        wp_register_script('espresso_core', EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-dialog', EE_ADMIN_URL . 'assets/ee-dialog-helper.js', array('jquery', 'jquery-ui-draggable'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee_admin_js', EE_ADMIN_URL . 'assets/ee-admin-page.js', array('espresso_core', 'ee-parse-uri', 'ee-dialog'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('jquery-ui-timepicker-addon', EE_GLOBAL_ASSETS_URL . 'scripts/jquery-ui-timepicker-addon.js', array('jquery-ui-datepicker', 'jquery-ui-slider'), EVENT_ESPRESSO_VERSION, true);
-        // register jQuery Validate - see /includes/functions/wp_hooks.php
-        add_filter('FHEE_load_jquery_validate', '__return_true');
-        add_filter('FHEE_load_joyride', '__return_true');
-        //script for sorting tables
-        wp_register_script('espresso_ajax_table_sorting', EE_ADMIN_URL . "assets/espresso_ajax_table_sorting.js", array('ee_admin_js', 'jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, true);
-        //script for parsing uri's
-        wp_register_script('ee-parse-uri', EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js', array(), EVENT_ESPRESSO_VERSION, true);
-        //and parsing associative serialized form elements
-        wp_register_script('ee-serialize-full-array', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
-        //helpers scripts
-        wp_register_script('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-moment-core', EE_THIRD_PARTY_URL . 'moment/moment-with-locales.min.js', array(), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-moment', EE_THIRD_PARTY_URL . 'moment/moment-timezone-with-data.min.js', array('ee-moment-core'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-datepicker', EE_ADMIN_URL . 'assets/ee-datepicker.js', array('jquery-ui-timepicker-addon', 'ee-moment'), EVENT_ESPRESSO_VERSION, true);
-        //google charts
-        wp_register_script('google-charts', 'https://www.gstatic.com/charts/loader.js', array(), EVENT_ESPRESSO_VERSION, false);
-        //enqueue global scripts
-        //taking care of metaboxes
-        if ((isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes'])) && empty($this->_cpt_route)) {
-            wp_enqueue_script('dashboard');
-        }
-        //enqueue thickbox for ee help popups.  default is to enqueue unless its explicitly set to false since we're assuming all EE pages will have popups
-        if ( ! isset($this->_route_config['has_help_popups']) || (isset($this->_route_config['has_help_popups']) && $this->_route_config['has_help_popups'])) {
-            wp_enqueue_script('ee_admin_js');
-            wp_enqueue_style('ee-admin-css');
-        }
-        //localize script for ajax lazy loading
-        $lazy_loader_container_ids = apply_filters('FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers', array('espresso_news_post_box_content'));
-        wp_localize_script('ee_admin_js', 'eeLazyLoadingContainers', $lazy_loader_container_ids);
-        /**
-         * help tour stuff
-         */
-        if ( ! empty($this->_help_tour)) {
-            //register the js for kicking things off
-            wp_enqueue_script('ee-help-tour', EE_ADMIN_URL . 'assets/ee-help-tour.js', array('jquery-joyride'), EVENT_ESPRESSO_VERSION, true);
-            //setup tours for the js tour object
-            foreach ($this->_help_tour['tours'] as $tour) {
-                $tours[] = array(
-                        'id'      => $tour->get_slug(),
-                        'options' => $tour->get_options(),
-                );
-            }
-            wp_localize_script('ee-help-tour', 'EE_HELP_TOUR', array('tours' => $tours));
-            //admin_footer_global will take care of making sure our help_tour skeleton gets printed via the info stored in $this->_help_tour
-        }
-    }
-
-
-
-    /**
-     *        admin_footer_scripts_eei18n_js_strings
-     *
-     * @access        public
-     * @return        void
-     */
-    public function admin_footer_scripts_eei18n_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['ajax_url'] = WP_AJAX_URL;
-        EE_Registry::$i18n_js_strings['confirm_delete'] = __('Are you absolutely sure you want to delete this item?\nThis action will delete ALL DATA associated with this item!!!\nThis can NOT be undone!!!', 'event_espresso');
-        EE_Registry::$i18n_js_strings['January'] = __('January', 'event_espresso');
-        EE_Registry::$i18n_js_strings['February'] = __('February', 'event_espresso');
-        EE_Registry::$i18n_js_strings['March'] = __('March', 'event_espresso');
-        EE_Registry::$i18n_js_strings['April'] = __('April', 'event_espresso');
-        EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
-        EE_Registry::$i18n_js_strings['June'] = __('June', 'event_espresso');
-        EE_Registry::$i18n_js_strings['July'] = __('July', 'event_espresso');
-        EE_Registry::$i18n_js_strings['August'] = __('August', 'event_espresso');
-        EE_Registry::$i18n_js_strings['September'] = __('September', 'event_espresso');
-        EE_Registry::$i18n_js_strings['October'] = __('October', 'event_espresso');
-        EE_Registry::$i18n_js_strings['November'] = __('November', 'event_espresso');
-        EE_Registry::$i18n_js_strings['December'] = __('December', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Jan'] = __('Jan', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Feb'] = __('Feb', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Mar'] = __('Mar', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Apr'] = __('Apr', 'event_espresso');
-        EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Jun'] = __('Jun', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Jul'] = __('Jul', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Aug'] = __('Aug', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Sep'] = __('Sep', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Oct'] = __('Oct', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Nov'] = __('Nov', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Dec'] = __('Dec', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Sunday'] = __('Sunday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Monday'] = __('Monday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Tuesday'] = __('Tuesday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Wednesday'] = __('Wednesday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Thursday'] = __('Thursday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Friday'] = __('Friday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Saturday'] = __('Saturday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Sun'] = __('Sun', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Mon'] = __('Mon', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Tue'] = __('Tue', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Wed'] = __('Wed', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Thu'] = __('Thu', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Fri'] = __('Fri', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Sat'] = __('Sat', 'event_espresso');
-        //setting on espresso_core instead of ee_admin_js because espresso_core is enqueued by the maintenance
-        //admin page when in maintenance mode and ee_admin_js is not loaded then.  This works everywhere else because
-        //espresso_core is listed as a dependency of ee_admin_js.
-        wp_localize_script('espresso_core', 'eei18n', EE_Registry::$i18n_js_strings);
-    }
-
-
-
-    /**
-     *        load enhanced xdebug styles for ppl with failing eyesight
-     *
-     * @access        public
-     * @return        void
-     */
-    public function add_xdebug_style()
-    {
-        echo '<style>.xdebug-error { font-size:1.5em; }</style>';
-    }
-
-
-    /************************/
-    /** LIST TABLE METHODS **/
-    /************************/
-    /**
-     * this sets up the list table if the current view requires it.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_list_table()
-    {
-        //first is this a list_table view?
-        if ( ! isset($this->_route_config['list_table'])) {
-            return;
-        } //not a list_table view so get out.
-        //list table functions are per view specific (because some admin pages might have more than one listtable!)
-        if (call_user_func(array($this, '_set_list_table_views_' . $this->_req_action)) === false) {
-            //user error msg
-            $error_msg = __('An error occurred. The requested list table views could not be found.', 'event_espresso');
-            //developer error msg
-            $error_msg .= '||' . sprintf(__('List table views for "%s" route could not be setup. Check that you have the corresponding method, "%s" set up for defining list_table_views for this route.', 'event_espresso'),
-                            $this->_req_action, '_set_list_table_views_' . $this->_req_action);
-            throw new EE_Error($error_msg);
-        }
-        //let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action, $this->_views);
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
-        $this->_views = apply_filters('FHEE_list_table_views', $this->_views);
-        $this->_set_list_table_view();
-        $this->_set_list_table_object();
-    }
-
-
-
-    /**
-     *        set current view for List Table
-     *
-     * @access public
-     * @return array
-     */
-    protected function _set_list_table_view()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // looking at active items or dumpster diving ?
-        if ( ! isset($this->_req_data['status']) || ! array_key_exists($this->_req_data['status'], $this->_views)) {
-            $this->_view = isset($this->_views['in_use']) ? 'in_use' : 'all';
-        } else {
-            $this->_view = sanitize_key($this->_req_data['status']);
-        }
-    }
-
-
-
-    /**
-     * _set_list_table_object
-     * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
-     *
-     * @throws \EE_Error
-     */
-    protected function _set_list_table_object()
-    {
-        if (isset($this->_route_config['list_table'])) {
-            if ( ! class_exists($this->_route_config['list_table'])) {
-                throw new EE_Error(
-                        sprintf(
-                                __(
-                                        'The %s class defined for the list table does not exist.  Please check the spelling of the class ref in the $_page_config property on %s.',
-                                        'event_espresso'
-                                ),
-                                $this->_route_config['list_table'],
-                                get_class($this)
-                        )
-                );
-            }
-            $list_table = $this->_route_config['list_table'];
-            $this->_list_table_object = new $list_table($this);
-        }
-    }
-
-
-
-    /**
-     * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
-     *
-     * @param array $extra_query_args                     Optional. An array of extra query args to add to the generated
-     *                                                    urls.  The array should be indexed by the view it is being
-     *                                                    added to.
-     * @return array
-     */
-    public function get_list_table_view_RLs($extra_query_args = array())
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (empty($this->_views)) {
-            $this->_views = array();
-        }
-        // cycle thru views
-        foreach ($this->_views as $key => $view) {
-            $query_args = array();
-            // check for current view
-            $this->_views[$key]['class'] = $this->_view == $view['slug'] ? 'current' : '';
-            $query_args['action'] = $this->_req_action;
-            $query_args[$this->_req_action . '_nonce'] = wp_create_nonce($query_args['action'] . '_nonce');
-            $query_args['status'] = $view['slug'];
-            //merge any other arguments sent in.
-            if (isset($extra_query_args[$view['slug']])) {
-                $query_args = array_merge($query_args, $extra_query_args[$view['slug']]);
-            }
-            $this->_views[$key]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-        }
-        return $this->_views;
-    }
-
-
-
-    /**
-     * _entries_per_page_dropdown
-     * generates a drop down box for selecting the number of visiable rows in an admin page list table
-     *
-     * @todo   : Note: ideally this should be added to the screen options dropdown as that would be consistent with how WP does it.
-     * @access protected
-     * @param int $max_entries total number of rows in the table
-     * @return string
-     */
-    protected function _entries_per_page_dropdown($max_entries = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $values = array(10, 25, 50, 100);
-        $per_page = ( ! empty($this->_req_data['per_page'])) ? absint($this->_req_data['per_page']) : 10;
-        if ($max_entries) {
-            $values[] = $max_entries;
-            sort($values);
-        }
-        $entries_per_page_dropdown = '
+	// yes / no array for admin form fields
+	protected $_yes_no_values = array();
+
+	//some default things shared by all child classes
+	protected $_default_espresso_metaboxes;
+
+	/**
+	 *    EE_Registry Object
+	 *
+	 * @var    EE_Registry
+	 * @access    protected
+	 */
+	protected $EE = null;
+
+
+
+	/**
+	 * This is just a property that flags whether the given route is a caffeinated route or not.
+	 *
+	 * @var boolean
+	 */
+	protected $_is_caf = false;
+
+
+
+	/**
+	 * @Constructor
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @access public
+	 */
+	public function __construct($routing = true)
+	{
+		if (strpos($this->_get_dir(), 'caffeinated') !== false) {
+			$this->_is_caf = true;
+		}
+		$this->_yes_no_values = array(
+				array('id' => true, 'text' => __('Yes', 'event_espresso')),
+				array('id' => false, 'text' => __('No', 'event_espresso')),
+		);
+		//set the _req_data property.
+		$this->_req_data = array_merge($_GET, $_POST);
+		//routing enabled?
+		$this->_routing = $routing;
+		//set initial page props (child method)
+		$this->_init_page_props();
+		//set global defaults
+		$this->_set_defaults();
+		//set early because incoming requests could be ajax related and we need to register those hooks.
+		$this->_global_ajax_hooks();
+		$this->_ajax_hooks();
+		//other_page_hooks have to be early too.
+		$this->_do_other_page_hooks();
+		//This just allows us to have extending clases do something specific before the parent constructor runs _page_setup.
+		if (method_exists($this, '_before_page_setup')) {
+			$this->_before_page_setup();
+		}
+		//set up page dependencies
+		$this->_page_setup();
+	}
+
+
+
+	/**
+	 * _init_page_props
+	 * Child classes use to set at least the following properties:
+	 * $page_slug.
+	 * $page_label.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _init_page_props();
+
+
+
+	/**
+	 * _ajax_hooks
+	 * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
+	 * Note: within the ajax callback methods.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _ajax_hooks();
+
+
+
+	/**
+	 * _define_page_props
+	 * child classes define page properties in here.  Must include at least:
+	 * $_admin_base_url = base_url for all admin pages
+	 * $_admin_page_title = default admin_page_title for admin pages
+	 * $_labels = array of default labels for various automatically generated elements:
+	 *    array(
+	 *        'buttons' => array(
+	 *            'add' => __('label for add new button'),
+	 *            'edit' => __('label for edit button'),
+	 *            'delete' => __('label for delete button')
+	 *            )
+	 *        )
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _define_page_props();
+
+
+
+	/**
+	 * _set_page_routes
+	 * child classes use this to define the page routes for all subpages handled by the class.  Page routes are assigned to a action => method pairs in an array and to the $_page_routes property.  Each page route must also have a 'default'
+	 * route. Here's the format
+	 * $this->_page_routes = array(
+	 *        'default' => array(
+	 *            'func' => '_default_method_handling_route',
+	 *            'args' => array('array','of','args'),
+	 *            'noheader' => true, //add this in if this page route is processed before any headers are loaded (i.e. ajax request, backend processing)
+	 *            'headers_sent_route'=>'headers_route_reference', //add this if noheader=>true, and you want to load a headers route after.  The string you enter here should match the defined route reference for a headers sent route.
+	 *            'capability' => 'route_capability', //indicate a string for minimum capability required to access this route.
+	 *            'obj_id' => 10 // if this route has an object id, then this can include it (used for capability checks).
+	 *        ),
+	 *        'insert_item' => '_method_for_handling_insert_item' //this can be used if all we need to have is a handling method.
+	 *        )
+	 * )
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_page_routes();
+
+
+
+	/**
+	 * _set_page_config
+	 * child classes use this to define the _page_config array for all subpages handled by the class. Each key in the array corresponds to the page_route for the loaded page.
+	 * Format:
+	 * $this->_page_config = array(
+	 *        'default' => array(
+	 *            'labels' => array(
+	 *                'buttons' => array(
+	 *                    'add' => __('label for adding item'),
+	 *                    'edit' => __('label for editing item'),
+	 *                    'delete' => __('label for deleting item')
+	 *                ),
+	 *                'publishbox' => __('Localized Title for Publish metabox', 'event_espresso')
+	 *            ), //optional an array of custom labels for various automatically generated elements to use on the page. If this isn't present then the defaults will be used as set for the $this->_labels in _define_page_props() method
+	 *            'nav' => array(
+	 *                'label' => __('Label for Tab', 'event_espresso').
+	 *                'url' => 'http://someurl', //automatically generated UNLESS you define
+	 *                'css_class' => 'css-class', //automatically generated UNLESS you define
+	 *                'order' => 10, //required to indicate tab position.
+	 *                'persistent' => false //if you want the nav tab to ONLY display when the specific route is displayed then add this parameter.
+	 *            'list_table' => 'name_of_list_table' //string for list table class to be loaded for this admin_page.
+	 *            'metaboxes' => array('metabox1', 'metabox2'), //if present this key indicates we want to load metaboxes set for eventespresso admin pages.
+	 *            'has_metaboxes' => true, //this boolean flag can simply be used to indicate if the route will have metaboxes.  Typically this is used if the 'metaboxes' index is not used because metaboxes are added later.  We just use
+	 *            this flag to make sure the necessary js gets enqueued on page load.
+	 *            'has_help_popups' => false //defaults(true) //this boolean flag can simply be used to indicate if the given route has help popups setup and if it does then we need to make sure thickbox is enqueued.
+	 *            'columns' => array(4, 2), //this key triggers the setup of a page that uses columns (metaboxes).  The array indicates the max number of columns (4) and the default number of columns on page load (2).  There is an option
+	 *            in the "screen_options" dropdown that is setup so users can pick what columns they want to display.
+	 *            'help_tabs' => array( //this is used for adding help tabs to a page
+	 *                'tab_id' => array(
+	 *                    'title' => 'tab_title',
+	 *                    'filename' => 'name_of_file_containing_content', //this is the primary method for setting help tab content.  The fallback if it isn't present is to try a the callback.  Filename should match a file in the admin
+	 *                    folder's "help_tabs" dir (ie.. events/help_tabs/name_of_file_containing_content.help_tab.php)
+	 *                    'callback' => 'callback_method_for_content', //if 'filename' isn't present then system will attempt to use the callback which should match the name of a method in the class
+	 *                    ),
+	 *                'tab2_id' => array(
+	 *                    'title' => 'tab2 title',
+	 *                    'filename' => 'file_name_2'
+	 *                    'callback' => 'callback_method_for_content',
+	 *                 ),
+	 *            'help_sidebar' => 'callback_for_sidebar_content', //this is used for setting up the sidebar in the help tab area on an admin page. @link http://make.wordpress.org/core/2011/12/06/help-and-screen-api-changes-in-3-3/
+	 *            'help_tour' => array(
+	 *                'name_of_help_tour_class', //all help tours shoudl be a child class of EE_Help_Tour and located in a folder for this admin page named "help_tours", a file name matching the key given here
+	 *                (name_of_help_tour_class.class.php), and class matching key given here (name_of_help_tour_class)
+	 *            ),
+	 *            'require_nonce' => TRUE //this is used if you want to set a route to NOT require a nonce (default is true if it isn't present).  To remove the requirement for a nonce check when this route is visited just set
+	 *            'require_nonce' to FALSE
+	 *            )
+	 * )
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_page_config();
+
+
+
+
+
+	/** end sample help_tour methods **/
+	/**
+	 * _add_screen_options
+	 * Child classes can add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
+	 * Note child classes can also define _add_screen_options_($this->_current_view) to limit screen options to a particular view.
+	 *
+	 * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
+	 *         see also WP_Screen object documents...
+	 * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _add_screen_options();
+
+
+
+	/**
+	 * _add_feature_pointers
+	 * Child classes should use this method for implementing any "feature pointers" (using built-in WP styling js).
+	 * Note child classes can also define _add_feature_pointers_($this->_current_view) to limit screen options to a particular view.
+	 * Note: this is just a placeholder for now.  Implementation will come down the road
+	 * See: WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
+	 *
+	 * @link   http://eamann.com/tech/wordpress-portland/
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _add_feature_pointers();
+
+
+
+	/**
+	 * load_scripts_styles
+	 * child classes put their wp_enqueue_script and wp_enqueue_style hooks in here for anything they need loaded for their pages/subpages.  Note this is for all pages/subpages of the system.  You can also load only specific scripts/styles
+	 * per view by putting them in a dynamic function in this format (load_scripts_styles_{$this->_current_view}) which matches your page route (action request arg)
+	 *
+	 * @abstract
+	 * @access public
+	 * @return void
+	 */
+	abstract public function load_scripts_styles();
+
+
+
+	/**
+	 * admin_init
+	 * Anything that should be set/executed at 'admin_init' WP hook runtime should be put in here.  This will apply to all pages/views loaded by child class.
+	 *
+	 * @abstract
+	 * @access public
+	 * @return void
+	 */
+	abstract public function admin_init();
+
+
+
+	/**
+	 * admin_notices
+	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply to all pages/views loaded by child class.
+	 *
+	 * @abstract
+	 * @access public
+	 * @return void
+	 */
+	abstract public function admin_notices();
+
+
+
+	/**
+	 * admin_footer_scripts
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method will apply to all pages/views loaded by child class.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	abstract public function admin_footer_scripts();
+
+
+
+	/**
+	 * admin_footer
+	 * anything triggered by the 'admin_footer' WP action hook should be added to here. This particular method will apply to all pages/views loaded by child class.
+	 *
+	 * @access  public
+	 * @return void
+	 */
+	public function admin_footer()
+	{
+	}
+
+
+
+	/**
+	 * _global_ajax_hooks
+	 * all global add_action('wp_ajax_{name_of_hook}') hooks in here.
+	 * Note: within the ajax callback methods.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	protected function _global_ajax_hooks()
+	{
+		//for lazy loading of metabox content
+		add_action('wp_ajax_espresso-ajax-content', array($this, 'ajax_metabox_content'), 10);
+	}
+
+
+
+	public function ajax_metabox_content()
+	{
+		$contentid = isset($this->_req_data['contentid']) ? $this->_req_data['contentid'] : '';
+		$url = isset($this->_req_data['contenturl']) ? $this->_req_data['contenturl'] : '';
+		self::cached_rss_display($contentid, $url);
+		wp_die();
+	}
+
+
+
+	/**
+	 * _page_setup
+	 * Makes sure any things that need to be loaded early get handled.  We also escape early here if the page requested doesn't match the object.
+	 *
+	 * @final
+	 * @access protected
+	 * @return void
+	 */
+	final protected function _page_setup()
+	{
+		//requires?
+		//admin_init stuff - global - we're setting this REALLY early so if EE_Admin pages have to hook into other WP pages they can.  But keep in mind, not everything is available from the EE_Admin Page object at this point.
+		add_action('admin_init', array($this, 'admin_init_global'), 5);
+		//next verify if we need to load anything...
+		$this->_current_page = ! empty($_GET['page']) ? sanitize_key($_GET['page']) : '';
+		$this->page_folder = strtolower(str_replace('_Admin_Page', '', str_replace('Extend_', '', get_class($this))));
+		global $ee_menu_slugs;
+		$ee_menu_slugs = (array)$ee_menu_slugs;
+		if (( ! $this->_current_page || ! isset($ee_menu_slugs[$this->_current_page])) && ! defined('DOING_AJAX')) {
+			return false;
+		}
+		// becuz WP List tables have two duplicate select inputs for choosing bulk actions, we need to copy the action from the second to the first
+		if (isset($this->_req_data['action2']) && $this->_req_data['action'] == -1) {
+			$this->_req_data['action'] = ! empty($this->_req_data['action2']) && $this->_req_data['action2'] != -1 ? $this->_req_data['action2'] : $this->_req_data['action'];
+		}
+		// then set blank or -1 action values to 'default'
+		$this->_req_action = isset($this->_req_data['action']) && ! empty($this->_req_data['action']) && $this->_req_data['action'] != -1 ? sanitize_key($this->_req_data['action']) : 'default';
+		//if action is 'default' after the above BUT we have  'route' var set, then let's use the route as the action.  This covers cases where we're coming in from a list table that isn't on the default route.
+		$this->_req_action = $this->_req_action == 'default' && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
+		//however if we are doing_ajax and we've got a 'route' set then that's what the req_action will be
+		$this->_req_action = defined('DOING_AJAX') && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
+		$this->_current_view = $this->_req_action;
+		$this->_req_nonce = $this->_req_action . '_nonce';
+		$this->_define_page_props();
+		$this->_current_page_view_url = add_query_arg(array('page' => $this->_current_page, 'action' => $this->_current_view), $this->_admin_base_url);
+		//default things
+		$this->_default_espresso_metaboxes = array('_espresso_news_post_box', '_espresso_links_post_box', '_espresso_ratings_request', '_espresso_sponsors_post_box');
+		//set page configs
+		$this->_set_page_routes();
+		$this->_set_page_config();
+		//let's include any referrer data in our default_query_args for this route for "stickiness".
+		if (isset($this->_req_data['wp_referer'])) {
+			$this->_default_route_query_args['wp_referer'] = $this->_req_data['wp_referer'];
+		}
+		//for caffeinated and other extended functionality.  If there is a _extend_page_config method then let's run that to modify the all the various page configuration arrays
+		if (method_exists($this, '_extend_page_config')) {
+			$this->_extend_page_config();
+		}
+		//for CPT and other extended functionality. If there is an _extend_page_config_for_cpt then let's run that to modify all the various page configuration arrays.
+		if (method_exists($this, '_extend_page_config_for_cpt')) {
+			$this->_extend_page_config_for_cpt();
+		}
+		//filter routes and page_config so addons can add their stuff. Filtering done per class
+		$this->_page_routes = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_routes', $this->_page_routes, $this);
+		$this->_page_config = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_config', $this->_page_config, $this);
+		//if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
+		if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
+			add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view), 10, 2);
+		}
+		//next route only if routing enabled
+		if ($this->_routing && ! defined('DOING_AJAX')) {
+			$this->_verify_routes();
+			//next let's just check user_access and kill if no access
+			$this->check_user_access();
+			if ($this->_is_UI_request) {
+				//admin_init stuff - global, all views for this page class, specific view
+				add_action('admin_init', array($this, 'admin_init'), 10);
+				if (method_exists($this, 'admin_init_' . $this->_current_view)) {
+					add_action('admin_init', array($this, 'admin_init_' . $this->_current_view), 15);
+				}
+			} else {
+				//hijack regular WP loading and route admin request immediately
+				@ini_set('memory_limit', apply_filters('admin_memory_limit', WP_MAX_MEMORY_LIMIT));
+				$this->route_admin_request();
+			}
+		}
+	}
+
+
+
+	/**
+	 * Provides a way for related child admin pages to load stuff on the loaded admin page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _do_other_page_hooks()
+	{
+		$registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, array());
+		foreach ($registered_pages as $page) {
+			//now let's setup the file name and class that should be present
+			$classname = str_replace('.class.php', '', $page);
+			//autoloaders should take care of loading file
+			if ( ! class_exists($classname)) {
+				$error_msg[] = sprintf(__('Something went wrong with loading the %s admin hooks page.', 'event_espresso'), $page);
+				$error_msg[] = $error_msg[0]
+							   . "\r\n"
+							   . sprintf(__('There is no class in place for the %s admin hooks page.%sMake sure you have <strong>%s</strong> defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
+								'event_espresso'), $page, '<br />', $classname);
+				throw new EE_Error(implode('||', $error_msg));
+			}
+			$a = new ReflectionClass($classname);
+			//notice we are passing the instance of this class to the hook object.
+			$hookobj[] = $a->newInstance($this);
+		}
+	}
+
+
+
+	public function load_page_dependencies()
+	{
+		try {
+			$this->_load_page_dependencies();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+
+	/**
+	 * load_page_dependencies
+	 * loads things specific to this page class when its loaded.  Really helps with efficiency.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	protected function _load_page_dependencies()
+	{
+		//let's set the current_screen and screen options to override what WP set
+		$this->_current_screen = get_current_screen();
+		//load admin_notices - global, page class, and view specific
+		add_action('admin_notices', array($this, 'admin_notices_global'), 5);
+		add_action('admin_notices', array($this, 'admin_notices'), 10);
+		if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
+			add_action('admin_notices', array($this, 'admin_notices_' . $this->_current_view), 15);
+		}
+		//load network admin_notices - global, page class, and view specific
+		add_action('network_admin_notices', array($this, 'network_admin_notices_global'), 5);
+		if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
+			add_action('network_admin_notices', array($this, 'network_admin_notices_' . $this->_current_view));
+		}
+		//this will save any per_page screen options if they are present
+		$this->_set_per_page_screen_options();
+		//setup list table properties
+		$this->_set_list_table();
+		// child classes can "register" a metabox to be automatically handled via the _page_config array property.  However in some cases the metaboxes will need to be added within a route handling callback.
+		$this->_add_registered_meta_boxes();
+		$this->_add_screen_columns();
+		//add screen options - global, page child class, and view specific
+		$this->_add_global_screen_options();
+		$this->_add_screen_options();
+		if (method_exists($this, '_add_screen_options_' . $this->_current_view)) {
+			call_user_func(array($this, '_add_screen_options_' . $this->_current_view));
+		}
+		//add help tab(s) and tours- set via page_config and qtips.
+		$this->_add_help_tour();
+		$this->_add_help_tabs();
+		$this->_add_qtips();
+		//add feature_pointers - global, page child class, and view specific
+		$this->_add_feature_pointers();
+		$this->_add_global_feature_pointers();
+		if (method_exists($this, '_add_feature_pointer_' . $this->_current_view)) {
+			call_user_func(array($this, '_add_feature_pointer_' . $this->_current_view));
+		}
+		//enqueue scripts/styles - global, page class, and view specific
+		add_action('admin_enqueue_scripts', array($this, 'load_global_scripts_styles'), 5);
+		add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles'), 10);
+		if (method_exists($this, 'load_scripts_styles_' . $this->_current_view)) {
+			add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles_' . $this->_current_view), 15);
+		}
+		add_action('admin_enqueue_scripts', array($this, 'admin_footer_scripts_eei18n_js_strings'), 100);
+		//admin_print_footer_scripts - global, page child class, and view specific.  NOTE, despite the name, whenever possible, scripts should NOT be loaded using this.  In most cases that's doing_it_wrong().  But adding hidden container elements etc. is a good use case. Notice the late priority we're giving these
+		add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_global'), 99);
+		add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts'), 100);
+		if (method_exists($this, 'admin_footer_scripts_' . $this->_current_view)) {
+			add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_' . $this->_current_view), 101);
+		}
+		//admin footer scripts
+		add_action('admin_footer', array($this, 'admin_footer_global'), 99);
+		add_action('admin_footer', array($this, 'admin_footer'), 100);
+		if (method_exists($this, 'admin_footer_' . $this->_current_view)) {
+			add_action('admin_footer', array($this, 'admin_footer_' . $this->_current_view), 101);
+		}
+		do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', $this->page_slug);
+		//targeted hook
+		do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load__' . $this->page_slug . '__' . $this->_req_action);
+	}
+
+
+
+	/**
+	 * _set_defaults
+	 * This sets some global defaults for class properties.
+	 */
+	private function _set_defaults()
+	{
+		$this->_current_screen = $this->_admin_page_title = $this->_req_action = $this->_req_nonce = $this->_event = $this->_template_path = $this->_column_template_path = null;
+		$this->_nav_tabs = $this_views = $this->_page_routes = $this->_page_config = $this->_default_route_query_args = array();
+		$this->default_nav_tab_name = 'overview';
+		//init template args
+		$this->_template_args = array(
+				'admin_page_header'  => '',
+				'admin_page_content' => '',
+				'post_body_content'  => '',
+				'before_list_table'  => '',
+				'after_list_table'   => '',
+		);
+	}
+
+
+
+	/**
+	 * route_admin_request
+	 *
+	 * @see    _route_admin_request()
+	 * @access public
+	 * @return void|exception error
+	 */
+	public function route_admin_request()
+	{
+		try {
+			$this->_route_admin_request();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+
+	public function set_wp_page_slug($wp_page_slug)
+	{
+		$this->_wp_page_slug = $wp_page_slug;
+		//if in network admin then we need to append "-network" to the page slug. Why? Because that's how WP rolls...
+		if (is_network_admin()) {
+			$this->_wp_page_slug .= '-network';
+		}
+	}
+
+
+
+	/**
+	 * _verify_routes
+	 * All this method does is verify the incoming request and make sure that routes exist for it.  We do this early so we know if we need to drop out.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _verify_routes()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if ( ! $this->_current_page && ! defined('DOING_AJAX')) {
+			return false;
+		}
+		$this->_route = false;
+		$func = false;
+		$args = array();
+		// check that the page_routes array is not empty
+		if (empty($this->_page_routes)) {
+			// user error msg
+			$error_msg = sprintf(__('No page routes have been set for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
+			// developer error msg
+			$error_msg .= '||' . $error_msg . __(' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.', 'event_espresso');
+			throw new EE_Error($error_msg);
+		}
+		// and that the requested page route exists
+		if (array_key_exists($this->_req_action, $this->_page_routes)) {
+			$this->_route = $this->_page_routes[$this->_req_action];
+			$this->_route_config = isset($this->_page_config[$this->_req_action]) ? $this->_page_config[$this->_req_action] : array();
+		} else {
+			// user error msg
+			$error_msg = sprintf(__('The requested page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
+			// developer error msg
+			$error_msg .= '||' . $error_msg . sprintf(__(' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.', 'event_espresso'), $this->_req_action);
+			throw new EE_Error($error_msg);
+		}
+		// and that a default route exists
+		if ( ! array_key_exists('default', $this->_page_routes)) {
+			// user error msg
+			$error_msg = sprintf(__('A default page route has not been set for the % admin page.', 'event_espresso'), $this->_admin_page_title);
+			// developer error msg
+			$error_msg .= '||' . $error_msg . __(' Create a key in the "_page_routes" array named "default" and set its value to your default page method.', 'event_espresso');
+			throw new EE_Error($error_msg);
+		}
+		//first lets' catch if the UI request has EVER been set.
+		if ($this->_is_UI_request === null) {
+			//lets set if this is a UI request or not.
+			$this->_is_UI_request = ( ! isset($this->_req_data['noheader']) || $this->_req_data['noheader'] !== true) ? true : false;
+			//wait a minute... we might have a noheader in the route array
+			$this->_is_UI_request = is_array($this->_route) && isset($this->_route['noheader']) && $this->_route['noheader'] ? false : $this->_is_UI_request;
+		}
+		$this->_set_current_labels();
+	}
+
+
+
+	/**
+	 * this method simply verifies a given route and makes sure its an actual route available for the loaded page
+	 *
+	 * @param  string $route the route name we're verifying
+	 * @return mixed  (bool|Exception)      we'll throw an exception if this isn't a valid route.
+	 */
+	protected function _verify_route($route)
+	{
+		if (array_key_exists($this->_req_action, $this->_page_routes)) {
+			return true;
+		} else {
+			// user error msg
+			$error_msg = sprintf(__('The given page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
+			// developer error msg
+			$error_msg .= '||' . $error_msg . sprintf(__(' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property', 'event_espresso'), $route);
+			throw new EE_Error($error_msg);
+		}
+	}
+
+
+
+	/**
+	 * perform nonce verification
+	 * This method has be encapsulated here so that any ajax requests that bypass normal routes can verify their nonces using this method (and save retyping!)
+	 *
+	 * @param  string $nonce     The nonce sent
+	 * @param  string $nonce_ref The nonce reference string (name0)
+	 * @return mixed (bool|die)
+	 */
+	protected function _verify_nonce($nonce, $nonce_ref)
+	{
+		// verify nonce against expected value
+		if ( ! wp_verify_nonce($nonce, $nonce_ref)) {
+			// these are not the droids you are looking for !!!
+			$msg = sprintf(__('%sNonce Fail.%s', 'event_espresso'), '<a href="http://www.youtube.com/watch?v=56_S0WeTkzs">', '</a>');
+			if (WP_DEBUG) {
+				$msg .= "\n  " . sprintf(__('In order to dynamically generate nonces for your actions, use the %s::add_query_args_and_nonce() method. May the Nonce be with you!', 'event_espresso'), __CLASS__);
+			}
+			if ( ! defined('DOING_AJAX')) {
+				wp_die($msg);
+			} else {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+				$this->_return_json();
+			}
+		}
+	}
+
+
+
+	/**
+	 * _route_admin_request()
+	 * Meat and potatoes of the class.  Basically, this dude checks out what's being requested and sees if theres are
+	 * some doodads to work the magic and handle the flingjangy. Translation:  Checks if the requested action is listed
+	 * in the page routes and then will try to load the corresponding method.
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _route_admin_request()
+	{
+		if ( ! $this->_is_UI_request) {
+			$this->_verify_routes();
+		}
+		$nonce_check = isset($this->_route_config['require_nonce'])
+			? $this->_route_config['require_nonce']
+			: true;
+		if ($this->_req_action !== 'default' && $nonce_check) {
+			// set nonce from post data
+			$nonce = isset($this->_req_data[$this->_req_nonce])
+				? sanitize_text_field($this->_req_data[$this->_req_nonce])
+				: '';
+			$this->_verify_nonce($nonce, $this->_req_nonce);
+		}
+		//set the nav_tabs array but ONLY if this is  UI_request
+		if ($this->_is_UI_request) {
+			$this->_set_nav_tabs();
+		}
+		// grab callback function
+		$func = is_array($this->_route) ? $this->_route['func'] : $this->_route;
+		// check if callback has args
+		$args = is_array($this->_route) && isset($this->_route['args']) ? $this->_route['args'] : array();
+		$error_msg = '';
+		// action right before calling route
+		// (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
+		if ( ! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
+			do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
+		}
+		// right before calling the route, let's remove _wp_http_referer from the
+		// $_SERVER[REQUEST_URI] global (its now in _req_data for route processing).
+		$_SERVER['REQUEST_URI'] = remove_query_arg('_wp_http_referer', wp_unslash($_SERVER['REQUEST_URI']));
+		if ( ! empty($func)) {
+			if (is_array($func)) {
+				list($class, $method) = $func;
+			} else if (strpos($func, '::') !== false) {
+				list($class, $method) = explode('::', $func);
+			} else {
+				$class = $this;
+				$method = $func;
+			}
+			if ( ! (is_object($class) && $class === $this)) {
+				// send along this admin page object for access by addons.
+				$args['admin_page_object'] = $this;
+			}
+
+			if (
+				//is it a method on a class that doesn't work?
+				(
+					(
+						method_exists($class, $method)
+						&& call_user_func_array(array($class, $method), $args) === false
+					)
+					&& (
+						//is it a standalone function that doesn't work?
+						function_exists($method)
+						&& call_user_func_array($func, array_merge(array('admin_page_object' => $this), $args)) === false
+					)
+				)
+				|| (
+					//is it neither a class method NOR a standalone function?
+					! method_exists($class, $method)
+					&& ! function_exists($method)
+				)
+			) {
+				// user error msg
+				$error_msg = __('An error occurred. The  requested page route could not be found.', 'event_espresso');
+				// developer error msg
+				$error_msg .= '||';
+				$error_msg .= sprintf(
+					__(
+						'Page route "%s" could not be called. Check that the spelling for method names and actions in the "_page_routes" array are all correct.',
+						'event_espresso'
+					),
+					$method
+				);
+			}
+			if ( ! empty($error_msg)) {
+				throw new EE_Error($error_msg);
+			}
+		}
+		//if we've routed and this route has a no headers route AND a sent_headers_route, then we need to reset the routing properties to the new route.
+		//now if UI request is FALSE and noheader is true AND we have a headers_sent_route in the route array then let's set UI_request to true because the no header route has a second func after headers have been sent.
+		if ($this->_is_UI_request === false
+			&& is_array($this->_route)
+			&& ! empty($this->_route['headers_sent_route'])
+		) {
+			$this->_reset_routing_properties($this->_route['headers_sent_route']);
+		}
+	}
+
+
+
+	/**
+	 * This method just allows the resetting of page properties in the case where a no headers
+	 * route redirects to a headers route in its route config.
+	 *
+	 * @since   4.3.0
+	 * @param  string $new_route New (non header) route to redirect to.
+	 * @return   void
+	 */
+	protected function _reset_routing_properties($new_route)
+	{
+		$this->_is_UI_request = true;
+		//now we set the current route to whatever the headers_sent_route is set at
+		$this->_req_data['action'] = $new_route;
+		//rerun page setup
+		$this->_page_setup();
+	}
+
+
+
+	/**
+	 * _add_query_arg
+	 * adds nonce to array of arguments then calls WP add_query_arg function
+	 *(internally just uses EEH_URL's function with the same name)
+	 *
+	 * @access public
+	 * @param array  $args
+	 * @param string $url
+	 * @param bool   $sticky                  if true, then the existing Request params will be appended to the generated
+	 *                                        url in an associative array indexed by the key 'wp_referer';
+	 *                                        Example usage:
+	 *                                        If the current page is:
+	 *                                        http://mydomain.com/wp-admin/admin.php?page=espresso_registrations
+	 *                                        &action=default&event_id=20&month_range=March%202015
+	 *                                        &_wpnonce=5467821
+	 *                                        and you call:
+	 *                                        EE_Admin_Page::add_query_args_and_nonce(
+	 *                                        array(
+	 *                                        'action' => 'resend_something',
+	 *                                        'page=>espresso_registrations'
+	 *                                        ),
+	 *                                        $some_url,
+	 *                                        true
+	 *                                        );
+	 *                                        It will produce a url in this structure:
+	 *                                        http://{$some_url}/?page=espresso_registrations&action=resend_something
+	 *                                        &wp_referer[action]=default&wp_referer[event_id]=20&wpreferer[
+	 *                                        month_range]=March%202015
+	 * @param   bool $exclude_nonce           If true, the the nonce will be excluded from the generated nonce.
+	 * @return string
+	 */
+	public static function add_query_args_and_nonce($args = array(), $url = false, $sticky = false, $exclude_nonce = false)
+	{
+		//if there is a _wp_http_referer include the values from the request but only if sticky = true
+		if ($sticky) {
+			$request = $_REQUEST;
+			unset($request['_wp_http_referer']);
+			unset($request['wp_referer']);
+			foreach ($request as $key => $value) {
+				//do not add nonces
+				if (strpos($key, 'nonce') !== false) {
+					continue;
+				}
+				$args['wp_referer[' . $key . ']'] = $value;
+			}
+		}
+		return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
+	}
+
+
+
+	/**
+	 * This returns a generated link that will load the related help tab.
+	 *
+	 * @param  string $help_tab_id the id for the connected help tab
+	 * @param  string $icon_style  (optional) include css class for the style you want to use for the help icon.
+	 * @param  string $help_text   (optional) send help text you want to use for the link if default not to be used
+	 * @uses EEH_Template::get_help_tab_link()
+	 * @return string              generated link
+	 */
+	protected function _get_help_tab_link($help_tab_id, $icon_style = false, $help_text = false)
+	{
+		return EEH_Template::get_help_tab_link($help_tab_id, $this->page_slug, $this->_req_action, $icon_style, $help_text);
+	}
+
+
+
+	/**
+	 * _add_help_tabs
+	 * Note child classes define their help tabs within the page_config array.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/add_help_tab
+	 * @access protected
+	 * @return void
+	 */
+	protected function _add_help_tabs()
+	{
+		$tour_buttons = '';
+		if (isset($this->_page_config[$this->_req_action])) {
+			$config = $this->_page_config[$this->_req_action];
+			//is there a help tour for the current route?  if there is let's setup the tour buttons
+			if (isset($this->_help_tour[$this->_req_action])) {
+				$tb = array();
+				$tour_buttons = '<div class="ee-abs-container"><div class="ee-help-tour-restart-buttons">';
+				foreach ($this->_help_tour['tours'] as $tour) {
+					//if this is the end tour then we don't need to setup a button
+					if ($tour instanceof EE_Help_Tour_final_stop) {
+						continue;
+					}
+					$tb[] = '<button id="trigger-tour-' . $tour->get_slug() . '" class="button-primary trigger-ee-help-tour">' . $tour->get_label() . '</button>';
+				}
+				$tour_buttons .= implode('<br />', $tb);
+				$tour_buttons .= '</div></div>';
+			}
+			// let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
+			if (is_array($config) && isset($config['help_sidebar'])) {
+				//check that the callback given is valid
+				if ( ! method_exists($this, $config['help_sidebar'])) {
+					throw new EE_Error(sprintf(__('The _page_config array has a callback set for the "help_sidebar" option.  However the callback given (%s) is not a valid callback.  Doublecheck the spelling and make sure this method exists for the class %s',
+							'event_espresso'), $config['help_sidebar'], get_class($this)));
+				}
+				$content = apply_filters('FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar', call_user_func(array($this, $config['help_sidebar'])));
+				$content .= $tour_buttons; //add help tour buttons.
+				//do we have any help tours setup?  Cause if we do we want to add the buttons
+				$this->_current_screen->set_help_sidebar($content);
+			}
+			//if we DON'T have config help sidebar and there ARE toure buttons then we'll just add the tour buttons to the sidebar.
+			if ( ! isset($config['help_sidebar']) && ! empty($tour_buttons)) {
+				$this->_current_screen->set_help_sidebar($tour_buttons);
+			}
+			//handle if no help_tabs are set so the sidebar will still show for the help tour buttons
+			if ( ! isset($config['help_tabs']) && ! empty($tour_buttons)) {
+				$_ht['id'] = $this->page_slug;
+				$_ht['title'] = __('Help Tours', 'event_espresso');
+				$_ht['content'] = '<p>' . __('The buttons to the right allow you to start/restart any help tours available for this page', 'event_espresso') . '</p>';
+				$this->_current_screen->add_help_tab($_ht);
+			}/**/
+			if ( ! isset($config['help_tabs'])) {
+				return;
+			} //no help tabs for this route
+			foreach ((array)$config['help_tabs'] as $tab_id => $cfg) {
+				//we're here so there ARE help tabs!
+				//make sure we've got what we need
+				if ( ! isset($cfg['title'])) {
+					throw new EE_Error(__('The _page_config array is not set up properly for help tabs.  It is missing a title', 'event_espresso'));
+				}
+				if ( ! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
+					throw new EE_Error(__('The _page_config array is not setup properly for help tabs. It is missing a either a filename reference, or a callback reference or a content reference so there is no way to know the content for the help tab',
+							'event_espresso'));
+				}
+				//first priority goes to content.
+				if ( ! empty($cfg['content'])) {
+					$content = ! empty($cfg['content']) ? $cfg['content'] : null;
+					//second priority goes to filename
+				} else if ( ! empty($cfg['filename'])) {
+					$file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
+					//it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
+					$file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tabs/' . $cfg['filename'] . '.help_tab.php' : $file_path;
+					//if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
+					if ( ! is_readable($file_path) && ! isset($cfg['callback'])) {
+						EE_Error::add_error(sprintf(__('The filename given for the help tab %s is not a valid file and there is no other configuration for the tab content.  Please check that the string you set for the help tab on this route (%s) is the correct spelling.  The file should be in %s',
+								'event_espresso'), $tab_id, key($config), $file_path), __FILE__, __FUNCTION__, __LINE__);
+						return;
+					}
+					$template_args['admin_page_obj'] = $this;
+					$content = EEH_Template::display_template($file_path, $template_args, true);
+				} else {
+					$content = '';
+				}
+				//check if callback is valid
+				if (empty($content) && ( ! isset($cfg['callback']) || ! method_exists($this, $cfg['callback']))) {
+					EE_Error::add_error(sprintf(__('The callback given for a %s help tab on this page does not content OR a corresponding method for generating the content.  Check the spelling or make sure the method is present.',
+							'event_espresso'), $cfg['title']), __FILE__, __FUNCTION__, __LINE__);
+					return;
+				}
+				//setup config array for help tab method
+				$id = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
+				$_ht = array(
+						'id'       => $id,
+						'title'    => $cfg['title'],
+						'callback' => isset($cfg['callback']) && empty($content) ? array($this, $cfg['callback']) : null,
+						'content'  => $content,
+				);
+				$this->_current_screen->add_help_tab($_ht);
+			}
+		}
+	}
+
+
+
+	/**
+	 * This basically checks loaded $_page_config property to see if there are any help_tours defined.  "help_tours" is an array with properties for setting up usage of the joyride plugin
+	 *
+	 * @link   http://zurb.com/playground/jquery-joyride-feature-tour-plugin
+	 * @see    instructions regarding the format and construction of the "help_tour" array element is found in the _set_page_config() comments
+	 * @access protected
+	 * @return void
+	 */
+	protected function _add_help_tour()
+	{
+		$tours = array();
+		$this->_help_tour = array();
+		//exit early if help tours are turned off globally
+		if ( ! EE_Registry::instance()->CFG->admin->help_tour_activation || (defined('EE_DISABLE_HELP_TOURS') && EE_DISABLE_HELP_TOURS)) {
+			return;
+		}
+		//loop through _page_config to find any help_tour defined
+		foreach ($this->_page_config as $route => $config) {
+			//we're only going to set things up for this route
+			if ($route !== $this->_req_action) {
+				continue;
+			}
+			if (isset($config['help_tour'])) {
+				foreach ($config['help_tour'] as $tour) {
+					$file_path = $this->_get_dir() . '/help_tours/' . $tour . '.class.php';
+					//let's see if we can get that file... if not its possible this is a decaf route not set in caffienated so lets try and get the caffeinated equivalent
+					$file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tours/' . $tour . '.class.php' : $file_path;
+					//if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
+					if ( ! is_readable($file_path)) {
+						EE_Error::add_error(sprintf(__('The file path given for the help tour (%s) is not a valid path.  Please check that the string you set for the help tour on this route (%s) is the correct spelling', 'event_espresso'),
+								$file_path, $tour), __FILE__, __FUNCTION__, __LINE__);
+						return;
+					}
+					require_once $file_path;
+					if ( ! class_exists($tour)) {
+						$error_msg[] = sprintf(__('Something went wrong with loading the %s Help Tour Class.', 'event_espresso'), $tour);
+						$error_msg[] = $error_msg[0] . "\r\n" . sprintf(__('There is no class in place for the %s help tour.%s Make sure you have <strong>%s</strong> defined in the "help_tour" array for the %s route of the % admin page.',
+										'event_espresso'), $tour, '<br />', $tour, $this->_req_action, get_class($this));
+						throw new EE_Error(implode('||', $error_msg));
+					}
+					$a = new ReflectionClass($tour);
+					$tour_obj = $a->newInstance($this->_is_caf);
+					$tours[] = $tour_obj;
+					$this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($tour_obj);
+				}
+				//let's inject the end tour stop element common to all pages... this will only get seen once per machine.
+				$end_stop_tour = new EE_Help_Tour_final_stop($this->_is_caf);
+				$tours[] = $end_stop_tour;
+				$this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($end_stop_tour);
+			}
+		}
+		if ( ! empty($tours)) {
+			$this->_help_tour['tours'] = $tours;
+		}
+		//thats it!  Now that the $_help_tours property is set (or not) the scripts and html should be taken care of automatically.
+	}
+
+
+
+	/**
+	 * This simply sets up any qtips that have been defined in the page config
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _add_qtips()
+	{
+		if (isset($this->_route_config['qtips'])) {
+			$qtips = (array)$this->_route_config['qtips'];
+			//load qtip loader
+			$path = array(
+					$this->_get_dir() . '/qtips/',
+					EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
+			);
+			EEH_Qtip_Loader::instance()->register($qtips, $path);
+		}
+	}
+
+
+
+	/**
+	 * _set_nav_tabs
+	 * This sets up the nav tabs from the page_routes array.  This method can be overwritten by child classes if you wish to add additional tabs or modify accordingly.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_nav_tabs()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$i = 0;
+		foreach ($this->_page_config as $slug => $config) {
+			if ( ! is_array($config) || (is_array($config) && (isset($config['nav']) && ! $config['nav']) || ! isset($config['nav']))) {
+				continue;
+			} //no nav tab for this config
+			//check for persistent flag
+			if (isset($config['nav']['persistent']) && ! $config['nav']['persistent'] && $slug !== $this->_req_action) {
+				continue;
+			} //nav tab is only to appear when route requested.
+			if ( ! $this->check_user_access($slug, true)) {
+				continue;
+			} //no nav tab becasue current user does not have access.
+			$css_class = isset($config['css_class']) ? $config['css_class'] . ' ' : '';
+			$this->_nav_tabs[$slug] = array(
+					'url'       => isset($config['nav']['url']) ? $config['nav']['url'] : self::add_query_args_and_nonce(array('action' => $slug), $this->_admin_base_url),
+					'link_text' => isset($config['nav']['label']) ? $config['nav']['label'] : ucwords(str_replace('_', ' ', $slug)),
+					'css_class' => $this->_req_action == $slug ? $css_class . 'nav-tab-active' : $css_class,
+					'order'     => isset($config['nav']['order']) ? $config['nav']['order'] : $i,
+			);
+			$i++;
+		}
+		//if $this->_nav_tabs is empty then lets set the default
+		if (empty($this->_nav_tabs)) {
+			$this->_nav_tabs[$this->default_nav_tab_name] = array(
+					'url'       => $this->admin_base_url,
+					'link_text' => ucwords(str_replace('_', ' ', $this->default_nav_tab_name)),
+					'css_class' => 'nav-tab-active',
+					'order'     => 10,
+			);
+		}
+		//now let's sort the tabs according to order
+		usort($this->_nav_tabs, array($this, '_sort_nav_tabs'));
+	}
+
+
+
+	/**
+	 * _set_current_labels
+	 * This method modifies the _labels property with any optional specific labels indicated in the _page_routes property array
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_current_labels()
+	{
+		if (is_array($this->_route_config) && isset($this->_route_config['labels'])) {
+			foreach ($this->_route_config['labels'] as $label => $text) {
+				if (is_array($text)) {
+					foreach ($text as $sublabel => $subtext) {
+						$this->_labels[$label][$sublabel] = $subtext;
+					}
+				} else {
+					$this->_labels[$label] = $text;
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *        verifies user access for this admin page
+	 *
+	 * @param string $route_to_check if present then the capability for the route matching this string is checked.
+	 * @param bool   $verify_only    Default is FALSE which means if user check fails then wp_die().  Otherwise just return false if verify fail.
+	 * @return        BOOL|wp_die()
+	 */
+	public function check_user_access($route_to_check = '', $verify_only = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$route_to_check = empty($route_to_check) ? $this->_req_action : $route_to_check;
+		$capability = ! empty($route_to_check) && isset($this->_page_routes[$route_to_check]) && is_array($this->_page_routes[$route_to_check]) && ! empty($this->_page_routes[$route_to_check]['capability'])
+				? $this->_page_routes[$route_to_check]['capability'] : null;
+		if (empty($capability) && empty($route_to_check)) {
+			$capability = is_array($this->_route) && empty($this->_route['capability']) ? 'manage_options' : $this->_route['capability'];
+		} else {
+			$capability = empty($capability) ? 'manage_options' : $capability;
+		}
+		$id = is_array($this->_route) && ! empty($this->_route['obj_id']) ? $this->_route['obj_id'] : 0;
+		if (( ! function_exists('is_admin') || ! EE_Registry::instance()->CAP->current_user_can($capability, $this->page_slug . '_' . $route_to_check, $id)) && ! defined('DOING_AJAX')) {
+			if ($verify_only) {
+				return false;
+			} else {
+				if ( is_user_logged_in() ) {
+					wp_die(__('You do not have access to this route.', 'event_espresso'));
+				} else {
+					return false;
+				}
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * 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()
+	{
+	}
+
+
+
+	/**
+	 * wp_loaded_global
+	 * This runs all the code that we want executed within the WP wp_loaded hook.  This method is optional for an EE_Admin page and will execute on every EE Admin Page load
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+
+	/**
+	 * admin_notices
+	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on ALL EE_Admin pages.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function admin_notices_global()
+	{
+		$this->_display_no_javascript_warning();
+		$this->_display_espresso_notices();
+	}
+
+
+
+	public function network_admin_notices_global()
+	{
+		$this->_display_no_javascript_warning();
+		$this->_display_espresso_notices();
+	}
+
+
+
+	/**
+	 * 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();
+		//if metaboxes are present we need to add the nonce field
+		if ((isset($this->_route_config['metaboxes']) || (isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes']) || isset($this->_route_config['list_table']))) {
+			wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
+			wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
+		}
+	}
+
+
+
+	/**
+	 * admin_footer_global
+	 * Anything triggered by the wp 'admin_footer' wp hook should be put in here. This particluar method will apply on ALL EE_Admin Pages.
+	 *
+	 * @access  public
+	 * @return  void
+	 */
+	public function admin_footer_global()
+	{
+		//dialog container for dialog helper
+		$d_cont = '<div class="ee-admin-dialog-container auto-hide hidden">' . "\n";
+		$d_cont .= '<div class="ee-notices"></div>';
+		$d_cont .= '<div class="ee-admin-dialog-container-inner-content"></div>';
+		$d_cont .= '</div>';
+		echo $d_cont;
+		//help tour stuff?
+		if (isset($this->_help_tour[$this->_req_action])) {
+			echo implode('<br />', $this->_help_tour[$this->_req_action]);
+		}
+		//current set timezone for timezone js
+		echo '<span id="current_timezone" class="hidden">' . EEH_DTT_Helper::get_timezone() . '</span>';
+	}
+
+
+
+	/**
+	 * This function sees if there is a method for help popup content existing for the given route.  If there is then we'll use the retrieved array to output the content using the template.
+	 * For child classes:
+	 * If you want to have help popups then in your templates or your content you set "triggers" for the content using the "_set_help_trigger('help_trigger_id')" where "help_trigger_id" is what you will use later in your custom method for
+	 * the help popup content on that page. Then in your Child_Admin_Page class you need to define a help popup method for the content in the format "_help_popup_content_{route_name}()"  So if you are setting help content for the
+	 * 'edit_event' route you should have a method named "_help_popup_content_edit_route". In your defined "help_popup_content_..." method.  You must prepare and return an array in the following format array(
+	 *    'help_trigger_id' => array(
+	 *        'title' => __('localized title for popup', 'event_espresso'),
+	 *        'content' => __('localized content for popup', 'event_espresso')
+	 *    )
+	 * );
+	 * Then the EE_Admin_Parent will take care of making sure that is setup properly on the correct route.
+	 *
+	 * @access protected
+	 * @return string content
+	 */
+	protected function _set_help_popup_content($help_array = array(), $display = false)
+	{
+		$content = '';
+		$help_array = empty($help_array) ? $this->_get_help_content() : $help_array;
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php';
+		//loop through the array and setup content
+		foreach ($help_array as $trigger => $help) {
+			//make sure the array is setup properly
+			if ( ! isset($help['title']) || ! isset($help['content'])) {
+				throw new EE_Error(__('Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
+						'event_espresso'));
+			}
+			//we're good so let'd setup the template vars and then assign parsed template content to our content.
+			$template_args = array(
+					'help_popup_id'      => $trigger,
+					'help_popup_title'   => $help['title'],
+					'help_popup_content' => $help['content'],
+			);
+			$content .= EEH_Template::display_template($template_path, $template_args, true);
+		}
+		if ($display) {
+			echo $content;
+		} else {
+			return $content;
+		}
+	}
+
+
+
+	/**
+	 * All this does is retrive the help content array if set by the EE_Admin_Page child
+	 *
+	 * @access private
+	 * @return array properly formatted array for help popup content
+	 */
+	private function _get_help_content()
+	{
+		//what is the method we're looking for?
+		$method_name = '_help_popup_content_' . $this->_req_action;
+		//if method doesn't exist let's get out.
+		if ( ! method_exists($this, $method_name)) {
+			return array();
+		}
+		//k we're good to go let's retrieve the help array
+		$help_array = call_user_func(array($this, $method_name));
+		//make sure we've got an array!
+		if ( ! is_array($help_array)) {
+			throw new EE_Error(__('Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.', 'event_espresso'));
+		}
+		return $help_array;
+	}
+
+
+
+	/**
+	 * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
+	 * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
+	 * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
+	 *
+	 * @access protected
+	 * @param string  $trigger_id reference for retrieving the trigger content for the popup
+	 * @param boolean $display    if false then we return the trigger string
+	 * @param array   $dimensions an array of dimensions for the box (array(h,w))
+	 * @return string
+	 */
+	protected function _set_help_trigger($trigger_id, $display = true, $dimensions = array('400', '640'))
+	{
+		if (defined('DOING_AJAX')) {
+			return;
+		}
+		//let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
+		$help_array = $this->_get_help_content();
+		$help_content = '';
+		if (empty($help_array) || ! isset($help_array[$trigger_id])) {
+			$help_array[$trigger_id] = array(
+					'title'   => __('Missing Content', 'event_espresso'),
+					'content' => __('A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
+							'event_espresso'),
+			);
+			$help_content = $this->_set_help_popup_content($help_array, false);
+		}
+		//let's setup the trigger
+		$content = '<a class="ee-dialog" href="?height=' . $dimensions[0] . '&width=' . $dimensions[1] . '&inlineId=' . $trigger_id . '" target="_blank"><span class="question ee-help-popup-question"></span></a>';
+		$content = $content . $help_content;
+		if ($display) {
+			echo $content;
+		} else {
+			return $content;
+		}
+	}
+
+
+
+	/**
+	 * _add_global_screen_options
+	 * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
+	 * This particular method will add_screen_options on ALL EE_Admin Pages
+	 *
+	 * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
+	 *         see also WP_Screen object documents...
+	 * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
+	 * @abstract
+	 * @access private
+	 * @return void
+	 */
+	private function _add_global_screen_options()
+	{
+	}
+
+
+
+	/**
+	 * _add_global_feature_pointers
+	 * This method is used for implementing any "feature pointers" (using built-in WP styling js).
+	 * This particular method will implement feature pointers for ALL EE_Admin pages.
+	 * Note: this is just a placeholder for now.  Implementation will come down the road
+	 *
+	 * @see    WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
+	 * @link   http://eamann.com/tech/wordpress-portland/
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	private function _add_global_feature_pointers()
+	{
+	}
+
+
+
+	/**
+	 * load_global_scripts_styles
+	 * The scripts and styles enqueued in here will be loaded on every EE Admin page
+	 *
+	 * @return void
+	 */
+	public function load_global_scripts_styles()
+	{
+		/** STYLES **/
+		// add debugging styles
+		if (WP_DEBUG) {
+			add_action('admin_head', array($this, 'add_xdebug_style'));
+		}
+		//register all styles
+		wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
+		wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', array(), EVENT_ESPRESSO_VERSION);
+		//helpers styles
+		wp_register_style('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css', array(), EVENT_ESPRESSO_VERSION);
+		//enqueue global styles
+		wp_enqueue_style('ee-admin-css');
+		/** SCRIPTS **/
+		//register all scripts
+		wp_register_script('espresso_core', EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('ee-dialog', EE_ADMIN_URL . 'assets/ee-dialog-helper.js', array('jquery', 'jquery-ui-draggable'), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('ee_admin_js', EE_ADMIN_URL . 'assets/ee-admin-page.js', array('espresso_core', 'ee-parse-uri', 'ee-dialog'), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('jquery-ui-timepicker-addon', EE_GLOBAL_ASSETS_URL . 'scripts/jquery-ui-timepicker-addon.js', array('jquery-ui-datepicker', 'jquery-ui-slider'), EVENT_ESPRESSO_VERSION, true);
+		// register jQuery Validate - see /includes/functions/wp_hooks.php
+		add_filter('FHEE_load_jquery_validate', '__return_true');
+		add_filter('FHEE_load_joyride', '__return_true');
+		//script for sorting tables
+		wp_register_script('espresso_ajax_table_sorting', EE_ADMIN_URL . "assets/espresso_ajax_table_sorting.js", array('ee_admin_js', 'jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, true);
+		//script for parsing uri's
+		wp_register_script('ee-parse-uri', EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js', array(), EVENT_ESPRESSO_VERSION, true);
+		//and parsing associative serialized form elements
+		wp_register_script('ee-serialize-full-array', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
+		//helpers scripts
+		wp_register_script('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('ee-moment-core', EE_THIRD_PARTY_URL . 'moment/moment-with-locales.min.js', array(), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('ee-moment', EE_THIRD_PARTY_URL . 'moment/moment-timezone-with-data.min.js', array('ee-moment-core'), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('ee-datepicker', EE_ADMIN_URL . 'assets/ee-datepicker.js', array('jquery-ui-timepicker-addon', 'ee-moment'), EVENT_ESPRESSO_VERSION, true);
+		//google charts
+		wp_register_script('google-charts', 'https://www.gstatic.com/charts/loader.js', array(), EVENT_ESPRESSO_VERSION, false);
+		//enqueue global scripts
+		//taking care of metaboxes
+		if ((isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes'])) && empty($this->_cpt_route)) {
+			wp_enqueue_script('dashboard');
+		}
+		//enqueue thickbox for ee help popups.  default is to enqueue unless its explicitly set to false since we're assuming all EE pages will have popups
+		if ( ! isset($this->_route_config['has_help_popups']) || (isset($this->_route_config['has_help_popups']) && $this->_route_config['has_help_popups'])) {
+			wp_enqueue_script('ee_admin_js');
+			wp_enqueue_style('ee-admin-css');
+		}
+		//localize script for ajax lazy loading
+		$lazy_loader_container_ids = apply_filters('FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers', array('espresso_news_post_box_content'));
+		wp_localize_script('ee_admin_js', 'eeLazyLoadingContainers', $lazy_loader_container_ids);
+		/**
+		 * help tour stuff
+		 */
+		if ( ! empty($this->_help_tour)) {
+			//register the js for kicking things off
+			wp_enqueue_script('ee-help-tour', EE_ADMIN_URL . 'assets/ee-help-tour.js', array('jquery-joyride'), EVENT_ESPRESSO_VERSION, true);
+			//setup tours for the js tour object
+			foreach ($this->_help_tour['tours'] as $tour) {
+				$tours[] = array(
+						'id'      => $tour->get_slug(),
+						'options' => $tour->get_options(),
+				);
+			}
+			wp_localize_script('ee-help-tour', 'EE_HELP_TOUR', array('tours' => $tours));
+			//admin_footer_global will take care of making sure our help_tour skeleton gets printed via the info stored in $this->_help_tour
+		}
+	}
+
+
+
+	/**
+	 *        admin_footer_scripts_eei18n_js_strings
+	 *
+	 * @access        public
+	 * @return        void
+	 */
+	public function admin_footer_scripts_eei18n_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['ajax_url'] = WP_AJAX_URL;
+		EE_Registry::$i18n_js_strings['confirm_delete'] = __('Are you absolutely sure you want to delete this item?\nThis action will delete ALL DATA associated with this item!!!\nThis can NOT be undone!!!', 'event_espresso');
+		EE_Registry::$i18n_js_strings['January'] = __('January', 'event_espresso');
+		EE_Registry::$i18n_js_strings['February'] = __('February', 'event_espresso');
+		EE_Registry::$i18n_js_strings['March'] = __('March', 'event_espresso');
+		EE_Registry::$i18n_js_strings['April'] = __('April', 'event_espresso');
+		EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
+		EE_Registry::$i18n_js_strings['June'] = __('June', 'event_espresso');
+		EE_Registry::$i18n_js_strings['July'] = __('July', 'event_espresso');
+		EE_Registry::$i18n_js_strings['August'] = __('August', 'event_espresso');
+		EE_Registry::$i18n_js_strings['September'] = __('September', 'event_espresso');
+		EE_Registry::$i18n_js_strings['October'] = __('October', 'event_espresso');
+		EE_Registry::$i18n_js_strings['November'] = __('November', 'event_espresso');
+		EE_Registry::$i18n_js_strings['December'] = __('December', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Jan'] = __('Jan', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Feb'] = __('Feb', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Mar'] = __('Mar', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Apr'] = __('Apr', 'event_espresso');
+		EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Jun'] = __('Jun', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Jul'] = __('Jul', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Aug'] = __('Aug', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Sep'] = __('Sep', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Oct'] = __('Oct', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Nov'] = __('Nov', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Dec'] = __('Dec', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Sunday'] = __('Sunday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Monday'] = __('Monday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Tuesday'] = __('Tuesday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Wednesday'] = __('Wednesday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Thursday'] = __('Thursday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Friday'] = __('Friday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Saturday'] = __('Saturday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Sun'] = __('Sun', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Mon'] = __('Mon', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Tue'] = __('Tue', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Wed'] = __('Wed', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Thu'] = __('Thu', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Fri'] = __('Fri', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Sat'] = __('Sat', 'event_espresso');
+		//setting on espresso_core instead of ee_admin_js because espresso_core is enqueued by the maintenance
+		//admin page when in maintenance mode and ee_admin_js is not loaded then.  This works everywhere else because
+		//espresso_core is listed as a dependency of ee_admin_js.
+		wp_localize_script('espresso_core', 'eei18n', EE_Registry::$i18n_js_strings);
+	}
+
+
+
+	/**
+	 *        load enhanced xdebug styles for ppl with failing eyesight
+	 *
+	 * @access        public
+	 * @return        void
+	 */
+	public function add_xdebug_style()
+	{
+		echo '<style>.xdebug-error { font-size:1.5em; }</style>';
+	}
+
+
+	/************************/
+	/** LIST TABLE METHODS **/
+	/************************/
+	/**
+	 * this sets up the list table if the current view requires it.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_list_table()
+	{
+		//first is this a list_table view?
+		if ( ! isset($this->_route_config['list_table'])) {
+			return;
+		} //not a list_table view so get out.
+		//list table functions are per view specific (because some admin pages might have more than one listtable!)
+		if (call_user_func(array($this, '_set_list_table_views_' . $this->_req_action)) === false) {
+			//user error msg
+			$error_msg = __('An error occurred. The requested list table views could not be found.', 'event_espresso');
+			//developer error msg
+			$error_msg .= '||' . sprintf(__('List table views for "%s" route could not be setup. Check that you have the corresponding method, "%s" set up for defining list_table_views for this route.', 'event_espresso'),
+							$this->_req_action, '_set_list_table_views_' . $this->_req_action);
+			throw new EE_Error($error_msg);
+		}
+		//let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
+		$this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action, $this->_views);
+		$this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
+		$this->_views = apply_filters('FHEE_list_table_views', $this->_views);
+		$this->_set_list_table_view();
+		$this->_set_list_table_object();
+	}
+
+
+
+	/**
+	 *        set current view for List Table
+	 *
+	 * @access public
+	 * @return array
+	 */
+	protected function _set_list_table_view()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// looking at active items or dumpster diving ?
+		if ( ! isset($this->_req_data['status']) || ! array_key_exists($this->_req_data['status'], $this->_views)) {
+			$this->_view = isset($this->_views['in_use']) ? 'in_use' : 'all';
+		} else {
+			$this->_view = sanitize_key($this->_req_data['status']);
+		}
+	}
+
+
+
+	/**
+	 * _set_list_table_object
+	 * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
+	 *
+	 * @throws \EE_Error
+	 */
+	protected function _set_list_table_object()
+	{
+		if (isset($this->_route_config['list_table'])) {
+			if ( ! class_exists($this->_route_config['list_table'])) {
+				throw new EE_Error(
+						sprintf(
+								__(
+										'The %s class defined for the list table does not exist.  Please check the spelling of the class ref in the $_page_config property on %s.',
+										'event_espresso'
+								),
+								$this->_route_config['list_table'],
+								get_class($this)
+						)
+				);
+			}
+			$list_table = $this->_route_config['list_table'];
+			$this->_list_table_object = new $list_table($this);
+		}
+	}
+
+
+
+	/**
+	 * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
+	 *
+	 * @param array $extra_query_args                     Optional. An array of extra query args to add to the generated
+	 *                                                    urls.  The array should be indexed by the view it is being
+	 *                                                    added to.
+	 * @return array
+	 */
+	public function get_list_table_view_RLs($extra_query_args = array())
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if (empty($this->_views)) {
+			$this->_views = array();
+		}
+		// cycle thru views
+		foreach ($this->_views as $key => $view) {
+			$query_args = array();
+			// check for current view
+			$this->_views[$key]['class'] = $this->_view == $view['slug'] ? 'current' : '';
+			$query_args['action'] = $this->_req_action;
+			$query_args[$this->_req_action . '_nonce'] = wp_create_nonce($query_args['action'] . '_nonce');
+			$query_args['status'] = $view['slug'];
+			//merge any other arguments sent in.
+			if (isset($extra_query_args[$view['slug']])) {
+				$query_args = array_merge($query_args, $extra_query_args[$view['slug']]);
+			}
+			$this->_views[$key]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+		}
+		return $this->_views;
+	}
+
+
+
+	/**
+	 * _entries_per_page_dropdown
+	 * generates a drop down box for selecting the number of visiable rows in an admin page list table
+	 *
+	 * @todo   : Note: ideally this should be added to the screen options dropdown as that would be consistent with how WP does it.
+	 * @access protected
+	 * @param int $max_entries total number of rows in the table
+	 * @return string
+	 */
+	protected function _entries_per_page_dropdown($max_entries = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$values = array(10, 25, 50, 100);
+		$per_page = ( ! empty($this->_req_data['per_page'])) ? absint($this->_req_data['per_page']) : 10;
+		if ($max_entries) {
+			$values[] = $max_entries;
+			sort($values);
+		}
+		$entries_per_page_dropdown = '
 			<div id="entries-per-page-dv" class="alignleft actions">
 				<label class="hide-if-no-js">
 					Show
 					<select id="entries-per-page-slct" name="entries-per-page-slct">';
-        foreach ($values as $value) {
-            if ($value < $max_entries) {
-                $selected = $value == $per_page ? ' selected="' . $per_page . '"' : '';
-                $entries_per_page_dropdown .= '
+		foreach ($values as $value) {
+			if ($value < $max_entries) {
+				$selected = $value == $per_page ? ' selected="' . $per_page . '"' : '';
+				$entries_per_page_dropdown .= '
 						<option value="' . $value . '"' . $selected . '>' . $value . '&nbsp;&nbsp;</option>';
-            }
-        }
-        $selected = $max_entries == $per_page ? ' selected="' . $per_page . '"' : '';
-        $entries_per_page_dropdown .= '
+			}
+		}
+		$selected = $max_entries == $per_page ? ' selected="' . $per_page . '"' : '';
+		$entries_per_page_dropdown .= '
 						<option value="' . $max_entries . '"' . $selected . '>All&nbsp;&nbsp;</option>';
-        $entries_per_page_dropdown .= '
+		$entries_per_page_dropdown .= '
 					</select>
 					entries
 				</label>
 				<input id="entries-per-page-btn" class="button-secondary" type="submit" value="Go" >
 			</div>
 		';
-        return $entries_per_page_dropdown;
-    }
-
-
-
-    /**
-     *        _set_search_attributes
-     *
-     * @access        protected
-     * @return        void
-     */
-    public function _set_search_attributes()
-    {
-        $this->_template_args['search']['btn_label'] = sprintf(__('Search %s', 'event_espresso'), empty($this->_search_btn_label) ? $this->page_label : $this->_search_btn_label);
-        $this->_template_args['search']['callback'] = 'search_' . $this->page_slug;
-    }
-
-    /*** END LIST TABLE METHODS **/
-    /*****************************/
-    /**
-     *        _add_registered_metaboxes
-     *        this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/add_meta_box
-     * @access private
-     * @return void
-     */
-    private function _add_registered_meta_boxes()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        //we only add meta boxes if the page_route calls for it
-        if (is_array($this->_route_config) && isset($this->_route_config['metaboxes'])
-            && is_array(
-                    $this->_route_config['metaboxes']
-            )
-        ) {
-            // this simply loops through the callbacks provided
-            // and checks if there is a corresponding callback registered by the child
-            // if there is then we go ahead and process the metabox loader.
-            foreach ($this->_route_config['metaboxes'] as $metabox_callback) {
-                // first check for Closures
-                if ($metabox_callback instanceof Closure) {
-                    $result = $metabox_callback();
-                } else if (is_array($metabox_callback) && isset($metabox_callback[0], $metabox_callback[1])) {
-                    $result = call_user_func(array($metabox_callback[0], $metabox_callback[1]));
-                } else {
-                    $result = call_user_func(array($this, &$metabox_callback));
-                }
-                if ($result === false) {
-                    // user error msg
-                    $error_msg = __('An error occurred. The  requested metabox could not be found.', 'event_espresso');
-                    // developer error msg
-                    $error_msg .= '||' . sprintf(
-                                    __(
-                                            'The metabox with the string "%s" could not be called. Check that the spelling for method names and actions in the "_page_config[\'metaboxes\']" array are all correct.',
-                                            'event_espresso'
-                                    ),
-                                    $metabox_callback
-                            );
-                    throw new EE_Error($error_msg);
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * _add_screen_columns
-     * This will check the _page_config array and if there is "columns" key index indicated, we'll set the template as the dynamic column template and we'll setup the column options for the page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _add_screen_columns()
-    {
-        if (
-                is_array($this->_route_config)
-                && isset($this->_route_config['columns'])
-                && is_array($this->_route_config['columns'])
-                && count($this->_route_config['columns']) === 2
-        ) {
-            add_screen_option('layout_columns', array('max' => (int)$this->_route_config['columns'][0], 'default' => (int)$this->_route_config['columns'][1]));
-            $this->_template_args['num_columns'] = $this->_route_config['columns'][0];
-            $screen_id = $this->_current_screen->id;
-            $screen_columns = (int)get_user_option("screen_layout_$screen_id");
-            $total_columns = ! empty($screen_columns) ? $screen_columns : $this->_route_config['columns'][1];
-            $this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
-            $this->_template_args['current_page'] = $this->_wp_page_slug;
-            $this->_template_args['screen'] = $this->_current_screen;
-            $this->_column_template_path = EE_ADMIN_TEMPLATE . 'admin_details_metabox_column_wrapper.template.php';
-            //finally if we don't have has_metaboxes set in the route config let's make sure it IS set other wise the necessary hidden fields for this won't be loaded.
-            $this->_route_config['has_metaboxes'] = true;
-        }
-    }
-
-
-
-    /**********************************/
-    /** GLOBALLY AVAILABLE METABOXES **/
-    /**
-     * In this section we put any globally available EE metaboxes for all EE Admin pages.  They are called by simply referencing the callback in the _page_config array property.  This way you can be very specific about what pages these get
-     * loaded on.
-     */
-    private function _espresso_news_post_box()
-    {
-        $news_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('New @ Event Espresso', 'event_espresso'));
-        add_meta_box('espresso_news_post_box', $news_box_title, array(
-                $this,
-                'espresso_news_post_box',
-        ), $this->_wp_page_slug, 'side');
-    }
-
-
-
-    /**
-     * Code for setting up espresso ratings request metabox.
-     */
-    protected function _espresso_ratings_request()
-    {
-        if ( ! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
-            return '';
-        }
-        $ratings_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('Keep Event Espresso Decaf Free', 'event_espresso'));
-        add_meta_box('espresso_ratings_request', $ratings_box_title, array(
-                $this,
-                'espresso_ratings_request',
-        ), $this->_wp_page_slug, 'side');
-    }
-
-
-
-    /**
-     * Code for setting up espresso ratings request metabox content.
-     */
-    public function espresso_ratings_request()
-    {
-        $template_path = EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php';
-        EEH_Template::display_template($template_path, array());
-    }
-
-
-
-    public static function cached_rss_display($rss_id, $url)
-    {
-        $loading = '<p class="widget-loading hide-if-no-js">' . __('Loading&#8230;') . '</p><p class="hide-if-js">' . __('This widget requires JavaScript.') . '</p>';
-        $doing_ajax = (defined('DOING_AJAX') && DOING_AJAX);
-        $pre = '<div class="espresso-rss-display">' . "\n\t";
-        $pre .= '<span id="' . $rss_id . '_url" class="hidden">' . $url . '</span>';
-        $post = '</div>' . "\n";
-        $cache_key = 'ee_rss_' . md5($rss_id);
-        if (false != ($output = get_transient($cache_key))) {
-            echo $pre . $output . $post;
-            return true;
-        }
-        if ( ! $doing_ajax) {
-            echo $pre . $loading . $post;
-            return false;
-        }
-        ob_start();
-        wp_widget_rss_output($url, array('show_date' => 0, 'items' => 5));
-        set_transient($cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS);
-        return true;
-    }
-
-
-
-    public function espresso_news_post_box()
-    {
-        ?>
+		return $entries_per_page_dropdown;
+	}
+
+
+
+	/**
+	 *        _set_search_attributes
+	 *
+	 * @access        protected
+	 * @return        void
+	 */
+	public function _set_search_attributes()
+	{
+		$this->_template_args['search']['btn_label'] = sprintf(__('Search %s', 'event_espresso'), empty($this->_search_btn_label) ? $this->page_label : $this->_search_btn_label);
+		$this->_template_args['search']['callback'] = 'search_' . $this->page_slug;
+	}
+
+	/*** END LIST TABLE METHODS **/
+	/*****************************/
+	/**
+	 *        _add_registered_metaboxes
+	 *        this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/add_meta_box
+	 * @access private
+	 * @return void
+	 */
+	private function _add_registered_meta_boxes()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		//we only add meta boxes if the page_route calls for it
+		if (is_array($this->_route_config) && isset($this->_route_config['metaboxes'])
+			&& is_array(
+					$this->_route_config['metaboxes']
+			)
+		) {
+			// this simply loops through the callbacks provided
+			// and checks if there is a corresponding callback registered by the child
+			// if there is then we go ahead and process the metabox loader.
+			foreach ($this->_route_config['metaboxes'] as $metabox_callback) {
+				// first check for Closures
+				if ($metabox_callback instanceof Closure) {
+					$result = $metabox_callback();
+				} else if (is_array($metabox_callback) && isset($metabox_callback[0], $metabox_callback[1])) {
+					$result = call_user_func(array($metabox_callback[0], $metabox_callback[1]));
+				} else {
+					$result = call_user_func(array($this, &$metabox_callback));
+				}
+				if ($result === false) {
+					// user error msg
+					$error_msg = __('An error occurred. The  requested metabox could not be found.', 'event_espresso');
+					// developer error msg
+					$error_msg .= '||' . sprintf(
+									__(
+											'The metabox with the string "%s" could not be called. Check that the spelling for method names and actions in the "_page_config[\'metaboxes\']" array are all correct.',
+											'event_espresso'
+									),
+									$metabox_callback
+							);
+					throw new EE_Error($error_msg);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * _add_screen_columns
+	 * This will check the _page_config array and if there is "columns" key index indicated, we'll set the template as the dynamic column template and we'll setup the column options for the page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _add_screen_columns()
+	{
+		if (
+				is_array($this->_route_config)
+				&& isset($this->_route_config['columns'])
+				&& is_array($this->_route_config['columns'])
+				&& count($this->_route_config['columns']) === 2
+		) {
+			add_screen_option('layout_columns', array('max' => (int)$this->_route_config['columns'][0], 'default' => (int)$this->_route_config['columns'][1]));
+			$this->_template_args['num_columns'] = $this->_route_config['columns'][0];
+			$screen_id = $this->_current_screen->id;
+			$screen_columns = (int)get_user_option("screen_layout_$screen_id");
+			$total_columns = ! empty($screen_columns) ? $screen_columns : $this->_route_config['columns'][1];
+			$this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
+			$this->_template_args['current_page'] = $this->_wp_page_slug;
+			$this->_template_args['screen'] = $this->_current_screen;
+			$this->_column_template_path = EE_ADMIN_TEMPLATE . 'admin_details_metabox_column_wrapper.template.php';
+			//finally if we don't have has_metaboxes set in the route config let's make sure it IS set other wise the necessary hidden fields for this won't be loaded.
+			$this->_route_config['has_metaboxes'] = true;
+		}
+	}
+
+
+
+	/**********************************/
+	/** GLOBALLY AVAILABLE METABOXES **/
+	/**
+	 * In this section we put any globally available EE metaboxes for all EE Admin pages.  They are called by simply referencing the callback in the _page_config array property.  This way you can be very specific about what pages these get
+	 * loaded on.
+	 */
+	private function _espresso_news_post_box()
+	{
+		$news_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('New @ Event Espresso', 'event_espresso'));
+		add_meta_box('espresso_news_post_box', $news_box_title, array(
+				$this,
+				'espresso_news_post_box',
+		), $this->_wp_page_slug, 'side');
+	}
+
+
+
+	/**
+	 * Code for setting up espresso ratings request metabox.
+	 */
+	protected function _espresso_ratings_request()
+	{
+		if ( ! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
+			return '';
+		}
+		$ratings_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('Keep Event Espresso Decaf Free', 'event_espresso'));
+		add_meta_box('espresso_ratings_request', $ratings_box_title, array(
+				$this,
+				'espresso_ratings_request',
+		), $this->_wp_page_slug, 'side');
+	}
+
+
+
+	/**
+	 * Code for setting up espresso ratings request metabox content.
+	 */
+	public function espresso_ratings_request()
+	{
+		$template_path = EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php';
+		EEH_Template::display_template($template_path, array());
+	}
+
+
+
+	public static function cached_rss_display($rss_id, $url)
+	{
+		$loading = '<p class="widget-loading hide-if-no-js">' . __('Loading&#8230;') . '</p><p class="hide-if-js">' . __('This widget requires JavaScript.') . '</p>';
+		$doing_ajax = (defined('DOING_AJAX') && DOING_AJAX);
+		$pre = '<div class="espresso-rss-display">' . "\n\t";
+		$pre .= '<span id="' . $rss_id . '_url" class="hidden">' . $url . '</span>';
+		$post = '</div>' . "\n";
+		$cache_key = 'ee_rss_' . md5($rss_id);
+		if (false != ($output = get_transient($cache_key))) {
+			echo $pre . $output . $post;
+			return true;
+		}
+		if ( ! $doing_ajax) {
+			echo $pre . $loading . $post;
+			return false;
+		}
+		ob_start();
+		wp_widget_rss_output($url, array('show_date' => 0, 'items' => 5));
+		set_transient($cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS);
+		return true;
+	}
+
+
+
+	public function espresso_news_post_box()
+	{
+		?>
         <div class="padding">
             <div id="espresso_news_post_box_content" class="infolinks">
                 <?php
-                // Get RSS Feed(s)
-                $feed_url = apply_filters('FHEE__EE_Admin_Page__espresso_news_post_box__feed_url', 'http://eventespresso.com/feed/');
-                $url = urlencode($feed_url);
-                self::cached_rss_display('espresso_news_post_box_content', $url);
-                ?>
+				// Get RSS Feed(s)
+				$feed_url = apply_filters('FHEE__EE_Admin_Page__espresso_news_post_box__feed_url', 'http://eventespresso.com/feed/');
+				$url = urlencode($feed_url);
+				self::cached_rss_display('espresso_news_post_box_content', $url);
+				?>
             </div>
             <?php do_action('AHEE__EE_Admin_Page__espresso_news_post_box__after_content'); ?>
         </div>
         <?php
-    }
-
-
-
-    private function _espresso_links_post_box()
-    {
-        //Hiding until we actually have content to put in here...
-        //add_meta_box('espresso_links_post_box', __('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
-    }
-
-
-
-    public function espresso_links_post_box()
-    {
-        //Hiding until we actually have content to put in here...
-        //$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php';
-        //EEH_Template::display_template( $templatepath );
-    }
-
-
-
-    protected function _espresso_sponsors_post_box()
-    {
-        $show_sponsors = apply_filters('FHEE_show_sponsors_meta_box', true);
-        if ($show_sponsors) {
-            add_meta_box('espresso_sponsors_post_box', __('Event Espresso Highlights', 'event_espresso'), array($this, 'espresso_sponsors_post_box'), $this->_wp_page_slug, 'side');
-        }
-    }
-
-
-
-    public function espresso_sponsors_post_box()
-    {
-        $templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php';
-        EEH_Template::display_template($templatepath);
-    }
-
-
-
-    private function _publish_post_box()
-    {
-        $meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
-        //if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array then we'll use that for the metabox label.  Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
-        if ( ! empty($this->_labels['publishbox'])) {
-            $box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][$this->_req_action] : $this->_labels['publishbox'];
-        } else {
-            $box_label = __('Publish', 'event_espresso');
-        }
-        $box_label = apply_filters('FHEE__EE_Admin_Page___publish_post_box__box_label', $box_label, $this->_req_action, $this);
-        add_meta_box($meta_box_ref, $box_label, array($this, 'editor_overview'), $this->_current_screen->id, 'side', 'high');
-    }
-
-
-
-    public function editor_overview()
-    {
-        //if we have extra content set let's add it in if not make sure its empty
-        $this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /** end of globally available metaboxes section **/
-    /*************************************************/
-    /**
-     * Public wrapper for the protected method.  Allows plugins/addons to externally call the
-     * protected method.
-     *
-     * @see   $this->_set_publish_post_box_vars for param details
-     * @since 4.6.0
-     */
-    public function set_publish_post_box_vars($name = null, $id = false, $delete = false, $save_close_redirect_URL = null, $both_btns = true)
-    {
-        $this->_set_publish_post_box_vars($name, $id, $delete, $save_close_redirect_URL, $both_btns);
-    }
-
-
-
-    /**
-     * Sets the _template_args arguments used by the _publish_post_box shortcut
-     * Note: currently there is no validation for this.  However if you want the delete button, the
-     * save, and save and close buttons to work properly, then you will want to include a
-     * values for the name and id arguments.
-     *
-     * @todo  Add in validation for name/id arguments.
-     * @param    string  $name                    key used for the action ID (i.e. event_id)
-     * @param    int     $id                      id attached to the item published
-     * @param    string  $delete                  page route callback for the delete action
-     * @param    string  $save_close_redirect_URL custom URL to redirect to after Save & Close has been completed
-     * @param    boolean $both_btns               whether to display BOTH the "Save & Close" and "Save" buttons or just the Save button
-     * @throws \EE_Error
-     */
-    protected function _set_publish_post_box_vars(
-            $name = '',
-            $id = 0,
-            $delete = '',
-            $save_close_redirect_URL = '',
-            $both_btns = true
-    ) {
-        // if Save & Close, use a custom redirect URL or default to the main page?
-        $save_close_redirect_URL = ! empty($save_close_redirect_URL) ? $save_close_redirect_URL : $this->_admin_base_url;
-        // create the Save & Close and Save buttons
-        $this->_set_save_buttons($both_btns, array(), array(), $save_close_redirect_URL);
-        //if we have extra content set let's add it in if not make sure its empty
-        $this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
-        if ($delete && ! empty($id)) {
-            //make sure we have a default if just true is sent.
-            $delete = ! empty($delete) ? $delete : 'delete';
-            $delete_link_args = array($name => $id);
-            $delete = $this->get_action_link_or_button(
-                    $delete,
-                    $delete,
-                    $delete_link_args,
-                    'submitdelete deletion',
-                    '',
-                    false
-            );
-        }
-        $this->_template_args['publish_delete_link'] = ! empty($id) ? $delete : '';
-        if ( ! empty($name) && ! empty($id)) {
-            $hidden_field_arr[$name] = array(
-                    'type'  => 'hidden',
-                    'value' => $id,
-            );
-            $hf = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
-        } else {
-            $hf = '';
-        }
-        // add hidden field
-        $this->_template_args['publish_hidden_fields'] = ! empty($hf) ? $hf[$name]['field'] : $hf;
-    }
-
-
-
-    /**
-     *        displays an error message to ppl who have javascript disabled
-     *
-     * @access        private
-     * @return        string
-     */
-    private function _display_no_javascript_warning()
-    {
-        ?>
+	}
+
+
+
+	private function _espresso_links_post_box()
+	{
+		//Hiding until we actually have content to put in here...
+		//add_meta_box('espresso_links_post_box', __('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
+	}
+
+
+
+	public function espresso_links_post_box()
+	{
+		//Hiding until we actually have content to put in here...
+		//$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php';
+		//EEH_Template::display_template( $templatepath );
+	}
+
+
+
+	protected function _espresso_sponsors_post_box()
+	{
+		$show_sponsors = apply_filters('FHEE_show_sponsors_meta_box', true);
+		if ($show_sponsors) {
+			add_meta_box('espresso_sponsors_post_box', __('Event Espresso Highlights', 'event_espresso'), array($this, 'espresso_sponsors_post_box'), $this->_wp_page_slug, 'side');
+		}
+	}
+
+
+
+	public function espresso_sponsors_post_box()
+	{
+		$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php';
+		EEH_Template::display_template($templatepath);
+	}
+
+
+
+	private function _publish_post_box()
+	{
+		$meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
+		//if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array then we'll use that for the metabox label.  Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
+		if ( ! empty($this->_labels['publishbox'])) {
+			$box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][$this->_req_action] : $this->_labels['publishbox'];
+		} else {
+			$box_label = __('Publish', 'event_espresso');
+		}
+		$box_label = apply_filters('FHEE__EE_Admin_Page___publish_post_box__box_label', $box_label, $this->_req_action, $this);
+		add_meta_box($meta_box_ref, $box_label, array($this, 'editor_overview'), $this->_current_screen->id, 'side', 'high');
+	}
+
+
+
+	public function editor_overview()
+	{
+		//if we have extra content set let's add it in if not make sure its empty
+		$this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/** end of globally available metaboxes section **/
+	/*************************************************/
+	/**
+	 * Public wrapper for the protected method.  Allows plugins/addons to externally call the
+	 * protected method.
+	 *
+	 * @see   $this->_set_publish_post_box_vars for param details
+	 * @since 4.6.0
+	 */
+	public function set_publish_post_box_vars($name = null, $id = false, $delete = false, $save_close_redirect_URL = null, $both_btns = true)
+	{
+		$this->_set_publish_post_box_vars($name, $id, $delete, $save_close_redirect_URL, $both_btns);
+	}
+
+
+
+	/**
+	 * Sets the _template_args arguments used by the _publish_post_box shortcut
+	 * Note: currently there is no validation for this.  However if you want the delete button, the
+	 * save, and save and close buttons to work properly, then you will want to include a
+	 * values for the name and id arguments.
+	 *
+	 * @todo  Add in validation for name/id arguments.
+	 * @param    string  $name                    key used for the action ID (i.e. event_id)
+	 * @param    int     $id                      id attached to the item published
+	 * @param    string  $delete                  page route callback for the delete action
+	 * @param    string  $save_close_redirect_URL custom URL to redirect to after Save & Close has been completed
+	 * @param    boolean $both_btns               whether to display BOTH the "Save & Close" and "Save" buttons or just the Save button
+	 * @throws \EE_Error
+	 */
+	protected function _set_publish_post_box_vars(
+			$name = '',
+			$id = 0,
+			$delete = '',
+			$save_close_redirect_URL = '',
+			$both_btns = true
+	) {
+		// if Save & Close, use a custom redirect URL or default to the main page?
+		$save_close_redirect_URL = ! empty($save_close_redirect_URL) ? $save_close_redirect_URL : $this->_admin_base_url;
+		// create the Save & Close and Save buttons
+		$this->_set_save_buttons($both_btns, array(), array(), $save_close_redirect_URL);
+		//if we have extra content set let's add it in if not make sure its empty
+		$this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
+		if ($delete && ! empty($id)) {
+			//make sure we have a default if just true is sent.
+			$delete = ! empty($delete) ? $delete : 'delete';
+			$delete_link_args = array($name => $id);
+			$delete = $this->get_action_link_or_button(
+					$delete,
+					$delete,
+					$delete_link_args,
+					'submitdelete deletion',
+					'',
+					false
+			);
+		}
+		$this->_template_args['publish_delete_link'] = ! empty($id) ? $delete : '';
+		if ( ! empty($name) && ! empty($id)) {
+			$hidden_field_arr[$name] = array(
+					'type'  => 'hidden',
+					'value' => $id,
+			);
+			$hf = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
+		} else {
+			$hf = '';
+		}
+		// add hidden field
+		$this->_template_args['publish_hidden_fields'] = ! empty($hf) ? $hf[$name]['field'] : $hf;
+	}
+
+
+
+	/**
+	 *        displays an error message to ppl who have javascript disabled
+	 *
+	 * @access        private
+	 * @return        string
+	 */
+	private function _display_no_javascript_warning()
+	{
+		?>
         <noscript>
             <div id="no-js-message" class="error">
                 <p style="font-size:1.3em;">
@@ -2150,1231 +2150,1231 @@ 
             </div>
         </noscript>
         <?php
-    }
+	}
 
 
 
-    /**
-     *        displays espresso success and/or error notices
-     *
-     * @access        private
-     * @return        string
-     */
-    private function _display_espresso_notices()
-    {
-        $notices = $this->_get_transient(true);
-        echo stripslashes($notices);
-    }
+	/**
+	 *        displays espresso success and/or error notices
+	 *
+	 * @access        private
+	 * @return        string
+	 */
+	private function _display_espresso_notices()
+	{
+		$notices = $this->_get_transient(true);
+		echo stripslashes($notices);
+	}
 
 
 
-    /**
-     *        spinny things pacify the masses
-     *
-     * @access private
-     * @return string
-     */
-    protected function _add_admin_page_ajax_loading_img()
-    {
-        ?>
+	/**
+	 *        spinny things pacify the masses
+	 *
+	 * @access private
+	 * @return string
+	 */
+	protected function _add_admin_page_ajax_loading_img()
+	{
+		?>
         <div id="espresso-ajax-loading" class="ajax-loading-grey">
             <span class="ee-spinner ee-spin"></span><span class="hidden"><?php _e('loading...', 'event_espresso'); ?></span>
         </div>
         <?php
-    }
+	}
 
 
 
-    /**
-     *        add admin page overlay for modal boxes
-     *
-     * @access private
-     * @return string
-     */
-    protected function _add_admin_page_overlay()
-    {
-        ?>
+	/**
+	 *        add admin page overlay for modal boxes
+	 *
+	 * @access private
+	 * @return string
+	 */
+	protected function _add_admin_page_overlay()
+	{
+		?>
         <div id="espresso-admin-page-overlay-dv" class=""></div>
         <?php
-    }
-
-
-
-    /**
-     * facade for add_meta_box
-     *
-     * @param string  $action        where the metabox get's displayed
-     * @param string  $title         Title of Metabox (output in metabox header)
-     * @param string  $callback      If not empty and $create_fun is set to false then we'll use a custom callback instead of the one created in here.
-     * @param array   $callback_args an array of args supplied for the metabox
-     * @param string  $column        what metabox column
-     * @param string  $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
-     * @param boolean $create_func   default is true.  Basically we can say we don't WANT to have the runtime function created but just set our own callback for wp's add_meta_box.
-     */
-    public function _add_admin_page_meta_box($action, $title, $callback, $callback_args, $column = 'normal', $priority = 'high', $create_func = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, $callback);
-        //if we have empty callback args and we want to automatically create the metabox callback then we need to make sure the callback args are generated.
-        if (empty($callback_args) && $create_func) {
-            $callback_args = array(
-                    'template_path' => $this->_template_path,
-                    'template_args' => $this->_template_args,
-            );
-        }
-        //if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
-        $call_back_func = $create_func ? create_function('$post, $metabox',
-                'do_action( "AHEE_log", __FILE__, __FUNCTION__, ""); echo EEH_Template::display_template( $metabox["args"]["template_path"], $metabox["args"]["template_args"], TRUE );') : $callback;
-        add_meta_box(str_replace('_', '-', $action) . '-mbox', $title, $call_back_func, $this->_wp_page_slug, $column, $priority, $callback_args);
-    }
-
-
-
-    /**
-     * generates HTML wrapper for and admin details page that contains metaboxes in columns
-     *
-     * @return [type] [description]
-     */
-    public function display_admin_page_with_metabox_columns()
-    {
-        $this->_template_args['post_body_content'] = $this->_template_args['admin_page_content'];
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_column_template_path, $this->_template_args, true);
-        //the final wrapper
-        $this->admin_page_wrapper();
-    }
-
-
-
-    /**
-     *        generates  HTML wrapper for an admin details page
-     *
-     * @access public
-     * @return void
-     */
-    public function display_admin_page_with_sidebar()
-    {
-        $this->_display_admin_page(true);
-    }
-
-
-
-    /**
-     *        generates  HTML wrapper for an admin details page (except no sidebar)
-     *
-     * @access public
-     * @return void
-     */
-    public function display_admin_page_with_no_sidebar()
-    {
-        $this->_display_admin_page();
-    }
-
-
-
-    /**
-     * generates HTML wrapper for an EE about admin page (no sidebar)
-     *
-     * @access public
-     * @return void
-     */
-    public function display_about_admin_page()
-    {
-        $this->_display_admin_page(false, true);
-    }
-
-
-
-    /**
-     * display_admin_page
-     * contains the code for actually displaying an admin page
-     *
-     * @access private
-     * @param  boolean $sidebar true with sidebar, false without
-     * @param  boolean $about   use the about admin wrapper instead of the default.
-     * @return void
-     */
-    private function _display_admin_page($sidebar = false, $about = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        //custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
-        do_action('AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes');
-        // set current wp page slug - looks like: event-espresso_page_event_categories
-        // keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
-        $this->_template_args['current_page'] = $this->_wp_page_slug;
-        $this->_template_args['admin_page_wrapper_div_id'] = $this->_cpt_route
-                ? 'poststuff'
-                : 'espresso-default-admin';
-        $template_path = $sidebar
-                ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
-                : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
-        }
-        $template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
-        $this->_template_args['post_body_content'] = isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '';
-        $this->_template_args['before_admin_page_content'] = isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '';
-        $this->_template_args['after_admin_page_content'] = isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
-        // the final template wrapper
-        $this->admin_page_wrapper($about);
-    }
-
-
-
-    /**
-     * This is used to display caf preview pages.
-     *
-     * @since 4.3.2
-     * @param string $utm_campaign_source what is the key used for google analytics link
-     * @param bool   $display_sidebar     whether to use the sidebar template or the full template for the page.  TRUE = SHOW sidebar, FALSE = no sidebar. Default no sidebar.
-     * @return void
-     * @throws \EE_Error
-     */
-    public function display_admin_caf_preview_page($utm_campaign_source = '', $display_sidebar = true)
-    {
-        //let's generate a default preview action button if there isn't one already present.
-        $this->_labels['buttons']['buy_now'] = __('Upgrade to Event Espresso 4 Right Now', 'event_espresso');
-        $buy_now_url = add_query_arg(
-                array(
-                        'ee_ver'       => 'ee4',
-                        'utm_source'   => 'ee4_plugin_admin',
-                        'utm_medium'   => 'link',
-                        'utm_campaign' => $utm_campaign_source,
-                        'utm_content'  => 'buy_now_button',
-                ),
-                'https://eventespresso.com/pricing/'
-        );
-        $this->_template_args['preview_action_button'] = ! isset($this->_template_args['preview_action_button'])
-                ? $this->get_action_link_or_button(
-                        '',
-                        'buy_now',
-                        array(),
-                        'button-primary button-large',
-                        $buy_now_url,
-                        true
-                )
-                : $this->_template_args['preview_action_button'];
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-                $template_path,
-                $this->_template_args,
-                true
-        );
-        $this->_display_admin_page($display_sidebar);
-    }
-
-
-
-    /**
-     * display_admin_list_table_page_with_sidebar
-     * generates HTML wrapper for an admin_page with list_table
-     *
-     * @access public
-     * @return void
-     */
-    public function display_admin_list_table_page_with_sidebar()
-    {
-        $this->_display_admin_list_table_page(true);
-    }
-
-
-
-    /**
-     * display_admin_list_table_page_with_no_sidebar
-     * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
-     *
-     * @access public
-     * @return void
-     */
-    public function display_admin_list_table_page_with_no_sidebar()
-    {
-        $this->_display_admin_list_table_page();
-    }
-
-
-
-    /**
-     * generates html wrapper for an admin_list_table page
-     *
-     * @access private
-     * @param boolean $sidebar whether to display with sidebar or not.
-     * @return void
-     */
-    private function _display_admin_list_table_page($sidebar = false)
-    {
-        //setup search attributes
-        $this->_set_search_attributes();
-        $this->_template_args['current_page'] = $this->_wp_page_slug;
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
-        $this->_template_args['table_url'] = defined('DOING_AJAX')
-                ? add_query_arg(array('noheader' => 'true', 'route' => $this->_req_action), $this->_admin_base_url)
-                : add_query_arg(array('route' => $this->_req_action), $this->_admin_base_url);
-        $this->_template_args['list_table'] = $this->_list_table_object;
-        $this->_template_args['current_route'] = $this->_req_action;
-        $this->_template_args['list_table_class'] = get_class($this->_list_table_object);
-        $ajax_sorting_callback = $this->_list_table_object->get_ajax_sorting_callback();
-        if ( ! empty($ajax_sorting_callback)) {
-            $sortable_list_table_form_fields = wp_nonce_field(
-                    $ajax_sorting_callback . '_nonce',
-                    $ajax_sorting_callback . '_nonce',
-                    false,
-                    false
-            );
-            //			$reorder_action = 'espresso_' . $ajax_sorting_callback . '_nonce';
-            //			$sortable_list_table_form_fields = wp_nonce_field( $reorder_action, 'ajax_table_sort_nonce', FALSE, FALSE );
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="' . $this->page_slug . '" />';
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="' . $ajax_sorting_callback . '" />';
-        } else {
-            $sortable_list_table_form_fields = '';
-        }
-        $this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
-        $hidden_form_fields = isset($this->_template_args['list_table_hidden_fields']) ? $this->_template_args['list_table_hidden_fields'] : '';
-        $nonce_ref = $this->_req_action . '_nonce';
-        $hidden_form_fields .= '<input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
-        $this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
-        //display message about search results?
-        $this->_template_args['before_list_table'] .= apply_filters(
-                'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
-                ! empty($this->_req_data['s'])
-                        ? '<p class="ee-search-results">' . sprintf(
-                                __('Displaying search results for the search string: <strong><em>%s</em></strong>', 'event_espresso'),
-                                trim($this->_req_data['s'], '%')
-                        ) . '</p>'
-                        : '',
-                $this->page_slug,
-                $this->_req_data,
-                $this->_req_action
-        );
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-                $template_path,
-                $this->_template_args,
-                true
-        );
-        // the final template wrapper
-        if ($sidebar) {
-            $this->display_admin_page_with_sidebar();
-        } else {
-            $this->display_admin_page_with_no_sidebar();
-        }
-    }
-
-
-
-    /**
-     * This just prepares a legend using the given items and the admin_details_legend.template.php file and returns the html string for the legend.
-     * $items are expected in an array in the following format:
-     * $legend_items = array(
-     *        'item_id' => array(
-     *            'icon' => 'http://url_to_icon_being_described.png',
-     *            'desc' => __('localized description of item');
-     *        )
-     * );
-     *
-     * @param  array $items see above for format of array
-     * @return string        html string of legend
-     */
-    protected function _display_legend($items)
-    {
-        $this->_template_args['items'] = apply_filters('FHEE__EE_Admin_Page___display_legend__items', (array)$items, $this);
-        $legend_template = EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php';
-        return EEH_Template::display_template($legend_template, $this->_template_args, true);
-    }
-
-
-
-    /**
-     * this is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
-     *
-     * @param bool $sticky_notices Used to indicate whether you want to ensure notices are added to a transient instead of displayed.
-     *                             The returned json object is created from an array in the following format:
-     *                             array(
-     *                             'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
-     *                             'success' => FALSE, //(default FALSE) - contains any special success message.
-     *                             'notices' => '', // - contains any EE_Error formatted notices
-     *                             'content' => 'string can be html', //this is a string of formatted content (can be html)
-     *                             'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js. We're also going to include the template args with every package (so js can pick out any
-     *                             specific template args that might be included in here)
-     *                             )
-     *                             The json object is populated by whatever is set in the $_template_args property.
-     * @return void
-     */
-    protected function _return_json($sticky_notices = false)
-    {
-        //make sure any EE_Error notices have been handled.
-        $this->_process_notices(array(), true, $sticky_notices);
-        $data = isset($this->_template_args['data']) ? $this->_template_args['data'] : array();
-        unset($this->_template_args['data']);
-        $json = array(
-                'error'     => isset($this->_template_args['error']) ? $this->_template_args['error'] : false,
-                'success'   => isset($this->_template_args['success']) ? $this->_template_args['success'] : false,
-                'errors'    => isset($this->_template_args['errors']) ? $this->_template_args['errors'] : false,
-                'attention' => isset($this->_template_args['attention']) ? $this->_template_args['attention'] : false,
-                'notices'   => EE_Error::get_notices(),
-                'content'   => isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '',
-                'data'      => array_merge($data, array('template_args' => $this->_template_args)),
-                'isEEajax'  => true //special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
-        );
-        // make sure there are no php errors or headers_sent.  Then we can set correct json header.
-        if (null === error_get_last() || ! headers_sent()) {
-            header('Content-Type: application/json; charset=UTF-8');
-        }
-        echo wp_json_encode($json);
-
-        exit();
-    }
-
-
-
-    /**
-     * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function return_json()
-    {
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $this->_return_json();
-        } else {
-            throw new EE_Error(sprintf(__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'), __FUNCTION__));
-        }
-    }
-
-
-
-    /**
-     * This provides a way for child hook classes to send along themselves by reference so methods/properties within them can be accessed by EE_Admin_child pages. This is assigned to the $_hook_obj property.
-     *
-     * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
-     * @access   public
-     */
-    public function set_hook_object(EE_Admin_Hooks $hook_obj)
-    {
-        $this->_hook_obj = $hook_obj;
-    }
-
-
-
-    /**
-     *        generates  HTML wrapper with Tabbed nav for an admin page
-     *
-     * @access public
-     * @param  boolean $about whether to use the special about page wrapper or default.
-     * @return void
-     */
-    public function admin_page_wrapper($about = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_nav_tabs = $this->_get_main_nav_tabs();
-        $this->_template_args['nav_tabs'] = $this->_nav_tabs;
-        $this->_template_args['admin_page_title'] = $this->_admin_page_title;
-        $this->_template_args['before_admin_page_content'] = apply_filters('FHEE_before_admin_page_content' . $this->_current_page . $this->_current_view,
-                isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '');
-        $this->_template_args['after_admin_page_content'] = apply_filters('FHEE_after_admin_page_content' . $this->_current_page . $this->_current_view,
-                isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '');
-        $this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
-        // load settings page wrapper template
-        $template_path = ! defined('DOING_AJAX') ? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php' : EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php';
-        //about page?
-        $template_path = $about ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php' : $template_path;
-        if (defined('DOING_AJAX')) {
-            $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
-            $this->_return_json();
-        } else {
-            EEH_Template::display_template($template_path, $this->_template_args);
-        }
-    }
-
-
-
-    /**
-     * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
-     *
-     * @return string html
-     */
-    protected function _get_main_nav_tabs()
-    {
-        //let's generate the html using the EEH_Tabbed_Content helper.  We do this here so that it's possible for child classes to add in nav tabs dynamically at the last minute (rather than setting in the page_routes array)
-        return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
-    }
-
-
-
-    /**
-     *        sort nav tabs
-     *
-     * @access public
-     * @param $a
-     * @param $b
-     * @return int
-     */
-    private function _sort_nav_tabs($a, $b)
-    {
-        if ($a['order'] == $b['order']) {
-            return 0;
-        }
-        return ($a['order'] < $b['order']) ? -1 : 1;
-    }
-
-
-
-    /**
-     *    generates HTML for the forms used on admin pages
-     *
-     * @access protected
-     * @param    array $input_vars - array of input field details
-     * @param string   $generator  (options are 'string' or 'array', basically use this to indicate which generator to use)
-     * @return string
-     * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
-     * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
-     */
-    protected function _generate_admin_form_fields($input_vars = array(), $generator = 'string', $id = false)
-    {
-        $content = $generator == 'string' ? EEH_Form_Fields::get_form_fields($input_vars, $id) : EEH_Form_Fields::get_form_fields_array($input_vars);
-        return $content;
-    }
-
-
-
-    /**
-     * generates the "Save" and "Save & Close" buttons for edit forms
-     *
-     * @access protected
-     * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save & Close" button.
-     * @param array            $text     if included, generator will use the given text for the buttons ( array([0] => 'Save', [1] => 'save & close')
-     * @param array            $actions  if included allows us to set the actions that each button will carry out (i.e. via the "name" value in the button).  We can also use this to just dump default actions by submitting some other value.
-     * @param bool|string|null $referrer if false then we just do the default action on save and close.  Other wise it will use the $referrer string. IF null, then we don't do ANYTHING on save and close (normal form handling).
-     */
-    protected function _set_save_buttons($both = true, $text = array(), $actions = array(), $referrer = null)
-    {
-        //make sure $text and $actions are in an array
-        $text = (array)$text;
-        $actions = (array)$actions;
-        $referrer_url = empty($referrer) ? '' : $referrer;
-        $referrer_url = ! $referrer ? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $_SERVER['REQUEST_URI'] . '" />'
-                : '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $referrer . '" />';
-        $button_text = ! empty($text) ? $text : array(__('Save', 'event_espresso'), __('Save and Close', 'event_espresso'));
-        $default_names = array('save', 'save_and_close');
-        //add in a hidden index for the current page (so save and close redirects properly)
-        $this->_template_args['save_buttons'] = $referrer_url;
-        foreach ($button_text as $key => $button) {
-            $ref = $default_names[$key];
-            $id = $this->_current_view . '_' . $ref;
-            $name = ! empty($actions) ? $actions[$key] : $ref;
-            $this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary ' . $ref . '" value="' . $button . '" name="' . $name . '" id="' . $id . '" />';
-            if ( ! $both) {
-                break;
-            }
-        }
-    }
-
-
-
-    /**
-     * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
-     *
-     * @see   $this->_set_add_edit_form_tags() for details on params
-     * @since 4.6.0
-     * @param string $route
-     * @param array  $additional_hidden_fields
-     */
-    public function set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
-    {
-        $this->_set_add_edit_form_tags($route, $additional_hidden_fields);
-    }
-
-
-
-    /**
-     * set form open and close tags on add/edit pages.
-     *
-     * @access protected
-     * @param string $route                    the route you want the form to direct to
-     * @param array  $additional_hidden_fields any additional hidden fields required in the form header
-     * @return void
-     */
-    protected function _set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
-    {
-        if (empty($route)) {
-            $user_msg = __('An error occurred. No action was set for this page\'s form.', 'event_espresso');
-            $dev_msg = $user_msg . "\n" . sprintf(__('The $route argument is required for the %s->%s method.', 'event_espresso'), __FUNCTION__, __CLASS__);
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // open form
-        $this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="' . $this->_admin_base_url . '" id="' . $route . '_event_form" >';
-        // add nonce
-        $nonce = wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
-        //		$nonce = wp_nonce_field( $route . '_nonce', '_wpnonce', FALSE, FALSE );
-        $this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
-        // add REQUIRED form action
-        $hidden_fields = array(
-                'action' => array('type' => 'hidden', 'value' => $route),
-        );
-        // merge arrays
-        $hidden_fields = is_array($additional_hidden_fields) ? array_merge($hidden_fields, $additional_hidden_fields) : $hidden_fields;
-        // generate form fields
-        $form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
-        // add fields to form
-        foreach ((array)$form_fields as $field_name => $form_field) {
-            $this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
-        }
-        // close form
-        $this->_template_args['after_admin_page_content'] = '</form>';
-    }
-
-
-
-    /**
-     * Public Wrapper for _redirect_after_action() method since its
-     * discovered it would be useful for external code to have access.
-     *
-     * @see   EE_Admin_Page::_redirect_after_action() for params.
-     * @since 4.5.0
-     */
-    public function redirect_after_action($success = false, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
-    {
-        $this->_redirect_after_action($success, $what, $action_desc, $query_args, $override_overwrite);
-    }
-
-
-
-    /**
-     *    _redirect_after_action
-     *
-     * @param int    $success            - whether success was for two or more records, or just one, or none
-     * @param string $what               - what the action was performed on
-     * @param string $action_desc        - what was done ie: updated, deleted, etc
-     * @param array  $query_args         - an array of query_args to be added to the URL to redirect to after the admin action is completed
-     * @param BOOL   $override_overwrite by default all EE_Error::success messages are overwritten, this allows you to override this so that they show.
-     * @access protected
-     * @return void
-     */
-    protected function _redirect_after_action($success = 0, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        //class name for actions/filters.
-        $classname = get_class($this);
-        //set redirect url. Note if there is a "page" index in the $query_args then we go with vanilla admin.php route, otherwise we go with whatever is set as the _admin_base_url
-        $redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
-        $notices = EE_Error::get_notices(false);
-        // overwrite default success messages //BUT ONLY if overwrite not overridden
-        if ( ! $override_overwrite || ! empty($notices['errors'])) {
-            EE_Error::overwrite_success();
-        }
-        if ( ! empty($what) && ! empty($action_desc)) {
-            // how many records affected ? more than one record ? or just one ?
-            if ($success > 1 && empty($notices['errors'])) {
-                // set plural msg
-                EE_Error::add_success(
-                        sprintf(
-                                __('The "%s" have been successfully %s.', 'event_espresso'),
-                                $what,
-                                $action_desc
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                );
-            } else if ($success == 1 && empty($notices['errors'])) {
-                // set singular msg
-                EE_Error::add_success(
-                        sprintf(
-                                __('The "%s" has been successfully %s.', 'event_espresso'),
-                                $what,
-                                $action_desc
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                );
-            }
-        }
-        // check that $query_args isn't something crazy
-        if ( ! is_array($query_args)) {
-            $query_args = array();
-        }
-        /**
-         * Allow injecting actions before the query_args are modified for possible different
-         * redirections on save and close actions
-         *
-         * @since 4.2.0
-         * @param array $query_args       The original query_args array coming into the
-         *                                method.
-         */
-        do_action('AHEE__' . $classname . '___redirect_after_action__before_redirect_modification_' . $this->_req_action, $query_args);
-        //calculate where we're going (if we have a "save and close" button pushed)
-        if (isset($this->_req_data['save_and_close']) && isset($this->_req_data['save_and_close_referrer'])) {
-            // even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
-            $parsed_url = parse_url($this->_req_data['save_and_close_referrer']);
-            // regenerate query args array from referrer URL
-            parse_str($parsed_url['query'], $query_args);
-            // correct page and action will be in the query args now
-            $redirect_url = admin_url('admin.php');
-        }
-        //merge any default query_args set in _default_route_query_args property
-        if ( ! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
-            $args_to_merge = array();
-            foreach ($this->_default_route_query_args as $query_param => $query_value) {
-                //is there a wp_referer array in our _default_route_query_args property?
-                if ($query_param == 'wp_referer') {
-                    $query_value = (array)$query_value;
-                    foreach ($query_value as $reference => $value) {
-                        if (strpos($reference, 'nonce') !== false) {
-                            continue;
-                        }
-                        //finally we will override any arguments in the referer with
-                        //what might be set on the _default_route_query_args array.
-                        if (isset($this->_default_route_query_args[$reference])) {
-                            $args_to_merge[$reference] = urlencode($this->_default_route_query_args[$reference]);
-                        } else {
-                            $args_to_merge[$reference] = urlencode($value);
-                        }
-                    }
-                    continue;
-                }
-                $args_to_merge[$query_param] = $query_value;
-            }
-            //now let's merge these arguments but override with what was specifically sent in to the
-            //redirect.
-            $query_args = array_merge($args_to_merge, $query_args);
-        }
-        $this->_process_notices($query_args);
-        // generate redirect url
-        // if redirecting to anything other than the main page, add a nonce
-        if (isset($query_args['action'])) {
-            // manually generate wp_nonce and merge that with the query vars becuz the wp_nonce_url function wrecks havoc on some vars
-            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
-        }
-        //we're adding some hooks and filters in here for processing any things just before redirects (example: an admin page has done an insert or update and we want to run something after that).
-        do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
-        $redirect_url = apply_filters('FHEE_redirect_' . $classname . $this->_req_action, self::add_query_args_and_nonce($query_args, $redirect_url), $query_args);
-        // check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
-        if (defined('DOING_AJAX')) {
-            $default_data = array(
-                    'close'        => true,
-                    'redirect_url' => $redirect_url,
-                    'where'        => 'main',
-                    'what'         => 'append',
-            );
-            $this->_template_args['success'] = $success;
-            $this->_template_args['data'] = ! empty($this->_template_args['data']) ? array_merge($default_data, $this->_template_args['data']) : $default_data;
-            $this->_return_json();
-        }
-        wp_safe_redirect($redirect_url);
-        exit();
-    }
-
-
-
-    /**
-     * process any notices before redirecting (or returning ajax request)
-     * This method sets the $this->_template_args['notices'] attribute;
-     *
-     * @param  array $query_args        any query args that need to be used for notice transient ('action')
-     * @param bool   $skip_route_verify This is typically used when we are processing notices REALLY early and page_routes haven't been defined yet.
-     * @param bool   $sticky_notices    This is used to flag that regardless of whether this is doing_ajax or not, we still save a transient for the notice.
-     * @return void
-     */
-    protected function _process_notices($query_args = array(), $skip_route_verify = false, $sticky_notices = true)
-    {
-        //first let's set individual error properties if doing_ajax and the properties aren't already set.
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $notices = EE_Error::get_notices(false);
-            if (empty($this->_template_args['success'])) {
-                $this->_template_args['success'] = isset($notices['success']) ? $notices['success'] : false;
-            }
-            if (empty($this->_template_args['errors'])) {
-                $this->_template_args['errors'] = isset($notices['errors']) ? $notices['errors'] : false;
-            }
-            if (empty($this->_template_args['attention'])) {
-                $this->_template_args['attention'] = isset($notices['attention']) ? $notices['attention'] : false;
-            }
-        }
-        $this->_template_args['notices'] = EE_Error::get_notices();
-        //IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
-        if ( ! defined('DOING_AJAX') || $sticky_notices) {
-            $route = isset($query_args['action']) ? $query_args['action'] : 'default';
-            $this->_add_transient($route, $this->_template_args['notices'], true, $skip_route_verify);
-        }
-    }
-
-
-
-    /**
-     * get_action_link_or_button
-     * returns the button html for adding, editing, or deleting an item (depending on given type)
-     *
-     * @param string $action        use this to indicate which action the url is generated with.
-     * @param string $type          accepted strings must be defined in the $_labels['button'] array(as the key) property.
-     * @param array  $extra_request if the button requires extra params you can include them in $key=>$value pairs.
-     * @param string $class         Use this to give the class for the button. Defaults to 'button-primary'
-     * @param string $base_url      If this is not provided
-     *                              the _admin_base_url will be used as the default for the button base_url.
-     *                              Otherwise this value will be used.
-     * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
-     * @return string
-     * @throws \EE_Error
-     */
-    public function get_action_link_or_button(
-            $action,
-            $type = 'add',
-            $extra_request = array(),
-            $class = 'button-primary',
-            $base_url = '',
-            $exclude_nonce = false
-    ) {
-        //first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
-        if (empty($base_url) && ! isset($this->_page_routes[$action])) {
-            throw new EE_Error(
-                    sprintf(
-                            __(
-                                    'There is no page route for given action for the button.  This action was given: %s',
-                                    'event_espresso'
-                            ),
-                            $action
-                    )
-            );
-        }
-        if ( ! isset($this->_labels['buttons'][$type])) {
-            throw new EE_Error(
-                    sprintf(
-                            __(
-                                    'There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.',
-                                    'event_espresso'
-                            ),
-                            $type
-                    )
-            );
-        }
-        //finally check user access for this button.
-        $has_access = $this->check_user_access($action, true);
-        if ( ! $has_access) {
-            return '';
-        }
-        $_base_url = ! $base_url ? $this->_admin_base_url : $base_url;
-        $query_args = array(
-                'action' => $action,
-        );
-        //merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
-        if ( ! empty($extra_request)) {
-            $query_args = array_merge($extra_request, $query_args);
-        }
-        $url = self::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
-        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][$type], $class);
-    }
-
-
-
-    /**
-     * _per_page_screen_option
-     * Utility function for adding in a per_page_option in the screen_options_dropdown.
-     *
-     * @return void
-     */
-    protected function _per_page_screen_option()
-    {
-        $option = 'per_page';
-        $args = array(
-                'label'   => $this->_admin_page_title,
-                'default' => 10,
-                'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
-        );
-        //ONLY add the screen option if the user has access to it.
-        if ($this->check_user_access($this->_current_view, true)) {
-            add_screen_option($option, $args);
-        }
-    }
-
-
-
-    /**
-     * set_per_page_screen_option
-     * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
-     * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than admin_menu.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_per_page_screen_options()
-    {
-        if (isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options'])) {
-            check_admin_referer('screen-options-nonce', 'screenoptionnonce');
-            if ( ! $user = wp_get_current_user()) {
-                return;
-            }
-            $option = $_POST['wp_screen_options']['option'];
-            $value = $_POST['wp_screen_options']['value'];
-            if ($option != sanitize_key($option)) {
-                return;
-            }
-            $map_option = $option;
-            $option = str_replace('-', '_', $option);
-            switch ($map_option) {
-                case $this->_current_page . '_' . $this->_current_view . '_per_page':
-                    $value = (int)$value;
-                    if ($value < 1 || $value > 999) {
-                        return;
-                    }
-                    break;
-                default:
-                    $value = apply_filters('FHEE__EE_Admin_Page___set_per_page_screen_options__value', false, $option, $value);
-                    if (false === $value) {
-                        return;
-                    }
-                    break;
-            }
-            update_user_meta($user->ID, $option, $value);
-            wp_safe_redirect(remove_query_arg(array('pagenum', 'apage', 'paged'), wp_get_referer()));
-            exit;
-        }
-    }
-
-
-
-    /**
-     * This just allows for setting the $_template_args property if it needs to be set outside the object
-     *
-     * @param array $data array that will be assigned to template args.
-     */
-    public function set_template_args($data)
-    {
-        $this->_template_args = array_merge($this->_template_args, (array)$data);
-    }
-
-
-
-    /**
-     * This makes available the WP transient system for temporarily moving data between routes
-     *
-     * @access protected
-     * @param string $route             the route that should receive the transient
-     * @param array  $data              the data that gets sent
-     * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a normal route transient.
-     * @param bool   $skip_route_verify Used to indicate we want to skip route verification.  This is usually ONLY used when we are adding a transient before page_routes have been defined.
-     * @return void
-     */
-    protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
-    {
-        $user_id = get_current_user_id();
-        if ( ! $skip_route_verify) {
-            $this->_verify_route($route);
-        }
-        //now let's set the string for what kind of transient we're setting
-        $transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
-        $data = $notices ? array('notices' => $data) : $data;
-        //is there already a transient for this route?  If there is then let's ADD to that transient
-        $existing = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
-        if ($existing) {
-            $data = array_merge((array)$data, (array)$existing);
-        }
-        if (is_multisite() && is_network_admin()) {
-            set_site_transient($transient, $data, 8);
-        } else {
-            set_transient($transient, $data, 8);
-        }
-    }
-
-
-
-    /**
-     * this retrieves the temporary transient that has been set for moving data between routes.
-     *
-     * @param bool $notices true we get notices transient. False we just return normal route transient
-     * @return mixed data
-     */
-    protected function _get_transient($notices = false, $route = false)
-    {
-        $user_id = get_current_user_id();
-        $route = ! $route ? $this->_req_action : $route;
-        $transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
-        $data = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
-        //delete transient after retrieval (just in case it hasn't expired);
-        if (is_multisite() && is_network_admin()) {
-            delete_site_transient($transient);
-        } else {
-            delete_transient($transient);
-        }
-        return $notices && isset($data['notices']) ? $data['notices'] : $data;
-    }
-
-
-
-    /**
-     * The purpose of this method is just to run garbage collection on any EE transients that might have expired but would not be called later.
-     * This will be assigned to run on a specific EE Admin page. (place the method in the default route callback on the EE_Admin page you want it run.)
-     *
-     * @return void
-     */
-    protected function _transient_garbage_collection()
-    {
-        global $wpdb;
-        //retrieve all existing transients
-        $query = "SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
-        if ($results = $wpdb->get_results($query)) {
-            foreach ($results as $result) {
-                $transient = str_replace('_transient_', '', $result->option_name);
-                get_transient($transient);
-                if (is_multisite() && is_network_admin()) {
-                    get_site_transient($transient);
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * get_view
-     *
-     * @access public
-     * @return string content of _view property
-     */
-    public function get_view()
-    {
-        return $this->_view;
-    }
-
-
-
-    /**
-     * getter for the protected $_views property
-     *
-     * @return array
-     */
-    public function get_views()
-    {
-        return $this->_views;
-    }
-
-
-
-    /**
-     * get_current_page
-     *
-     * @access public
-     * @return string _current_page property value
-     */
-    public function get_current_page()
-    {
-        return $this->_current_page;
-    }
-
-
-
-    /**
-     * get_current_view
-     *
-     * @access public
-     * @return string _current_view property value
-     */
-    public function get_current_view()
-    {
-        return $this->_current_view;
-    }
-
-
-
-    /**
-     * get_current_screen
-     *
-     * @access public
-     * @return object The current WP_Screen object
-     */
-    public function get_current_screen()
-    {
-        return $this->_current_screen;
-    }
-
-
-
-    /**
-     * get_current_page_view_url
-     *
-     * @access public
-     * @return string This returns the url for the current_page_view.
-     */
-    public function get_current_page_view_url()
-    {
-        return $this->_current_page_view_url;
-    }
-
-
-
-    /**
-     * just returns the _req_data property
-     *
-     * @return array
-     */
-    public function get_request_data()
-    {
-        return $this->_req_data;
-    }
-
-
-
-    /**
-     * returns the _req_data protected property
-     *
-     * @return string
-     */
-    public function get_req_action()
-    {
-        return $this->_req_action;
-    }
-
-
-
-    /**
-     * @return bool  value of $_is_caf property
-     */
-    public function is_caf()
-    {
-        return $this->_is_caf;
-    }
-
-
-
-    /**
-     * @return mixed
-     */
-    public function default_espresso_metaboxes()
-    {
-        return $this->_default_espresso_metaboxes;
-    }
-
-
-
-    /**
-     * @return mixed
-     */
-    public function admin_base_url()
-    {
-        return $this->_admin_base_url;
-    }
-
-
-
-    /**
-     * @return mixed
-     */
-    public function wp_page_slug()
-    {
-        return $this->_wp_page_slug;
-    }
-
-
-
-    /**
-     * updates  espresso configuration settings
-     *
-     * @access    protected
-     * @param string                   $tab
-     * @param EE_Config_Base|EE_Config $config
-     * @param string                   $file file where error occurred
-     * @param string                   $func function  where error occurred
-     * @param string                   $line line no where error occurred
-     * @return boolean
-     */
-    protected function _update_espresso_configuration($tab, $config, $file = '', $func = '', $line = '')
-    {
-        //remove any options that are NOT going to be saved with the config settings.
-        if (isset($config->core->ee_ueip_optin)) {
-            $config->core->ee_ueip_has_notified = true;
-            // TODO: remove the following two lines and make sure values are migrated from 3.1
-            update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
-            update_option('ee_ueip_has_notified', true);
-        }
-        // and save it (note we're also doing the network save here)
-        $net_saved = is_main_site() ? EE_Network_Config::instance()->update_config(false, false) : true;
-        $config_saved = EE_Config::instance()->update_espresso_config(false, false);
-        if ($config_saved && $net_saved) {
-            EE_Error::add_success(sprintf(__('"%s" have been successfully updated.', 'event_espresso'), $tab));
-            return true;
-        } else {
-            EE_Error::add_error(sprintf(__('The "%s" were not updated.', 'event_espresso'), $tab), $file, $func, $line);
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
-     *
-     * @return array
-     */
-    public function get_yes_no_values()
-    {
-        return $this->_yes_no_values;
-    }
-
-
-
-    protected function _get_dir()
-    {
-        $reflector = new ReflectionClass(get_class($this));
-        return dirname($reflector->getFileName());
-    }
-
-
-
-    /**
-     * A helper for getting a "next link".
-     *
-     * @param string $url   The url to link to
-     * @param string $class The class to use.
-     * @return string
-     */
-    protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
-    {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
-    }
-
-
-
-    /**
-     * A helper for getting a "previous link".
-     *
-     * @param string $url   The url to link to
-     * @param string $class The class to use.
-     * @return string
-     */
-    protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
-    {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
-    }
-
-
-
-
-
-
-
-    //below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
-    /**
-     * This processes an request to resend a registration and assumes we have a _REG_ID for doing so. So if the caller knows that the _REG_ID isn't in the req_data array but CAN obtain it, the caller should ADD the _REG_ID to the _req_data
-     * array.
-     *
-     * @return bool success/fail
-     */
-    protected function _process_resend_registration()
-    {
-        $this->_template_args['success'] = EED_Messages::process_resend($this->_req_data);
-        do_action('AHEE__EE_Admin_Page___process_resend_registration', $this->_template_args['success'], $this->_req_data);
-        return $this->_template_args['success'];
-    }
-
-
-
-    /**
-     * This automatically processes any payment message notifications when manual payment has been applied.
-     *
-     * @access protected
-     * @param \EE_Payment $payment
-     * @return bool success/fail
-     */
-    protected function _process_payment_notification(EE_Payment $payment)
-    {
-        add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
-        do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
-        $this->_template_args['success'] = apply_filters('FHEE__EE_Admin_Page___process_admin_payment_notification__success', false, $payment);
-        return $this->_template_args['success'];
-    }
+	}
+
+
+
+	/**
+	 * facade for add_meta_box
+	 *
+	 * @param string  $action        where the metabox get's displayed
+	 * @param string  $title         Title of Metabox (output in metabox header)
+	 * @param string  $callback      If not empty and $create_fun is set to false then we'll use a custom callback instead of the one created in here.
+	 * @param array   $callback_args an array of args supplied for the metabox
+	 * @param string  $column        what metabox column
+	 * @param string  $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
+	 * @param boolean $create_func   default is true.  Basically we can say we don't WANT to have the runtime function created but just set our own callback for wp's add_meta_box.
+	 */
+	public function _add_admin_page_meta_box($action, $title, $callback, $callback_args, $column = 'normal', $priority = 'high', $create_func = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, $callback);
+		//if we have empty callback args and we want to automatically create the metabox callback then we need to make sure the callback args are generated.
+		if (empty($callback_args) && $create_func) {
+			$callback_args = array(
+					'template_path' => $this->_template_path,
+					'template_args' => $this->_template_args,
+			);
+		}
+		//if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
+		$call_back_func = $create_func ? create_function('$post, $metabox',
+				'do_action( "AHEE_log", __FILE__, __FUNCTION__, ""); echo EEH_Template::display_template( $metabox["args"]["template_path"], $metabox["args"]["template_args"], TRUE );') : $callback;
+		add_meta_box(str_replace('_', '-', $action) . '-mbox', $title, $call_back_func, $this->_wp_page_slug, $column, $priority, $callback_args);
+	}
+
+
+
+	/**
+	 * generates HTML wrapper for and admin details page that contains metaboxes in columns
+	 *
+	 * @return [type] [description]
+	 */
+	public function display_admin_page_with_metabox_columns()
+	{
+		$this->_template_args['post_body_content'] = $this->_template_args['admin_page_content'];
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_column_template_path, $this->_template_args, true);
+		//the final wrapper
+		$this->admin_page_wrapper();
+	}
+
+
+
+	/**
+	 *        generates  HTML wrapper for an admin details page
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function display_admin_page_with_sidebar()
+	{
+		$this->_display_admin_page(true);
+	}
+
+
+
+	/**
+	 *        generates  HTML wrapper for an admin details page (except no sidebar)
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function display_admin_page_with_no_sidebar()
+	{
+		$this->_display_admin_page();
+	}
+
+
+
+	/**
+	 * generates HTML wrapper for an EE about admin page (no sidebar)
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function display_about_admin_page()
+	{
+		$this->_display_admin_page(false, true);
+	}
+
+
+
+	/**
+	 * display_admin_page
+	 * contains the code for actually displaying an admin page
+	 *
+	 * @access private
+	 * @param  boolean $sidebar true with sidebar, false without
+	 * @param  boolean $about   use the about admin wrapper instead of the default.
+	 * @return void
+	 */
+	private function _display_admin_page($sidebar = false, $about = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		//custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
+		do_action('AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes');
+		// set current wp page slug - looks like: event-espresso_page_event_categories
+		// keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
+		$this->_template_args['current_page'] = $this->_wp_page_slug;
+		$this->_template_args['admin_page_wrapper_div_id'] = $this->_cpt_route
+				? 'poststuff'
+				: 'espresso-default-admin';
+		$template_path = $sidebar
+				? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
+				: EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
+		}
+		$template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
+		$this->_template_args['post_body_content'] = isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '';
+		$this->_template_args['before_admin_page_content'] = isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '';
+		$this->_template_args['after_admin_page_content'] = isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
+		// the final template wrapper
+		$this->admin_page_wrapper($about);
+	}
+
+
+
+	/**
+	 * This is used to display caf preview pages.
+	 *
+	 * @since 4.3.2
+	 * @param string $utm_campaign_source what is the key used for google analytics link
+	 * @param bool   $display_sidebar     whether to use the sidebar template or the full template for the page.  TRUE = SHOW sidebar, FALSE = no sidebar. Default no sidebar.
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function display_admin_caf_preview_page($utm_campaign_source = '', $display_sidebar = true)
+	{
+		//let's generate a default preview action button if there isn't one already present.
+		$this->_labels['buttons']['buy_now'] = __('Upgrade to Event Espresso 4 Right Now', 'event_espresso');
+		$buy_now_url = add_query_arg(
+				array(
+						'ee_ver'       => 'ee4',
+						'utm_source'   => 'ee4_plugin_admin',
+						'utm_medium'   => 'link',
+						'utm_campaign' => $utm_campaign_source,
+						'utm_content'  => 'buy_now_button',
+				),
+				'https://eventespresso.com/pricing/'
+		);
+		$this->_template_args['preview_action_button'] = ! isset($this->_template_args['preview_action_button'])
+				? $this->get_action_link_or_button(
+						'',
+						'buy_now',
+						array(),
+						'button-primary button-large',
+						$buy_now_url,
+						true
+				)
+				: $this->_template_args['preview_action_button'];
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+				$template_path,
+				$this->_template_args,
+				true
+		);
+		$this->_display_admin_page($display_sidebar);
+	}
+
+
+
+	/**
+	 * display_admin_list_table_page_with_sidebar
+	 * generates HTML wrapper for an admin_page with list_table
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function display_admin_list_table_page_with_sidebar()
+	{
+		$this->_display_admin_list_table_page(true);
+	}
+
+
+
+	/**
+	 * display_admin_list_table_page_with_no_sidebar
+	 * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function display_admin_list_table_page_with_no_sidebar()
+	{
+		$this->_display_admin_list_table_page();
+	}
+
+
+
+	/**
+	 * generates html wrapper for an admin_list_table page
+	 *
+	 * @access private
+	 * @param boolean $sidebar whether to display with sidebar or not.
+	 * @return void
+	 */
+	private function _display_admin_list_table_page($sidebar = false)
+	{
+		//setup search attributes
+		$this->_set_search_attributes();
+		$this->_template_args['current_page'] = $this->_wp_page_slug;
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
+		$this->_template_args['table_url'] = defined('DOING_AJAX')
+				? add_query_arg(array('noheader' => 'true', 'route' => $this->_req_action), $this->_admin_base_url)
+				: add_query_arg(array('route' => $this->_req_action), $this->_admin_base_url);
+		$this->_template_args['list_table'] = $this->_list_table_object;
+		$this->_template_args['current_route'] = $this->_req_action;
+		$this->_template_args['list_table_class'] = get_class($this->_list_table_object);
+		$ajax_sorting_callback = $this->_list_table_object->get_ajax_sorting_callback();
+		if ( ! empty($ajax_sorting_callback)) {
+			$sortable_list_table_form_fields = wp_nonce_field(
+					$ajax_sorting_callback . '_nonce',
+					$ajax_sorting_callback . '_nonce',
+					false,
+					false
+			);
+			//			$reorder_action = 'espresso_' . $ajax_sorting_callback . '_nonce';
+			//			$sortable_list_table_form_fields = wp_nonce_field( $reorder_action, 'ajax_table_sort_nonce', FALSE, FALSE );
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="' . $this->page_slug . '" />';
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="' . $ajax_sorting_callback . '" />';
+		} else {
+			$sortable_list_table_form_fields = '';
+		}
+		$this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
+		$hidden_form_fields = isset($this->_template_args['list_table_hidden_fields']) ? $this->_template_args['list_table_hidden_fields'] : '';
+		$nonce_ref = $this->_req_action . '_nonce';
+		$hidden_form_fields .= '<input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
+		$this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
+		//display message about search results?
+		$this->_template_args['before_list_table'] .= apply_filters(
+				'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
+				! empty($this->_req_data['s'])
+						? '<p class="ee-search-results">' . sprintf(
+								__('Displaying search results for the search string: <strong><em>%s</em></strong>', 'event_espresso'),
+								trim($this->_req_data['s'], '%')
+						) . '</p>'
+						: '',
+				$this->page_slug,
+				$this->_req_data,
+				$this->_req_action
+		);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+				$template_path,
+				$this->_template_args,
+				true
+		);
+		// the final template wrapper
+		if ($sidebar) {
+			$this->display_admin_page_with_sidebar();
+		} else {
+			$this->display_admin_page_with_no_sidebar();
+		}
+	}
+
+
+
+	/**
+	 * This just prepares a legend using the given items and the admin_details_legend.template.php file and returns the html string for the legend.
+	 * $items are expected in an array in the following format:
+	 * $legend_items = array(
+	 *        'item_id' => array(
+	 *            'icon' => 'http://url_to_icon_being_described.png',
+	 *            'desc' => __('localized description of item');
+	 *        )
+	 * );
+	 *
+	 * @param  array $items see above for format of array
+	 * @return string        html string of legend
+	 */
+	protected function _display_legend($items)
+	{
+		$this->_template_args['items'] = apply_filters('FHEE__EE_Admin_Page___display_legend__items', (array)$items, $this);
+		$legend_template = EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php';
+		return EEH_Template::display_template($legend_template, $this->_template_args, true);
+	}
+
+
+
+	/**
+	 * this is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
+	 *
+	 * @param bool $sticky_notices Used to indicate whether you want to ensure notices are added to a transient instead of displayed.
+	 *                             The returned json object is created from an array in the following format:
+	 *                             array(
+	 *                             'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
+	 *                             'success' => FALSE, //(default FALSE) - contains any special success message.
+	 *                             'notices' => '', // - contains any EE_Error formatted notices
+	 *                             'content' => 'string can be html', //this is a string of formatted content (can be html)
+	 *                             'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js. We're also going to include the template args with every package (so js can pick out any
+	 *                             specific template args that might be included in here)
+	 *                             )
+	 *                             The json object is populated by whatever is set in the $_template_args property.
+	 * @return void
+	 */
+	protected function _return_json($sticky_notices = false)
+	{
+		//make sure any EE_Error notices have been handled.
+		$this->_process_notices(array(), true, $sticky_notices);
+		$data = isset($this->_template_args['data']) ? $this->_template_args['data'] : array();
+		unset($this->_template_args['data']);
+		$json = array(
+				'error'     => isset($this->_template_args['error']) ? $this->_template_args['error'] : false,
+				'success'   => isset($this->_template_args['success']) ? $this->_template_args['success'] : false,
+				'errors'    => isset($this->_template_args['errors']) ? $this->_template_args['errors'] : false,
+				'attention' => isset($this->_template_args['attention']) ? $this->_template_args['attention'] : false,
+				'notices'   => EE_Error::get_notices(),
+				'content'   => isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '',
+				'data'      => array_merge($data, array('template_args' => $this->_template_args)),
+				'isEEajax'  => true //special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
+		);
+		// make sure there are no php errors or headers_sent.  Then we can set correct json header.
+		if (null === error_get_last() || ! headers_sent()) {
+			header('Content-Type: application/json; charset=UTF-8');
+		}
+		echo wp_json_encode($json);
+
+		exit();
+	}
+
+
+
+	/**
+	 * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function return_json()
+	{
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$this->_return_json();
+		} else {
+			throw new EE_Error(sprintf(__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'), __FUNCTION__));
+		}
+	}
+
+
+
+	/**
+	 * This provides a way for child hook classes to send along themselves by reference so methods/properties within them can be accessed by EE_Admin_child pages. This is assigned to the $_hook_obj property.
+	 *
+	 * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
+	 * @access   public
+	 */
+	public function set_hook_object(EE_Admin_Hooks $hook_obj)
+	{
+		$this->_hook_obj = $hook_obj;
+	}
+
+
+
+	/**
+	 *        generates  HTML wrapper with Tabbed nav for an admin page
+	 *
+	 * @access public
+	 * @param  boolean $about whether to use the special about page wrapper or default.
+	 * @return void
+	 */
+	public function admin_page_wrapper($about = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_nav_tabs = $this->_get_main_nav_tabs();
+		$this->_template_args['nav_tabs'] = $this->_nav_tabs;
+		$this->_template_args['admin_page_title'] = $this->_admin_page_title;
+		$this->_template_args['before_admin_page_content'] = apply_filters('FHEE_before_admin_page_content' . $this->_current_page . $this->_current_view,
+				isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '');
+		$this->_template_args['after_admin_page_content'] = apply_filters('FHEE_after_admin_page_content' . $this->_current_page . $this->_current_view,
+				isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '');
+		$this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
+		// load settings page wrapper template
+		$template_path = ! defined('DOING_AJAX') ? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php' : EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php';
+		//about page?
+		$template_path = $about ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php' : $template_path;
+		if (defined('DOING_AJAX')) {
+			$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
+			$this->_return_json();
+		} else {
+			EEH_Template::display_template($template_path, $this->_template_args);
+		}
+	}
+
+
+
+	/**
+	 * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
+	 *
+	 * @return string html
+	 */
+	protected function _get_main_nav_tabs()
+	{
+		//let's generate the html using the EEH_Tabbed_Content helper.  We do this here so that it's possible for child classes to add in nav tabs dynamically at the last minute (rather than setting in the page_routes array)
+		return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
+	}
+
+
+
+	/**
+	 *        sort nav tabs
+	 *
+	 * @access public
+	 * @param $a
+	 * @param $b
+	 * @return int
+	 */
+	private function _sort_nav_tabs($a, $b)
+	{
+		if ($a['order'] == $b['order']) {
+			return 0;
+		}
+		return ($a['order'] < $b['order']) ? -1 : 1;
+	}
+
+
+
+	/**
+	 *    generates HTML for the forms used on admin pages
+	 *
+	 * @access protected
+	 * @param    array $input_vars - array of input field details
+	 * @param string   $generator  (options are 'string' or 'array', basically use this to indicate which generator to use)
+	 * @return string
+	 * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
+	 * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
+	 */
+	protected function _generate_admin_form_fields($input_vars = array(), $generator = 'string', $id = false)
+	{
+		$content = $generator == 'string' ? EEH_Form_Fields::get_form_fields($input_vars, $id) : EEH_Form_Fields::get_form_fields_array($input_vars);
+		return $content;
+	}
+
+
+
+	/**
+	 * generates the "Save" and "Save & Close" buttons for edit forms
+	 *
+	 * @access protected
+	 * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save & Close" button.
+	 * @param array            $text     if included, generator will use the given text for the buttons ( array([0] => 'Save', [1] => 'save & close')
+	 * @param array            $actions  if included allows us to set the actions that each button will carry out (i.e. via the "name" value in the button).  We can also use this to just dump default actions by submitting some other value.
+	 * @param bool|string|null $referrer if false then we just do the default action on save and close.  Other wise it will use the $referrer string. IF null, then we don't do ANYTHING on save and close (normal form handling).
+	 */
+	protected function _set_save_buttons($both = true, $text = array(), $actions = array(), $referrer = null)
+	{
+		//make sure $text and $actions are in an array
+		$text = (array)$text;
+		$actions = (array)$actions;
+		$referrer_url = empty($referrer) ? '' : $referrer;
+		$referrer_url = ! $referrer ? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $_SERVER['REQUEST_URI'] . '" />'
+				: '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $referrer . '" />';
+		$button_text = ! empty($text) ? $text : array(__('Save', 'event_espresso'), __('Save and Close', 'event_espresso'));
+		$default_names = array('save', 'save_and_close');
+		//add in a hidden index for the current page (so save and close redirects properly)
+		$this->_template_args['save_buttons'] = $referrer_url;
+		foreach ($button_text as $key => $button) {
+			$ref = $default_names[$key];
+			$id = $this->_current_view . '_' . $ref;
+			$name = ! empty($actions) ? $actions[$key] : $ref;
+			$this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary ' . $ref . '" value="' . $button . '" name="' . $name . '" id="' . $id . '" />';
+			if ( ! $both) {
+				break;
+			}
+		}
+	}
+
+
+
+	/**
+	 * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
+	 *
+	 * @see   $this->_set_add_edit_form_tags() for details on params
+	 * @since 4.6.0
+	 * @param string $route
+	 * @param array  $additional_hidden_fields
+	 */
+	public function set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
+	{
+		$this->_set_add_edit_form_tags($route, $additional_hidden_fields);
+	}
+
+
+
+	/**
+	 * set form open and close tags on add/edit pages.
+	 *
+	 * @access protected
+	 * @param string $route                    the route you want the form to direct to
+	 * @param array  $additional_hidden_fields any additional hidden fields required in the form header
+	 * @return void
+	 */
+	protected function _set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
+	{
+		if (empty($route)) {
+			$user_msg = __('An error occurred. No action was set for this page\'s form.', 'event_espresso');
+			$dev_msg = $user_msg . "\n" . sprintf(__('The $route argument is required for the %s->%s method.', 'event_espresso'), __FUNCTION__, __CLASS__);
+			EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// open form
+		$this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="' . $this->_admin_base_url . '" id="' . $route . '_event_form" >';
+		// add nonce
+		$nonce = wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
+		//		$nonce = wp_nonce_field( $route . '_nonce', '_wpnonce', FALSE, FALSE );
+		$this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
+		// add REQUIRED form action
+		$hidden_fields = array(
+				'action' => array('type' => 'hidden', 'value' => $route),
+		);
+		// merge arrays
+		$hidden_fields = is_array($additional_hidden_fields) ? array_merge($hidden_fields, $additional_hidden_fields) : $hidden_fields;
+		// generate form fields
+		$form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
+		// add fields to form
+		foreach ((array)$form_fields as $field_name => $form_field) {
+			$this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
+		}
+		// close form
+		$this->_template_args['after_admin_page_content'] = '</form>';
+	}
+
+
+
+	/**
+	 * Public Wrapper for _redirect_after_action() method since its
+	 * discovered it would be useful for external code to have access.
+	 *
+	 * @see   EE_Admin_Page::_redirect_after_action() for params.
+	 * @since 4.5.0
+	 */
+	public function redirect_after_action($success = false, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
+	{
+		$this->_redirect_after_action($success, $what, $action_desc, $query_args, $override_overwrite);
+	}
+
+
+
+	/**
+	 *    _redirect_after_action
+	 *
+	 * @param int    $success            - whether success was for two or more records, or just one, or none
+	 * @param string $what               - what the action was performed on
+	 * @param string $action_desc        - what was done ie: updated, deleted, etc
+	 * @param array  $query_args         - an array of query_args to be added to the URL to redirect to after the admin action is completed
+	 * @param BOOL   $override_overwrite by default all EE_Error::success messages are overwritten, this allows you to override this so that they show.
+	 * @access protected
+	 * @return void
+	 */
+	protected function _redirect_after_action($success = 0, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		//class name for actions/filters.
+		$classname = get_class($this);
+		//set redirect url. Note if there is a "page" index in the $query_args then we go with vanilla admin.php route, otherwise we go with whatever is set as the _admin_base_url
+		$redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
+		$notices = EE_Error::get_notices(false);
+		// overwrite default success messages //BUT ONLY if overwrite not overridden
+		if ( ! $override_overwrite || ! empty($notices['errors'])) {
+			EE_Error::overwrite_success();
+		}
+		if ( ! empty($what) && ! empty($action_desc)) {
+			// how many records affected ? more than one record ? or just one ?
+			if ($success > 1 && empty($notices['errors'])) {
+				// set plural msg
+				EE_Error::add_success(
+						sprintf(
+								__('The "%s" have been successfully %s.', 'event_espresso'),
+								$what,
+								$action_desc
+						),
+						__FILE__, __FUNCTION__, __LINE__
+				);
+			} else if ($success == 1 && empty($notices['errors'])) {
+				// set singular msg
+				EE_Error::add_success(
+						sprintf(
+								__('The "%s" has been successfully %s.', 'event_espresso'),
+								$what,
+								$action_desc
+						),
+						__FILE__, __FUNCTION__, __LINE__
+				);
+			}
+		}
+		// check that $query_args isn't something crazy
+		if ( ! is_array($query_args)) {
+			$query_args = array();
+		}
+		/**
+		 * Allow injecting actions before the query_args are modified for possible different
+		 * redirections on save and close actions
+		 *
+		 * @since 4.2.0
+		 * @param array $query_args       The original query_args array coming into the
+		 *                                method.
+		 */
+		do_action('AHEE__' . $classname . '___redirect_after_action__before_redirect_modification_' . $this->_req_action, $query_args);
+		//calculate where we're going (if we have a "save and close" button pushed)
+		if (isset($this->_req_data['save_and_close']) && isset($this->_req_data['save_and_close_referrer'])) {
+			// even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
+			$parsed_url = parse_url($this->_req_data['save_and_close_referrer']);
+			// regenerate query args array from referrer URL
+			parse_str($parsed_url['query'], $query_args);
+			// correct page and action will be in the query args now
+			$redirect_url = admin_url('admin.php');
+		}
+		//merge any default query_args set in _default_route_query_args property
+		if ( ! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
+			$args_to_merge = array();
+			foreach ($this->_default_route_query_args as $query_param => $query_value) {
+				//is there a wp_referer array in our _default_route_query_args property?
+				if ($query_param == 'wp_referer') {
+					$query_value = (array)$query_value;
+					foreach ($query_value as $reference => $value) {
+						if (strpos($reference, 'nonce') !== false) {
+							continue;
+						}
+						//finally we will override any arguments in the referer with
+						//what might be set on the _default_route_query_args array.
+						if (isset($this->_default_route_query_args[$reference])) {
+							$args_to_merge[$reference] = urlencode($this->_default_route_query_args[$reference]);
+						} else {
+							$args_to_merge[$reference] = urlencode($value);
+						}
+					}
+					continue;
+				}
+				$args_to_merge[$query_param] = $query_value;
+			}
+			//now let's merge these arguments but override with what was specifically sent in to the
+			//redirect.
+			$query_args = array_merge($args_to_merge, $query_args);
+		}
+		$this->_process_notices($query_args);
+		// generate redirect url
+		// if redirecting to anything other than the main page, add a nonce
+		if (isset($query_args['action'])) {
+			// manually generate wp_nonce and merge that with the query vars becuz the wp_nonce_url function wrecks havoc on some vars
+			$query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
+		}
+		//we're adding some hooks and filters in here for processing any things just before redirects (example: an admin page has done an insert or update and we want to run something after that).
+		do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
+		$redirect_url = apply_filters('FHEE_redirect_' . $classname . $this->_req_action, self::add_query_args_and_nonce($query_args, $redirect_url), $query_args);
+		// check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
+		if (defined('DOING_AJAX')) {
+			$default_data = array(
+					'close'        => true,
+					'redirect_url' => $redirect_url,
+					'where'        => 'main',
+					'what'         => 'append',
+			);
+			$this->_template_args['success'] = $success;
+			$this->_template_args['data'] = ! empty($this->_template_args['data']) ? array_merge($default_data, $this->_template_args['data']) : $default_data;
+			$this->_return_json();
+		}
+		wp_safe_redirect($redirect_url);
+		exit();
+	}
+
+
+
+	/**
+	 * process any notices before redirecting (or returning ajax request)
+	 * This method sets the $this->_template_args['notices'] attribute;
+	 *
+	 * @param  array $query_args        any query args that need to be used for notice transient ('action')
+	 * @param bool   $skip_route_verify This is typically used when we are processing notices REALLY early and page_routes haven't been defined yet.
+	 * @param bool   $sticky_notices    This is used to flag that regardless of whether this is doing_ajax or not, we still save a transient for the notice.
+	 * @return void
+	 */
+	protected function _process_notices($query_args = array(), $skip_route_verify = false, $sticky_notices = true)
+	{
+		//first let's set individual error properties if doing_ajax and the properties aren't already set.
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$notices = EE_Error::get_notices(false);
+			if (empty($this->_template_args['success'])) {
+				$this->_template_args['success'] = isset($notices['success']) ? $notices['success'] : false;
+			}
+			if (empty($this->_template_args['errors'])) {
+				$this->_template_args['errors'] = isset($notices['errors']) ? $notices['errors'] : false;
+			}
+			if (empty($this->_template_args['attention'])) {
+				$this->_template_args['attention'] = isset($notices['attention']) ? $notices['attention'] : false;
+			}
+		}
+		$this->_template_args['notices'] = EE_Error::get_notices();
+		//IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
+		if ( ! defined('DOING_AJAX') || $sticky_notices) {
+			$route = isset($query_args['action']) ? $query_args['action'] : 'default';
+			$this->_add_transient($route, $this->_template_args['notices'], true, $skip_route_verify);
+		}
+	}
+
+
+
+	/**
+	 * get_action_link_or_button
+	 * returns the button html for adding, editing, or deleting an item (depending on given type)
+	 *
+	 * @param string $action        use this to indicate which action the url is generated with.
+	 * @param string $type          accepted strings must be defined in the $_labels['button'] array(as the key) property.
+	 * @param array  $extra_request if the button requires extra params you can include them in $key=>$value pairs.
+	 * @param string $class         Use this to give the class for the button. Defaults to 'button-primary'
+	 * @param string $base_url      If this is not provided
+	 *                              the _admin_base_url will be used as the default for the button base_url.
+	 *                              Otherwise this value will be used.
+	 * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function get_action_link_or_button(
+			$action,
+			$type = 'add',
+			$extra_request = array(),
+			$class = 'button-primary',
+			$base_url = '',
+			$exclude_nonce = false
+	) {
+		//first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
+		if (empty($base_url) && ! isset($this->_page_routes[$action])) {
+			throw new EE_Error(
+					sprintf(
+							__(
+									'There is no page route for given action for the button.  This action was given: %s',
+									'event_espresso'
+							),
+							$action
+					)
+			);
+		}
+		if ( ! isset($this->_labels['buttons'][$type])) {
+			throw new EE_Error(
+					sprintf(
+							__(
+									'There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.',
+									'event_espresso'
+							),
+							$type
+					)
+			);
+		}
+		//finally check user access for this button.
+		$has_access = $this->check_user_access($action, true);
+		if ( ! $has_access) {
+			return '';
+		}
+		$_base_url = ! $base_url ? $this->_admin_base_url : $base_url;
+		$query_args = array(
+				'action' => $action,
+		);
+		//merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
+		if ( ! empty($extra_request)) {
+			$query_args = array_merge($extra_request, $query_args);
+		}
+		$url = self::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
+		return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][$type], $class);
+	}
+
+
+
+	/**
+	 * _per_page_screen_option
+	 * Utility function for adding in a per_page_option in the screen_options_dropdown.
+	 *
+	 * @return void
+	 */
+	protected function _per_page_screen_option()
+	{
+		$option = 'per_page';
+		$args = array(
+				'label'   => $this->_admin_page_title,
+				'default' => 10,
+				'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
+		);
+		//ONLY add the screen option if the user has access to it.
+		if ($this->check_user_access($this->_current_view, true)) {
+			add_screen_option($option, $args);
+		}
+	}
+
+
+
+	/**
+	 * set_per_page_screen_option
+	 * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
+	 * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than admin_menu.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_per_page_screen_options()
+	{
+		if (isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options'])) {
+			check_admin_referer('screen-options-nonce', 'screenoptionnonce');
+			if ( ! $user = wp_get_current_user()) {
+				return;
+			}
+			$option = $_POST['wp_screen_options']['option'];
+			$value = $_POST['wp_screen_options']['value'];
+			if ($option != sanitize_key($option)) {
+				return;
+			}
+			$map_option = $option;
+			$option = str_replace('-', '_', $option);
+			switch ($map_option) {
+				case $this->_current_page . '_' . $this->_current_view . '_per_page':
+					$value = (int)$value;
+					if ($value < 1 || $value > 999) {
+						return;
+					}
+					break;
+				default:
+					$value = apply_filters('FHEE__EE_Admin_Page___set_per_page_screen_options__value', false, $option, $value);
+					if (false === $value) {
+						return;
+					}
+					break;
+			}
+			update_user_meta($user->ID, $option, $value);
+			wp_safe_redirect(remove_query_arg(array('pagenum', 'apage', 'paged'), wp_get_referer()));
+			exit;
+		}
+	}
+
+
+
+	/**
+	 * This just allows for setting the $_template_args property if it needs to be set outside the object
+	 *
+	 * @param array $data array that will be assigned to template args.
+	 */
+	public function set_template_args($data)
+	{
+		$this->_template_args = array_merge($this->_template_args, (array)$data);
+	}
+
+
+
+	/**
+	 * This makes available the WP transient system for temporarily moving data between routes
+	 *
+	 * @access protected
+	 * @param string $route             the route that should receive the transient
+	 * @param array  $data              the data that gets sent
+	 * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a normal route transient.
+	 * @param bool   $skip_route_verify Used to indicate we want to skip route verification.  This is usually ONLY used when we are adding a transient before page_routes have been defined.
+	 * @return void
+	 */
+	protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
+	{
+		$user_id = get_current_user_id();
+		if ( ! $skip_route_verify) {
+			$this->_verify_route($route);
+		}
+		//now let's set the string for what kind of transient we're setting
+		$transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
+		$data = $notices ? array('notices' => $data) : $data;
+		//is there already a transient for this route?  If there is then let's ADD to that transient
+		$existing = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
+		if ($existing) {
+			$data = array_merge((array)$data, (array)$existing);
+		}
+		if (is_multisite() && is_network_admin()) {
+			set_site_transient($transient, $data, 8);
+		} else {
+			set_transient($transient, $data, 8);
+		}
+	}
+
+
+
+	/**
+	 * this retrieves the temporary transient that has been set for moving data between routes.
+	 *
+	 * @param bool $notices true we get notices transient. False we just return normal route transient
+	 * @return mixed data
+	 */
+	protected function _get_transient($notices = false, $route = false)
+	{
+		$user_id = get_current_user_id();
+		$route = ! $route ? $this->_req_action : $route;
+		$transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
+		$data = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
+		//delete transient after retrieval (just in case it hasn't expired);
+		if (is_multisite() && is_network_admin()) {
+			delete_site_transient($transient);
+		} else {
+			delete_transient($transient);
+		}
+		return $notices && isset($data['notices']) ? $data['notices'] : $data;
+	}
+
+
+
+	/**
+	 * The purpose of this method is just to run garbage collection on any EE transients that might have expired but would not be called later.
+	 * This will be assigned to run on a specific EE Admin page. (place the method in the default route callback on the EE_Admin page you want it run.)
+	 *
+	 * @return void
+	 */
+	protected function _transient_garbage_collection()
+	{
+		global $wpdb;
+		//retrieve all existing transients
+		$query = "SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
+		if ($results = $wpdb->get_results($query)) {
+			foreach ($results as $result) {
+				$transient = str_replace('_transient_', '', $result->option_name);
+				get_transient($transient);
+				if (is_multisite() && is_network_admin()) {
+					get_site_transient($transient);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * get_view
+	 *
+	 * @access public
+	 * @return string content of _view property
+	 */
+	public function get_view()
+	{
+		return $this->_view;
+	}
+
+
+
+	/**
+	 * getter for the protected $_views property
+	 *
+	 * @return array
+	 */
+	public function get_views()
+	{
+		return $this->_views;
+	}
+
+
+
+	/**
+	 * get_current_page
+	 *
+	 * @access public
+	 * @return string _current_page property value
+	 */
+	public function get_current_page()
+	{
+		return $this->_current_page;
+	}
+
+
+
+	/**
+	 * get_current_view
+	 *
+	 * @access public
+	 * @return string _current_view property value
+	 */
+	public function get_current_view()
+	{
+		return $this->_current_view;
+	}
+
+
+
+	/**
+	 * get_current_screen
+	 *
+	 * @access public
+	 * @return object The current WP_Screen object
+	 */
+	public function get_current_screen()
+	{
+		return $this->_current_screen;
+	}
+
+
+
+	/**
+	 * get_current_page_view_url
+	 *
+	 * @access public
+	 * @return string This returns the url for the current_page_view.
+	 */
+	public function get_current_page_view_url()
+	{
+		return $this->_current_page_view_url;
+	}
+
+
+
+	/**
+	 * just returns the _req_data property
+	 *
+	 * @return array
+	 */
+	public function get_request_data()
+	{
+		return $this->_req_data;
+	}
+
+
+
+	/**
+	 * returns the _req_data protected property
+	 *
+	 * @return string
+	 */
+	public function get_req_action()
+	{
+		return $this->_req_action;
+	}
+
+
+
+	/**
+	 * @return bool  value of $_is_caf property
+	 */
+	public function is_caf()
+	{
+		return $this->_is_caf;
+	}
+
+
+
+	/**
+	 * @return mixed
+	 */
+	public function default_espresso_metaboxes()
+	{
+		return $this->_default_espresso_metaboxes;
+	}
+
+
+
+	/**
+	 * @return mixed
+	 */
+	public function admin_base_url()
+	{
+		return $this->_admin_base_url;
+	}
+
+
+
+	/**
+	 * @return mixed
+	 */
+	public function wp_page_slug()
+	{
+		return $this->_wp_page_slug;
+	}
+
+
+
+	/**
+	 * updates  espresso configuration settings
+	 *
+	 * @access    protected
+	 * @param string                   $tab
+	 * @param EE_Config_Base|EE_Config $config
+	 * @param string                   $file file where error occurred
+	 * @param string                   $func function  where error occurred
+	 * @param string                   $line line no where error occurred
+	 * @return boolean
+	 */
+	protected function _update_espresso_configuration($tab, $config, $file = '', $func = '', $line = '')
+	{
+		//remove any options that are NOT going to be saved with the config settings.
+		if (isset($config->core->ee_ueip_optin)) {
+			$config->core->ee_ueip_has_notified = true;
+			// TODO: remove the following two lines and make sure values are migrated from 3.1
+			update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
+			update_option('ee_ueip_has_notified', true);
+		}
+		// and save it (note we're also doing the network save here)
+		$net_saved = is_main_site() ? EE_Network_Config::instance()->update_config(false, false) : true;
+		$config_saved = EE_Config::instance()->update_espresso_config(false, false);
+		if ($config_saved && $net_saved) {
+			EE_Error::add_success(sprintf(__('"%s" have been successfully updated.', 'event_espresso'), $tab));
+			return true;
+		} else {
+			EE_Error::add_error(sprintf(__('The "%s" were not updated.', 'event_espresso'), $tab), $file, $func, $line);
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
+	 *
+	 * @return array
+	 */
+	public function get_yes_no_values()
+	{
+		return $this->_yes_no_values;
+	}
+
+
+
+	protected function _get_dir()
+	{
+		$reflector = new ReflectionClass(get_class($this));
+		return dirname($reflector->getFileName());
+	}
+
+
+
+	/**
+	 * A helper for getting a "next link".
+	 *
+	 * @param string $url   The url to link to
+	 * @param string $class The class to use.
+	 * @return string
+	 */
+	protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
+	{
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
+	}
+
+
+
+	/**
+	 * A helper for getting a "previous link".
+	 *
+	 * @param string $url   The url to link to
+	 * @param string $class The class to use.
+	 * @return string
+	 */
+	protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
+	{
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
+	}
+
+
+
+
+
+
+
+	//below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
+	/**
+	 * This processes an request to resend a registration and assumes we have a _REG_ID for doing so. So if the caller knows that the _REG_ID isn't in the req_data array but CAN obtain it, the caller should ADD the _REG_ID to the _req_data
+	 * array.
+	 *
+	 * @return bool success/fail
+	 */
+	protected function _process_resend_registration()
+	{
+		$this->_template_args['success'] = EED_Messages::process_resend($this->_req_data);
+		do_action('AHEE__EE_Admin_Page___process_resend_registration', $this->_template_args['success'], $this->_req_data);
+		return $this->_template_args['success'];
+	}
+
+
+
+	/**
+	 * This automatically processes any payment message notifications when manual payment has been applied.
+	 *
+	 * @access protected
+	 * @param \EE_Payment $payment
+	 * @return bool success/fail
+	 */
+	protected function _process_payment_notification(EE_Payment $payment)
+	{
+		add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
+		do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
+		$this->_template_args['success'] = apply_filters('FHEE__EE_Admin_Page___process_admin_payment_notification__success', false, $payment);
+		return $this->_template_args['success'];
+	}
 
 
 }