eventespresso / event-espresso-core

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

Indentation +243 added lines, -243 removed lines

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

Spacing +10 added lines, -10 removed lines

@@ -34,9 +34,9 @@ 
     public function __construct($routing = true)
     {
         parent::__construct($routing);
-        define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/templates/');
-        define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/assets/');
-        define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'transactions/assets/');
+        define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND.'transactions/templates/');
+        define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND.'transactions/assets/');
+        define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'transactions/assets/');
     }
 
 
@@ -48,7 +48,7 @@ 
      */
     protected function _extend_page_config()
     {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'transactions';
+        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND.'transactions';
 
         $new_page_routes = array(
             'reports' => array(
@@ -89,7 +89,7 @@ 
     {
         wp_register_script(
             'ee-txn-reports-js',
-            TXN_CAF_ASSETS_URL . 'ee-transaction-admin-reports.js',
+            TXN_CAF_ASSETS_URL.'ee-transaction-admin-reports.js',
             array('google-charts'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -119,7 +119,7 @@ 
      */
     protected function _transaction_reports()
     {
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+        $template_path = EE_ADMIN_TEMPLATE.'admin_reports.template.php';
         $this->_admin_page_title = __('Transactions', 'event_espresso');
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
             $template_path,
@@ -162,7 +162,7 @@ 
             }
 
             // setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+            $beginning_date = new DateTime('now'.$period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $ending_date = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $subtitle = sprintf(
                 wp_strip_all_tags(
@@ -185,7 +185,7 @@ 
                 wp_strip_all_tags(
                     __('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso')
                 ),
-                '<h2>' . $report_title . '</h2><p>',
+                '<h2>'.$report_title.'</h2><p>',
                 '</p>'
             ),
         );
@@ -228,7 +228,7 @@ 
             }
 
             // setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+            $beginning_date = new DateTime('now'.$period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $ending_date = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $subtitle = sprintf(
                 wp_strip_all_tags(
@@ -251,7 +251,7 @@ 
                 wp_strip_all_tags(
                     __('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso')
                 ),
-                '<h2>' . $report_title . '</h2><p>',
+                '<h2>'.$report_title.'</h2><p>',
                 '</p>'
             ),
         );

core/admin/EE_Admin_Page_CPT_Init.core.php

Indentation +37 added lines, -37 removed lines

@@ -14,45 +14,45 @@
 {
 
 
-    public function do_initial_loads()
-    {
-        // we want to use the corresponding admin page object (but not route it!).  To do this we just set _routing to false.  That way this page object is being loaded on all pages to make sure we hook into admin properly.  But note... we are ONLY doing this if the given page is NOT pages we WANT to load ;)
-        // This is important because we have hooks that help redirect custom post type saves
-        if (! isset($_REQUEST['page'])
-            || (isset($_REQUEST['page'])
-                && $_REQUEST['page']
-                   != $this->_menu_map->menu_slug)) {
-            $this->_routing = false;
-            $this->_initialize_admin_page();
-        } else {
-            // normal init loads
-            $this->_initialize_admin_page();
-            // added for 4.1 to completely disable autosave for our pages. This can be removed once we fully enable autosave functionality
-            remove_filter('wp_print_scripts', 'wp_just_in_time_script_localization');
-            add_filter('wp_print_scripts', array($this, 'wp_just_in_time_script_localization'), 100);
-            // end removal of autosave functionality.
-        }
-    }
+	public function do_initial_loads()
+	{
+		// we want to use the corresponding admin page object (but not route it!).  To do this we just set _routing to false.  That way this page object is being loaded on all pages to make sure we hook into admin properly.  But note... we are ONLY doing this if the given page is NOT pages we WANT to load ;)
+		// This is important because we have hooks that help redirect custom post type saves
+		if (! isset($_REQUEST['page'])
+			|| (isset($_REQUEST['page'])
+				&& $_REQUEST['page']
+				   != $this->_menu_map->menu_slug)) {
+			$this->_routing = false;
+			$this->_initialize_admin_page();
+		} else {
+			// normal init loads
+			$this->_initialize_admin_page();
+			// added for 4.1 to completely disable autosave for our pages. This can be removed once we fully enable autosave functionality
+			remove_filter('wp_print_scripts', 'wp_just_in_time_script_localization');
+			add_filter('wp_print_scripts', array($this, 'wp_just_in_time_script_localization'), 100);
+			// end removal of autosave functionality.
+		}
+	}
 
 
-    public function wp_just_in_time_script_localization()
-    {
-        wp_localize_script(
-            'autosave',
-            'autosaveL10n',
-            array(
-                'autosaveInterval' => 172800,
-                'savingText'       => wp_strip_all_tags(__('Saving Draft…', 'event_espresso')),
-                'saveAlert'        => wp_strip_all_tags(
-                    __('The changes you made will be lost if you navigate away from this page.', 'event_espresso')
-                ),
-            )
-        );
-    }
+	public function wp_just_in_time_script_localization()
+	{
+		wp_localize_script(
+			'autosave',
+			'autosaveL10n',
+			array(
+				'autosaveInterval' => 172800,
+				'savingText'       => wp_strip_all_tags(__('Saving Draft…', 'event_espresso')),
+				'saveAlert'        => wp_strip_all_tags(
+					__('The changes you made will be lost if you navigate away from this page.', 'event_espresso')
+				),
+			)
+		);
+	}
 
 
-    public function adjust_post_lock_window($interval)
-    {
-        return 172800;
-    }
+	public function adjust_post_lock_window($interval)
+	{
+		return 172800;
+	}
 }

admin_pages/maintenance/Maintenance_Admin_Page.core.php

Indentation +882 added lines, -882 removed lines

@@ -17,886 +17,886 @@
 {
 
 
-    /**
-     * @var EE_Form_Section_Proper
-     */
-    protected $datetime_fix_offset_form;
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug = EE_MAINTENANCE_PG_SLUG;
-        $this->page_label = EE_MAINTENANCE_LABEL;
-        $this->_admin_base_url = EE_MAINTENANCE_ADMIN_URL;
-        $this->_admin_base_path = EE_MAINTENANCE_ADMIN;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_migration_step', array($this, 'migration_step'));
-        add_action('wp_ajax_add_error_to_migrations_ran', array($this, 'add_error_to_migrations_ran'));
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = EE_MAINTENANCE_LABEL;
-        $this->_labels = array(
-            'buttons' => array(
-                'reset_reservations' => esc_html__('Reset Ticket and Datetime Reserved Counts', 'event_espresso'),
-                'reset_capabilities' => esc_html__('Reset Event Espresso Capabilities', 'event_espresso'),
-            ),
-        );
-    }
-
-
-    protected function _set_page_routes()
-    {
-        $this->_page_routes = array(
-            'default'                             => array(
-                'func'       => '_maintenance',
-                'capability' => 'manage_options',
-            ),
-            'change_maintenance_level'            => array(
-                'func'       => '_change_maintenance_level',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'system_status'                       => array(
-                'func'       => '_system_status',
-                'capability' => 'manage_options',
-            ),
-            'download_system_status'              => array(
-                'func'       => '_download_system_status',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'send_migration_crash_report'         => array(
-                'func'       => '_send_migration_crash_report',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'confirm_migration_crash_report_sent' => array(
-                'func'       => '_confirm_migration_crash_report_sent',
-                'capability' => 'manage_options',
-            ),
-            'data_reset'                          => array(
-                'func'       => '_data_reset_and_delete',
-                'capability' => 'manage_options',
-            ),
-            'reset_db'                            => array(
-                'func'       => '_reset_db',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-                'args'       => array('nuke_old_ee4_data' => true),
-            ),
-            'start_with_fresh_ee4_db'             => array(
-                'func'       => '_reset_db',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-                'args'       => array('nuke_old_ee4_data' => false),
-            ),
-            'delete_db'                           => array(
-                'func'       => '_delete_db',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'rerun_migration_from_ee3'            => array(
-                'func'       => '_rerun_migration_from_ee3',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'reset_reservations'                  => array(
-                'func'       => '_reset_reservations',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'reset_capabilities'                  => array(
-                'func'       => '_reset_capabilities',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'reattempt_migration'                 => array(
-                'func'       => '_reattempt_migration',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'datetime_tools'                      => array(
-                'func'       => '_datetime_tools',
-                'capability' => 'manage_options',
-            ),
-            'run_datetime_offset_fix'             => array(
-                'func'               => '_apply_datetime_offset',
-                'noheader'           => true,
-                'headers_sent_route' => 'datetime_tools',
-                'capability'         => 'manage_options',
-            ),
-        );
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'        => array(
-                'nav'           => array(
-                    'label' => esc_html__('Maintenance', 'event_espresso'),
-                    'order' => 10,
-                ),
-                'require_nonce' => false,
-            ),
-            'data_reset'     => array(
-                'nav'           => array(
-                    'label' => esc_html__('Reset/Delete Data', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'require_nonce' => false,
-            ),
-            'datetime_tools' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Datetime Utilities', 'event_espresso'),
-                    'order' => 25,
-                ),
-                'require_nonce' => false,
-            ),
-            'system_status'  => array(
-                'nav'           => array(
-                    'label' => esc_html__("System Information", "event_espresso"),
-                    'order' => 30,
-                ),
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-    /**
-     * default maintenance page. If we're in maintenance mode level 2, then we need to show
-     * the migration scripts and all that UI.
-     */
-    public function _maintenance()
-    {
-        // it all depends if we're in maintenance model level 1 (frontend-only) or
-        // level 2 (everything except maintenance page)
-        try {
-            // get the current maintenance level and check if
-            // we are removed
-            $mm = EE_Maintenance_Mode::instance()->level();
-            $placed_in_mm = EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-            if ($mm == EE_Maintenance_Mode::level_2_complete_maintenance && ! $placed_in_mm) {
-                // we just took the site out of maintenance mode, so notify the user.
-                // unfortunately this message appears to be echoed on the NEXT page load...
-                // oh well, we should really be checking for this on addon deactivation anyways
-                EE_Error::add_attention(
-                    __(
-                        'Site taken out of maintenance mode because no data migration scripts are required',
-                        'event_espresso'
-                    )
-                );
-                $this->_process_notices(array('page' => 'espresso_maintenance_settings'), false);
-            }
-            // in case an exception is thrown while trying to handle migrations
-            switch (EE_Maintenance_Mode::instance()->level()) {
-                case EE_Maintenance_Mode::level_0_not_in_maintenance:
-                case EE_Maintenance_Mode::level_1_frontend_only_maintenance:
-                    $show_maintenance_switch = true;
-                    $show_backup_db_text = false;
-                    $show_migration_progress = false;
-                    $script_names = array();
-                    $addons_should_be_upgraded_first = false;
-                    break;
-                case EE_Maintenance_Mode::level_2_complete_maintenance:
-                    $show_maintenance_switch = false;
-                    $show_migration_progress = true;
-                    if (isset($this->_req_data['continue_migration'])) {
-                        $show_backup_db_text = false;
-                    } else {
-                        $show_backup_db_text = true;
-                    }
-                    $scripts_needing_to_run = EE_Data_Migration_Manager::instance()
-                                                                       ->check_for_applicable_data_migration_scripts();
-                    $addons_should_be_upgraded_first = EE_Data_Migration_Manager::instance()->addons_need_updating();
-                    $script_names = array();
-                    $current_script = null;
-                    foreach ($scripts_needing_to_run as $script) {
-                        if ($script instanceof EE_Data_Migration_Script_Base) {
-                            if (! $current_script) {
-                                $current_script = $script;
-                                $current_script->migration_page_hooks();
-                            }
-                            $script_names[] = $script->pretty_name();
-                        }
-                    }
-                    break;
-            }
-            $most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
-            $exception_thrown = false;
-        } catch (EE_Error $e) {
-            EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
-            // now, just so we can display the page correctly, make a error migration script stage object
-            // and also put the error on it. It only persists for the duration of this request
-            $most_recent_migration = new EE_DMS_Unknown_1_0_0();
-            $most_recent_migration->add_error($e->getMessage());
-            $exception_thrown = true;
-        }
-        $current_db_state = EE_Data_Migration_Manager::instance()->ensure_current_database_state_is_set();
-        $current_db_state = str_replace('.decaf', '', $current_db_state);
-        if ($exception_thrown
-            || ($most_recent_migration
-                && $most_recent_migration instanceof EE_Data_Migration_Script_Base
-                && $most_recent_migration->is_broken()
-            )
-        ) {
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php';
-            $this->_template_args['support_url'] = 'http://eventespresso.com/support/forums/';
-            $this->_template_args['next_url'] = EEH_URL::add_query_args_and_nonce(
-                array(
-                    'action'  => 'confirm_migration_crash_report_sent',
-                    'success' => '0',
-                ),
-                EE_MAINTENANCE_ADMIN_URL
-            );
-        } elseif ($addons_should_be_upgraded_first) {
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php';
-        } else {
-            if ($most_recent_migration
-                && $most_recent_migration instanceof EE_Data_Migration_Script_Base
-                && $most_recent_migration->can_continue()
-            ) {
-                $show_backup_db_text = false;
-                $show_continue_current_migration_script = true;
-                $show_most_recent_migration = true;
-            } elseif (isset($this->_req_data['continue_migration'])) {
-                $show_most_recent_migration = true;
-                $show_continue_current_migration_script = false;
-            } else {
-                $show_most_recent_migration = false;
-                $show_continue_current_migration_script = false;
-            }
-            if (isset($current_script)) {
-                $migrates_to = $current_script->migrates_to_version();
-                $plugin_slug = $migrates_to['slug'];
-                $new_version = $migrates_to['version'];
-                $this->_template_args = array_merge(
-                    $this->_template_args,
-                    array(
-                        'current_db_state' => sprintf(
-                            __("EE%s (%s)", "event_espresso"),
-                            isset($current_db_state[ $plugin_slug ]) ? $current_db_state[ $plugin_slug ] : 3,
-                            $plugin_slug
-                        ),
-                        'next_db_state'    => isset($current_script) ? sprintf(
-                            __("EE%s (%s)", 'event_espresso'),
-                            $new_version,
-                            $plugin_slug
-                        ) : null,
-                    )
-                );
-            } else {
-                $this->_template_args['current_db_state'] = null;
-                $this->_template_args['next_db_state'] = null;
-            }
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php';
-            $this->_template_args = array_merge(
-                $this->_template_args,
-                array(
-                    'show_most_recent_migration'             => $show_most_recent_migration,
-                    // flag for showing the most recent migration's status and/or errors
-                    'show_migration_progress'                => $show_migration_progress,
-                    // flag for showing the option to run migrations and see their progress
-                    'show_backup_db_text'                    => $show_backup_db_text,
-                    // flag for showing text telling the user to backup their DB
-                    'show_maintenance_switch'                => $show_maintenance_switch,
-                    // flag for showing the option to change maintenance mode between levels 0 and 1
-                    'script_names'                           => $script_names,
-                    // array of names of scripts that have run
-                    'show_continue_current_migration_script' => $show_continue_current_migration_script,
-                    // flag to change wording to indicating that we're only CONTINUING a migration script (somehow it got interrupted0
-                    'reset_db_page_link'                     => EE_Admin_Page::add_query_args_and_nonce(
-                        array('action' => 'reset_db'),
-                        EE_MAINTENANCE_ADMIN_URL
-                    ),
-                    'data_reset_page'                        => EE_Admin_Page::add_query_args_and_nonce(
-                        array('action' => 'data_reset'),
-                        EE_MAINTENANCE_ADMIN_URL
-                    ),
-                    'update_migration_script_page_link'      => EE_Admin_Page::add_query_args_and_nonce(
-                        array('action' => 'change_maintenance_level'),
-                        EE_MAINTENANCE_ADMIN_URL
-                    ),
-                    'ultimate_db_state'                      => sprintf(
-                        __("EE%s", 'event_espresso'),
-                        espresso_version()
-                    ),
-                )
-            );
-            // make sure we have the form fields helper available. It usually is, but sometimes it isn't
-        }
-        $this->_template_args['most_recent_migration'] = $most_recent_migration;// the actual most recently ran migration
-        // now render the migration options part, and put it in a variable
-        $migration_options_template_file = apply_filters(
-            'FHEE__ee_migration_page__migration_options_template',
-            EE_MAINTENANCE_TEMPLATE_PATH . 'migration_options_from_ee4.template.php'
-        );
-        $migration_options_html = EEH_Template::display_template(
-            $migration_options_template_file,
-            $this->_template_args,
-            true
-        );
-        $this->_template_args['migration_options_html'] = $migration_options_html;
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $this->_template_path,
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * returns JSON and executes another step of the currently-executing data migration (called via ajax)
-     */
-    public function migration_step()
-    {
-        $this->_template_args['data'] = EE_Data_Migration_Manager::instance()->response_to_migration_ajax_request();
-        $this->_return_json();
-    }
-
-
-    /**
-     * Can be used by js when it notices a response with HTML in it in order
-     * to log the malformed response
-     */
-    public function add_error_to_migrations_ran()
-    {
-        EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($this->_req_data['message']);
-        $this->_template_args['data'] = array('ok' => true);
-        $this->_return_json();
-    }
-
-
-    /**
-     * changes the maintenance level, provided there are still no migration scripts that should run
-     */
-    public function _change_maintenance_level()
-    {
-        $new_level = absint($this->_req_data['maintenance_mode_level']);
-        if (! EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
-            EE_Maintenance_Mode::instance()->set_maintenance_level($new_level);
-            $success = true;
-        } else {
-            EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-            $success = false;
-        }
-        $this->_redirect_after_action($success, 'Maintenance Mode', esc_html__("Updated", "event_espresso"));
-    }
-
-
-    /**
-     * a tab with options for resetting and/or deleting EE data
-     *
-     * @throws \EE_Error
-     * @throws \DomainException
-     */
-    public function _data_reset_and_delete()
-    {
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php';
-        $this->_template_args['reset_reservations_button'] = $this->get_action_link_or_button(
-            'reset_reservations',
-            'reset_reservations',
-            array(),
-            'button button-primary ee-confirm',
-            '',
-            false
-        );
-        $this->_template_args['reset_capabilities_button'] = $this->get_action_link_or_button(
-            'reset_capabilities',
-            'reset_capabilities',
-            array(),
-            'button button-primary ee-confirm',
-            '',
-            false
-        );
-        $this->_template_args['delete_db_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'delete_db'),
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['reset_db_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'reset_db'),
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $this->_template_path,
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    protected function _reset_reservations()
-    {
-        if (\EED_Ticket_Sales_Monitor::reset_reservation_counts()) {
-            EE_Error::add_success(
-                __(
-                    'Ticket and datetime reserved counts have been successfully reset.',
-                    'event_espresso'
-                )
-            );
-        } else {
-            EE_Error::add_success(
-                __(
-                    'Ticket and datetime reserved counts were correct and did not need resetting.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->_redirect_after_action(true, '', '', array('action' => 'data_reset'), true);
-    }
-
-
-    protected function _reset_capabilities()
-    {
-        EE_Registry::instance()->CAP->init_caps(true);
-        EE_Error::add_success(
-            __(
-                'Default Event Espresso capabilities have been restored for all current roles.',
-                'event_espresso'
-            )
-        );
-        $this->_redirect_after_action(false, '', '', array('action' => 'data_reset'), true);
-    }
-
-
-    /**
-     * resets the DMSs so we can attempt to continue migrating after a fatal error
-     * (only a good idea when someone has somehow tried ot fix whatever caused
-     * the fatal error in teh first place)
-     */
-    protected function _reattempt_migration()
-    {
-        EE_Data_Migration_Manager::instance()->reattempt();
-        $this->_redirect_after_action(false, '', '', array('action' => 'default'), true);
-    }
-
-
-    /**
-     * shows the big ol' System Information page
-     */
-    public function _system_status()
-    {
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php';
-        $this->_template_args['system_stati'] = EEM_System_Status::instance()->get_system_stati();
-        $this->_template_args['download_system_status_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'download_system_status',
-            ),
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $this->_template_path,
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-    /**
-     * Downloads an HTML file of the system status that can be easily stored or emailed
-     */
-    public function _download_system_status()
-    {
-        $status_info = EEM_System_Status::instance()->get_system_stati();
-        header('Content-Disposition: attachment');
-        header("Content-Disposition: attachment; filename=system_status_" . sanitize_key(site_url()) . ".html");
-        echo "<style>table{border:1px solid darkgrey;}td{vertical-align:top}</style>";
-        echo "<h1>System Information for " . site_url() . "</h1>";
-        echo EEH_Template::layout_array_as_table($status_info);
-        die;
-    }
-
-
-    public function _send_migration_crash_report()
-    {
-        $from = $this->_req_data['from'];
-        $from_name = $this->_req_data['from_name'];
-        $body = $this->_req_data['body'];
-        try {
-            $success = wp_mail(
-                EE_SUPPORT_EMAIL,
-                'Migration Crash Report',
-                $body . "/r/n<br>" . print_r(EEM_System_Status::instance()->get_system_stati(), true),
-                array(
-                    "from:$from_name<$from>",
-                )
-            );
-        } catch (Exception $e) {
-            $success = false;
-        }
-        $this->_redirect_after_action(
-            $success,
-            esc_html__("Migration Crash Report", "event_espresso"),
-            esc_html__("sent", "event_espresso"),
-            array('success' => $success, 'action' => 'confirm_migration_crash_report_sent')
-        );
-    }
-
-
-    public function _confirm_migration_crash_report_sent()
-    {
-        try {
-            $most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
-        } catch (EE_Error $e) {
-            EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
-            // now, just so we can display the page correctly, make a error migration script stage object
-            // and also put the error on it. It only persists for the duration of this request
-            $most_recent_migration = new EE_DMS_Unknown_1_0_0();
-            $most_recent_migration->add_error($e->getMessage());
-        }
-        $success = $this->_req_data['success'] == '1' ? true : false;
-        $this->_template_args['success'] = $success;
-        $this->_template_args['most_recent_migration'] = $most_recent_migration;
-        $this->_template_args['reset_db_action_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'reset_db'),
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['reset_db_page_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'data_reset'),
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['reattempt_action_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'reattempt_migration'),
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $this->_template_path,
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Resets the entire EE4 database.
-     * Currently basically only sets up ee4 database for a fresh install- doesn't
-     * actually clean out the old wp options, or cpts (although does erase old ee table data)
-     *
-     * @param boolean $nuke_old_ee4_data controls whether or not we
-     *                                   destroy the old ee4 data, or just try initializing ee4 default data
-     */
-    public function _reset_db($nuke_old_ee4_data = true)
-    {
-        EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
-        if ($nuke_old_ee4_data) {
-            EEH_Activation::delete_all_espresso_cpt_data();
-            EEH_Activation::delete_all_espresso_tables_and_data(false);
-            EEH_Activation::remove_cron_tasks();
-        }
-        // make sure when we reset the registry's config that it
-        // switches to using the new singleton
-        EE_Registry::instance()->CFG = EE_Registry::instance()->CFG->reset(true);
-        EE_System::instance()->initialize_db_if_no_migrations_required(true);
-        EE_System::instance()->redirect_to_about_ee();
-    }
-
-
-    /**
-     * Deletes ALL EE tables, Records, and Options from the database.
-     */
-    public function _delete_db()
-    {
-        EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
-        EEH_Activation::delete_all_espresso_cpt_data();
-        EEH_Activation::delete_all_espresso_tables_and_data();
-        EEH_Activation::remove_cron_tasks();
-        EEH_Activation::deactivate_event_espresso();
-        wp_safe_redirect(admin_url('plugins.php'));
-        exit;
-    }
-
-
-    /**
-     * sets up EE4 to rerun the migrations from ee3 to ee4
-     */
-    public function _rerun_migration_from_ee3()
-    {
-        EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
-        EEH_Activation::delete_all_espresso_cpt_data();
-        EEH_Activation::delete_all_espresso_tables_and_data(false);
-        // set the db state to something that will require migrations
-        update_option(EE_Data_Migration_Manager::current_database_state, '3.1.36.0');
-        EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_2_complete_maintenance);
-        $this->_redirect_after_action(
-            true,
-            esc_html__("Database", 'event_espresso'),
-            esc_html__("reset", 'event_espresso')
-        );
-    }
-
-
-    // none of the below group are currently used for Gateway Settings
-    protected function _add_screen_options()
-    {
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles()
-    {
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script(
-            'ee-maintenance',
-            EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.js',
-            array('jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_style(
-            'espresso_maintenance',
-            EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_maintenance');
-        // localize script stuff
-        wp_localize_script(
-            'ee-maintenance',
-            'ee_maintenance',
-            array(
-                'migrating'                        => wp_strip_all_tags(__("Updating Database...", "event_espresso")),
-                'next'                             => wp_strip_all_tags(__("Next", "event_espresso")),
-                'fatal_error'                      => wp_strip_all_tags(__("A Fatal Error Has Occurred", "event_espresso")),
-                'click_next_when_ready'            => wp_strip_all_tags(
-                    __(
-                        "The current Database Update has ended. Click 'next' when ready to proceed",
-                        "event_espresso"
-                    )
-                ),
-                'status_no_more_migration_scripts' => EE_Data_Migration_Manager::status_no_more_migration_scripts,
-                'status_fatal_error'               => EE_Data_Migration_Manager::status_fatal_error,
-                'status_completed'                 => EE_Data_Migration_Manager::status_completed,
-                'confirm'                          => wp_strip_all_tags(
-                    __(
-                        'Are you sure you want to do this? It CANNOT be undone!',
-                        'event_espresso'
-                    )
-                ),
-                'confirm_skip_migration'           => wp_strip_all_tags(
-                    __(
-                        'You have chosen to NOT migrate your existing data. Are you sure you want to continue?',
-                        'event_espresso'
-                    )
-                ),
-            )
-        );
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-    }
-
-
-    /**
-     * Enqueue scripts and styles for the datetime tools page.
-     */
-    public function load_scripts_styles_datetime_tools()
-    {
-        EE_Datepicker_Input::enqueue_styles_and_scripts();
-    }
-
-
-    protected function _datetime_tools()
-    {
-        $form_action = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action'        => 'run_datetime_offset_fix',
-                'return_action' => $this->_req_action,
-            ),
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $form = $this->_get_datetime_offset_fix_form();
-        $this->_admin_page_title = esc_html__('Datetime Utilities', 'event_espresso');
-        $this->_template_args['admin_page_content'] = $form->form_open($form_action, 'post')
-                                                      . $form->get_html_and_js()
-                                                      . $form->form_close();
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    protected function _get_datetime_offset_fix_form()
-    {
-        if (! $this->datetime_fix_offset_form instanceof EE_Form_Section_Proper) {
-            $this->datetime_fix_offset_form = new EE_Form_Section_Proper(
-                array(
-                    'name'            => 'datetime_offset_fix_option',
-                    'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                    'subsections'     => array(
-                        'title'                  => new EE_Form_Section_HTML(
-                            EEH_HTML::h2(
-                                esc_html__('Datetime Offset Tool', 'event_espresso')
-                            )
-                        ),
-                        'explanation'            => new EE_Form_Section_HTML(
-                            EEH_HTML::p(
-                                esc_html__(
-                                    'Use this tool to automatically apply the provided offset to all Event Espresso records in your database that involve dates and times.',
-                                    'event_espresso'
-                                )
-                            )
-                            . EEH_HTML::p(
-                                esc_html__(
-                                    'Note: If you enter 1.25, that will result in the offset of 1 hour 15 minutes being applied.  Decimals represent the fraction of hours, not minutes.',
-                                    'event_espresso'
-                                )
-                            )
-                        ),
-                        'offset_input'           => new EE_Float_Input(
-                            array(
-                                'html_name'       => 'offset_for_datetimes',
-                                'html_label_text' => esc_html__(
-                                    'Offset to apply (in hours):',
-                                    'event_espresso'
-                                ),
-                                'min_value'       => '-12',
-                                'max_value'       => '14',
-                                'step_value'      => '.25',
-                                'default'         => DatetimeOffsetFix::getOffset(),
-                            )
-                        ),
-                        'date_range_explanation' => new EE_Form_Section_HTML(
-                            EEH_HTML::p(
-                                esc_html__(
-                                    'Leave the following fields blank if you want the offset to be applied to all dates. If however, you want to just apply the offset to a specific range of dates you can restrict the offset application using these fields.',
-                                    'event_espresso'
-                                )
-                            )
-                            . EEH_HTML::p(
-                                EEH_HTML::strong(
-                                    sprintf(
-                                        esc_html__(
-                                            'Note: please enter the dates in UTC (You can use %1$sthis online tool%2$s to assist with conversions).',
-                                            'event_espresso'
-                                        ),
-                                        '<a href="https://www.timeanddate.com/worldclock/converter.html">',
-                                        '</a>'
-                                    )
-                                )
-                            )
-                        ),
-                        'date_range_start_date'  => new EE_Datepicker_Input(
-                            array(
-                                'html_name'       => 'offset_date_start_range',
-                                'html_label_text' => esc_html__(
-                                    'Start Date for dates the offset applied to:',
-                                    'event_espresso'
-                                ),
-                            )
-                        ),
-                        'date_range_end_date'    => new EE_Datepicker_Input(
-                            array(
-                                'html_name'       => 'offset_date_end_range',
-                                'html_label_text' => esc_html__(
-                                    'End Date for dates the offset is applied to:',
-                                    'event_espresso'
-                                ),
-                            )
-                        ),
-                        'submit'                 => new EE_Submit_Input(
-                            array(
-                                'html_label_text' => '',
-                                'default'         => esc_html__('Apply Offset', 'event_espresso'),
-                            )
-                        ),
-                    ),
-                )
-            );
-        }
-        return $this->datetime_fix_offset_form;
-    }
-
-
-    /**
-     * Callback for the run_datetime_offset_fix route.
-     *
-     * @throws EE_Error
-     */
-    protected function _apply_datetime_offset()
-    {
-        if ($_SERVER['REQUEST_METHOD'] === 'POST') {
-            $form = $this->_get_datetime_offset_fix_form();
-            $form->receive_form_submission($this->_req_data);
-            if ($form->is_valid()) {
-                // save offset data so batch processor can get it.
-                DatetimeOffsetFix::updateOffset($form->get_input_value('offset_input'));
-                $utc_timezone = new DateTimeZone('UTC');
-                $date_range_start_date = DateTime::createFromFormat(
-                    'm/d/Y H:i:s',
-                    $form->get_input_value('date_range_start_date') . ' 00:00:00',
-                    $utc_timezone
-                );
-                $date_range_end_date = DateTime::createFromFormat(
-                    'm/d/Y H:i:s',
-                    $form->get_input_value('date_range_end_date') . ' 23:59:59',
-                    $utc_timezone
-                );
-                if ($date_range_start_date instanceof DateTime) {
-                    DatetimeOffsetFix::updateStartDateRange(DbSafeDateTime::createFromDateTime($date_range_start_date));
-                }
-                if ($date_range_end_date instanceof DateTime) {
-                    DatetimeOffsetFix::updateEndDateRange(DbSafeDateTime::createFromDateTime($date_range_end_date));
-                }
-                // redirect to batch tool
-                wp_redirect(
-                    EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'page'        => 'espresso_batch',
-                            'batch'       => 'job',
-                            'label'       => esc_html__('Applying Offset', 'event_espresso'),
-                            'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\DatetimeOffsetFix'),
-                            'return_url'  => urlencode(
-                                add_query_arg(
-                                    array(
-                                        'action' => 'datetime_tools',
-                                    ),
-                                    EEH_URL::current_url_without_query_paramaters(
-                                        array(
-                                            'return_action',
-                                            'run_datetime_offset_fix_nonce',
-                                            'return',
-                                            'datetime_tools_nonce',
-                                        )
-                                    )
-                                )
-                            ),
-                        ),
-                        admin_url()
-                    )
-                );
-                exit;
-            }
-        }
-    }
+	/**
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $datetime_fix_offset_form;
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug = EE_MAINTENANCE_PG_SLUG;
+		$this->page_label = EE_MAINTENANCE_LABEL;
+		$this->_admin_base_url = EE_MAINTENANCE_ADMIN_URL;
+		$this->_admin_base_path = EE_MAINTENANCE_ADMIN;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_migration_step', array($this, 'migration_step'));
+		add_action('wp_ajax_add_error_to_migrations_ran', array($this, 'add_error_to_migrations_ran'));
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = EE_MAINTENANCE_LABEL;
+		$this->_labels = array(
+			'buttons' => array(
+				'reset_reservations' => esc_html__('Reset Ticket and Datetime Reserved Counts', 'event_espresso'),
+				'reset_capabilities' => esc_html__('Reset Event Espresso Capabilities', 'event_espresso'),
+			),
+		);
+	}
+
+
+	protected function _set_page_routes()
+	{
+		$this->_page_routes = array(
+			'default'                             => array(
+				'func'       => '_maintenance',
+				'capability' => 'manage_options',
+			),
+			'change_maintenance_level'            => array(
+				'func'       => '_change_maintenance_level',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'system_status'                       => array(
+				'func'       => '_system_status',
+				'capability' => 'manage_options',
+			),
+			'download_system_status'              => array(
+				'func'       => '_download_system_status',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'send_migration_crash_report'         => array(
+				'func'       => '_send_migration_crash_report',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'confirm_migration_crash_report_sent' => array(
+				'func'       => '_confirm_migration_crash_report_sent',
+				'capability' => 'manage_options',
+			),
+			'data_reset'                          => array(
+				'func'       => '_data_reset_and_delete',
+				'capability' => 'manage_options',
+			),
+			'reset_db'                            => array(
+				'func'       => '_reset_db',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+				'args'       => array('nuke_old_ee4_data' => true),
+			),
+			'start_with_fresh_ee4_db'             => array(
+				'func'       => '_reset_db',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+				'args'       => array('nuke_old_ee4_data' => false),
+			),
+			'delete_db'                           => array(
+				'func'       => '_delete_db',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'rerun_migration_from_ee3'            => array(
+				'func'       => '_rerun_migration_from_ee3',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'reset_reservations'                  => array(
+				'func'       => '_reset_reservations',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'reset_capabilities'                  => array(
+				'func'       => '_reset_capabilities',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'reattempt_migration'                 => array(
+				'func'       => '_reattempt_migration',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'datetime_tools'                      => array(
+				'func'       => '_datetime_tools',
+				'capability' => 'manage_options',
+			),
+			'run_datetime_offset_fix'             => array(
+				'func'               => '_apply_datetime_offset',
+				'noheader'           => true,
+				'headers_sent_route' => 'datetime_tools',
+				'capability'         => 'manage_options',
+			),
+		);
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'        => array(
+				'nav'           => array(
+					'label' => esc_html__('Maintenance', 'event_espresso'),
+					'order' => 10,
+				),
+				'require_nonce' => false,
+			),
+			'data_reset'     => array(
+				'nav'           => array(
+					'label' => esc_html__('Reset/Delete Data', 'event_espresso'),
+					'order' => 20,
+				),
+				'require_nonce' => false,
+			),
+			'datetime_tools' => array(
+				'nav'           => array(
+					'label' => esc_html__('Datetime Utilities', 'event_espresso'),
+					'order' => 25,
+				),
+				'require_nonce' => false,
+			),
+			'system_status'  => array(
+				'nav'           => array(
+					'label' => esc_html__("System Information", "event_espresso"),
+					'order' => 30,
+				),
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+	/**
+	 * default maintenance page. If we're in maintenance mode level 2, then we need to show
+	 * the migration scripts and all that UI.
+	 */
+	public function _maintenance()
+	{
+		// it all depends if we're in maintenance model level 1 (frontend-only) or
+		// level 2 (everything except maintenance page)
+		try {
+			// get the current maintenance level and check if
+			// we are removed
+			$mm = EE_Maintenance_Mode::instance()->level();
+			$placed_in_mm = EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+			if ($mm == EE_Maintenance_Mode::level_2_complete_maintenance && ! $placed_in_mm) {
+				// we just took the site out of maintenance mode, so notify the user.
+				// unfortunately this message appears to be echoed on the NEXT page load...
+				// oh well, we should really be checking for this on addon deactivation anyways
+				EE_Error::add_attention(
+					__(
+						'Site taken out of maintenance mode because no data migration scripts are required',
+						'event_espresso'
+					)
+				);
+				$this->_process_notices(array('page' => 'espresso_maintenance_settings'), false);
+			}
+			// in case an exception is thrown while trying to handle migrations
+			switch (EE_Maintenance_Mode::instance()->level()) {
+				case EE_Maintenance_Mode::level_0_not_in_maintenance:
+				case EE_Maintenance_Mode::level_1_frontend_only_maintenance:
+					$show_maintenance_switch = true;
+					$show_backup_db_text = false;
+					$show_migration_progress = false;
+					$script_names = array();
+					$addons_should_be_upgraded_first = false;
+					break;
+				case EE_Maintenance_Mode::level_2_complete_maintenance:
+					$show_maintenance_switch = false;
+					$show_migration_progress = true;
+					if (isset($this->_req_data['continue_migration'])) {
+						$show_backup_db_text = false;
+					} else {
+						$show_backup_db_text = true;
+					}
+					$scripts_needing_to_run = EE_Data_Migration_Manager::instance()
+																	   ->check_for_applicable_data_migration_scripts();
+					$addons_should_be_upgraded_first = EE_Data_Migration_Manager::instance()->addons_need_updating();
+					$script_names = array();
+					$current_script = null;
+					foreach ($scripts_needing_to_run as $script) {
+						if ($script instanceof EE_Data_Migration_Script_Base) {
+							if (! $current_script) {
+								$current_script = $script;
+								$current_script->migration_page_hooks();
+							}
+							$script_names[] = $script->pretty_name();
+						}
+					}
+					break;
+			}
+			$most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
+			$exception_thrown = false;
+		} catch (EE_Error $e) {
+			EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
+			// now, just so we can display the page correctly, make a error migration script stage object
+			// and also put the error on it. It only persists for the duration of this request
+			$most_recent_migration = new EE_DMS_Unknown_1_0_0();
+			$most_recent_migration->add_error($e->getMessage());
+			$exception_thrown = true;
+		}
+		$current_db_state = EE_Data_Migration_Manager::instance()->ensure_current_database_state_is_set();
+		$current_db_state = str_replace('.decaf', '', $current_db_state);
+		if ($exception_thrown
+			|| ($most_recent_migration
+				&& $most_recent_migration instanceof EE_Data_Migration_Script_Base
+				&& $most_recent_migration->is_broken()
+			)
+		) {
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php';
+			$this->_template_args['support_url'] = 'http://eventespresso.com/support/forums/';
+			$this->_template_args['next_url'] = EEH_URL::add_query_args_and_nonce(
+				array(
+					'action'  => 'confirm_migration_crash_report_sent',
+					'success' => '0',
+				),
+				EE_MAINTENANCE_ADMIN_URL
+			);
+		} elseif ($addons_should_be_upgraded_first) {
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php';
+		} else {
+			if ($most_recent_migration
+				&& $most_recent_migration instanceof EE_Data_Migration_Script_Base
+				&& $most_recent_migration->can_continue()
+			) {
+				$show_backup_db_text = false;
+				$show_continue_current_migration_script = true;
+				$show_most_recent_migration = true;
+			} elseif (isset($this->_req_data['continue_migration'])) {
+				$show_most_recent_migration = true;
+				$show_continue_current_migration_script = false;
+			} else {
+				$show_most_recent_migration = false;
+				$show_continue_current_migration_script = false;
+			}
+			if (isset($current_script)) {
+				$migrates_to = $current_script->migrates_to_version();
+				$plugin_slug = $migrates_to['slug'];
+				$new_version = $migrates_to['version'];
+				$this->_template_args = array_merge(
+					$this->_template_args,
+					array(
+						'current_db_state' => sprintf(
+							__("EE%s (%s)", "event_espresso"),
+							isset($current_db_state[ $plugin_slug ]) ? $current_db_state[ $plugin_slug ] : 3,
+							$plugin_slug
+						),
+						'next_db_state'    => isset($current_script) ? sprintf(
+							__("EE%s (%s)", 'event_espresso'),
+							$new_version,
+							$plugin_slug
+						) : null,
+					)
+				);
+			} else {
+				$this->_template_args['current_db_state'] = null;
+				$this->_template_args['next_db_state'] = null;
+			}
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php';
+			$this->_template_args = array_merge(
+				$this->_template_args,
+				array(
+					'show_most_recent_migration'             => $show_most_recent_migration,
+					// flag for showing the most recent migration's status and/or errors
+					'show_migration_progress'                => $show_migration_progress,
+					// flag for showing the option to run migrations and see their progress
+					'show_backup_db_text'                    => $show_backup_db_text,
+					// flag for showing text telling the user to backup their DB
+					'show_maintenance_switch'                => $show_maintenance_switch,
+					// flag for showing the option to change maintenance mode between levels 0 and 1
+					'script_names'                           => $script_names,
+					// array of names of scripts that have run
+					'show_continue_current_migration_script' => $show_continue_current_migration_script,
+					// flag to change wording to indicating that we're only CONTINUING a migration script (somehow it got interrupted0
+					'reset_db_page_link'                     => EE_Admin_Page::add_query_args_and_nonce(
+						array('action' => 'reset_db'),
+						EE_MAINTENANCE_ADMIN_URL
+					),
+					'data_reset_page'                        => EE_Admin_Page::add_query_args_and_nonce(
+						array('action' => 'data_reset'),
+						EE_MAINTENANCE_ADMIN_URL
+					),
+					'update_migration_script_page_link'      => EE_Admin_Page::add_query_args_and_nonce(
+						array('action' => 'change_maintenance_level'),
+						EE_MAINTENANCE_ADMIN_URL
+					),
+					'ultimate_db_state'                      => sprintf(
+						__("EE%s", 'event_espresso'),
+						espresso_version()
+					),
+				)
+			);
+			// make sure we have the form fields helper available. It usually is, but sometimes it isn't
+		}
+		$this->_template_args['most_recent_migration'] = $most_recent_migration;// the actual most recently ran migration
+		// now render the migration options part, and put it in a variable
+		$migration_options_template_file = apply_filters(
+			'FHEE__ee_migration_page__migration_options_template',
+			EE_MAINTENANCE_TEMPLATE_PATH . 'migration_options_from_ee4.template.php'
+		);
+		$migration_options_html = EEH_Template::display_template(
+			$migration_options_template_file,
+			$this->_template_args,
+			true
+		);
+		$this->_template_args['migration_options_html'] = $migration_options_html;
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$this->_template_path,
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * returns JSON and executes another step of the currently-executing data migration (called via ajax)
+	 */
+	public function migration_step()
+	{
+		$this->_template_args['data'] = EE_Data_Migration_Manager::instance()->response_to_migration_ajax_request();
+		$this->_return_json();
+	}
+
+
+	/**
+	 * Can be used by js when it notices a response with HTML in it in order
+	 * to log the malformed response
+	 */
+	public function add_error_to_migrations_ran()
+	{
+		EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($this->_req_data['message']);
+		$this->_template_args['data'] = array('ok' => true);
+		$this->_return_json();
+	}
+
+
+	/**
+	 * changes the maintenance level, provided there are still no migration scripts that should run
+	 */
+	public function _change_maintenance_level()
+	{
+		$new_level = absint($this->_req_data['maintenance_mode_level']);
+		if (! EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
+			EE_Maintenance_Mode::instance()->set_maintenance_level($new_level);
+			$success = true;
+		} else {
+			EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+			$success = false;
+		}
+		$this->_redirect_after_action($success, 'Maintenance Mode', esc_html__("Updated", "event_espresso"));
+	}
+
+
+	/**
+	 * a tab with options for resetting and/or deleting EE data
+	 *
+	 * @throws \EE_Error
+	 * @throws \DomainException
+	 */
+	public function _data_reset_and_delete()
+	{
+		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php';
+		$this->_template_args['reset_reservations_button'] = $this->get_action_link_or_button(
+			'reset_reservations',
+			'reset_reservations',
+			array(),
+			'button button-primary ee-confirm',
+			'',
+			false
+		);
+		$this->_template_args['reset_capabilities_button'] = $this->get_action_link_or_button(
+			'reset_capabilities',
+			'reset_capabilities',
+			array(),
+			'button button-primary ee-confirm',
+			'',
+			false
+		);
+		$this->_template_args['delete_db_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'delete_db'),
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['reset_db_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'reset_db'),
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$this->_template_path,
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	protected function _reset_reservations()
+	{
+		if (\EED_Ticket_Sales_Monitor::reset_reservation_counts()) {
+			EE_Error::add_success(
+				__(
+					'Ticket and datetime reserved counts have been successfully reset.',
+					'event_espresso'
+				)
+			);
+		} else {
+			EE_Error::add_success(
+				__(
+					'Ticket and datetime reserved counts were correct and did not need resetting.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->_redirect_after_action(true, '', '', array('action' => 'data_reset'), true);
+	}
+
+
+	protected function _reset_capabilities()
+	{
+		EE_Registry::instance()->CAP->init_caps(true);
+		EE_Error::add_success(
+			__(
+				'Default Event Espresso capabilities have been restored for all current roles.',
+				'event_espresso'
+			)
+		);
+		$this->_redirect_after_action(false, '', '', array('action' => 'data_reset'), true);
+	}
+
+
+	/**
+	 * resets the DMSs so we can attempt to continue migrating after a fatal error
+	 * (only a good idea when someone has somehow tried ot fix whatever caused
+	 * the fatal error in teh first place)
+	 */
+	protected function _reattempt_migration()
+	{
+		EE_Data_Migration_Manager::instance()->reattempt();
+		$this->_redirect_after_action(false, '', '', array('action' => 'default'), true);
+	}
+
+
+	/**
+	 * shows the big ol' System Information page
+	 */
+	public function _system_status()
+	{
+		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php';
+		$this->_template_args['system_stati'] = EEM_System_Status::instance()->get_system_stati();
+		$this->_template_args['download_system_status_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'download_system_status',
+			),
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$this->_template_path,
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+	/**
+	 * Downloads an HTML file of the system status that can be easily stored or emailed
+	 */
+	public function _download_system_status()
+	{
+		$status_info = EEM_System_Status::instance()->get_system_stati();
+		header('Content-Disposition: attachment');
+		header("Content-Disposition: attachment; filename=system_status_" . sanitize_key(site_url()) . ".html");
+		echo "<style>table{border:1px solid darkgrey;}td{vertical-align:top}</style>";
+		echo "<h1>System Information for " . site_url() . "</h1>";
+		echo EEH_Template::layout_array_as_table($status_info);
+		die;
+	}
+
+
+	public function _send_migration_crash_report()
+	{
+		$from = $this->_req_data['from'];
+		$from_name = $this->_req_data['from_name'];
+		$body = $this->_req_data['body'];
+		try {
+			$success = wp_mail(
+				EE_SUPPORT_EMAIL,
+				'Migration Crash Report',
+				$body . "/r/n<br>" . print_r(EEM_System_Status::instance()->get_system_stati(), true),
+				array(
+					"from:$from_name<$from>",
+				)
+			);
+		} catch (Exception $e) {
+			$success = false;
+		}
+		$this->_redirect_after_action(
+			$success,
+			esc_html__("Migration Crash Report", "event_espresso"),
+			esc_html__("sent", "event_espresso"),
+			array('success' => $success, 'action' => 'confirm_migration_crash_report_sent')
+		);
+	}
+
+
+	public function _confirm_migration_crash_report_sent()
+	{
+		try {
+			$most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
+		} catch (EE_Error $e) {
+			EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
+			// now, just so we can display the page correctly, make a error migration script stage object
+			// and also put the error on it. It only persists for the duration of this request
+			$most_recent_migration = new EE_DMS_Unknown_1_0_0();
+			$most_recent_migration->add_error($e->getMessage());
+		}
+		$success = $this->_req_data['success'] == '1' ? true : false;
+		$this->_template_args['success'] = $success;
+		$this->_template_args['most_recent_migration'] = $most_recent_migration;
+		$this->_template_args['reset_db_action_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'reset_db'),
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['reset_db_page_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'data_reset'),
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['reattempt_action_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'reattempt_migration'),
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$this->_template_path,
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Resets the entire EE4 database.
+	 * Currently basically only sets up ee4 database for a fresh install- doesn't
+	 * actually clean out the old wp options, or cpts (although does erase old ee table data)
+	 *
+	 * @param boolean $nuke_old_ee4_data controls whether or not we
+	 *                                   destroy the old ee4 data, or just try initializing ee4 default data
+	 */
+	public function _reset_db($nuke_old_ee4_data = true)
+	{
+		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
+		if ($nuke_old_ee4_data) {
+			EEH_Activation::delete_all_espresso_cpt_data();
+			EEH_Activation::delete_all_espresso_tables_and_data(false);
+			EEH_Activation::remove_cron_tasks();
+		}
+		// make sure when we reset the registry's config that it
+		// switches to using the new singleton
+		EE_Registry::instance()->CFG = EE_Registry::instance()->CFG->reset(true);
+		EE_System::instance()->initialize_db_if_no_migrations_required(true);
+		EE_System::instance()->redirect_to_about_ee();
+	}
+
+
+	/**
+	 * Deletes ALL EE tables, Records, and Options from the database.
+	 */
+	public function _delete_db()
+	{
+		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
+		EEH_Activation::delete_all_espresso_cpt_data();
+		EEH_Activation::delete_all_espresso_tables_and_data();
+		EEH_Activation::remove_cron_tasks();
+		EEH_Activation::deactivate_event_espresso();
+		wp_safe_redirect(admin_url('plugins.php'));
+		exit;
+	}
+
+
+	/**
+	 * sets up EE4 to rerun the migrations from ee3 to ee4
+	 */
+	public function _rerun_migration_from_ee3()
+	{
+		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
+		EEH_Activation::delete_all_espresso_cpt_data();
+		EEH_Activation::delete_all_espresso_tables_and_data(false);
+		// set the db state to something that will require migrations
+		update_option(EE_Data_Migration_Manager::current_database_state, '3.1.36.0');
+		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_2_complete_maintenance);
+		$this->_redirect_after_action(
+			true,
+			esc_html__("Database", 'event_espresso'),
+			esc_html__("reset", 'event_espresso')
+		);
+	}
+
+
+	// none of the below group are currently used for Gateway Settings
+	protected function _add_screen_options()
+	{
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles()
+	{
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script(
+			'ee-maintenance',
+			EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.js',
+			array('jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_style(
+			'espresso_maintenance',
+			EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_maintenance');
+		// localize script stuff
+		wp_localize_script(
+			'ee-maintenance',
+			'ee_maintenance',
+			array(
+				'migrating'                        => wp_strip_all_tags(__("Updating Database...", "event_espresso")),
+				'next'                             => wp_strip_all_tags(__("Next", "event_espresso")),
+				'fatal_error'                      => wp_strip_all_tags(__("A Fatal Error Has Occurred", "event_espresso")),
+				'click_next_when_ready'            => wp_strip_all_tags(
+					__(
+						"The current Database Update has ended. Click 'next' when ready to proceed",
+						"event_espresso"
+					)
+				),
+				'status_no_more_migration_scripts' => EE_Data_Migration_Manager::status_no_more_migration_scripts,
+				'status_fatal_error'               => EE_Data_Migration_Manager::status_fatal_error,
+				'status_completed'                 => EE_Data_Migration_Manager::status_completed,
+				'confirm'                          => wp_strip_all_tags(
+					__(
+						'Are you sure you want to do this? It CANNOT be undone!',
+						'event_espresso'
+					)
+				),
+				'confirm_skip_migration'           => wp_strip_all_tags(
+					__(
+						'You have chosen to NOT migrate your existing data. Are you sure you want to continue?',
+						'event_espresso'
+					)
+				),
+			)
+		);
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+	}
+
+
+	/**
+	 * Enqueue scripts and styles for the datetime tools page.
+	 */
+	public function load_scripts_styles_datetime_tools()
+	{
+		EE_Datepicker_Input::enqueue_styles_and_scripts();
+	}
+
+
+	protected function _datetime_tools()
+	{
+		$form_action = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action'        => 'run_datetime_offset_fix',
+				'return_action' => $this->_req_action,
+			),
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$form = $this->_get_datetime_offset_fix_form();
+		$this->_admin_page_title = esc_html__('Datetime Utilities', 'event_espresso');
+		$this->_template_args['admin_page_content'] = $form->form_open($form_action, 'post')
+													  . $form->get_html_and_js()
+													  . $form->form_close();
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	protected function _get_datetime_offset_fix_form()
+	{
+		if (! $this->datetime_fix_offset_form instanceof EE_Form_Section_Proper) {
+			$this->datetime_fix_offset_form = new EE_Form_Section_Proper(
+				array(
+					'name'            => 'datetime_offset_fix_option',
+					'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+					'subsections'     => array(
+						'title'                  => new EE_Form_Section_HTML(
+							EEH_HTML::h2(
+								esc_html__('Datetime Offset Tool', 'event_espresso')
+							)
+						),
+						'explanation'            => new EE_Form_Section_HTML(
+							EEH_HTML::p(
+								esc_html__(
+									'Use this tool to automatically apply the provided offset to all Event Espresso records in your database that involve dates and times.',
+									'event_espresso'
+								)
+							)
+							. EEH_HTML::p(
+								esc_html__(
+									'Note: If you enter 1.25, that will result in the offset of 1 hour 15 minutes being applied.  Decimals represent the fraction of hours, not minutes.',
+									'event_espresso'
+								)
+							)
+						),
+						'offset_input'           => new EE_Float_Input(
+							array(
+								'html_name'       => 'offset_for_datetimes',
+								'html_label_text' => esc_html__(
+									'Offset to apply (in hours):',
+									'event_espresso'
+								),
+								'min_value'       => '-12',
+								'max_value'       => '14',
+								'step_value'      => '.25',
+								'default'         => DatetimeOffsetFix::getOffset(),
+							)
+						),
+						'date_range_explanation' => new EE_Form_Section_HTML(
+							EEH_HTML::p(
+								esc_html__(
+									'Leave the following fields blank if you want the offset to be applied to all dates. If however, you want to just apply the offset to a specific range of dates you can restrict the offset application using these fields.',
+									'event_espresso'
+								)
+							)
+							. EEH_HTML::p(
+								EEH_HTML::strong(
+									sprintf(
+										esc_html__(
+											'Note: please enter the dates in UTC (You can use %1$sthis online tool%2$s to assist with conversions).',
+											'event_espresso'
+										),
+										'<a href="https://www.timeanddate.com/worldclock/converter.html">',
+										'</a>'
+									)
+								)
+							)
+						),
+						'date_range_start_date'  => new EE_Datepicker_Input(
+							array(
+								'html_name'       => 'offset_date_start_range',
+								'html_label_text' => esc_html__(
+									'Start Date for dates the offset applied to:',
+									'event_espresso'
+								),
+							)
+						),
+						'date_range_end_date'    => new EE_Datepicker_Input(
+							array(
+								'html_name'       => 'offset_date_end_range',
+								'html_label_text' => esc_html__(
+									'End Date for dates the offset is applied to:',
+									'event_espresso'
+								),
+							)
+						),
+						'submit'                 => new EE_Submit_Input(
+							array(
+								'html_label_text' => '',
+								'default'         => esc_html__('Apply Offset', 'event_espresso'),
+							)
+						),
+					),
+				)
+			);
+		}
+		return $this->datetime_fix_offset_form;
+	}
+
+
+	/**
+	 * Callback for the run_datetime_offset_fix route.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _apply_datetime_offset()
+	{
+		if ($_SERVER['REQUEST_METHOD'] === 'POST') {
+			$form = $this->_get_datetime_offset_fix_form();
+			$form->receive_form_submission($this->_req_data);
+			if ($form->is_valid()) {
+				// save offset data so batch processor can get it.
+				DatetimeOffsetFix::updateOffset($form->get_input_value('offset_input'));
+				$utc_timezone = new DateTimeZone('UTC');
+				$date_range_start_date = DateTime::createFromFormat(
+					'm/d/Y H:i:s',
+					$form->get_input_value('date_range_start_date') . ' 00:00:00',
+					$utc_timezone
+				);
+				$date_range_end_date = DateTime::createFromFormat(
+					'm/d/Y H:i:s',
+					$form->get_input_value('date_range_end_date') . ' 23:59:59',
+					$utc_timezone
+				);
+				if ($date_range_start_date instanceof DateTime) {
+					DatetimeOffsetFix::updateStartDateRange(DbSafeDateTime::createFromDateTime($date_range_start_date));
+				}
+				if ($date_range_end_date instanceof DateTime) {
+					DatetimeOffsetFix::updateEndDateRange(DbSafeDateTime::createFromDateTime($date_range_end_date));
+				}
+				// redirect to batch tool
+				wp_redirect(
+					EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'page'        => 'espresso_batch',
+							'batch'       => 'job',
+							'label'       => esc_html__('Applying Offset', 'event_espresso'),
+							'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\DatetimeOffsetFix'),
+							'return_url'  => urlencode(
+								add_query_arg(
+									array(
+										'action' => 'datetime_tools',
+									),
+									EEH_URL::current_url_without_query_paramaters(
+										array(
+											'return_action',
+											'run_datetime_offset_fix_nonce',
+											'return',
+											'datetime_tools_nonce',
+										)
+									)
+								)
+							),
+						),
+						admin_url()
+					)
+				);
+				exit;
+			}
+		}
+	}
 }

caffeinated/modules/recaptcha_invisible/InvisibleRecaptcha.php

Indentation +240 added lines, -240 removed lines

@@ -27,270 +27,270 @@
 class InvisibleRecaptcha
 {
 
-    const URL_GOOGLE_RECAPTCHA_API          = 'https://www.google.com/recaptcha/api/siteverify';
+	const URL_GOOGLE_RECAPTCHA_API          = 'https://www.google.com/recaptcha/api/siteverify';
 
-    const SESSION_DATA_KEY_RECAPTCHA_PASSED = 'recaptcha_passed';
+	const SESSION_DATA_KEY_RECAPTCHA_PASSED = 'recaptcha_passed';
 
-    /**
-     * @var EE_Registration_Config $config
-     */
-    private $config;
+	/**
+	 * @var EE_Registration_Config $config
+	 */
+	private $config;
 
-    /**
-     * @var EE_Session $session
-     */
-    private $session;
+	/**
+	 * @var EE_Session $session
+	 */
+	private $session;
 
-    /**
-     * @var boolean $recaptcha_passed
-     */
-    private $recaptcha_passed;
+	/**
+	 * @var boolean $recaptcha_passed
+	 */
+	private $recaptcha_passed;
 
 
-    /**
-     * InvisibleRecaptcha constructor.
-     *
-     * @param EE_Registration_Config $registration_config
-     * @param EE_Session             $session
-     */
-    public function __construct(EE_Registration_Config $registration_config, EE_Session $session)
-    {
-        $this->config = $registration_config;
-        $this->session = $session;
-    }
+	/**
+	 * InvisibleRecaptcha constructor.
+	 *
+	 * @param EE_Registration_Config $registration_config
+	 * @param EE_Session             $session
+	 */
+	public function __construct(EE_Registration_Config $registration_config, EE_Session $session)
+	{
+		$this->config = $registration_config;
+		$this->session = $session;
+	}
 
 
-    /**
-     * @return boolean
-     */
-    public function useInvisibleRecaptcha()
-    {
-        return $this->config->use_captcha && $this->config->recaptcha_theme === 'invisible';
-    }
+	/**
+	 * @return boolean
+	 */
+	public function useInvisibleRecaptcha()
+	{
+		return $this->config->use_captcha && $this->config->recaptcha_theme === 'invisible';
+	}
 
 
-    /**
-     * @param array $input_settings
-     * @return EE_Invisible_Recaptcha_Input
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws DomainException
-     */
-    public function getInput(array $input_settings = array())
-    {
-        return new EE_Invisible_Recaptcha_Input(
-            $input_settings,
-            $this->config
-        );
-    }
+	/**
+	 * @param array $input_settings
+	 * @return EE_Invisible_Recaptcha_Input
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws DomainException
+	 */
+	public function getInput(array $input_settings = array())
+	{
+		return new EE_Invisible_Recaptcha_Input(
+			$input_settings,
+			$this->config
+		);
+	}
 
 
-    /**
-     * @param array $input_settings
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws DomainException
-     */
-    public function getInputHtml(array $input_settings = array())
-    {
-        return $this->getInput($input_settings)->get_html_for_input();
-    }
+	/**
+	 * @param array $input_settings
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws DomainException
+	 */
+	public function getInputHtml(array $input_settings = array())
+	{
+		return $this->getInput($input_settings)->get_html_for_input();
+	}
 
 
-    /**
-     * @param EE_Form_Section_Proper $form
-     * @param array                  $input_settings
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws DomainException
-     */
-    public function addToFormSection(EE_Form_Section_Proper $form, array $input_settings = array())
-    {
-        $form->add_subsections(
-            array(
-                'espresso_recaptcha' => $this->getInput($input_settings),
-            ),
-            null,
-            false
-        );
-    }
+	/**
+	 * @param EE_Form_Section_Proper $form
+	 * @param array                  $input_settings
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws DomainException
+	 */
+	public function addToFormSection(EE_Form_Section_Proper $form, array $input_settings = array())
+	{
+		$form->add_subsections(
+			array(
+				'espresso_recaptcha' => $this->getInput($input_settings),
+			),
+			null,
+			false
+		);
+	}
 
 
-    /**
-     * @param RequestInterface $request
-     * @return boolean
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     */
-    public function verifyToken(RequestInterface $request)
-    {
-        static $previous_recaptcha_response = array();
-        $grecaptcha_response = $request->getRequestParam('g-recaptcha-response');
-        // if this token has already been verified, then return previous response
-        if (isset($previous_recaptcha_response[ $grecaptcha_response ])) {
-            return $previous_recaptcha_response[ $grecaptcha_response ];
-        }
-        // still here but no g-recaptcha-response ? - verification failed
-        if (! $grecaptcha_response) {
-            EE_Error::add_error(
-                sprintf(
-                    /* translators: 1: missing parameter */
-                    esc_html__(
-                        // @codingStandardsIgnoreStart
-                        'We\'re sorry but an attempt to verify the form\'s reCAPTCHA has failed. Missing "%1$s". Please try again.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    'g-recaptcha-response'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // will update to true if everything passes
-        $previous_recaptcha_response[ $grecaptcha_response ] = false;
-        $response                                            = wp_safe_remote_post(
-            InvisibleRecaptcha::URL_GOOGLE_RECAPTCHA_API,
-            array(
-                'body' => array(
-                    'secret'   => $this->config->recaptcha_privatekey,
-                    'response' => $grecaptcha_response,
-                    'remoteip' => $request->ipAddress(),
-                ),
-            )
-        );
-        if ($response instanceof WP_Error) {
-            $this->generateError($response->get_error_messages());
-            return false;
-        }
-        $results = json_decode(wp_remote_retrieve_body($response), true);
-        if (filter_var($results['success'], FILTER_VALIDATE_BOOLEAN) !== true) {
-            $errors   = array_map(
-                array($this, 'getErrorCode'),
-                $results['error-codes']
-            );
-            if (isset($results['challenge_ts'])) {
-                $errors[] = 'challenge timestamp: ' . $results['challenge_ts'] . '.';
-            }
-            $this->generateError(implode(' ', $errors), true);
-        }
-        $previous_recaptcha_response[ $grecaptcha_response ] = true;
-        add_action('shutdown', array($this, 'setSessionData'));
-        return true;
-    }
+	/**
+	 * @param RequestInterface $request
+	 * @return boolean
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 */
+	public function verifyToken(RequestInterface $request)
+	{
+		static $previous_recaptcha_response = array();
+		$grecaptcha_response = $request->getRequestParam('g-recaptcha-response');
+		// if this token has already been verified, then return previous response
+		if (isset($previous_recaptcha_response[ $grecaptcha_response ])) {
+			return $previous_recaptcha_response[ $grecaptcha_response ];
+		}
+		// still here but no g-recaptcha-response ? - verification failed
+		if (! $grecaptcha_response) {
+			EE_Error::add_error(
+				sprintf(
+					/* translators: 1: missing parameter */
+					esc_html__(
+						// @codingStandardsIgnoreStart
+						'We\'re sorry but an attempt to verify the form\'s reCAPTCHA has failed. Missing "%1$s". Please try again.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					'g-recaptcha-response'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// will update to true if everything passes
+		$previous_recaptcha_response[ $grecaptcha_response ] = false;
+		$response                                            = wp_safe_remote_post(
+			InvisibleRecaptcha::URL_GOOGLE_RECAPTCHA_API,
+			array(
+				'body' => array(
+					'secret'   => $this->config->recaptcha_privatekey,
+					'response' => $grecaptcha_response,
+					'remoteip' => $request->ipAddress(),
+				),
+			)
+		);
+		if ($response instanceof WP_Error) {
+			$this->generateError($response->get_error_messages());
+			return false;
+		}
+		$results = json_decode(wp_remote_retrieve_body($response), true);
+		if (filter_var($results['success'], FILTER_VALIDATE_BOOLEAN) !== true) {
+			$errors   = array_map(
+				array($this, 'getErrorCode'),
+				$results['error-codes']
+			);
+			if (isset($results['challenge_ts'])) {
+				$errors[] = 'challenge timestamp: ' . $results['challenge_ts'] . '.';
+			}
+			$this->generateError(implode(' ', $errors), true);
+		}
+		$previous_recaptcha_response[ $grecaptcha_response ] = true;
+		add_action('shutdown', array($this, 'setSessionData'));
+		return true;
+	}
 
 
-    /**
-     * @param string $error_response
-     * @param bool   $show_errors
-     * @return void
-     * @throws RuntimeException
-     */
-    public function generateError($error_response = '', $show_errors = false)
-    {
-        throw new RuntimeException(
-            sprintf(
-                esc_html__(
-                    'We\'re sorry but an attempt to verify the form\'s reCAPTCHA has failed. %1$s %2$s Please try again.',
-                    'event_espresso'
-                ),
-                '<br />',
-                $show_errors || current_user_can('manage_options') ? $error_response : ''
-            )
-        );
-    }
+	/**
+	 * @param string $error_response
+	 * @param bool   $show_errors
+	 * @return void
+	 * @throws RuntimeException
+	 */
+	public function generateError($error_response = '', $show_errors = false)
+	{
+		throw new RuntimeException(
+			sprintf(
+				esc_html__(
+					'We\'re sorry but an attempt to verify the form\'s reCAPTCHA has failed. %1$s %2$s Please try again.',
+					'event_espresso'
+				),
+				'<br />',
+				$show_errors || current_user_can('manage_options') ? $error_response : ''
+			)
+		);
+	}
 
 
-    /**
-     * @param string $error_code
-     * @return string
-     */
-    public function getErrorCode(&$error_code)
-    {
-        $error_codes = array(
-            'missing-input-secret'   => 'The secret parameter is missing.',
-            'invalid-input-secret'   => 'The secret parameter is invalid or malformed.',
-            'missing-input-response' => 'The response parameter is missing.',
-            'invalid-input-response' => 'The response parameter is invalid or malformed.',
-            'bad-request'            => 'The request is invalid or malformed.',
-            'timeout-or-duplicate'   => 'The request took too long to be sent or was a duplicate of a previous request.',
-        );
-        return isset($error_codes[ $error_code ]) ? $error_codes[ $error_code ] : '';
-    }
+	/**
+	 * @param string $error_code
+	 * @return string
+	 */
+	public function getErrorCode(&$error_code)
+	{
+		$error_codes = array(
+			'missing-input-secret'   => 'The secret parameter is missing.',
+			'invalid-input-secret'   => 'The secret parameter is invalid or malformed.',
+			'missing-input-response' => 'The response parameter is missing.',
+			'invalid-input-response' => 'The response parameter is invalid or malformed.',
+			'bad-request'            => 'The request is invalid or malformed.',
+			'timeout-or-duplicate'   => 'The request took too long to be sent or was a duplicate of a previous request.',
+		);
+		return isset($error_codes[ $error_code ]) ? $error_codes[ $error_code ] : '';
+	}
 
 
-    /**
-     * @return array
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function getLocalizedVars()
-    {
-        return (array) apply_filters(
-            'FHEE__EventEspresso_caffeinated_modules_recaptcha_invisible_InvisibleRecaptcha__getLocalizedVars__localized_vars',
-            array(
-                'siteKey'          => $this->config->recaptcha_publickey,
-                'recaptcha_passed' => $this->recaptchaPassed(),
-                'wp_debug'         => WP_DEBUG,
-                'disable_submit'   => defined('EE_EVENT_QUEUE_BASE_URL'),
-                'failed_message'   => wp_strip_all_tags(
-                    __(
-                        'We\'re sorry but an attempt to verify the form\'s reCAPTCHA has failed. Please try again.',
-                        'event_espresso'
-                    )
-                )
-            )
-        );
-    }
+	/**
+	 * @return array
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function getLocalizedVars()
+	{
+		return (array) apply_filters(
+			'FHEE__EventEspresso_caffeinated_modules_recaptcha_invisible_InvisibleRecaptcha__getLocalizedVars__localized_vars',
+			array(
+				'siteKey'          => $this->config->recaptcha_publickey,
+				'recaptcha_passed' => $this->recaptchaPassed(),
+				'wp_debug'         => WP_DEBUG,
+				'disable_submit'   => defined('EE_EVENT_QUEUE_BASE_URL'),
+				'failed_message'   => wp_strip_all_tags(
+					__(
+						'We\'re sorry but an attempt to verify the form\'s reCAPTCHA has failed. Please try again.',
+						'event_espresso'
+					)
+				)
+			)
+		);
+	}
 
 
-    /**
-     * @return boolean
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function recaptchaPassed()
-    {
-        if ($this->recaptcha_passed !== null) {
-            return $this->recaptcha_passed;
-        }
-        // logged in means you have already passed a turing test of sorts
-        if ($this->useInvisibleRecaptcha() === false || is_user_logged_in()) {
-            $this->recaptcha_passed = true;
-            return $this->recaptcha_passed;
-        }
-        // was test already passed?
-        $this->recaptcha_passed = filter_var(
-            $this->session->get_session_data(
-                InvisibleRecaptcha::SESSION_DATA_KEY_RECAPTCHA_PASSED
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-        return $this->recaptcha_passed;
-    }
+	/**
+	 * @return boolean
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function recaptchaPassed()
+	{
+		if ($this->recaptcha_passed !== null) {
+			return $this->recaptcha_passed;
+		}
+		// logged in means you have already passed a turing test of sorts
+		if ($this->useInvisibleRecaptcha() === false || is_user_logged_in()) {
+			$this->recaptcha_passed = true;
+			return $this->recaptcha_passed;
+		}
+		// was test already passed?
+		$this->recaptcha_passed = filter_var(
+			$this->session->get_session_data(
+				InvisibleRecaptcha::SESSION_DATA_KEY_RECAPTCHA_PASSED
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+		return $this->recaptcha_passed;
+	}
 
 
-    /**
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function setSessionData()
-    {
-        $this->session->set_session_data(
-            array(InvisibleRecaptcha::SESSION_DATA_KEY_RECAPTCHA_PASSED => true)
-        );
-    }
+	/**
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function setSessionData()
+	{
+		$this->session->set_session_data(
+			array(InvisibleRecaptcha::SESSION_DATA_KEY_RECAPTCHA_PASSED => true)
+		);
+	}
 }

core/services/notifications/PersistentAdminNoticeManager.php

Indentation +383 added lines, -383 removed lines

@@ -31,387 +31,387 @@
 class PersistentAdminNoticeManager
 {
 
-    const WP_OPTION_KEY = 'ee_pers_admin_notices';
-
-    /**
-     * @var Collection|PersistentAdminNotice[] $notice_collection
-     */
-    private $notice_collection;
-
-    /**
-     * if AJAX is not enabled, then the return URL will be used for redirecting back to the admin page where the
-     * persistent admin notice was displayed, and ultimately dismissed from.
-     *
-     * @var string $return_url
-     */
-    private $return_url;
-
-    /**
-     * @var CapabilitiesChecker $capabilities_checker
-     */
-    private $capabilities_checker;
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-
-    /**
-     * PersistentAdminNoticeManager constructor
-     *
-     * @param string              $return_url where to  redirect to after dismissing notices
-     * @param CapabilitiesChecker $capabilities_checker
-     * @param RequestInterface          $request
-     * @throws InvalidDataTypeException
-     */
-    public function __construct($return_url = '', CapabilitiesChecker $capabilities_checker, RequestInterface $request)
-    {
-        $this->setReturnUrl($return_url);
-        $this->capabilities_checker = $capabilities_checker;
-        $this->request = $request;
-        // setup up notices at priority 9 because `EE_Admin::display_admin_notices()` runs at priority 10,
-        // and we want to retrieve and generate any nag notices at the last possible moment
-        add_action('admin_notices', array($this, 'displayNotices'), 9);
-        add_action('network_admin_notices', array($this, 'displayNotices'), 9);
-        add_action('wp_ajax_dismiss_ee_nag_notice', array($this, 'dismissNotice'));
-        add_action('shutdown', array($this, 'registerAndSaveNotices'), 998);
-    }
-
-
-    /**
-     * @param string $return_url
-     * @throws InvalidDataTypeException
-     */
-    public function setReturnUrl($return_url)
-    {
-        if (! is_string($return_url)) {
-            throw new InvalidDataTypeException('$return_url', $return_url, 'string');
-        }
-        $this->return_url = $return_url;
-    }
-
-
-    /**
-     * @return Collection
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    protected function getPersistentAdminNoticeCollection()
-    {
-        if (! $this->notice_collection instanceof Collection) {
-            $this->notice_collection = new Collection(
-                'EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
-            );
-            $this->retrieveStoredNotices();
-            $this->registerNotices();
-        }
-        return $this->notice_collection;
-    }
-
-
-    /**
-     * generates PersistentAdminNotice objects for all non-dismissed notices saved to the db
-     *
-     * @return void
-     * @throws InvalidEntityException
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    protected function retrieveStoredNotices()
-    {
-        $persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
-        if (! empty($persistent_admin_notices)) {
-            foreach ($persistent_admin_notices as $name => $details) {
-                if (is_array($details)) {
-                    if (! isset(
-                        $details['message'],
-                        $details['capability'],
-                        $details['cap_context'],
-                        $details['dismissed']
-                    )) {
-                        throw new DomainException(
-                            sprintf(
-                                esc_html__(
-                                    'The "%1$s" PersistentAdminNotice could not be retrieved from the database.',
-                                    'event_espresso'
-                                ),
-                                $name
-                            )
-                        );
-                    }
-                    // new format for nag notices
-                    $this->notice_collection->add(
-                        new PersistentAdminNotice(
-                            $name,
-                            $details['message'],
-                            false,
-                            $details['capability'],
-                            $details['cap_context'],
-                            $details['dismissed']
-                        ),
-                        sanitize_key($name)
-                    );
-                } else {
-                    try {
-                        // old nag notices, that we want to convert to the new format
-                        $this->notice_collection->add(
-                            new PersistentAdminNotice(
-                                $name,
-                                (string) $details,
-                                false,
-                                '',
-                                '',
-                                empty($details)
-                            ),
-                            sanitize_key($name)
-                        );
-                    } catch (Exception $e) {
-                        EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                    }
-                }
-                // each notice will self register when the action hook in registerNotices is triggered
-            }
-        }
-    }
-
-
-    /**
-     * exposes the Persistent Admin Notice Collection via an action
-     * so that PersistentAdminNotice objects can be added and/or removed
-     * without compromising the actual collection like a filter would
-     */
-    protected function registerNotices()
-    {
-        do_action(
-            'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices',
-            $this->notice_collection
-        );
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidEntityException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function displayNotices()
-    {
-        $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if ($this->notice_collection->hasObjects()) {
-            $enqueue_assets = false;
-            // and display notices
-            foreach ($this->notice_collection as $persistent_admin_notice) {
-                /** @var PersistentAdminNotice $persistent_admin_notice */
-                // don't display notices that have already been dismissed
-                if ($persistent_admin_notice->getDismissed()) {
-                    continue;
-                }
-                try {
-                    $this->capabilities_checker->processCapCheck(
-                        $persistent_admin_notice->getCapCheck()
-                    );
-                } catch (InsufficientPermissionsException $e) {
-                    // user does not have required cap, so skip to next notice
-                    // and just eat the exception - nom nom nom nom
-                    continue;
-                }
-                if ($persistent_admin_notice->getMessage() === '') {
-                    continue;
-                }
-                $this->displayPersistentAdminNotice($persistent_admin_notice);
-                $enqueue_assets = true;
-            }
-            if ($enqueue_assets) {
-                $this->enqueueAssets();
-            }
-        }
-    }
-
-
-    /**
-     * does what it's named
-     *
-     * @return void
-     */
-    public function enqueueAssets()
-    {
-        wp_register_script(
-            'espresso_core',
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-            array('jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_script(
-            'ee_error_js',
-            EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
-            array('espresso_core'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script(
-            'ee_error_js',
-            'ee_dismiss',
-            array(
-                'return_url'    => urlencode($this->return_url),
-                'ajax_url'      => WP_AJAX_URL,
-                'unknown_error' => wp_strip_all_tags(
-                    __(
-                        'An unknown error has occurred on the server while attempting to dismiss this notice.',
-                        'event_espresso'
-                    )
-                ),
-            )
-        );
-        wp_enqueue_script('ee_error_js');
-    }
-
-
-    /**
-     * displayPersistentAdminNoticeHtml
-     *
-     * @param  PersistentAdminNotice $persistent_admin_notice
-     */
-    protected function displayPersistentAdminNotice(PersistentAdminNotice $persistent_admin_notice)
-    {
-        // used in template
-        $persistent_admin_notice_name = $persistent_admin_notice->getName();
-        $persistent_admin_notice_message = $persistent_admin_notice->getMessage();
-        require EE_TEMPLATES . '/notifications/persistent_admin_notice.template.php';
-    }
-
-
-    /**
-     * dismissNotice
-     *
-     * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
-     * @param bool   $purge    if true, then delete it from the db
-     * @param bool   $return   forget all of this AJAX or redirect nonsense, and just return
-     * @return void
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function dismissNotice($pan_name = '', $purge = false, $return = false)
-    {
-        $pan_name = $this->request->getRequestParam('ee_nag_notice', $pan_name);
-        $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if (! empty($pan_name) && $this->notice_collection->has($pan_name)) {
-            /** @var PersistentAdminNotice $persistent_admin_notice */
-            $persistent_admin_notice = $this->notice_collection->get($pan_name);
-            $persistent_admin_notice->setDismissed(true);
-            $persistent_admin_notice->setPurge($purge);
-            $this->saveNotices();
-        }
-        if ($return) {
-            return;
-        }
-        if ($this->request->isAjax()) {
-            // grab any notices and concatenate into string
-            echo wp_json_encode(
-                array(
-                    'errors' => implode('<br />', EE_Error::get_notices(false)),
-                )
-            );
-            exit();
-        }
-        // save errors to a transient to be displayed on next request (after redirect)
-        EE_Error::get_notices(false, true);
-        wp_safe_redirect(
-            urldecode(
-                $this->request->getRequestParam('return_url', '')
-            )
-        );
-    }
-
-
-    /**
-     * saveNotices
-     *
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidEntityException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function saveNotices()
-    {
-        $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if ($this->notice_collection->hasObjects()) {
-            $persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
-            // maybe initialize persistent_admin_notices
-            if (empty($persistent_admin_notices)) {
-                add_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array(), '', 'no');
-            }
-            foreach ($this->notice_collection as $persistent_admin_notice) {
-                // are we deleting this notice ?
-                if ($persistent_admin_notice->getPurge()) {
-                    unset($persistent_admin_notices[ $persistent_admin_notice->getName() ]);
-                } else {
-                    /** @var PersistentAdminNotice $persistent_admin_notice */
-                    $persistent_admin_notices[ $persistent_admin_notice->getName() ] = array(
-                        'message'     => $persistent_admin_notice->getMessage(),
-                        'capability'  => $persistent_admin_notice->getCapability(),
-                        'cap_context' => $persistent_admin_notice->getCapContext(),
-                        'dismissed'   => $persistent_admin_notice->getDismissed(),
-                    );
-                }
-            }
-            update_option(PersistentAdminNoticeManager::WP_OPTION_KEY, $persistent_admin_notices);
-        }
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function registerAndSaveNotices()
-    {
-        $this->getPersistentAdminNoticeCollection();
-        $this->registerNotices();
-        $this->saveNotices();
-        add_filter(
-            'PersistentAdminNoticeManager__registerAndSaveNotices__complete',
-            '__return_true'
-        );
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public static function loadRegisterAndSaveNotices()
-    {
-        /** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
-        $persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-        );
-        // if shutdown has already run, then call registerAndSaveNotices() manually
-        if (did_action('shutdown')) {
-            $persistent_admin_notice_manager->registerAndSaveNotices();
-        }
-    }
+	const WP_OPTION_KEY = 'ee_pers_admin_notices';
+
+	/**
+	 * @var Collection|PersistentAdminNotice[] $notice_collection
+	 */
+	private $notice_collection;
+
+	/**
+	 * if AJAX is not enabled, then the return URL will be used for redirecting back to the admin page where the
+	 * persistent admin notice was displayed, and ultimately dismissed from.
+	 *
+	 * @var string $return_url
+	 */
+	private $return_url;
+
+	/**
+	 * @var CapabilitiesChecker $capabilities_checker
+	 */
+	private $capabilities_checker;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+
+	/**
+	 * PersistentAdminNoticeManager constructor
+	 *
+	 * @param string              $return_url where to  redirect to after dismissing notices
+	 * @param CapabilitiesChecker $capabilities_checker
+	 * @param RequestInterface          $request
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct($return_url = '', CapabilitiesChecker $capabilities_checker, RequestInterface $request)
+	{
+		$this->setReturnUrl($return_url);
+		$this->capabilities_checker = $capabilities_checker;
+		$this->request = $request;
+		// setup up notices at priority 9 because `EE_Admin::display_admin_notices()` runs at priority 10,
+		// and we want to retrieve and generate any nag notices at the last possible moment
+		add_action('admin_notices', array($this, 'displayNotices'), 9);
+		add_action('network_admin_notices', array($this, 'displayNotices'), 9);
+		add_action('wp_ajax_dismiss_ee_nag_notice', array($this, 'dismissNotice'));
+		add_action('shutdown', array($this, 'registerAndSaveNotices'), 998);
+	}
+
+
+	/**
+	 * @param string $return_url
+	 * @throws InvalidDataTypeException
+	 */
+	public function setReturnUrl($return_url)
+	{
+		if (! is_string($return_url)) {
+			throw new InvalidDataTypeException('$return_url', $return_url, 'string');
+		}
+		$this->return_url = $return_url;
+	}
+
+
+	/**
+	 * @return Collection
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	protected function getPersistentAdminNoticeCollection()
+	{
+		if (! $this->notice_collection instanceof Collection) {
+			$this->notice_collection = new Collection(
+				'EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
+			);
+			$this->retrieveStoredNotices();
+			$this->registerNotices();
+		}
+		return $this->notice_collection;
+	}
+
+
+	/**
+	 * generates PersistentAdminNotice objects for all non-dismissed notices saved to the db
+	 *
+	 * @return void
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	protected function retrieveStoredNotices()
+	{
+		$persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
+		if (! empty($persistent_admin_notices)) {
+			foreach ($persistent_admin_notices as $name => $details) {
+				if (is_array($details)) {
+					if (! isset(
+						$details['message'],
+						$details['capability'],
+						$details['cap_context'],
+						$details['dismissed']
+					)) {
+						throw new DomainException(
+							sprintf(
+								esc_html__(
+									'The "%1$s" PersistentAdminNotice could not be retrieved from the database.',
+									'event_espresso'
+								),
+								$name
+							)
+						);
+					}
+					// new format for nag notices
+					$this->notice_collection->add(
+						new PersistentAdminNotice(
+							$name,
+							$details['message'],
+							false,
+							$details['capability'],
+							$details['cap_context'],
+							$details['dismissed']
+						),
+						sanitize_key($name)
+					);
+				} else {
+					try {
+						// old nag notices, that we want to convert to the new format
+						$this->notice_collection->add(
+							new PersistentAdminNotice(
+								$name,
+								(string) $details,
+								false,
+								'',
+								'',
+								empty($details)
+							),
+							sanitize_key($name)
+						);
+					} catch (Exception $e) {
+						EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+					}
+				}
+				// each notice will self register when the action hook in registerNotices is triggered
+			}
+		}
+	}
+
+
+	/**
+	 * exposes the Persistent Admin Notice Collection via an action
+	 * so that PersistentAdminNotice objects can be added and/or removed
+	 * without compromising the actual collection like a filter would
+	 */
+	protected function registerNotices()
+	{
+		do_action(
+			'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices',
+			$this->notice_collection
+		);
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidEntityException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function displayNotices()
+	{
+		$this->notice_collection = $this->getPersistentAdminNoticeCollection();
+		if ($this->notice_collection->hasObjects()) {
+			$enqueue_assets = false;
+			// and display notices
+			foreach ($this->notice_collection as $persistent_admin_notice) {
+				/** @var PersistentAdminNotice $persistent_admin_notice */
+				// don't display notices that have already been dismissed
+				if ($persistent_admin_notice->getDismissed()) {
+					continue;
+				}
+				try {
+					$this->capabilities_checker->processCapCheck(
+						$persistent_admin_notice->getCapCheck()
+					);
+				} catch (InsufficientPermissionsException $e) {
+					// user does not have required cap, so skip to next notice
+					// and just eat the exception - nom nom nom nom
+					continue;
+				}
+				if ($persistent_admin_notice->getMessage() === '') {
+					continue;
+				}
+				$this->displayPersistentAdminNotice($persistent_admin_notice);
+				$enqueue_assets = true;
+			}
+			if ($enqueue_assets) {
+				$this->enqueueAssets();
+			}
+		}
+	}
+
+
+	/**
+	 * does what it's named
+	 *
+	 * @return void
+	 */
+	public function enqueueAssets()
+	{
+		wp_register_script(
+			'espresso_core',
+			EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+			array('jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_script(
+			'ee_error_js',
+			EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+			array('espresso_core'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script(
+			'ee_error_js',
+			'ee_dismiss',
+			array(
+				'return_url'    => urlencode($this->return_url),
+				'ajax_url'      => WP_AJAX_URL,
+				'unknown_error' => wp_strip_all_tags(
+					__(
+						'An unknown error has occurred on the server while attempting to dismiss this notice.',
+						'event_espresso'
+					)
+				),
+			)
+		);
+		wp_enqueue_script('ee_error_js');
+	}
+
+
+	/**
+	 * displayPersistentAdminNoticeHtml
+	 *
+	 * @param  PersistentAdminNotice $persistent_admin_notice
+	 */
+	protected function displayPersistentAdminNotice(PersistentAdminNotice $persistent_admin_notice)
+	{
+		// used in template
+		$persistent_admin_notice_name = $persistent_admin_notice->getName();
+		$persistent_admin_notice_message = $persistent_admin_notice->getMessage();
+		require EE_TEMPLATES . '/notifications/persistent_admin_notice.template.php';
+	}
+
+
+	/**
+	 * dismissNotice
+	 *
+	 * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
+	 * @param bool   $purge    if true, then delete it from the db
+	 * @param bool   $return   forget all of this AJAX or redirect nonsense, and just return
+	 * @return void
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function dismissNotice($pan_name = '', $purge = false, $return = false)
+	{
+		$pan_name = $this->request->getRequestParam('ee_nag_notice', $pan_name);
+		$this->notice_collection = $this->getPersistentAdminNoticeCollection();
+		if (! empty($pan_name) && $this->notice_collection->has($pan_name)) {
+			/** @var PersistentAdminNotice $persistent_admin_notice */
+			$persistent_admin_notice = $this->notice_collection->get($pan_name);
+			$persistent_admin_notice->setDismissed(true);
+			$persistent_admin_notice->setPurge($purge);
+			$this->saveNotices();
+		}
+		if ($return) {
+			return;
+		}
+		if ($this->request->isAjax()) {
+			// grab any notices and concatenate into string
+			echo wp_json_encode(
+				array(
+					'errors' => implode('<br />', EE_Error::get_notices(false)),
+				)
+			);
+			exit();
+		}
+		// save errors to a transient to be displayed on next request (after redirect)
+		EE_Error::get_notices(false, true);
+		wp_safe_redirect(
+			urldecode(
+				$this->request->getRequestParam('return_url', '')
+			)
+		);
+	}
+
+
+	/**
+	 * saveNotices
+	 *
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidEntityException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function saveNotices()
+	{
+		$this->notice_collection = $this->getPersistentAdminNoticeCollection();
+		if ($this->notice_collection->hasObjects()) {
+			$persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
+			// maybe initialize persistent_admin_notices
+			if (empty($persistent_admin_notices)) {
+				add_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array(), '', 'no');
+			}
+			foreach ($this->notice_collection as $persistent_admin_notice) {
+				// are we deleting this notice ?
+				if ($persistent_admin_notice->getPurge()) {
+					unset($persistent_admin_notices[ $persistent_admin_notice->getName() ]);
+				} else {
+					/** @var PersistentAdminNotice $persistent_admin_notice */
+					$persistent_admin_notices[ $persistent_admin_notice->getName() ] = array(
+						'message'     => $persistent_admin_notice->getMessage(),
+						'capability'  => $persistent_admin_notice->getCapability(),
+						'cap_context' => $persistent_admin_notice->getCapContext(),
+						'dismissed'   => $persistent_admin_notice->getDismissed(),
+					);
+				}
+			}
+			update_option(PersistentAdminNoticeManager::WP_OPTION_KEY, $persistent_admin_notices);
+		}
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function registerAndSaveNotices()
+	{
+		$this->getPersistentAdminNoticeCollection();
+		$this->registerNotices();
+		$this->saveNotices();
+		add_filter(
+			'PersistentAdminNoticeManager__registerAndSaveNotices__complete',
+			'__return_true'
+		);
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public static function loadRegisterAndSaveNotices()
+	{
+		/** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
+		$persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+		);
+		// if shutdown has already run, then call registerAndSaveNotices() manually
+		if (did_action('shutdown')) {
+			$persistent_admin_notice_manager->registerAndSaveNotices();
+		}
+	}
 }

core/admin/EE_Admin_Page_CPT.core.php

Spacing +79 added lines, -79 removed lines

@@ -164,7 +164,7 @@ 
      */
     protected function getLoader()
     {
-        if (! $this->loader instanceof LoaderInterface) {
+        if ( ! $this->loader instanceof LoaderInterface) {
             $this->loader = LoaderFactory::getLoader();
         }
         return $this->loader;
@@ -188,11 +188,11 @@ 
             $this->_cpt_routes
         );
         // let's see if the current route has a value for cpt_object_slug if it does we use that instead of the page
-        $this->_cpt_object = isset($this->_req_data['action']) && isset($this->_cpt_routes[ $this->_req_data['action'] ])
-            ? get_post_type_object($this->_cpt_routes[ $this->_req_data['action'] ])
+        $this->_cpt_object = isset($this->_req_data['action']) && isset($this->_cpt_routes[$this->_req_data['action']])
+            ? get_post_type_object($this->_cpt_routes[$this->_req_data['action']])
             : get_post_type_object($page);
         // tweak pagenow for page loading.
-        if (! $this->_pagenow_map) {
+        if ( ! $this->_pagenow_map) {
             $this->_pagenow_map = array(
                 'create_new' => 'post-new.php',
                 'edit'       => 'post.php',
@@ -226,12 +226,12 @@ 
     {
         global $pagenow, $hook_suffix;
         // possibly reset pagenow.
-        if (! empty($this->_req_data['page'])
+        if ( ! empty($this->_req_data['page'])
             && $this->_req_data['page'] == $this->page_slug
             && ! empty($this->_req_data['action'])
-            && isset($this->_pagenow_map[ $this->_req_data['action'] ])
+            && isset($this->_pagenow_map[$this->_req_data['action']])
         ) {
-            $pagenow = $this->_pagenow_map[ $this->_req_data['action'] ];
+            $pagenow = $this->_pagenow_map[$this->_req_data['action']];
             $hook_suffix = $pagenow;
         }
     }
@@ -263,7 +263,7 @@ 
         if (empty($wp_meta_boxes)) {
             return;
         }
-        $current_metaboxes = isset($wp_meta_boxes[ $this->page_slug ]) ? $wp_meta_boxes[ $this->page_slug ] : array();
+        $current_metaboxes = isset($wp_meta_boxes[$this->page_slug]) ? $wp_meta_boxes[$this->page_slug] : array();
         foreach ($current_metaboxes as $box_context) {
             foreach ($box_context as $box_details) {
                 foreach ($box_details as $box) {
@@ -296,7 +296,7 @@ 
             $this
         );
         $containers = apply_filters(
-            'FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers',
+            'FHEE__EE_Admin_Page_CPT__'.get_class($this).'___load_autosave_scripts_styles__containers',
             $containers,
             $this
         );
@@ -342,7 +342,7 @@ 
     protected function _load_page_dependencies()
     {
         // we only add stuff if this is a cpt_route!
-        if (! $this->_cpt_route) {
+        if ( ! $this->_cpt_route) {
             parent::_load_page_dependencies();
             return;
         }
@@ -366,16 +366,16 @@ 
         add_filter('pre_get_shortlink', array($this, 'add_shortlink_button_to_editor'), 10, 4);
         // This basically allows us to change the title of the "publish" metabox area
         // on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class.
-        if (! empty($this->_labels['publishbox'])) {
+        if ( ! empty($this->_labels['publishbox'])) {
             $box_label = is_array($this->_labels['publishbox'])
-                         && isset($this->_labels['publishbox'][ $this->_req_action ])
-                ? $this->_labels['publishbox'][ $this->_req_action ]
+                         && isset($this->_labels['publishbox'][$this->_req_action])
+                ? $this->_labels['publishbox'][$this->_req_action]
                 : $this->_labels['publishbox'];
             add_meta_box(
                 'submitdiv',
                 $box_label,
                 'post_submit_meta_box',
-                $this->_cpt_routes[ $this->_req_action ],
+                $this->_cpt_routes[$this->_req_action],
                 'side',
                 'core'
             );
@@ -386,7 +386,7 @@ 
                 'page_templates',
                 __('Page Template', 'event_espresso'),
                 array($this, 'page_template_meta_box'),
-                $this->_cpt_routes[ $this->_req_action ],
+                $this->_cpt_routes[$this->_req_action],
                 'side',
                 'default'
             );
@@ -418,8 +418,8 @@ 
         // This is for any plugins that are doing things properly
         // and hooking into the load page hook for core wp cpt routes.
         global $pagenow;
-        add_action('load-' . $pagenow, array($this, 'modify_current_screen'), 20);
-        do_action('load-' . $pagenow);
+        add_action('load-'.$pagenow, array($this, 'modify_current_screen'), 20);
+        do_action('load-'.$pagenow);
         add_action('admin_enqueue_scripts', array($this, 'setup_autosave_hooks'), 30);
         // we route REALLY early.
         try {
@@ -448,8 +448,8 @@ 
                 'admin.php?page=espresso_registrations&action=contact_list',
             ),
             1 => array(
-                'edit.php?post_type=' . $this->_cpt_object->name,
-                'admin.php?page=' . $this->_cpt_object->name,
+                'edit.php?post_type='.$this->_cpt_object->name,
+                'admin.php?page='.$this->_cpt_object->name,
             ),
         );
         foreach ($routes_to_match as $route_matches) {
@@ -478,7 +478,7 @@ 
             'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
         );
         $cpt_args = $custom_post_types->getDefinitions();
-        $cpt_args = isset($cpt_args[ $cpt_name ]) ? $cpt_args[ $cpt_name ]['args'] : array();
+        $cpt_args = isset($cpt_args[$cpt_name]) ? $cpt_args[$cpt_name]['args'] : array();
         $cpt_has_support = ! empty($cpt_args['page_templates']);
 
         // if the installed version of WP is > 4.7 we do some additional checks.
@@ -487,7 +487,7 @@ 
             // if there are $post_templates for this cpt, then we return false for this method because
             // that means we aren't going to load our page template manager and leave that up to the native
             // cpt template manager.
-            $cpt_has_support = ! isset($post_templates[ $cpt_name ]) ? $cpt_has_support : false;
+            $cpt_has_support = ! isset($post_templates[$cpt_name]) ? $cpt_has_support : false;
         }
 
         return $cpt_has_support;
@@ -561,7 +561,7 @@ 
 
         $statuses = $this->_cpt_model_obj->get_custom_post_statuses();
         $cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses)
-            ? $statuses[ $this->_cpt_model_obj->status() ]
+            ? $statuses[$this->_cpt_model_obj->status()]
             : '';
         $template_args = array(
             'cur_status'            => $this->_cpt_model_obj->status(),
@@ -576,7 +576,7 @@ 
             $template_args['statuses'] = $statuses;
         }
 
-        $template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php';
+        $template = EE_ADMIN_TEMPLATE.'status_dropdown.template.php';
         EEH_Template::display_template($template, $template_args);
     }
 
@@ -617,7 +617,7 @@ 
             : null;
         $this->_verify_nonce($nonce, 'autosave');
         // make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it)
-        if (! defined('DOING_AUTOSAVE')) {
+        if ( ! defined('DOING_AUTOSAVE')) {
             define('DOING_AUTOSAVE', true);
         }
         // if we made it here then the nonce checked out.  Let's run our methods and actions
@@ -628,7 +628,7 @@ 
             $this->_template_args['success'] = true;
         }
         do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this);
-        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this);
+        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_'.get_class($this), $this);
         // now let's return json
         $this->_return_json();
     }
@@ -650,7 +650,7 @@ 
             return;
         }
         // set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes
-        if (! empty($this->_cpt_object)) {
+        if ( ! empty($this->_cpt_object)) {
             $this->_page_routes = array_merge(
                 array(
                     'create_new' => '_create_new_cpt_item',
@@ -681,10 +681,10 @@ 
             );
         }
         // load the next section only if this is a matching cpt route as set in the cpt routes array.
-        if (! isset($this->_cpt_routes[ $this->_req_action ])) {
+        if ( ! isset($this->_cpt_routes[$this->_req_action])) {
             return;
         }
-        $this->_cpt_route = isset($this->_cpt_routes[ $this->_req_action ]) ? true : false;
+        $this->_cpt_route = isset($this->_cpt_routes[$this->_req_action]) ? true : false;
         // add_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', array( $this, 'modify_current_screen') );
         if (empty($this->_cpt_object)) {
             $msg = sprintf(
@@ -724,7 +724,7 @@ 
         if (empty($this->_cpt_model_names)
             || (
                 ! $ignore_route_check
-                && ! isset($this->_cpt_routes[ $this->_req_action ])
+                && ! isset($this->_cpt_routes[$this->_req_action])
             ) || (
                 $this->_cpt_model_obj instanceof EE_CPT_Base
                 && $this->_cpt_model_obj->ID() === $id
@@ -741,11 +741,11 @@ 
                 'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
             );
             $model_names = $custom_post_types->getCustomPostTypeModelNames($post_type);
-            if (isset($model_names[ $post_type ])) {
-                $model = EE_Registry::instance()->load_model($model_names[ $post_type ]);
+            if (isset($model_names[$post_type])) {
+                $model = EE_Registry::instance()->load_model($model_names[$post_type]);
             }
         } else {
-            $model = EE_Registry::instance()->load_model($this->_cpt_model_names[ $this->_req_action ]);
+            $model = EE_Registry::instance()->load_model($this->_cpt_model_names[$this->_req_action]);
         }
         if ($model instanceof EEM_Base) {
             $this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object();
@@ -775,8 +775,8 @@ 
         $current_route = isset($this->_req_data['current_route'])
             ? $this->_req_data['current_route']
             : 'shouldneverwork';
-        $route_to_check = $post_type && isset($this->_cpt_routes[ $current_route ])
-            ? $this->_cpt_routes[ $current_route ]
+        $route_to_check = $post_type && isset($this->_cpt_routes[$current_route])
+            ? $this->_cpt_routes[$current_route]
             : '';
         add_filter('get_delete_post_link', array($this, 'modify_delete_post_link'), 10, 3);
         add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 3);
@@ -785,10 +785,10 @@ 
         }
         // now let's filter redirect if we're on a revision page and the revision is for an event CPT.
         $revision = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null;
-        if (! empty($revision)) {
+        if ( ! empty($revision)) {
             $action = isset($this->_req_data['action']) ? $this->_req_data['action'] : null;
             // doing a restore?
-            if (! empty($action) && $action === 'restore') {
+            if ( ! empty($action) && $action === 'restore') {
                 // get post for revision
                 $rev_post = get_post($revision);
                 $rev_parent = get_post($rev_post->post_parent);
@@ -824,7 +824,7 @@ 
     {
         $this->_set_model_object($post_id, true, 'trash');
         // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
             return;
         }
         $this->trash_cpt_item($post_id);
@@ -842,7 +842,7 @@ 
     {
         $this->_set_model_object($post_id, true, 'restore');
         // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
             return;
         }
         $this->restore_cpt_item($post_id);
@@ -860,7 +860,7 @@ 
     {
         $this->_set_model_object($post_id, true, 'delete');
         // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
             return;
         }
         $this->delete_cpt_item($post_id);
@@ -879,7 +879,7 @@ 
     {
         $label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label;
         // verify event object
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base) {
+        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -935,13 +935,13 @@ 
         if ($this->_cpt_model_obj instanceof EE_CPT_Base) {
             // setup custom post status object for localize script but only if we've got a cpt object
             $statuses = $this->_cpt_model_obj->get_custom_post_statuses();
-            if (! empty($statuses)) {
+            if ( ! empty($statuses)) {
                 // get ALL statuses!
                 $statuses = $this->_cpt_model_obj->get_all_post_statuses();
                 // setup object
                 $ee_cpt_statuses = array();
                 foreach ($statuses as $status => $label) {
-                    $ee_cpt_statuses[ $status ] = array(
+                    $ee_cpt_statuses[$status] = array(
                         'label'      => $label,
                         'save_label' => sprintf(
                             wp_strip_all_tags(__('Save as %s', 'event_espresso')),
@@ -1006,7 +1006,7 @@ 
                 $post->page_template = $this->_req_data['page_template'];
                 $page_templates = wp_get_theme()->get_page_templates($post);
             }
-            if ('default' != $this->_req_data['page_template'] && ! isset($page_templates[ $this->_req_data['page_template'] ])) {
+            if ('default' != $this->_req_data['page_template'] && ! isset($page_templates[$this->_req_data['page_template']])) {
                 EE_Error::add_error(__('Invalid Page Template.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
             } else {
                 update_post_meta($post_id, '_wp_page_template', $this->_req_data['page_template']);
@@ -1031,7 +1031,7 @@ 
     {
         // only do this if we're actually processing one of our CPTs
         // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base) {
+        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) {
             return;
         }
         delete_post_meta($post_id, '_wp_trash_meta_status');
@@ -1056,7 +1056,7 @@ 
         // global action
         do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id);
         // class specific action so you can limit hooking into a specific page.
-        do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id);
+        do_action('AHEE_EE_Admin_Page_CPT_'.get_class($this).'__restore_revision', $post_id, $revision_id);
     }
 
 
@@ -1083,11 +1083,11 @@ 
     public function modify_current_screen()
     {
         // ONLY do this if the current page_route IS a cpt route
-        if (! $this->_cpt_route) {
+        if ( ! $this->_cpt_route) {
             return;
         }
         // routing things REALLY early b/c this is a cpt admin page
-        set_current_screen($this->_cpt_routes[ $this->_req_action ]);
+        set_current_screen($this->_cpt_routes[$this->_req_action]);
         $this->_current_screen = get_current_screen();
         $this->_current_screen->base = 'event-espresso';
         $this->_add_help_tabs(); // we make sure we add any help tabs back in!
@@ -1110,8 +1110,8 @@ 
      */
     public function add_custom_editor_default_title($title)
     {
-        return isset($this->_labels['editor_title'][ $this->_cpt_routes[ $this->_req_action ] ])
-            ? $this->_labels['editor_title'][ $this->_cpt_routes[ $this->_req_action ] ]
+        return isset($this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]])
+            ? $this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]]
             : $title;
     }
 
@@ -1127,10 +1127,10 @@ 
      */
     public function add_shortlink_button_to_editor($shortlink, $id, $context, $allow_slugs)
     {
-        if (! empty($id) && get_option('permalink_structure') !== '') {
+        if ( ! empty($id) && get_option('permalink_structure') !== '') {
             $post = get_post($id);
             if (isset($post->post_type) && $this->page_slug === $post->post_type) {
-                $shortlink = home_url('?p=' . $post->ID);
+                $shortlink = home_url('?p='.$post->ID);
             }
         }
         return $shortlink;
@@ -1163,11 +1163,11 @@ 
      */
     public function cpt_post_form_hidden_input()
     {
-        echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="' . $this->_admin_base_url . '" />';
+        echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="'.$this->_admin_base_url.'" />';
         // we're also going to add the route value and the current page so we can direct autosave parsing correctly
         echo '<div id="ee-cpt-hidden-inputs">';
-        echo '<input type="hidden" id="current_route" name="current_route" value="' . $this->_current_view . '" />';
-        echo '<input type="hidden" id="current_page" name="current_page" value="' . $this->page_slug . '" />';
+        echo '<input type="hidden" id="current_route" name="current_route" value="'.$this->_current_view.'" />';
+        echo '<input type="hidden" id="current_page" name="current_page" value="'.$this->page_slug.'" />';
         echo '</div>';
     }
 
@@ -1212,15 +1212,15 @@ 
     public function modify_edit_post_link($link, $id, $context)
     {
         $post = get_post($id);
-        if (! isset($this->_req_data['action'])
-            || ! isset($this->_cpt_routes[ $this->_req_data['action'] ])
-            || $post->post_type !== $this->_cpt_routes[ $this->_req_data['action'] ]
+        if ( ! isset($this->_req_data['action'])
+            || ! isset($this->_cpt_routes[$this->_req_data['action']])
+            || $post->post_type !== $this->_cpt_routes[$this->_req_data['action']]
         ) {
             return $link;
         }
         $query_args = array(
-            'action' => isset($this->_cpt_edit_routes[ $post->post_type ])
-                ? $this->_cpt_edit_routes[ $post->post_type ]
+            'action' => isset($this->_cpt_edit_routes[$post->post_type])
+                ? $this->_cpt_edit_routes[$post->post_type]
                 : 'edit',
             'post'   => $id,
         );
@@ -1243,16 +1243,16 @@ 
         $post = get_post($post_id);
 
         if (empty($this->_req_data['action'])
-            || ! isset($this->_cpt_routes[ $this->_req_data['action'] ])
+            || ! isset($this->_cpt_routes[$this->_req_data['action']])
             || ! $post instanceof WP_Post
-            || $post->post_type !== $this->_cpt_routes[ $this->_req_data['action'] ]
+            || $post->post_type !== $this->_cpt_routes[$this->_req_data['action']]
         ) {
             return $delete_link;
         }
         $this->_set_model_object($post->ID, true);
 
         // returns something like `trash_event` or `trash_attendee` or `trash_venue`
-        $action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
+        $action = 'trash_'.str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
 
         return EE_Admin_Page::add_query_args_and_nonce(
             array(
@@ -1280,7 +1280,7 @@ 
         // we DO have a match so let's setup the url
         // we have to get the post to determine our route
         $post = get_post($post_id);
-        $edit_route = $this->_cpt_edit_routes[ $post->post_type ];
+        $edit_route = $this->_cpt_edit_routes[$post->post_type];
         // shared query_args
         $query_args = array('action' => $edit_route, 'post' => $post_id);
         $admin_url = $this->_admin_base_url;
@@ -1352,12 +1352,12 @@ 
         /*$current_route = isset($this->_req_data['current_route']) ? $this->_req_data['current_route'] : 'shouldneverwork';
 
         $route_to_check = $post_type && isset( $this->_cpt_routes[$current_route]) ? $this->_cpt_routes[$current_route] : '';/**/
-        $messages[ $post->post_type ] = array(
+        $messages[$post->post_type] = array(
             0  => '', // Unused. Messages start at index 1.
             1  => sprintf(
                 __('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
+                '<a href="'.esc_url(get_permalink($id)).'">',
                 '</a>'
             ),
             2  => __('Custom field updated', 'event_espresso'),
@@ -1372,27 +1372,27 @@ 
             6  => sprintf(
                 __('%1$s published. %2$sView %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
+                '<a href="'.esc_url(get_permalink($id)).'">',
                 '</a>'
             ),
             7  => sprintf(__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
             8  => sprintf(
                 __('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">',
+                '<a target="_blank" href="'.esc_url(add_query_arg('preview', 'true', get_permalink($id))).'">',
                 '</a>'
             ),
             9  => sprintf(
                 __('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<strong>' . date_i18n('M j, Y @ G:i', strtotime($post->post_date)) . '</strong>',
-                '<a target="_blank" href="' . esc_url(get_permalink($id)),
+                '<strong>'.date_i18n('M j, Y @ G:i', strtotime($post->post_date)).'</strong>',
+                '<a target="_blank" href="'.esc_url(get_permalink($id)),
                 '</a>'
             ),
             10 => sprintf(
                 __('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))),
+                '<a target="_blank" href="'.esc_url(add_query_arg('preview', 'true', get_permalink($id))),
                 '</a>'
             ),
         );
@@ -1411,10 +1411,10 @@ 
     {
         // gather template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
         global $post, $title, $is_IE, $post_type, $post_type_object;
-        $post_type = $this->_cpt_routes[ $this->_req_action ];
+        $post_type = $this->_cpt_routes[$this->_req_action];
         $post_type_object = $this->_cpt_object;
         $title = $post_type_object->labels->add_new_item;
-        $post = $post = get_default_post_to_edit($this->_cpt_routes[ $this->_req_action ], true);
+        $post = $post = get_default_post_to_edit($this->_cpt_routes[$this->_req_action], true);
         add_action('admin_print_styles', array($this, 'add_new_admin_page_global'));
         // modify the default editor title field with default title.
         add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10);
@@ -1439,8 +1439,8 @@ 
             if ($creating) {
                 wp_enqueue_script('autosave');
             } else {
-                if (isset($this->_cpt_routes[ $this->_req_data['action'] ])
-                    && ! isset($this->_labels['hide_add_button_on_cpt_route'][ $this->_req_data['action'] ])
+                if (isset($this->_cpt_routes[$this->_req_data['action']])
+                    && ! isset($this->_labels['hide_add_button_on_cpt_route'][$this->_req_data['action']])
                 ) {
                     $create_new_action = apply_filters(
                         'FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action',
@@ -1456,7 +1456,7 @@ 
                     );
                 }
             }
-            include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
+            include_once WP_ADMIN_PATH.'edit-form-advanced.php';
         }
     }
 
@@ -1487,21 +1487,21 @@ 
         if (empty($post)) {
             wp_die(__('You attempted to edit an item that doesn&#8217;t exist. Perhaps it was deleted?', 'event_espresso'));
         }
-        if (! empty($_GET['get-post-lock'])) {
+        if ( ! empty($_GET['get-post-lock'])) {
             wp_set_post_lock($post_id);
             wp_redirect(get_edit_post_link($post_id, 'url'));
             exit();
         }
 
         // template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
-        $post_type = $this->_cpt_routes[ $this->_req_action ];
+        $post_type = $this->_cpt_routes[$this->_req_action];
         $post_type_object = $this->_cpt_object;
 
-        if (! wp_check_post_lock($post->ID)) {
+        if ( ! wp_check_post_lock($post->ID)) {
             wp_set_post_lock($post->ID);
         }
         add_action('admin_footer', '_admin_notice_post_locked');
-        if (post_type_supports($this->_cpt_routes[ $this->_req_action ], 'comments')) {
+        if (post_type_supports($this->_cpt_routes[$this->_req_action], 'comments')) {
             wp_enqueue_script('admin-comments');
             enqueue_comment_hotkeys_js();
         }

Indentation +1469 added lines, -1469 removed lines

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

modules/batch/EED_Batch.module.php

Indentation +332 added lines, -332 removed lines

@@ -29,360 +29,360 @@
 class EED_Batch extends EED_Module
 {
 
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
-     * processes data only
-     */
-    const batch_job = 'job';
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
-     * produces a file for download
-     */
-    const batch_file_job = 'file';
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates this request is NOT
-     * for a batch job. It's the same as not providing the $_REQUEST[ 'batch' ]
-     * at all
-     */
-    const batch_not_job = 'none';
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
+	 * processes data only
+	 */
+	const batch_job = 'job';
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
+	 * produces a file for download
+	 */
+	const batch_file_job = 'file';
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates this request is NOT
+	 * for a batch job. It's the same as not providing the $_REQUEST[ 'batch' ]
+	 * at all
+	 */
+	const batch_not_job = 'none';
 
-    /**
-     *
-     * @var string 'file', or 'job', or false to indicate its not a batch request at all
-     */
-    protected $_batch_request_type = null;
+	/**
+	 *
+	 * @var string 'file', or 'job', or false to indicate its not a batch request at all
+	 */
+	protected $_batch_request_type = null;
 
-    /**
-     * Because we want to use the response in both the localized JS and in the body
-     * we need to make this response available between method calls
-     *
-     * @var \EventEspressoBatchRequest\Helpers\JobStepResponse
-     */
-    protected $_job_step_response = null;
+	/**
+	 * Because we want to use the response in both the localized JS and in the body
+	 * we need to make this response available between method calls
+	 *
+	 * @var \EventEspressoBatchRequest\Helpers\JobStepResponse
+	 */
+	protected $_job_step_response = null;
 
-    /**
-     * @var LoaderInterface
-     */
-    protected $loader;
+	/**
+	 * @var LoaderInterface
+	 */
+	protected $loader;
 
-    /**
-     * Gets the batch instance
-     *
-     * @return EED_Batch
-     */
-    public static function instance()
-    {
-        return self::get_instance();
-    }
+	/**
+	 * Gets the batch instance
+	 *
+	 * @return EED_Batch
+	 */
+	public static function instance()
+	{
+		return self::get_instance();
+	}
 
-    /**
-     * Sets hooks to enable batch jobs on the frontend. Disabled by default
-     * because it's an attack vector and there are currently no implementations
-     */
-    public static function set_hooks()
-    {
-        // because this is a possibel attack vector, let's have this disabled until
-        // we at least have a real use for it on the frontend
-        if (apply_filters('FHEE__EED_Batch__set_hooks__enable_frontend_batch', false)) {
-            add_action('wp_enqueue_scripts', array(self::instance(), 'enqueue_scripts'));
-            add_filter('template_include', array(self::instance(), 'override_template'), 99);
-        }
-    }
+	/**
+	 * Sets hooks to enable batch jobs on the frontend. Disabled by default
+	 * because it's an attack vector and there are currently no implementations
+	 */
+	public static function set_hooks()
+	{
+		// because this is a possibel attack vector, let's have this disabled until
+		// we at least have a real use for it on the frontend
+		if (apply_filters('FHEE__EED_Batch__set_hooks__enable_frontend_batch', false)) {
+			add_action('wp_enqueue_scripts', array(self::instance(), 'enqueue_scripts'));
+			add_filter('template_include', array(self::instance(), 'override_template'), 99);
+		}
+	}
 
-    /**
-     * Initializes some hooks for the admin in order to run batch jobs
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('admin_menu', array(self::instance(), 'register_admin_pages'));
-        add_action('admin_enqueue_scripts', array(self::instance(), 'enqueue_scripts'));
+	/**
+	 * Initializes some hooks for the admin in order to run batch jobs
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('admin_menu', array(self::instance(), 'register_admin_pages'));
+		add_action('admin_enqueue_scripts', array(self::instance(), 'enqueue_scripts'));
 
-        // ajax
-        add_action('wp_ajax_espresso_batch_continue', array(self::instance(), 'batch_continue'));
-        add_action('wp_ajax_espresso_batch_cleanup', array(self::instance(), 'batch_cleanup'));
-        add_action('wp_ajax_nopriv_espresso_batch_continue', array(self::instance(), 'batch_continue'));
-        add_action('wp_ajax_nopriv_espresso_batch_cleanup', array(self::instance(), 'batch_cleanup'));
-    }
+		// ajax
+		add_action('wp_ajax_espresso_batch_continue', array(self::instance(), 'batch_continue'));
+		add_action('wp_ajax_espresso_batch_cleanup', array(self::instance(), 'batch_cleanup'));
+		add_action('wp_ajax_nopriv_espresso_batch_continue', array(self::instance(), 'batch_continue'));
+		add_action('wp_ajax_nopriv_espresso_batch_cleanup', array(self::instance(), 'batch_cleanup'));
+	}
 
-    /**
-     * @since 4.9.80.p
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getLoader()
-    {
-        if (!$this->loader instanceof LoaderInterface) {
-            $this->loader = LoaderFactory::getLoader();
-        }
-        return $this->loader;
-    }
+	/**
+	 * @since 4.9.80.p
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getLoader()
+	{
+		if (!$this->loader instanceof LoaderInterface) {
+			$this->loader = LoaderFactory::getLoader();
+		}
+		return $this->loader;
+	}
 
-    /**
-     * Enqueues batch scripts on the frontend or admin, and creates a job
-     */
-    public function enqueue_scripts()
-    {
-        if (isset($_REQUEST['espresso_batch'])
-            ||
-            (
-                isset($_REQUEST['page'])
-                && $_REQUEST['page'] == 'espresso_batch'
-            )
-        ) {
-            if (! isset($_REQUEST['default_nonce']) || ! wp_verify_nonce($_REQUEST['default_nonce'], 'default_nonce')) {
-                wp_die(esc_html__('The link you clicked to start the batch job has expired. Please go back and refresh the previous page.', 'event_espresso'));
-            }
-            switch ($this->batch_request_type()) {
-                case self::batch_job:
-                    $this->enqueue_scripts_styles_batch_create();
-                    break;
-                case self::batch_file_job:
-                    $this->enqueue_scripts_styles_batch_file_create();
-                    break;
-            }
-        }
-    }
+	/**
+	 * Enqueues batch scripts on the frontend or admin, and creates a job
+	 */
+	public function enqueue_scripts()
+	{
+		if (isset($_REQUEST['espresso_batch'])
+			||
+			(
+				isset($_REQUEST['page'])
+				&& $_REQUEST['page'] == 'espresso_batch'
+			)
+		) {
+			if (! isset($_REQUEST['default_nonce']) || ! wp_verify_nonce($_REQUEST['default_nonce'], 'default_nonce')) {
+				wp_die(esc_html__('The link you clicked to start the batch job has expired. Please go back and refresh the previous page.', 'event_espresso'));
+			}
+			switch ($this->batch_request_type()) {
+				case self::batch_job:
+					$this->enqueue_scripts_styles_batch_create();
+					break;
+				case self::batch_file_job:
+					$this->enqueue_scripts_styles_batch_file_create();
+					break;
+			}
+		}
+	}
 
-    /**
-     * Create a batch job, enqueues a script to run it, and localizes some data for it
-     */
-    public function enqueue_scripts_styles_batch_create()
-    {
-        $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
-        wp_enqueue_script(
-            'batch_runner_init',
-            BATCH_URL . 'assets/batch_runner_init.js',
-            array('batch_runner'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script('batch_runner_init', 'ee_job_response', $job_response->to_array());
-        wp_localize_script(
-            'batch_runner_init',
-            'ee_job_i18n',
-            array(
-                'return_url' => $_REQUEST['return_url'],
-            )
-        );
-    }
+	/**
+	 * Create a batch job, enqueues a script to run it, and localizes some data for it
+	 */
+	public function enqueue_scripts_styles_batch_create()
+	{
+		$job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
+		wp_enqueue_script(
+			'batch_runner_init',
+			BATCH_URL . 'assets/batch_runner_init.js',
+			array('batch_runner'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script('batch_runner_init', 'ee_job_response', $job_response->to_array());
+		wp_localize_script(
+			'batch_runner_init',
+			'ee_job_i18n',
+			array(
+				'return_url' => $_REQUEST['return_url'],
+			)
+		);
+	}
 
-    /**
-     * Creates a batch job which will download a file, enqueues a script to run the job, and localizes some data for it
-     */
-    public function enqueue_scripts_styles_batch_file_create()
-    {
-        // creates a job based on the request variable
-        $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
-        wp_enqueue_script(
-            'batch_file_runner_init',
-            BATCH_URL . 'assets/batch_file_runner_init.js',
-            array('batch_runner'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script('batch_file_runner_init', 'ee_job_response', $job_response->to_array());
-        wp_localize_script(
-            'batch_file_runner_init',
-            'ee_job_i18n',
-            array(
-                'download_and_redirecting' => sprintf(
-                    wp_strip_all_tags(
-                        __('File Generation complete. Downloading, and %1$sredirecting%2$s...', 'event_espresso')
-                    ),
-                    '<a href="' . $_REQUEST['return_url'] . '">',
-                    '</a>'
-                ),
-                'return_url'               => $_REQUEST['return_url'],
-            )
-        );
-    }
+	/**
+	 * Creates a batch job which will download a file, enqueues a script to run the job, and localizes some data for it
+	 */
+	public function enqueue_scripts_styles_batch_file_create()
+	{
+		// creates a job based on the request variable
+		$job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
+		wp_enqueue_script(
+			'batch_file_runner_init',
+			BATCH_URL . 'assets/batch_file_runner_init.js',
+			array('batch_runner'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script('batch_file_runner_init', 'ee_job_response', $job_response->to_array());
+		wp_localize_script(
+			'batch_file_runner_init',
+			'ee_job_i18n',
+			array(
+				'download_and_redirecting' => sprintf(
+					wp_strip_all_tags(
+						__('File Generation complete. Downloading, and %1$sredirecting%2$s...', 'event_espresso')
+					),
+					'<a href="' . $_REQUEST['return_url'] . '">',
+					'</a>'
+				),
+				'return_url'               => $_REQUEST['return_url'],
+			)
+		);
+	}
 
-    /**
-     * Enqueues scripts and styles common to any batch job, and creates
-     * a job from the request data, and stores the response in the
-     * $this->_job_step_response property
-     *
-     * @return \EventEspressoBatchRequest\Helpers\JobStepResponse
-     */
-    protected function _enqueue_batch_job_scripts_and_styles_and_start_job()
-    {
-        // just copy the bits of EE admin's eei18n that we need in the JS
-        EE_Registry::$i18n_js_strings['batchJobError'] =  esc_html__(
-            'An error occurred and the job has been stopped. Please refresh the page to try again.',
-            'event_espresso'
-        );
-        wp_register_script(
-            'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js',
-            array('jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_style(
-            'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_script(
-            'batch_runner',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js',
-            array('progress_bar', CoreAssetManager::JS_HANDLE_CORE),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        $job_handler_classname = stripslashes($_GET['job_handler']);
-        $request_data = array_diff_key(
-            $_REQUEST,
-            array_flip(array('action', 'page', 'ee', 'batch'))
-        );
-        $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
-        // eg 'EventEspressoBatchRequest\JobHandlers\RegistrationsReport'
-        $job_response = $batch_runner->create_job($job_handler_classname, $request_data);
-        // remember the response for later. We need it to display the page body
-        $this->_job_step_response = $job_response;
-        return $job_response;
-    }
+	/**
+	 * Enqueues scripts and styles common to any batch job, and creates
+	 * a job from the request data, and stores the response in the
+	 * $this->_job_step_response property
+	 *
+	 * @return \EventEspressoBatchRequest\Helpers\JobStepResponse
+	 */
+	protected function _enqueue_batch_job_scripts_and_styles_and_start_job()
+	{
+		// just copy the bits of EE admin's eei18n that we need in the JS
+		EE_Registry::$i18n_js_strings['batchJobError'] =  esc_html__(
+			'An error occurred and the job has been stopped. Please refresh the page to try again.',
+			'event_espresso'
+		);
+		wp_register_script(
+			'progress_bar',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js',
+			array('jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_style(
+			'progress_bar',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_script(
+			'batch_runner',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js',
+			array('progress_bar', CoreAssetManager::JS_HANDLE_CORE),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		$job_handler_classname = stripslashes($_GET['job_handler']);
+		$request_data = array_diff_key(
+			$_REQUEST,
+			array_flip(array('action', 'page', 'ee', 'batch'))
+		);
+		$batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
+		// eg 'EventEspressoBatchRequest\JobHandlers\RegistrationsReport'
+		$job_response = $batch_runner->create_job($job_handler_classname, $request_data);
+		// remember the response for later. We need it to display the page body
+		$this->_job_step_response = $job_response;
+		return $job_response;
+	}
 
-    /**
-     * If we are doing a frontend batch job, this makes it so WP shows our template's HTML
-     *
-     * @param string $template
-     * @return string
-     */
-    public function override_template($template)
-    {
-        if (isset($_REQUEST['espresso_batch']) && isset($_REQUEST['batch'])) {
-            return EE_MODULES . 'batch/templates/batch_frontend_wrapper.template.html';
-        }
-        return $template;
-    }
+	/**
+	 * If we are doing a frontend batch job, this makes it so WP shows our template's HTML
+	 *
+	 * @param string $template
+	 * @return string
+	 */
+	public function override_template($template)
+	{
+		if (isset($_REQUEST['espresso_batch']) && isset($_REQUEST['batch'])) {
+			return EE_MODULES . 'batch/templates/batch_frontend_wrapper.template.html';
+		}
+		return $template;
+	}
 
-    /**
-     * Adds an admin page which doesn't appear in the admin menu
-     */
-    public function register_admin_pages()
-    {
-        add_submenu_page(
-            '', // parent slug. we don't want this to actually appear in the menu
-            __('Batch Job', 'event_espresso'), // page title
-            'n/a', // menu title
-            'read', // we want this page to actually be accessible to anyone,
-            'espresso_batch', // menu slug
-            array(self::instance(), 'show_admin_page')
-        );
-    }
+	/**
+	 * Adds an admin page which doesn't appear in the admin menu
+	 */
+	public function register_admin_pages()
+	{
+		add_submenu_page(
+			'', // parent slug. we don't want this to actually appear in the menu
+			__('Batch Job', 'event_espresso'), // page title
+			'n/a', // menu title
+			'read', // we want this page to actually be accessible to anyone,
+			'espresso_batch', // menu slug
+			array(self::instance(), 'show_admin_page')
+		);
+	}
 
-    /**
-     * Renders the admin page, after most of the work was already done during enqueuing scripts
-     * of creating the job and localizing some data
-     */
-    public function show_admin_page()
-    {
-        echo EEH_Template::locate_template(
-            EE_MODULES . 'batch/templates/batch_wrapper.template.html',
-            array('batch_request_type' => $this->batch_request_type())
-        );
-    }
+	/**
+	 * Renders the admin page, after most of the work was already done during enqueuing scripts
+	 * of creating the job and localizing some data
+	 */
+	public function show_admin_page()
+	{
+		echo EEH_Template::locate_template(
+			EE_MODULES . 'batch/templates/batch_wrapper.template.html',
+			array('batch_request_type' => $this->batch_request_type())
+		);
+	}
 
-    /**
-     * Receives ajax calls for continuing a job
-     */
-    public function batch_continue()
-    {
-        $job_id = sanitize_text_field($_REQUEST['job_id']);
-        $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
-        $response_obj = $batch_runner->continue_job($job_id);
-        $this->_return_json($response_obj->to_array());
-    }
+	/**
+	 * Receives ajax calls for continuing a job
+	 */
+	public function batch_continue()
+	{
+		$job_id = sanitize_text_field($_REQUEST['job_id']);
+		$batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
+		$response_obj = $batch_runner->continue_job($job_id);
+		$this->_return_json($response_obj->to_array());
+	}
 
-    /**
-     * Receives the ajax call to cleanup a job
-     *
-     * @return type
-     */
-    public function batch_cleanup()
-    {
-        $job_id = sanitize_text_field($_REQUEST['job_id']);
-        $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
-        $response_obj = $batch_runner->cleanup_job($job_id);
-        $this->_return_json($response_obj->to_array());
-    }
+	/**
+	 * Receives the ajax call to cleanup a job
+	 *
+	 * @return type
+	 */
+	public function batch_cleanup()
+	{
+		$job_id = sanitize_text_field($_REQUEST['job_id']);
+		$batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
+		$response_obj = $batch_runner->cleanup_job($job_id);
+		$this->_return_json($response_obj->to_array());
+	}
 
 
-    /**
-     * Returns a json response
-     *
-     * @param array $data The data we want to send echo via in the JSON response's "data" element
-     *
-     * The returned json object is created from an array in the following format:
-     * array(
-     *    'notices' => '', // - contains any EE_Error formatted notices
-     *    'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
-     *    We're also going to include the template args with every package (so js can pick out any specific template
-     *    args that might be included in here)
-     *    'isEEajax' => true,//indicates this is a response from EE
-     * )
-     */
-    protected function _return_json($data)
-    {
-        $json = array(
-            'notices'  => EE_Error::get_notices(),
-            'data'     => $data,
-            'isEEajax' => true
-            // special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
-        );
+	/**
+	 * Returns a json response
+	 *
+	 * @param array $data The data we want to send echo via in the JSON response's "data" element
+	 *
+	 * The returned json object is created from an array in the following format:
+	 * array(
+	 *    'notices' => '', // - contains any EE_Error formatted notices
+	 *    'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
+	 *    We're also going to include the template args with every package (so js can pick out any specific template
+	 *    args that might be included in here)
+	 *    'isEEajax' => true,//indicates this is a response from EE
+	 * )
+	 */
+	protected function _return_json($data)
+	{
+		$json = array(
+			'notices'  => EE_Error::get_notices(),
+			'data'     => $data,
+			'isEEajax' => true
+			// special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
+		);
 
 
-        // make sure there are no php errors or headers_sent.  Then we can set correct json header.
-        if (null === error_get_last() || ! headers_sent()) {
-            header('Content-Type: application/json; charset=UTF-8');
-        }
-        echo wp_json_encode($json);
-        exit();
-    }
+		// 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();
+	}
 
-    /**
-     * Gets the job step response which was done during the enqueuing of scripts
-     *
-     * @return \EventEspressoBatchRequest\Helpers\JobStepResponse
-     */
-    public function job_step_response()
-    {
-        return $this->_job_step_response;
-    }
+	/**
+	 * Gets the job step response which was done during the enqueuing of scripts
+	 *
+	 * @return \EventEspressoBatchRequest\Helpers\JobStepResponse
+	 */
+	public function job_step_response()
+	{
+		return $this->_job_step_response;
+	}
 
-    /**
-     * Gets the batch request type indicated in the $_REQUEST
-     *
-     * @return string: EED_Batch::batch_job, EED_Batch::batch_file_job, EED_Batch::batch_not_job
-     */
-    public function batch_request_type()
-    {
-        if ($this->_batch_request_type === null) {
-            if (isset($_GET['batch'])) {
-                if ($_GET['batch'] == self::batch_job) {
-                    $this->_batch_request_type = self::batch_job;
-                } elseif ($_GET['batch'] == self::batch_file_job) {
-                    $this->_batch_request_type = self::batch_file_job;
-                }
-            }
-            // if we didn't find that it was a batch request, indicate it wasn't
-            if ($this->_batch_request_type === null) {
-                $this->_batch_request_type = self::batch_not_job;
-            }
-        }
-        return $this->_batch_request_type;
-    }
+	/**
+	 * Gets the batch request type indicated in the $_REQUEST
+	 *
+	 * @return string: EED_Batch::batch_job, EED_Batch::batch_file_job, EED_Batch::batch_not_job
+	 */
+	public function batch_request_type()
+	{
+		if ($this->_batch_request_type === null) {
+			if (isset($_GET['batch'])) {
+				if ($_GET['batch'] == self::batch_job) {
+					$this->_batch_request_type = self::batch_job;
+				} elseif ($_GET['batch'] == self::batch_file_job) {
+					$this->_batch_request_type = self::batch_file_job;
+				}
+			}
+			// if we didn't find that it was a batch request, indicate it wasn't
+			if ($this->_batch_request_type === null) {
+				$this->_batch_request_type = self::batch_not_job;
+			}
+		}
+		return $this->_batch_request_type;
+	}
 
-    /**
-     * Unnecessary
-     *
-     * @param type $WP
-     */
-    public function run($WP)
-    {
-    }
+	/**
+	 * Unnecessary
+	 *
+	 * @param type $WP
+	 */
+	public function run($WP)
+	{
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -113,7 +113,7 @@ 
      */
     protected function getLoader()
     {
-        if (!$this->loader instanceof LoaderInterface) {
+        if ( ! $this->loader instanceof LoaderInterface) {
             $this->loader = LoaderFactory::getLoader();
         }
         return $this->loader;
@@ -131,7 +131,7 @@ 
                 && $_REQUEST['page'] == 'espresso_batch'
             )
         ) {
-            if (! isset($_REQUEST['default_nonce']) || ! wp_verify_nonce($_REQUEST['default_nonce'], 'default_nonce')) {
+            if ( ! isset($_REQUEST['default_nonce']) || ! wp_verify_nonce($_REQUEST['default_nonce'], 'default_nonce')) {
                 wp_die(esc_html__('The link you clicked to start the batch job has expired. Please go back and refresh the previous page.', 'event_espresso'));
             }
             switch ($this->batch_request_type()) {
@@ -153,7 +153,7 @@ 
         $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
         wp_enqueue_script(
             'batch_runner_init',
-            BATCH_URL . 'assets/batch_runner_init.js',
+            BATCH_URL.'assets/batch_runner_init.js',
             array('batch_runner'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -177,7 +177,7 @@ 
         $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
         wp_enqueue_script(
             'batch_file_runner_init',
-            BATCH_URL . 'assets/batch_file_runner_init.js',
+            BATCH_URL.'assets/batch_file_runner_init.js',
             array('batch_runner'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -191,7 +191,7 @@ 
                     wp_strip_all_tags(
                         __('File Generation complete. Downloading, and %1$sredirecting%2$s...', 'event_espresso')
                     ),
-                    '<a href="' . $_REQUEST['return_url'] . '">',
+                    '<a href="'.$_REQUEST['return_url'].'">',
                     '</a>'
                 ),
                 'return_url'               => $_REQUEST['return_url'],
@@ -209,26 +209,26 @@ 
     protected function _enqueue_batch_job_scripts_and_styles_and_start_job()
     {
         // just copy the bits of EE admin's eei18n that we need in the JS
-        EE_Registry::$i18n_js_strings['batchJobError'] =  esc_html__(
+        EE_Registry::$i18n_js_strings['batchJobError'] = esc_html__(
             'An error occurred and the job has been stopped. Please refresh the page to try again.',
             'event_espresso'
         );
         wp_register_script(
             'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js',
+            EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/progress_bar.js',
             array('jquery'),
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_enqueue_style(
             'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css',
+            EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/progress_bar.css',
             array(),
             EVENT_ESPRESSO_VERSION
         );
         wp_enqueue_script(
             'batch_runner',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js',
+            EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/batch_runner.js',
             array('progress_bar', CoreAssetManager::JS_HANDLE_CORE),
             EVENT_ESPRESSO_VERSION,
             true
@@ -255,7 +255,7 @@ 
     public function override_template($template)
     {
         if (isset($_REQUEST['espresso_batch']) && isset($_REQUEST['batch'])) {
-            return EE_MODULES . 'batch/templates/batch_frontend_wrapper.template.html';
+            return EE_MODULES.'batch/templates/batch_frontend_wrapper.template.html';
         }
         return $template;
     }
@@ -282,7 +282,7 @@ 
     public function show_admin_page()
     {
         echo EEH_Template::locate_template(
-            EE_MODULES . 'batch/templates/batch_wrapper.template.html',
+            EE_MODULES.'batch/templates/batch_wrapper.template.html',
             array('batch_request_type' => $this->batch_request_type())
         );
     }

core/domain/services/custom_post_types/RewriteRules.php

Indentation +27 added lines, -27 removed lines

@@ -13,35 +13,35 @@
 class RewriteRules
 {
 
-    const OPTION_KEY_FLUSH_REWRITE_RULES = 'ee_flush_rewrite_rules';
+	const OPTION_KEY_FLUSH_REWRITE_RULES = 'ee_flush_rewrite_rules';
 
 
-    /**
-     * This will flush rewrite rules on demand.  This actually gets called around wp init priority level 100.
-     *
-     * @return void
-     */
-    public function flush()
-    {
-        update_option(RewriteRules::OPTION_KEY_FLUSH_REWRITE_RULES, true);
-    }
+	/**
+	 * This will flush rewrite rules on demand.  This actually gets called around wp init priority level 100.
+	 *
+	 * @return void
+	 */
+	public function flush()
+	{
+		update_option(RewriteRules::OPTION_KEY_FLUSH_REWRITE_RULES, true);
+	}
 
 
-    /**
-     * This will flush rewrite rules on demand.  This actually gets called around wp init priority level 100.
-     *
-     * @return void
-     */
-    public function flushRewriteRules()
-    {
-        if (get_option(RewriteRules::OPTION_KEY_FLUSH_REWRITE_RULES, true)) {
-            add_action(
-                'shutdown',
-                static function () {
-                    flush_rewrite_rules();
-                    update_option(RewriteRules::OPTION_KEY_FLUSH_REWRITE_RULES, false);
-                }
-            );
-        }
-    }
+	/**
+	 * This will flush rewrite rules on demand.  This actually gets called around wp init priority level 100.
+	 *
+	 * @return void
+	 */
+	public function flushRewriteRules()
+	{
+		if (get_option(RewriteRules::OPTION_KEY_FLUSH_REWRITE_RULES, true)) {
+			add_action(
+				'shutdown',
+				static function () {
+					flush_rewrite_rules();
+					update_option(RewriteRules::OPTION_KEY_FLUSH_REWRITE_RULES, false);
+				}
+			);
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
         if (get_option(RewriteRules::OPTION_KEY_FLUSH_REWRITE_RULES, true)) {
             add_action(
                 'shutdown',
-                static function () {
+                static function() {
                     flush_rewrite_rules();
                     update_option(RewriteRules::OPTION_KEY_FLUSH_REWRITE_RULES, false);
                 }

core/libraries/messages/EE_messenger.lib.php

Indentation +735 added lines, -735 removed lines

@@ -18,182 +18,182 @@ 
 
 
 
-    /**
-     * This property holds the default message types associated with this messenger when it is activated. The values of the array must match a valid message type.
-     * This property gets set by the _set_default_message_types() method.
-     *
-     * @var array
-     */
-    protected $_default_message_types = array();
+	/**
+	 * This property holds the default message types associated with this messenger when it is activated. The values of the array must match a valid message type.
+	 * This property gets set by the _set_default_message_types() method.
+	 *
+	 * @var array
+	 */
+	protected $_default_message_types = array();
 
 
 
 
-    /**
-     * This property holds the message types that are valid for use with this messenger.
-     * It gets set by the _set_valid_message_types() method.
-     *
-     * @var array
-     */
-    protected $_valid_message_types = array();
+	/**
+	 * This property holds the message types that are valid for use with this messenger.
+	 * It gets set by the _set_valid_message_types() method.
+	 *
+	 * @var array
+	 */
+	protected $_valid_message_types = array();
 
 
 
-    /**
-     * Holds the configuration for the EE_Messages_Validator class to know how to validated the different fields. Note that the Validator will match each field here with the allowed shortcodes set in the "valid_shortcodes" array for the matched message type context.  So message types don't need to set a $_validator_config property.
-     *
-     * Remember, ALL fields must be declared in this array.  However, an empty value for the field means that the field will accept all valid shortcodes set for the given context in the message type (by default).
-     *
-     * Array should be in this format:
-     *
-     * array(
-     *  'field_name(i.e.to)' => array(
-     *      'shortcodes' => array('email'), //an array of shortcode groups (correspond to EE_Shortcodes library class) that are allowed in the field. Typically you can just include $this->_valid_shortcodes['field_name'] as the value here (because they will match).
-     *      'specific_shortcodes' => array( array('[EVENT_AUTHOR_EMAIL]' => __('Admin Email', 'event_espresso')), //if this index is present you can further restrict the field to ONLY specific shortcodes if an entire group isn't sufficient. Specific shortcodes need to be listed as an array with the index the shortcode and the value = the label.
-     *      'type' => 'email' //this is the field type and should match one of the validator types (see EE_Messages_Validator::validator() for all the possible types).  If not required you can just leave empty.,
-     *      'required' => array'[SHORTCODE]') //this is used to indicate the shortcodes that MUST be in the assembled array of shortcodes by the validator in order for this field to be included in validation.  Otherwise the validator will always assign shortcodes for this field (regardless of whether the field settings for the given messenger/message_type/context use the field or not.).. please note, this does NOT mean that the shortcodes listed here MUST be in the given field.
-     *  )
-     * )
-     *
-     * @var array
-     */
-    protected $_validator_config = array();
+	/**
+	 * Holds the configuration for the EE_Messages_Validator class to know how to validated the different fields. Note that the Validator will match each field here with the allowed shortcodes set in the "valid_shortcodes" array for the matched message type context.  So message types don't need to set a $_validator_config property.
+	 *
+	 * Remember, ALL fields must be declared in this array.  However, an empty value for the field means that the field will accept all valid shortcodes set for the given context in the message type (by default).
+	 *
+	 * Array should be in this format:
+	 *
+	 * array(
+	 *  'field_name(i.e.to)' => array(
+	 *      'shortcodes' => array('email'), //an array of shortcode groups (correspond to EE_Shortcodes library class) that are allowed in the field. Typically you can just include $this->_valid_shortcodes['field_name'] as the value here (because they will match).
+	 *      'specific_shortcodes' => array( array('[EVENT_AUTHOR_EMAIL]' => __('Admin Email', 'event_espresso')), //if this index is present you can further restrict the field to ONLY specific shortcodes if an entire group isn't sufficient. Specific shortcodes need to be listed as an array with the index the shortcode and the value = the label.
+	 *      'type' => 'email' //this is the field type and should match one of the validator types (see EE_Messages_Validator::validator() for all the possible types).  If not required you can just leave empty.,
+	 *      'required' => array'[SHORTCODE]') //this is used to indicate the shortcodes that MUST be in the assembled array of shortcodes by the validator in order for this field to be included in validation.  Otherwise the validator will always assign shortcodes for this field (regardless of whether the field settings for the given messenger/message_type/context use the field or not.).. please note, this does NOT mean that the shortcodes listed here MUST be in the given field.
+	 *  )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_validator_config = array();
 
 
 
-    /**
-     * This will hold the EEM_message_templates model for interacting with the database and retrieving active templates for the messenger
-     * @var object
-     */
-    protected $_EEM_data;
+	/**
+	 * This will hold the EEM_message_templates model for interacting with the database and retrieving active templates for the messenger
+	 * @var object
+	 */
+	protected $_EEM_data;
 
 
 
-    /**
-     * this property just holds an array of the various template refs.
-     * @var array
-     */
-    protected $_template_fields = array();
+	/**
+	 * this property just holds an array of the various template refs.
+	 * @var array
+	 */
+	protected $_template_fields = array();
 
 
 
 
-    /**
-     * This holds an array of the arguments used in parsing a template for the sender.
-     * @var array
-     */
-    protected $_template_args = array();
+	/**
+	 * This holds an array of the arguments used in parsing a template for the sender.
+	 * @var array
+	 */
+	protected $_template_args = array();
 
 
 
 
 
 
-    /**
-     * This property will hold the configuration for any test settings fields that are required for the "test" button that is used to trigger an actual test of this messenger
-     *
-     * @protected
-     * @var array
-     */
-    protected $_test_settings_fields = array();
+	/**
+	 * This property will hold the configuration for any test settings fields that are required for the "test" button that is used to trigger an actual test of this messenger
+	 *
+	 * @protected
+	 * @var array
+	 */
+	protected $_test_settings_fields = array();
 
 
 
 
 
 
-    /**
-     * This will hold the EE_Messages_Template_Pack object when set on the messenger.  This is set via the validate and setup method which grabs the template pack from the incoming messages object.
-     *
-     * @since 4.5.0
-     *
-     * @var EE_Messages_Template_Pack
-     */
-    protected $_tmp_pack;
+	/**
+	 * This will hold the EE_Messages_Template_Pack object when set on the messenger.  This is set via the validate and setup method which grabs the template pack from the incoming messages object.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var EE_Messages_Template_Pack
+	 */
+	protected $_tmp_pack;
 
 
 
 
-    /**
-     * This will hold the variation to use when performing a send.  It is set via the validate and setup method which grabs the variation from the incoming messages object on the send method.
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    protected $_variation;
+	/**
+	 * This will hold the variation to use when performing a send.  It is set via the validate and setup method which grabs the variation from the incoming messages object on the send method.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	protected $_variation;
 
 
 
 
 
-    /**
-     * This property is a stdClass that holds labels for all the various supporting properties for this messenger.  These labels are set via the _set_supports_labels() method in children classes. Initially this will include the label for:
-     *
-     *  - template pack
-     *  - template variation
-     *
-     * @since 4.5.0
-     *
-     * @var stdClass
-     */
-    protected $_supports_labels;
+	/**
+	 * This property is a stdClass that holds labels for all the various supporting properties for this messenger.  These labels are set via the _set_supports_labels() method in children classes. Initially this will include the label for:
+	 *
+	 *  - template pack
+	 *  - template variation
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var stdClass
+	 */
+	protected $_supports_labels;
 
 
 
 
 
-    /**
-     * This property is set when the send_message() method is called and holds the Message Type used to generate templates with this messenger for the messages.
-     *
-     * @var EE_message_type
-     */
-    protected $_incoming_message_type;
+	/**
+	 * This property is set when the send_message() method is called and holds the Message Type used to generate templates with this messenger for the messages.
+	 *
+	 * @var EE_message_type
+	 */
+	protected $_incoming_message_type;
 
 
 
-    /**
-     * This flag sets whether a messenger is activated by default  on installation (or reactivation) of EE core or not.
-     *
-     * @var bool
-     */
-    public $activate_on_install = false;
+	/**
+	 * This flag sets whether a messenger is activated by default  on installation (or reactivation) of EE core or not.
+	 *
+	 * @var bool
+	 */
+	public $activate_on_install = false;
 
 
 
 
 
-    public function __construct()
-    {
-        $this->_EEM_data = EEM_Message_Template_Group::instance();
-        $this->_messages_item_type = 'messenger';
+	public function __construct()
+	{
+		$this->_EEM_data = EEM_Message_Template_Group::instance();
+		$this->_messages_item_type = 'messenger';
 
-        parent::__construct();
+		parent::__construct();
 
-        $this->_set_test_settings_fields();
-        $this->_set_template_fields();
-        $this->_set_default_message_types();
-        $this->_set_valid_message_types();
-        $this->_set_validator_config();
+		$this->_set_test_settings_fields();
+		$this->_set_template_fields();
+		$this->_set_default_message_types();
+		$this->_set_valid_message_types();
+		$this->_set_validator_config();
 
 
-        $this->_supports_labels = new stdClass();
-        $this->_set_supports_labels();
-    }
+		$this->_supports_labels = new stdClass();
+		$this->_set_supports_labels();
+	}
 
 
 
 
 
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @abstract
-     * @access  protected
-     * @return void
-     */
-    abstract protected function _set_template_fields();
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @abstract
+	 * @access  protected
+	 * @return void
+	 */
+	abstract protected function _set_template_fields();
 
 
 
@@ -203,14 +203,14 @@ 
 
 
 
-    /**
-     * This method sets the _default_message_type property (see definition in docs attached to property)
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_default_message_types();
+	/**
+	 * This method sets the _default_message_type property (see definition in docs attached to property)
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_default_message_types();
 
 
 
@@ -218,15 +218,15 @@ 
 
 
 
-    /**
-     * Sets the _valid_message_types property (see definition in cods attached to property)
-     *
-     * @since 4.5.0
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _set_valid_message_types();
+	/**
+	 * Sets the _valid_message_types property (see definition in cods attached to property)
+	 *
+	 * @since 4.5.0
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _set_valid_message_types();
 
 
 
@@ -234,171 +234,171 @@ 
 
 
 
-    /**
-     * Child classes must declare the $_validator_config property using this method.
-     * See comments for $_validator_config for details on what it is used for.
-     *
-     * NOTE:  messengers should set an array of valid shortcodes for ALL scenarios.  The corresponding validator class (validators/{messenger}) can be used to restrict only certain shortcodes per template so users cannot add certain shortcodes.
-     *
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_validator_config();
+	/**
+	 * Child classes must declare the $_validator_config property using this method.
+	 * See comments for $_validator_config for details on what it is used for.
+	 *
+	 * NOTE:  messengers should set an array of valid shortcodes for ALL scenarios.  The corresponding validator class (validators/{messenger}) can be used to restrict only certain shortcodes per template so users cannot add certain shortcodes.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_validator_config();
 
 
 
 
 
 
-    /**
-     * We just deliver the messages don't kill us!!  This method will need to be modified by child classes for whatever action is taken to actually send a message.
-     *
-     * @return bool|WP_Error
-     * @throw \Exception
-     */
-    abstract protected function _send_message();
+	/**
+	 * We just deliver the messages don't kill us!!  This method will need to be modified by child classes for whatever action is taken to actually send a message.
+	 *
+	 * @return bool|WP_Error
+	 * @throw \Exception
+	 */
+	abstract protected function _send_message();
 
 
 
 
-    /**
-     * We give you pretty previews of the messages!
-     * @return string html body for message content.
-     */
-    abstract protected function _preview();
+	/**
+	 * We give you pretty previews of the messages!
+	 * @return string html body for message content.
+	 */
+	abstract protected function _preview();
 
 
 
 
-    /**
-     * Used by messengers (or preview) for enqueueing any scripts or styles need in message generation.
-     *
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    public function enqueue_scripts_styles()
-    {
-        do_action('AHEE__EE_messenger__enqueue_scripts_styles');
-    }
+	/**
+	 * Used by messengers (or preview) for enqueueing any scripts or styles need in message generation.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	public function enqueue_scripts_styles()
+	{
+		do_action('AHEE__EE_messenger__enqueue_scripts_styles');
+	}
 
 
 
 
 
-    /**
-     * This is used to indicate whether a messenger must be sent immediately or not.
-     * eg. The HTML messenger will override this to return true because it should be displayed in user's browser right
-     * away.  The PDF messenger is similar.
-     *
-     * This flag thus overrides any priorities that may be set on the message type used to generate the message.
-     *
-     * Default for this is false.  So children classes must override this if they want a message to be executed immediately.
-     *
-     * @since  4.9.0
-     * @return bool
-     */
-    public function send_now()
-    {
-        return false;
-    }
+	/**
+	 * This is used to indicate whether a messenger must be sent immediately or not.
+	 * eg. The HTML messenger will override this to return true because it should be displayed in user's browser right
+	 * away.  The PDF messenger is similar.
+	 *
+	 * This flag thus overrides any priorities that may be set on the message type used to generate the message.
+	 *
+	 * Default for this is false.  So children classes must override this if they want a message to be executed immediately.
+	 *
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function send_now()
+	{
+		return false;
+	}
 
 
 
 
 
-    /**
-     * This is a way for a messenger to indicate whether it allows an empty to field or not.
-     * Note: If the generated message is a for a preview, this value is ignored.
-     * @since 4.9.0
-     * @return bool
-     */
-    public function allow_empty_to_field()
-    {
-        return false;
-    }
+	/**
+	 * This is a way for a messenger to indicate whether it allows an empty to field or not.
+	 * Note: If the generated message is a for a preview, this value is ignored.
+	 * @since 4.9.0
+	 * @return bool
+	 */
+	public function allow_empty_to_field()
+	{
+		return false;
+	}
 
 
 
 
 
-    /**
-     * Sets the defaults for the _supports_labels property.  Can be overridden by child classes.
-     * @see property definition for info on how its formatted.
-     *
-     * @since 4.5.0;
-     * @return void
-     */
-    protected function _set_supports_labels()
-    {
-        $this->_set_supports_labels_defaults();
-    }
+	/**
+	 * Sets the defaults for the _supports_labels property.  Can be overridden by child classes.
+	 * @see property definition for info on how its formatted.
+	 *
+	 * @since 4.5.0;
+	 * @return void
+	 */
+	protected function _set_supports_labels()
+	{
+		$this->_set_supports_labels_defaults();
+	}
 
 
 
 
 
-    /**
-     * Sets the defaults for the _supports_labels property.
-     *
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    private function _set_supports_labels_defaults()
-    {
-        $this->_supports_labels->template_pack = __('Template Structure', 'event_espresso');
-        $this->_supports_labels->template_variation = __('Template Style', 'event_espresso');
-        $this->_supports_labels->template_pack_description = __('Template Structure options are bundled structural changes for templates.', 'event_espresso');
+	/**
+	 * Sets the defaults for the _supports_labels property.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	private function _set_supports_labels_defaults()
+	{
+		$this->_supports_labels->template_pack = __('Template Structure', 'event_espresso');
+		$this->_supports_labels->template_variation = __('Template Style', 'event_espresso');
+		$this->_supports_labels->template_pack_description = __('Template Structure options are bundled structural changes for templates.', 'event_espresso');
 
-        $this->_supports_labels->template_variation_description = __('These are different styles to choose from for the selected template structure.  Usually these affect things like font style, color, borders etc.  In some cases the styles will also make minor layout changes.', 'event_espresso');
+		$this->_supports_labels->template_variation_description = __('These are different styles to choose from for the selected template structure.  Usually these affect things like font style, color, borders etc.  In some cases the styles will also make minor layout changes.', 'event_espresso');
 
-        $this->_supports_labels = apply_filters('FHEE__EE_messenger___set_supports_labels_defaults___supports_labels', $this->_supports_labels, $this);
-    }
+		$this->_supports_labels = apply_filters('FHEE__EE_messenger___set_supports_labels_defaults___supports_labels', $this->_supports_labels, $this);
+	}
 
 
 
 
 
-    /**
-     * This returns the _supports_labels property.
-     *
-     * @since 4.5.0
-     *
-     * @return stdClass
-     */
-    public function get_supports_labels()
-    {
-        if (empty($this->_supports_labels->template_pack) || empty($this->_supports_labels->template_variation)) {
-            $this->_set_supports_labels_defaults();
-        }
-        return apply_filters('FHEE__EE_messenger__get_supports_labels', $this->_supports_labels, $this);
-    }
+	/**
+	 * This returns the _supports_labels property.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return stdClass
+	 */
+	public function get_supports_labels()
+	{
+		if (empty($this->_supports_labels->template_pack) || empty($this->_supports_labels->template_variation)) {
+			$this->_set_supports_labels_defaults();
+		}
+		return apply_filters('FHEE__EE_messenger__get_supports_labels', $this->_supports_labels, $this);
+	}
 
 
 
 
-    /**
-     * Used to retrieve a variation (typically the path/url to a css file)
-     *
-     * @since 4.5.0
-     *
-     * @param EE_Messages_Template_Pack $pack   The template pack used for retrieving the variation.
-     * @param string                    $message_type_name The name property of the message type that we need the variation for.
-     * @param bool                      $url   Whether to return url (true) or path (false). Default is false.
-     * @param string                    $type What variation type to return. Default is 'main'.
-     * @param string               $variation What variation for the template pack
-     * @param bool             $skip_filters This allows messengers to add a filter for another messengers get_variation but call skip filters on the callback so there is no recursion on apply_filters.
-     *
-     * @return string                    path or url for the requested variation.
-     */
-    public function get_variation(EE_Messages_Template_Pack $pack, $message_type_name, $url = false, $type = 'main', $variation = 'default', $skip_filters = false)
-    {
-        $this->_tmp_pack = $pack;
-        $variation_path = apply_filters('EE_messenger__get_variation__variation', false, $pack, $this->name, $message_type_name, $url, $type, $variation, $skip_filters);
-        $variation_path = empty($variation_path) ? $this->_tmp_pack->get_variation($this->name, $message_type_name, $type, $variation, $url, '.css', $skip_filters) : $variation_path;
-        return $variation_path;
-    }
+	/**
+	 * Used to retrieve a variation (typically the path/url to a css file)
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param EE_Messages_Template_Pack $pack   The template pack used for retrieving the variation.
+	 * @param string                    $message_type_name The name property of the message type that we need the variation for.
+	 * @param bool                      $url   Whether to return url (true) or path (false). Default is false.
+	 * @param string                    $type What variation type to return. Default is 'main'.
+	 * @param string               $variation What variation for the template pack
+	 * @param bool             $skip_filters This allows messengers to add a filter for another messengers get_variation but call skip filters on the callback so there is no recursion on apply_filters.
+	 *
+	 * @return string                    path or url for the requested variation.
+	 */
+	public function get_variation(EE_Messages_Template_Pack $pack, $message_type_name, $url = false, $type = 'main', $variation = 'default', $skip_filters = false)
+	{
+		$this->_tmp_pack = $pack;
+		$variation_path = apply_filters('EE_messenger__get_variation__variation', false, $pack, $this->name, $message_type_name, $url, $type, $variation, $skip_filters);
+		$variation_path = empty($variation_path) ? $this->_tmp_pack->get_variation($this->name, $message_type_name, $type, $variation, $url, '.css', $skip_filters) : $variation_path;
+		return $variation_path;
+	}
 
 
 
@@ -406,492 +406,492 @@ 
 
 
 
-    /**
-     * This just returns the default message types associated with this messenger when it is first activated.
-     *
-     * @access public
-     * @return array
-     */
-    public function get_default_message_types()
-    {
-        $class = get_class($this);
+	/**
+	 * This just returns the default message types associated with this messenger when it is first activated.
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_default_message_types()
+	{
+		$class = get_class($this);
 
-        // messenger specific filter
-        $default_types = apply_filters('FHEE__' . $class . '__get_default_message_types__default_types', $this->_default_message_types, $this);
+		// messenger specific filter
+		$default_types = apply_filters('FHEE__' . $class . '__get_default_message_types__default_types', $this->_default_message_types, $this);
 
-        // all messengers filter
-        $default_types = apply_filters('FHEE__EE_messenger__get_default_message_types__default_types', $default_types, $this);
-        return $default_types;
-    }
+		// all messengers filter
+		$default_types = apply_filters('FHEE__EE_messenger__get_default_message_types__default_types', $default_types, $this);
+		return $default_types;
+	}
 
 
 
 
-    /**
-     * Returns the valid message types associated with this messenger.
-     *
-     * @since 4.5.0
-     *
-     * @return array
-     */
-    public function get_valid_message_types()
-    {
-        $class = get_class($this);
-
-        // messenger specific filter
-        // messenger specific filter
-        $valid_types = apply_filters('FHEE__' . $class . '__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
-
-        // all messengers filter
-        $valid_types = apply_filters('FHEE__EE_messenger__get_valid_message_types__valid_types', $valid_types, $this);
-        return $valid_types;
-    }
-
-
-
-
-
-    /**
-     * this is just used by the custom validators (EE_Messages_Validator classes) to modify the _validator_config for certain message_type/messenger combos where a context may only use certain shortcodes etc.
-     *
-     * @access public
-     * @param array $new_config Whatever is put in here will reset the _validator_config property
-     */
-    public function set_validator_config($new_config)
-    {
-        $this->_validator_config = $new_config;
-    }
-
-
-
-
-    /**
-     * This returns the _validator_config property
-     *
-     * @access public
-     * @return array
-     */
-    public function get_validator_config()
-    {
-        $class = get_class($this);
-
-        $config = apply_filters('FHEE__' . $class . '__get_validator_config', $this->_validator_config, $this);
-        $config = apply_filters('FHEE__EE_messenger__get_validator_config', $config, $this);
-        return $config;
-    }
-
-
-
-
-    /**
-     * this public method accepts a page slug (for an EE_admin page) and will return the response from the child class callback function if that page is registered via the `_admin_registered_page` property set by the child class.
-     *
-     * @param string $page the slug of the EE admin page
-     * @param array $message_types an array of active message type objects
-     * @param string $action the page action (to allow for more specific handling - i.e. edit vs. add pages)
-     * @param array $extra  This is just an extra argument that can be used to pass additional data for setting up page content.
-     * @access public
-     * @return string content for page
-     */
-    public function get_messenger_admin_page_content($page, $action = null, $extra = array(), $message_types = array())
-    {
-        return $this->_get_admin_page_content($page, $action, $extra, $message_types);
-    }
-
-
-
-    /**
-     * @param $message_types
-     * @param array $extra
-     * @return mixed|string
-     */
-    protected function _get_admin_content_events_edit($message_types, $extra)
-    {
-        // defaults
-        $template_args = array();
-        $selector_rows = '';
-
-        // we don't need message types here so we're just going to ignore. we do, however, expect the event id here. The event id is needed to provide a link to setup a custom template for this event.
-        $event_id = isset($extra['event']) ? $extra['event'] : null;
-
-        $template_wrapper_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
-        $template_row_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_row.template.php';
-
-        // array of template objects for global and custom (non-trashed) (but remember just for this messenger!)
-        $global_templates = EEM_Message_Template_Group::instance()->get_all(
-            array( array( 'MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true ) )
-        );
-        $templates_for_event = EEM_Message_Template_Group::instance()->get_all_custom_templates_by_event(
-            $event_id,
-            array(
-                'MTP_messenger' => $this->name,
-                'MTP_is_active' => true
-            )
-        );
-        $templates_for_event = !empty($templates_for_event) ? $templates_for_event : array();
-
-        // so we need to setup the rows for the selectors and we use the global mtpgs (cause those will the active message template groups)
-        foreach ($global_templates as $mtpgID => $mtpg) {
-            if ($mtpg instanceof EE_Message_Template_Group) {
-                // verify this message type is supposed to show on this page
-                $mtp_obj = $mtpg->message_type_obj();
-                if (! $mtp_obj instanceof EE_message_type) {
-                    continue;
-                }
-                $mtp_obj->admin_registered_pages = (array) $mtp_obj->admin_registered_pages;
-                if (! in_array('events_edit', $mtp_obj->admin_registered_pages)) {
-                    continue;
-                }
-                $select_values = array();
-                $select_values[ $mtpgID ] = __('Global', 'event_espresso');
-                $default_value = array_key_exists($mtpgID, $templates_for_event) && ! $mtpg->get('MTP_is_override') ? $mtpgID : null;
-                // if the override has been set for the global template, then that means even if there are custom templates already created we ignore them because of the set override.
-                if (! $mtpg->get('MTP_is_override')) {
-                    // any custom templates for this message type?
-                    $custom_templates = EEM_Message_Template_Group::instance()->get_custom_message_template_by_m_and_mt($this->name, $mtpg->message_type());
-                    foreach ($custom_templates as $cmtpgID => $cmtpg) {
-                        $select_values[ $cmtpgID ] = $cmtpg->name();
-                        $default_value = array_key_exists($cmtpgID, $templates_for_event) ? $cmtpgID : $default_value;
-                    }
-                }
-                // if there is no $default_value then we set it as the global
-                $default_value = empty($default_value) ? $mtpgID : $default_value;
-                $edit_url_query_args = [
-                    'page' => 'espresso_messages',
-                    'action' => 'edit_message_template',
-                    'id' => $default_value,
-                    'evt_id' => $event_id
-                ];
-                $edit_url = EEH_URL::add_query_args_and_nonce($edit_url_query_args, admin_url('admin.php'));
-                $create_url_query_args = [
-                    'page' => 'espresso_messages',
-                    'action' => 'add_new_message_template',
-                    'GRP_ID' => $default_value
-                ];
-                $create_url = EEH_URL::add_query_args_and_nonce($create_url_query_args, admin_url('admin.php'));
-                $st_args['mt_name'] = ucwords($mtp_obj->label['singular']);
-                $st_args['mt_slug'] = $mtpg->message_type();
-                $st_args['messenger_slug'] = $this->name;
-                $st_args['selector'] = EEH_Form_Fields::select_input('event_message_templates_relation[' . $mtpgID . ']', $select_values, $default_value, 'data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '"', 'message-template-selector');
-                // note that  message template group that has override_all_custom set will remove the ability to set a custom message template based off of the global (and that also in turn overrides any other custom templates).
-                $st_args['create_button'] = $mtpg->get('MTP_is_override') ? '' : '<a data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $create_url . '" class="button button-small create-mtpg-button">' . __('Create New Custom', 'event_espresso') . '</a>';
-                $st_args['create_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'espresso_messages_add_new_message_template') ? $st_args['create_button'] : '';
-                $st_args['edit_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_message', 'espresso_messages_edit_message_template', $mtpgID) ? '<a data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $edit_url . '" class="button button-small edit-mtpg-button">' . __('Edit', 'event_espresso') . '</a>' : '';
-                $selector_rows .= EEH_Template::display_template($template_row_path, $st_args, true);
-            }
-        }
-
-        // if no selectors present then get out.
-        if (empty($selector_rows)) {
-            return '';
-        }
-
-        $template_args['selector_rows'] = $selector_rows;
-        return EEH_Template::display_template($template_wrapper_path, $template_args, true);
-    }
-
-
-
-
-
-
-    /**
-     * get_template_fields
-     *
-     * @access public
-     * @return array $this->_template_fields
-     */
-    public function get_template_fields()
-    {
-        $template_fields = apply_filters('FHEE__' . get_class($this) . '__get_template_fields', $this->_template_fields, $this);
-        $template_fields = apply_filters('FHEE__EE_messenger__get_template_fields', $template_fields, $this);
-        return $template_fields;
-    }
-
-
-
-
-    /** SETUP METHODS **/
-    /**
-     * The following method doesn't NEED to be used by child classes but might be modified by the specific messenger
-     * @param string $item
-     * @param mixed $value
-     */
-    protected function _set_template_value($item, $value)
-    {
-        if (array_key_exists($item, $this->_template_fields)) {
-            $prop = '_' . $item;
-            $this->{$prop}= $value;
-        }
-    }
-
-    /**
-     * Sets up the message for sending.
-     *
-     * @param  EE_message $message the message object that contains details about the message.
-     * @param EE_message_type $message_type The message type object used in combination with this messenger to generate the provided message.
-     *
-     * @return bool Very important that all messengers return bool for successful send or not.  Error messages can be
-     *              added to EE_Error.
-     *              true = message sent successfully
-     *              false = message not sent but can be retried (i.e. the failure might be just due to communication issues at the time of send).
-     *              Throwing a SendMessageException means the message failed sending and cannot be retried.
-     *
-     * @throws SendMessageException
-     */
-    final public function send_message($message, EE_message_type $message_type)
-    {
-        try {
-            $this->_validate_and_setup($message);
-            $this->_incoming_message_type = $message_type;
-            $response = $this->_send_message();
-            if ($response instanceof WP_Error) {
-                EE_Error::add_error($response->get_error_message(), __FILE__, __FUNCTION__, __LINE__);
-                $response = false;
-            }
-        } catch (\Exception $e) {
-            // convert to an instance of SendMessageException
-            throw new SendMessageException($e->getMessage());
-        }
-        return $response;
-    }
-
-
-
-    /**
-     * Sets up and returns message preview
-     * @param  EE_Message $message incoming message object
-     * @param EE_message_type $message_type This is whatever message type was used in combination with this messenger to generate the message.
-     * @param  bool   $send    true we will actually use the _send method (for test sends). FALSE we just return preview
-     * @return string          return the message html content
-     */
-    public function get_preview(EE_Message $message, EE_message_type $message_type, $send = false)
-    {
-        $this->_validate_and_setup($message);
-
-        $this->_incoming_message_type = $message_type;
-
-        if ($send) {
-            // are we overriding any existing template fields?
-            $settings = apply_filters(
-                'FHEE__EE_messenger__get_preview__messenger_test_settings',
-                $this->get_existing_test_settings(),
-                $this,
-                $send,
-                $message,
-                $message_type
-            );
-            if (! empty($settings)) {
-                foreach ($settings as $field => $value) {
-                    $this->_set_template_value($field, $value);
-                }
-            }
-        }
-
-        // enqueue preview js so that any links/buttons on the page are disabled.
-        if (! $send) {
-            // the below may seem like duplication.  However, typically if a messenger enqueues scripts/styles,
-            // it deregisters all existing wp scripts and styles first.  So the second hook ensures our previewer still gets setup.
-            add_action('admin_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
-            add_action('wp_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
-            add_action('AHEE__EE_messenger__enqueue_scripts_styles', array( $this, 'add_preview_script' ), 10);
-        }
-
-        return $send ? $this->_send_message() : $this->_preview();
-    }
-
-
-
-
-    /**
-     * Callback for enqueue_scripts so that we setup the preview script for all previews.
-     *
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    public function add_preview_script()
-    {
-        // error message
-        EE_Registry::$i18n_js_strings['links_disabled'] = wp_strip_all_tags(
-            __('All the links on this page have been disabled because this is a generated preview message for the purpose of ensuring layout, style, and content setup.  To test generated links, you must trigger an actual message notification.', 'event_espresso')
-        );
-        wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL . 'messages/messenger/assets/js/ee-messages-preview.js', array( 'jquery' ), EVENT_ESPRESSO_VERSION, true);
-        wp_localize_script('ee-messages-preview-js', 'eei18n', EE_Registry::$i18n_js_strings);
-        wp_enqueue_script('ee-messages-preview-js');
-    }
-
-
-
-
-    /**
-     * simply validates the incoming message object and then sets up the properties for the messenger
-     * @param  EE_Message $message
-     * @throws EE_Error
-     */
-    protected function _validate_and_setup(EE_Message $message)
-    {
-        $template_pack = $message->get_template_pack();
-        $variation = $message->get_template_pack_variation();
-
-        // verify we have the required template pack value on the $message object.
-        if (! $template_pack instanceof EE_Messages_Template_Pack) {
-            throw new EE_Error(__('Incoming $message object must have an EE_Messages_Template_Pack object available.', 'event_espresso'));
-        }
-
-        $this->_tmp_pack = $template_pack;
-
-        $this->_variation = $variation ? $variation : 'default';
-
-        $template_fields = $this->get_template_fields();
-
-        foreach ($template_fields as $template => $value) {
-            if ($template !== 'extra') {
-                $column_value = $message->get_field_or_extra_meta('MSG_' . $template);
-                $message_template_value = $column_value ? $column_value : null;
-                $this->_set_template_value($template, $message_template_value);
-            }
-        }
-    }
-
-
-
-    /**
-     * Utility method for child classes to get the contents of a template file and return
-     *
-     * We're assuming the child messenger class has already setup template args!
-     * @param  bool $preview if true we use the preview wrapper otherwise we use main wrapper.
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _get_main_template($preview = false)
-    {
-        $type = $preview ? 'preview' : 'main';
-
-        $wrapper_template = $this->_tmp_pack->get_wrapper($this->name, $type);
-
-        // check file exists and is readable
-        if (!is_readable($wrapper_template)) {
-            throw new EE_Error(sprintf(__('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso'), ucwords($this->label['singular']), $wrapper_template));
-        }
-
-        // add message type to template args
-        $this->_template_args['message_type'] = $this->_incoming_message_type;
-
-        return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
-    }
-
-
-
-    /**
-     * set the _test_settings_fields property
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_test_settings_fields()
-    {
-        $this->_test_settings_fields = array();
-    }
-
-
-
-    /**
-     * return the _test_settings_fields property
-     * @return array
-     */
-    public function get_test_settings_fields()
-    {
-        return $this->_test_settings_fields;
-    }
-
-
-
-
-    /**
-     * This just returns any existing test settings that might be saved in the database
-     *
-     * @access public
-     * @return array
-     */
-    public function get_existing_test_settings()
-    {
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $settings = $Message_Resource_Manager->get_active_messengers_option();
-        return isset($settings[ $this->name ]['test_settings']) ? $settings[ $this->name ]['test_settings'] : array();
-    }
-
-
-
-    /**
-     * All this does is set the existing test settings (in the db) for the messenger
-     *
-     * @access public
-     * @param $settings
-     * @return bool success/fail
-     */
-    public function set_existing_test_settings($settings)
-    {
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $existing = $Message_Resource_Manager->get_active_messengers_option();
-        $existing[ $this->name ]['test_settings'] = $settings;
-        return $Message_Resource_Manager->update_active_messengers_option($existing);
-    }
-
-
-
-    /**
-     * This just returns the field label for a given field setup in the _template_fields property.
-     *
-     * @since   4.3.0
-     *
-     * @param string $field The field to retrieve the label for
-     * @return string             The label
-     */
-    public function get_field_label($field)
-    {
-        // first let's see if the field requests is in the top level array.
-        if (isset($this->_template_fields[ $field ]) && !empty($this->_template_fields[ $field ]['label'])) {
-            return $this->_template[ $field ]['label'];
-        }
-
-        // nope so let's look in the extra array to see if it's there HOWEVER if the field exists as a top level index in the extra array then we know the label is in the 'main' index.
-        if (isset($this->_template_fields['extra']) && !empty($this->_template_fields['extra'][ $field ]) && !empty($this->_template_fields['extra'][ $field ]['main']['label'])) {
-            return $this->_template_fields['extra'][ $field ]['main']['label'];
-        }
-
-        // now it's possible this field may just be existing in any of the extra array items.
-        if (!empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
-            foreach ($this->_template_fields['extra'] as $main_field => $subfields) {
-                if (!is_array($subfields)) {
-                    continue;
-                }
-                if (isset($subfields[ $field ]) && !empty($subfields[ $field ]['label'])) {
-                    return $subfields[ $field ]['label'];
-                }
-            }
-        }
-
-        // if we made it here then there's no label set so let's just return the $field.
-        return $field;
-    }
-
-
-
-
-    /**
-     * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger is a different messenger.  Child messengers can set hooks for the sending messenger to callback on if necessary (i.e. swap out css files or something else).
-     *
-     * @since 4.5.0
-     *
-     * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed.
-     *
-     * @return void
-     */
-    public function do_secondary_messenger_hooks($sending_messenger_name)
-    {
-        return;
-    }
+	/**
+	 * Returns the valid message types associated with this messenger.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return array
+	 */
+	public function get_valid_message_types()
+	{
+		$class = get_class($this);
+
+		// messenger specific filter
+		// messenger specific filter
+		$valid_types = apply_filters('FHEE__' . $class . '__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
+
+		// all messengers filter
+		$valid_types = apply_filters('FHEE__EE_messenger__get_valid_message_types__valid_types', $valid_types, $this);
+		return $valid_types;
+	}
+
+
+
+
+
+	/**
+	 * this is just used by the custom validators (EE_Messages_Validator classes) to modify the _validator_config for certain message_type/messenger combos where a context may only use certain shortcodes etc.
+	 *
+	 * @access public
+	 * @param array $new_config Whatever is put in here will reset the _validator_config property
+	 */
+	public function set_validator_config($new_config)
+	{
+		$this->_validator_config = $new_config;
+	}
+
+
+
+
+	/**
+	 * This returns the _validator_config property
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_validator_config()
+	{
+		$class = get_class($this);
+
+		$config = apply_filters('FHEE__' . $class . '__get_validator_config', $this->_validator_config, $this);
+		$config = apply_filters('FHEE__EE_messenger__get_validator_config', $config, $this);
+		return $config;
+	}
+
+
+
+
+	/**
+	 * this public method accepts a page slug (for an EE_admin page) and will return the response from the child class callback function if that page is registered via the `_admin_registered_page` property set by the child class.
+	 *
+	 * @param string $page the slug of the EE admin page
+	 * @param array $message_types an array of active message type objects
+	 * @param string $action the page action (to allow for more specific handling - i.e. edit vs. add pages)
+	 * @param array $extra  This is just an extra argument that can be used to pass additional data for setting up page content.
+	 * @access public
+	 * @return string content for page
+	 */
+	public function get_messenger_admin_page_content($page, $action = null, $extra = array(), $message_types = array())
+	{
+		return $this->_get_admin_page_content($page, $action, $extra, $message_types);
+	}
+
+
+
+	/**
+	 * @param $message_types
+	 * @param array $extra
+	 * @return mixed|string
+	 */
+	protected function _get_admin_content_events_edit($message_types, $extra)
+	{
+		// defaults
+		$template_args = array();
+		$selector_rows = '';
+
+		// we don't need message types here so we're just going to ignore. we do, however, expect the event id here. The event id is needed to provide a link to setup a custom template for this event.
+		$event_id = isset($extra['event']) ? $extra['event'] : null;
+
+		$template_wrapper_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
+		$template_row_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_row.template.php';
+
+		// array of template objects for global and custom (non-trashed) (but remember just for this messenger!)
+		$global_templates = EEM_Message_Template_Group::instance()->get_all(
+			array( array( 'MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true ) )
+		);
+		$templates_for_event = EEM_Message_Template_Group::instance()->get_all_custom_templates_by_event(
+			$event_id,
+			array(
+				'MTP_messenger' => $this->name,
+				'MTP_is_active' => true
+			)
+		);
+		$templates_for_event = !empty($templates_for_event) ? $templates_for_event : array();
+
+		// so we need to setup the rows for the selectors and we use the global mtpgs (cause those will the active message template groups)
+		foreach ($global_templates as $mtpgID => $mtpg) {
+			if ($mtpg instanceof EE_Message_Template_Group) {
+				// verify this message type is supposed to show on this page
+				$mtp_obj = $mtpg->message_type_obj();
+				if (! $mtp_obj instanceof EE_message_type) {
+					continue;
+				}
+				$mtp_obj->admin_registered_pages = (array) $mtp_obj->admin_registered_pages;
+				if (! in_array('events_edit', $mtp_obj->admin_registered_pages)) {
+					continue;
+				}
+				$select_values = array();
+				$select_values[ $mtpgID ] = __('Global', 'event_espresso');
+				$default_value = array_key_exists($mtpgID, $templates_for_event) && ! $mtpg->get('MTP_is_override') ? $mtpgID : null;
+				// if the override has been set for the global template, then that means even if there are custom templates already created we ignore them because of the set override.
+				if (! $mtpg->get('MTP_is_override')) {
+					// any custom templates for this message type?
+					$custom_templates = EEM_Message_Template_Group::instance()->get_custom_message_template_by_m_and_mt($this->name, $mtpg->message_type());
+					foreach ($custom_templates as $cmtpgID => $cmtpg) {
+						$select_values[ $cmtpgID ] = $cmtpg->name();
+						$default_value = array_key_exists($cmtpgID, $templates_for_event) ? $cmtpgID : $default_value;
+					}
+				}
+				// if there is no $default_value then we set it as the global
+				$default_value = empty($default_value) ? $mtpgID : $default_value;
+				$edit_url_query_args = [
+					'page' => 'espresso_messages',
+					'action' => 'edit_message_template',
+					'id' => $default_value,
+					'evt_id' => $event_id
+				];
+				$edit_url = EEH_URL::add_query_args_and_nonce($edit_url_query_args, admin_url('admin.php'));
+				$create_url_query_args = [
+					'page' => 'espresso_messages',
+					'action' => 'add_new_message_template',
+					'GRP_ID' => $default_value
+				];
+				$create_url = EEH_URL::add_query_args_and_nonce($create_url_query_args, admin_url('admin.php'));
+				$st_args['mt_name'] = ucwords($mtp_obj->label['singular']);
+				$st_args['mt_slug'] = $mtpg->message_type();
+				$st_args['messenger_slug'] = $this->name;
+				$st_args['selector'] = EEH_Form_Fields::select_input('event_message_templates_relation[' . $mtpgID . ']', $select_values, $default_value, 'data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '"', 'message-template-selector');
+				// note that  message template group that has override_all_custom set will remove the ability to set a custom message template based off of the global (and that also in turn overrides any other custom templates).
+				$st_args['create_button'] = $mtpg->get('MTP_is_override') ? '' : '<a data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $create_url . '" class="button button-small create-mtpg-button">' . __('Create New Custom', 'event_espresso') . '</a>';
+				$st_args['create_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'espresso_messages_add_new_message_template') ? $st_args['create_button'] : '';
+				$st_args['edit_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_message', 'espresso_messages_edit_message_template', $mtpgID) ? '<a data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $edit_url . '" class="button button-small edit-mtpg-button">' . __('Edit', 'event_espresso') . '</a>' : '';
+				$selector_rows .= EEH_Template::display_template($template_row_path, $st_args, true);
+			}
+		}
+
+		// if no selectors present then get out.
+		if (empty($selector_rows)) {
+			return '';
+		}
+
+		$template_args['selector_rows'] = $selector_rows;
+		return EEH_Template::display_template($template_wrapper_path, $template_args, true);
+	}
+
+
+
+
+
+
+	/**
+	 * get_template_fields
+	 *
+	 * @access public
+	 * @return array $this->_template_fields
+	 */
+	public function get_template_fields()
+	{
+		$template_fields = apply_filters('FHEE__' . get_class($this) . '__get_template_fields', $this->_template_fields, $this);
+		$template_fields = apply_filters('FHEE__EE_messenger__get_template_fields', $template_fields, $this);
+		return $template_fields;
+	}
+
+
+
+
+	/** SETUP METHODS **/
+	/**
+	 * The following method doesn't NEED to be used by child classes but might be modified by the specific messenger
+	 * @param string $item
+	 * @param mixed $value
+	 */
+	protected function _set_template_value($item, $value)
+	{
+		if (array_key_exists($item, $this->_template_fields)) {
+			$prop = '_' . $item;
+			$this->{$prop}= $value;
+		}
+	}
+
+	/**
+	 * Sets up the message for sending.
+	 *
+	 * @param  EE_message $message the message object that contains details about the message.
+	 * @param EE_message_type $message_type The message type object used in combination with this messenger to generate the provided message.
+	 *
+	 * @return bool Very important that all messengers return bool for successful send or not.  Error messages can be
+	 *              added to EE_Error.
+	 *              true = message sent successfully
+	 *              false = message not sent but can be retried (i.e. the failure might be just due to communication issues at the time of send).
+	 *              Throwing a SendMessageException means the message failed sending and cannot be retried.
+	 *
+	 * @throws SendMessageException
+	 */
+	final public function send_message($message, EE_message_type $message_type)
+	{
+		try {
+			$this->_validate_and_setup($message);
+			$this->_incoming_message_type = $message_type;
+			$response = $this->_send_message();
+			if ($response instanceof WP_Error) {
+				EE_Error::add_error($response->get_error_message(), __FILE__, __FUNCTION__, __LINE__);
+				$response = false;
+			}
+		} catch (\Exception $e) {
+			// convert to an instance of SendMessageException
+			throw new SendMessageException($e->getMessage());
+		}
+		return $response;
+	}
+
+
+
+	/**
+	 * Sets up and returns message preview
+	 * @param  EE_Message $message incoming message object
+	 * @param EE_message_type $message_type This is whatever message type was used in combination with this messenger to generate the message.
+	 * @param  bool   $send    true we will actually use the _send method (for test sends). FALSE we just return preview
+	 * @return string          return the message html content
+	 */
+	public function get_preview(EE_Message $message, EE_message_type $message_type, $send = false)
+	{
+		$this->_validate_and_setup($message);
+
+		$this->_incoming_message_type = $message_type;
+
+		if ($send) {
+			// are we overriding any existing template fields?
+			$settings = apply_filters(
+				'FHEE__EE_messenger__get_preview__messenger_test_settings',
+				$this->get_existing_test_settings(),
+				$this,
+				$send,
+				$message,
+				$message_type
+			);
+			if (! empty($settings)) {
+				foreach ($settings as $field => $value) {
+					$this->_set_template_value($field, $value);
+				}
+			}
+		}
+
+		// enqueue preview js so that any links/buttons on the page are disabled.
+		if (! $send) {
+			// the below may seem like duplication.  However, typically if a messenger enqueues scripts/styles,
+			// it deregisters all existing wp scripts and styles first.  So the second hook ensures our previewer still gets setup.
+			add_action('admin_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
+			add_action('wp_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
+			add_action('AHEE__EE_messenger__enqueue_scripts_styles', array( $this, 'add_preview_script' ), 10);
+		}
+
+		return $send ? $this->_send_message() : $this->_preview();
+	}
+
+
+
+
+	/**
+	 * Callback for enqueue_scripts so that we setup the preview script for all previews.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	public function add_preview_script()
+	{
+		// error message
+		EE_Registry::$i18n_js_strings['links_disabled'] = wp_strip_all_tags(
+			__('All the links on this page have been disabled because this is a generated preview message for the purpose of ensuring layout, style, and content setup.  To test generated links, you must trigger an actual message notification.', 'event_espresso')
+		);
+		wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL . 'messages/messenger/assets/js/ee-messages-preview.js', array( 'jquery' ), EVENT_ESPRESSO_VERSION, true);
+		wp_localize_script('ee-messages-preview-js', 'eei18n', EE_Registry::$i18n_js_strings);
+		wp_enqueue_script('ee-messages-preview-js');
+	}
+
+
+
+
+	/**
+	 * simply validates the incoming message object and then sets up the properties for the messenger
+	 * @param  EE_Message $message
+	 * @throws EE_Error
+	 */
+	protected function _validate_and_setup(EE_Message $message)
+	{
+		$template_pack = $message->get_template_pack();
+		$variation = $message->get_template_pack_variation();
+
+		// verify we have the required template pack value on the $message object.
+		if (! $template_pack instanceof EE_Messages_Template_Pack) {
+			throw new EE_Error(__('Incoming $message object must have an EE_Messages_Template_Pack object available.', 'event_espresso'));
+		}
+
+		$this->_tmp_pack = $template_pack;
+
+		$this->_variation = $variation ? $variation : 'default';
+
+		$template_fields = $this->get_template_fields();
+
+		foreach ($template_fields as $template => $value) {
+			if ($template !== 'extra') {
+				$column_value = $message->get_field_or_extra_meta('MSG_' . $template);
+				$message_template_value = $column_value ? $column_value : null;
+				$this->_set_template_value($template, $message_template_value);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Utility method for child classes to get the contents of a template file and return
+	 *
+	 * We're assuming the child messenger class has already setup template args!
+	 * @param  bool $preview if true we use the preview wrapper otherwise we use main wrapper.
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _get_main_template($preview = false)
+	{
+		$type = $preview ? 'preview' : 'main';
+
+		$wrapper_template = $this->_tmp_pack->get_wrapper($this->name, $type);
+
+		// check file exists and is readable
+		if (!is_readable($wrapper_template)) {
+			throw new EE_Error(sprintf(__('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso'), ucwords($this->label['singular']), $wrapper_template));
+		}
+
+		// add message type to template args
+		$this->_template_args['message_type'] = $this->_incoming_message_type;
+
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
+	}
+
+
+
+	/**
+	 * set the _test_settings_fields property
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_test_settings_fields()
+	{
+		$this->_test_settings_fields = array();
+	}
+
+
+
+	/**
+	 * return the _test_settings_fields property
+	 * @return array
+	 */
+	public function get_test_settings_fields()
+	{
+		return $this->_test_settings_fields;
+	}
+
+
+
+
+	/**
+	 * This just returns any existing test settings that might be saved in the database
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_existing_test_settings()
+	{
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$settings = $Message_Resource_Manager->get_active_messengers_option();
+		return isset($settings[ $this->name ]['test_settings']) ? $settings[ $this->name ]['test_settings'] : array();
+	}
+
+
+
+	/**
+	 * All this does is set the existing test settings (in the db) for the messenger
+	 *
+	 * @access public
+	 * @param $settings
+	 * @return bool success/fail
+	 */
+	public function set_existing_test_settings($settings)
+	{
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$existing = $Message_Resource_Manager->get_active_messengers_option();
+		$existing[ $this->name ]['test_settings'] = $settings;
+		return $Message_Resource_Manager->update_active_messengers_option($existing);
+	}
+
+
+
+	/**
+	 * This just returns the field label for a given field setup in the _template_fields property.
+	 *
+	 * @since   4.3.0
+	 *
+	 * @param string $field The field to retrieve the label for
+	 * @return string             The label
+	 */
+	public function get_field_label($field)
+	{
+		// first let's see if the field requests is in the top level array.
+		if (isset($this->_template_fields[ $field ]) && !empty($this->_template_fields[ $field ]['label'])) {
+			return $this->_template[ $field ]['label'];
+		}
+
+		// nope so let's look in the extra array to see if it's there HOWEVER if the field exists as a top level index in the extra array then we know the label is in the 'main' index.
+		if (isset($this->_template_fields['extra']) && !empty($this->_template_fields['extra'][ $field ]) && !empty($this->_template_fields['extra'][ $field ]['main']['label'])) {
+			return $this->_template_fields['extra'][ $field ]['main']['label'];
+		}
+
+		// now it's possible this field may just be existing in any of the extra array items.
+		if (!empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
+			foreach ($this->_template_fields['extra'] as $main_field => $subfields) {
+				if (!is_array($subfields)) {
+					continue;
+				}
+				if (isset($subfields[ $field ]) && !empty($subfields[ $field ]['label'])) {
+					return $subfields[ $field ]['label'];
+				}
+			}
+		}
+
+		// if we made it here then there's no label set so let's just return the $field.
+		return $field;
+	}
+
+
+
+
+	/**
+	 * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger is a different messenger.  Child messengers can set hooks for the sending messenger to callback on if necessary (i.e. swap out css files or something else).
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed.
+	 *
+	 * @return void
+	 */
+	public function do_secondary_messenger_hooks($sending_messenger_name)
+	{
+		return;
+	}
 }

Spacing +37 added lines, -37 removed lines

@@ -417,7 +417,7 @@ 
         $class = get_class($this);
 
         // messenger specific filter
-        $default_types = apply_filters('FHEE__' . $class . '__get_default_message_types__default_types', $this->_default_message_types, $this);
+        $default_types = apply_filters('FHEE__'.$class.'__get_default_message_types__default_types', $this->_default_message_types, $this);
 
         // all messengers filter
         $default_types = apply_filters('FHEE__EE_messenger__get_default_message_types__default_types', $default_types, $this);
@@ -440,7 +440,7 @@ 
 
         // messenger specific filter
         // messenger specific filter
-        $valid_types = apply_filters('FHEE__' . $class . '__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
+        $valid_types = apply_filters('FHEE__'.$class.'__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
 
         // all messengers filter
         $valid_types = apply_filters('FHEE__EE_messenger__get_valid_message_types__valid_types', $valid_types, $this);
@@ -475,7 +475,7 @@ 
     {
         $class = get_class($this);
 
-        $config = apply_filters('FHEE__' . $class . '__get_validator_config', $this->_validator_config, $this);
+        $config = apply_filters('FHEE__'.$class.'__get_validator_config', $this->_validator_config, $this);
         $config = apply_filters('FHEE__EE_messenger__get_validator_config', $config, $this);
         return $config;
     }
@@ -514,12 +514,12 @@ 
         // we don't need message types here so we're just going to ignore. we do, however, expect the event id here. The event id is needed to provide a link to setup a custom template for this event.
         $event_id = isset($extra['event']) ? $extra['event'] : null;
 
-        $template_wrapper_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
-        $template_row_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_row.template.php';
+        $template_wrapper_path = EE_LIBRARIES.'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
+        $template_row_path = EE_LIBRARIES.'messages/messenger/admin_templates/event_switcher_row.template.php';
 
         // array of template objects for global and custom (non-trashed) (but remember just for this messenger!)
         $global_templates = EEM_Message_Template_Group::instance()->get_all(
-            array( array( 'MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true ) )
+            array(array('MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true))
         );
         $templates_for_event = EEM_Message_Template_Group::instance()->get_all_custom_templates_by_event(
             $event_id,
@@ -528,29 +528,29 @@ 
                 'MTP_is_active' => true
             )
         );
-        $templates_for_event = !empty($templates_for_event) ? $templates_for_event : array();
+        $templates_for_event = ! empty($templates_for_event) ? $templates_for_event : array();
 
         // so we need to setup the rows for the selectors and we use the global mtpgs (cause those will the active message template groups)
         foreach ($global_templates as $mtpgID => $mtpg) {
             if ($mtpg instanceof EE_Message_Template_Group) {
                 // verify this message type is supposed to show on this page
                 $mtp_obj = $mtpg->message_type_obj();
-                if (! $mtp_obj instanceof EE_message_type) {
+                if ( ! $mtp_obj instanceof EE_message_type) {
                     continue;
                 }
                 $mtp_obj->admin_registered_pages = (array) $mtp_obj->admin_registered_pages;
-                if (! in_array('events_edit', $mtp_obj->admin_registered_pages)) {
+                if ( ! in_array('events_edit', $mtp_obj->admin_registered_pages)) {
                     continue;
                 }
                 $select_values = array();
-                $select_values[ $mtpgID ] = __('Global', 'event_espresso');
+                $select_values[$mtpgID] = __('Global', 'event_espresso');
                 $default_value = array_key_exists($mtpgID, $templates_for_event) && ! $mtpg->get('MTP_is_override') ? $mtpgID : null;
                 // if the override has been set for the global template, then that means even if there are custom templates already created we ignore them because of the set override.
-                if (! $mtpg->get('MTP_is_override')) {
+                if ( ! $mtpg->get('MTP_is_override')) {
                     // any custom templates for this message type?
                     $custom_templates = EEM_Message_Template_Group::instance()->get_custom_message_template_by_m_and_mt($this->name, $mtpg->message_type());
                     foreach ($custom_templates as $cmtpgID => $cmtpg) {
-                        $select_values[ $cmtpgID ] = $cmtpg->name();
+                        $select_values[$cmtpgID] = $cmtpg->name();
                         $default_value = array_key_exists($cmtpgID, $templates_for_event) ? $cmtpgID : $default_value;
                     }
                 }
@@ -572,11 +572,11 @@ 
                 $st_args['mt_name'] = ucwords($mtp_obj->label['singular']);
                 $st_args['mt_slug'] = $mtpg->message_type();
                 $st_args['messenger_slug'] = $this->name;
-                $st_args['selector'] = EEH_Form_Fields::select_input('event_message_templates_relation[' . $mtpgID . ']', $select_values, $default_value, 'data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '"', 'message-template-selector');
+                $st_args['selector'] = EEH_Form_Fields::select_input('event_message_templates_relation['.$mtpgID.']', $select_values, $default_value, 'data-messenger="'.$this->name.'" data-messagetype="'.$mtpg->message_type().'"', 'message-template-selector');
                 // note that  message template group that has override_all_custom set will remove the ability to set a custom message template based off of the global (and that also in turn overrides any other custom templates).
-                $st_args['create_button'] = $mtpg->get('MTP_is_override') ? '' : '<a data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $create_url . '" class="button button-small create-mtpg-button">' . __('Create New Custom', 'event_espresso') . '</a>';
+                $st_args['create_button'] = $mtpg->get('MTP_is_override') ? '' : '<a data-messenger="'.$this->name.'" data-messagetype="'.$mtpg->message_type().'" data-grpid="'.$default_value.'" target="_blank" href="'.$create_url.'" class="button button-small create-mtpg-button">'.__('Create New Custom', 'event_espresso').'</a>';
                 $st_args['create_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'espresso_messages_add_new_message_template') ? $st_args['create_button'] : '';
-                $st_args['edit_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_message', 'espresso_messages_edit_message_template', $mtpgID) ? '<a data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $edit_url . '" class="button button-small edit-mtpg-button">' . __('Edit', 'event_espresso') . '</a>' : '';
+                $st_args['edit_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_message', 'espresso_messages_edit_message_template', $mtpgID) ? '<a data-messagetype="'.$mtpg->message_type().'" data-grpid="'.$default_value.'" target="_blank" href="'.$edit_url.'" class="button button-small edit-mtpg-button">'.__('Edit', 'event_espresso').'</a>' : '';
                 $selector_rows .= EEH_Template::display_template($template_row_path, $st_args, true);
             }
         }
@@ -603,7 +603,7 @@ 
      */
     public function get_template_fields()
     {
-        $template_fields = apply_filters('FHEE__' . get_class($this) . '__get_template_fields', $this->_template_fields, $this);
+        $template_fields = apply_filters('FHEE__'.get_class($this).'__get_template_fields', $this->_template_fields, $this);
         $template_fields = apply_filters('FHEE__EE_messenger__get_template_fields', $template_fields, $this);
         return $template_fields;
     }
@@ -620,8 +620,8 @@ 
     protected function _set_template_value($item, $value)
     {
         if (array_key_exists($item, $this->_template_fields)) {
-            $prop = '_' . $item;
-            $this->{$prop}= $value;
+            $prop = '_'.$item;
+            $this->{$prop} = $value;
         }
     }
 
@@ -681,7 +681,7 @@ 
                 $message,
                 $message_type
             );
-            if (! empty($settings)) {
+            if ( ! empty($settings)) {
                 foreach ($settings as $field => $value) {
                     $this->_set_template_value($field, $value);
                 }
@@ -689,12 +689,12 @@ 
         }
 
         // enqueue preview js so that any links/buttons on the page are disabled.
-        if (! $send) {
+        if ( ! $send) {
             // the below may seem like duplication.  However, typically if a messenger enqueues scripts/styles,
             // it deregisters all existing wp scripts and styles first.  So the second hook ensures our previewer still gets setup.
-            add_action('admin_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
-            add_action('wp_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
-            add_action('AHEE__EE_messenger__enqueue_scripts_styles', array( $this, 'add_preview_script' ), 10);
+            add_action('admin_enqueue_scripts', array($this, 'add_preview_script'), 10);
+            add_action('wp_enqueue_scripts', array($this, 'add_preview_script'), 10);
+            add_action('AHEE__EE_messenger__enqueue_scripts_styles', array($this, 'add_preview_script'), 10);
         }
 
         return $send ? $this->_send_message() : $this->_preview();
@@ -716,7 +716,7 @@ 
         EE_Registry::$i18n_js_strings['links_disabled'] = wp_strip_all_tags(
             __('All the links on this page have been disabled because this is a generated preview message for the purpose of ensuring layout, style, and content setup.  To test generated links, you must trigger an actual message notification.', 'event_espresso')
         );
-        wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL . 'messages/messenger/assets/js/ee-messages-preview.js', array( 'jquery' ), EVENT_ESPRESSO_VERSION, true);
+        wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL.'messages/messenger/assets/js/ee-messages-preview.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
         wp_localize_script('ee-messages-preview-js', 'eei18n', EE_Registry::$i18n_js_strings);
         wp_enqueue_script('ee-messages-preview-js');
     }
@@ -735,7 +735,7 @@ 
         $variation = $message->get_template_pack_variation();
 
         // verify we have the required template pack value on the $message object.
-        if (! $template_pack instanceof EE_Messages_Template_Pack) {
+        if ( ! $template_pack instanceof EE_Messages_Template_Pack) {
             throw new EE_Error(__('Incoming $message object must have an EE_Messages_Template_Pack object available.', 'event_espresso'));
         }
 
@@ -747,7 +747,7 @@ 
 
         foreach ($template_fields as $template => $value) {
             if ($template !== 'extra') {
-                $column_value = $message->get_field_or_extra_meta('MSG_' . $template);
+                $column_value = $message->get_field_or_extra_meta('MSG_'.$template);
                 $message_template_value = $column_value ? $column_value : null;
                 $this->_set_template_value($template, $message_template_value);
             }
@@ -771,7 +771,7 @@ 
         $wrapper_template = $this->_tmp_pack->get_wrapper($this->name, $type);
 
         // check file exists and is readable
-        if (!is_readable($wrapper_template)) {
+        if ( ! is_readable($wrapper_template)) {
             throw new EE_Error(sprintf(__('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso'), ucwords($this->label['singular']), $wrapper_template));
         }
 
@@ -819,7 +819,7 @@ 
         /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
         $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
         $settings = $Message_Resource_Manager->get_active_messengers_option();
-        return isset($settings[ $this->name ]['test_settings']) ? $settings[ $this->name ]['test_settings'] : array();
+        return isset($settings[$this->name]['test_settings']) ? $settings[$this->name]['test_settings'] : array();
     }
 
 
@@ -836,7 +836,7 @@ 
         /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
         $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
         $existing = $Message_Resource_Manager->get_active_messengers_option();
-        $existing[ $this->name ]['test_settings'] = $settings;
+        $existing[$this->name]['test_settings'] = $settings;
         return $Message_Resource_Manager->update_active_messengers_option($existing);
     }
 
@@ -853,23 +853,23 @@ 
     public function get_field_label($field)
     {
         // first let's see if the field requests is in the top level array.
-        if (isset($this->_template_fields[ $field ]) && !empty($this->_template_fields[ $field ]['label'])) {
-            return $this->_template[ $field ]['label'];
+        if (isset($this->_template_fields[$field]) && ! empty($this->_template_fields[$field]['label'])) {
+            return $this->_template[$field]['label'];
         }
 
         // nope so let's look in the extra array to see if it's there HOWEVER if the field exists as a top level index in the extra array then we know the label is in the 'main' index.
-        if (isset($this->_template_fields['extra']) && !empty($this->_template_fields['extra'][ $field ]) && !empty($this->_template_fields['extra'][ $field ]['main']['label'])) {
-            return $this->_template_fields['extra'][ $field ]['main']['label'];
+        if (isset($this->_template_fields['extra']) && ! empty($this->_template_fields['extra'][$field]) && ! empty($this->_template_fields['extra'][$field]['main']['label'])) {
+            return $this->_template_fields['extra'][$field]['main']['label'];
         }
 
         // now it's possible this field may just be existing in any of the extra array items.
-        if (!empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
+        if ( ! empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
             foreach ($this->_template_fields['extra'] as $main_field => $subfields) {
-                if (!is_array($subfields)) {
+                if ( ! is_array($subfields)) {
                     continue;
                 }
-                if (isset($subfields[ $field ]) && !empty($subfields[ $field ]['label'])) {
-                    return $subfields[ $field ]['label'];
+                if (isset($subfields[$field]) && ! empty($subfields[$field]['label'])) {
+                    return $subfields[$field]['label'];
                 }
             }
         }